pyxecm 1.5__py3-none-any.whl → 2.0.0__py3-none-any.whl

pyxecm/otawp.py

@@ -0,0 +1,2689 @@
+"""Synchronize AppWorks projects, publsh and create run time instances for that."""
+
+__author__ = "Dr. Marc Diefenbruch"
+__copyright__ = "Copyright (C) 2024-2025, OpenText"
+__credits__ = ["Kai-Philip Gatzweiler"]
+__maintainer__ = "Dr. Marc Diefenbruch"
+__email__ = "mdiefenb@opentext.com"
+
+import json
+import logging
+import re
+import time
+import uuid
+import xml.etree.ElementTree as ET
+
+import requests
+
+from pyxecm.otds import OTDS
+
+default_logger = logging.getLogger("pyxecm.otawp")
+
+REQUEST_HEADERS = {
+    "Content-Type": "text/xml; charset=utf-8",
+    "accept": "application/xml",
+}
+
+REQUEST_FORM_HEADERS = {
+    "accept": "application/xml;charset=utf-8",
+    "Content-Type": "application/x-www-form-urlencoded",
+}
+
+REQUEST_HEADERS_JSON = {
+    "Content-Type": "application/json; charset=utf-8",
+    "accept": "application/json",
+}
+REQUEST_TIMEOUT = 120
+SYNC_PUBLISH_REQUEST_TIMEOUT = 300
+
+
+class OTAWP:
+    """Class OTRAWP is used to automate settings in OpenText AppWorks Platform (OTAWP)."""
+
+    logger: logging.Logger = default_logger
+
+    _config: dict
+    _config = None
+    _cookie = None
+    _otawp_ticket = None
+
+    def __init__(
+        self,
+        protocol: str,
+        hostname: str,
+        port: int,
+        username: str | None = None,
+        password: str | None = None,
+        otawp_ticket: str | None = None,
+        otcs_partition_name: str | None = None,
+        otds_admin_partition_mame: str | None = None,
+        config_map_name: str | None = None,
+        otcs_resource_id: str | None = None,
+        otds_url: str | None = None,
+        otcs_url: str | None = None,
+        otcs_base_path: str | None = None,
+        license_file: str | None = None,
+        product_name: str | None = None,
+        product_description: str | None = None,
+        logger: logging.Logger = default_logger,
+    ) -> None:
+        """Initialize OTAWP (AppWorks Platform) object.
+
+        Args:
+            protocol (str): #TODO _description_
+            hostname (str): #TODO _description_
+            port (int): #TODO _description_
+            username (str | None, optional): #TODO _description_. Defaults to None.
+            password (str | None, optional): #TODO _description_. Defaults to None.
+            otawp_ticket (str | None, optional): #TODO _description_. Defaults to None.
+            otcs_partition_name (str | None, optional): #TODO _description_. Defaults to None.
+            otds_admin_partition_mame (str | None, optional): #TODO _description_. Defaults to None.
+            config_map_name (str | None, optional): #TODO _description_. Defaults to None.
+            otcs_resource_id (str | None, optional): #TODO _description_. Defaults to None.
+            otds_url (str | None, optional): #TODO _description_. Defaults to None.
+            otcs_url (str | None, optional): #TODO _description_. Defaults to None.
+            otcs_base_path (str | None, optional): #TODO _description_. Defaults to None.
+            license_file (str | None, optional): #TODO _description_. Defaults to None.
+            product_name (str | None, optional): #TODO _description_. Defaults to None.
+            product_description (str | None, optional): #TODO _description_. Defaults to None.
+            logger (logging.Logger, optional): #TODO: _description_. Defaults to default_logger.
+
+        """
+
+        if logger != default_logger:
+            self.logger = logger.getChild("otawp")
+            for logfilter in logger.filters:
+                self.logger.addFilter(logfilter)
+
+        otawp_config = {}
+
+        otawp_config["hostname"] = hostname if hostname else "appworks"
+        otawp_config["protocol"] = protocol if protocol else "http"
+        otawp_config["port"] = port if port else 8080
+        otawp_config["username"] = username if username else "sysadmin"
+        otawp_config["password"] = password if password else ""
+        otawp_config["otcs_partition_name"] = otcs_partition_name if otcs_partition_name else ""
+        otawp_config["otds_admin_partition_mame"] = otds_admin_partition_mame if otds_admin_partition_mame else ""
+        otawp_config["config_map_name"] = config_map_name if config_map_name else ""
+        otawp_config["otcs_resource_id"] = otcs_resource_id if otcs_resource_id else ""
+        otawp_config["otds_url"] = otds_url if otds_url else ""
+        otawp_config["otcs_url"] = otcs_url if otcs_url else ""
+        otawp_config["otcs_base_path"] = otcs_base_path if otcs_base_path else ""
+        otawp_config["license_file"] = license_file if license_file else ""
+        otawp_config["product_name"] = product_name if product_name else "APPWORKS_PLATFORM"
+        otawp_config["product_description"] = (
+            product_description if product_description else "OpenText Appworks Platform"
+        )
+
+        if otawp_ticket:
+            self._cookie = {"defaultinst_SAMLart": otawp_ticket}
+
+        server = "{}://{}".format(protocol, otawp_config["hostname"])
+        if str(port) not in ["80", "443"]:
+            server += f":{port}"
+
+        otawp_base_url = server + "/home/system"
+
+        otawp_config["server"] = server if server else "http://appworks"
+
+        otawp_config["gatewayAuthenticationUrl"] = (
+            otawp_base_url
+            + "/com.eibus.web.soap.Gateway.wcp?organization=o=system,cn=cordys,cn=defaultInst,o=opentext.net"
+        )
+
+        otawp_config["soapGatewayUrl"] = (
+            otawp_base_url
+            + "/com.eibus.web.soap.Gateway.wcp?organization=o=system,cn=cordys,cn=defaultInst,o=opentext.net&defaultinst_ct=abcd"
+        )
+
+        otawp_config["createPriority"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Priority?defaultinst_ct=abcd"
+        )
+        otawp_config["getAllPriorities"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Priority/lists/PriorityList"
+        )
+
+        otawp_config["createCustomer"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Customer?defaultinst_ct=abcd"
+        )
+        otawp_config["getAllCustomers"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Customer/lists/CustomerList"
+        )
+
+        otawp_config["createCaseType"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/CaseType?defaultinst_ct=abcd"
+        )
+        otawp_config["getAllCaseTypes"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/CaseType/lists/AllCaseTypes"
+        )
+
+        otawp_config["createCategory"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Category?defaultinst_ct=abcd"
+        )
+        otawp_config["getAllCategories"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Category/lists/CategoryList"
+        )
+
+        otawp_config["createSource"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Source"
+        )
+
+        otawp_config["getAllSources"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Source/lists/AllSources"
+        )
+
+        otawp_config["getAllSubCategories"] = (
+            otawp_base_url
+            + "/app/entityRestService/api/OpentextCaseManagement/entities/Category/childEntities/SubCategory/lists/AllSubcategories"
+        )
+
+        otawp_config["baseurl"] = otawp_base_url + ""
+        otawp_config["createLoan"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Case?defaultinst_ct=abcd"
+        )
+        otawp_config["getAllLoans"] = (
+            otawp_base_url + "/app/entityRestService/api/OpentextCaseManagement/entities/Case/lists/AllCasesList"
+        )
+        self._config = otawp_config
+
+    # end method definition
+
+    def server(self) -> str:
+        """Return server information.
+
+        Returns:
+            str:
+                Server configuration.
+
+        """
+
+        return self.config()["server"]
+
+    # end method definition
+
+    def set_organization(self, organization: str) -> None:
+        """Set the organization context.
+
+        Args:
+            organization (str):
+                Organization name.
+
+        """
+
+        otawp_base_url = f"/home/{organization}"
+        otawp_url = self.server() + otawp_base_url
+        ldap_root = (
+            f"com.eibus.web.soap.Gateway.wcp?organization=o={organization},cn=cordys,cn=defaultInst,o=opentext.net"
+        )
+
+        # Assign to self._config if that's where you store configuration data
+        self._config["gatewayAuthenticationUrl"] = otawp_url + f"/com.eibus.web.soap.Gateway.wcp?{ldap_root}"
+
+        self._config["soapGatewayUrl"] = otawp_url + f"/com.eibus.web.soap.Gateway.wcp?{ldap_root}&defaultinst_ct=abcd"
+
+        self.logger.info("Organization set to '%s'.", organization)
+
+    # end method definition
+
+    def baseurl(self) -> str:
+        """Return the configuration dictionary.
+
+        Returns:
+            str:
+                Base URL of AppWorks Platform.
+
+        """
+
+        return self.config()["baseurl"]
+
+    # end method definition
+
+    def license_file(self) -> str:
+        """Return the license_file.
+
+        Returns:
+            str:
+                Returns license_file
+
+        """
+
+        return self.config()["license_file"]
+
+    # end method definition
+
+    def product_name(self) -> str:
+        """Return the product_name.
+
+        Returns:
+            str:
+                Returns product_name
+
+        """
+
+        return self.config()["product_name"]
+
+    # end method definition
+
+    def product_description(self) -> str:
+        """Return the product_description.
+
+        Returns:
+            str:
+                Returns product_description
+
+        """
+
+        return self.config()["product_description"]
+
+    # end method definition
+
+    def hostname(self) -> str:
+        """Return hostname.
+
+        Returns:
+            str: Returns hostname
+
+        """
+
+        return self.config()["hostname"]
+
+    def username(self) -> str:
+        """Return username.
+
+        Returns:
+            str: Returns username
+
+        """
+        return self.config()["username"]
+
+    # end method definition
+
+    def password(self) -> str:
+        """Return password.
+
+        Returns:
+            str: Returns password
+
+        """
+        return self.config()["password"]
+
+    # end method definition
+
+    def otcs_partition_name(self) -> str:
+        """Return OTCS partition name.
+
+        Returns:
+            str: Returns OTCS partition name
+
+        """
+        return self.config()["otcs_partition_name"]
+
+    # end method definition
+
+    def otds_admin_partition_mame(self) -> str:
+        """Return OTDS admin partition name.
+
+        Returns:
+            str:
+                Returns OTDS admin partition mame.
+
+        """
+
+        return self.config()["otds_admin_partition_mame"]
+
+    # end method definition
+
+    def config_map_name(self) -> str:
+        """Return config map name.
+
+        Returns:
+            str:
+                Returns config map name
+
+        """
+        return self.config()["config_map_name"]
+
+    # end method definition
+
+    def otcs_resource_id(self) -> str:
+        """Return OTCS resource ID.
+
+        Returns:
+            str:
+                Returns otcs resource id
+
+        """
+        return self.config()["otcs_resource_id"]
+
+    # end method definition
+
+    def otcs_url(self) -> str:
+        """Return OTCS URL.
+
+        Returns:
+            str:
+                Returns the OTCS URL.
+
+        """
+        return self.config()["otcs_url"]
+
+    # end method definition
+
+    def otds_url(self) -> str:
+        """Return the OTDS URL.
+
+        Returns:
+            str:
+                Returns otds url
+
+        """
+        return self.config()["otds_url"]
+
+    # end method definition
+
+    def otcs_base_path(self) -> str:
+        """Return the OTCS base path.
+
+        Returns:
+            str: Returns otcs base path
+
+        """
+        return self.config()["otcs_base_path"]
+
+    # end method definition
+
+    def config(self) -> dict:
+        """Return the configuration dictionary.
+
+        Returns:
+            dict: Configuration dictionary
+
+        """
+
+        return self._config
+
+    # end method definition
+
+    def cookie(self) -> dict:
+        """Return the login cookie of OTAWP.
+
+        This is set by the authenticate() method
+
+        Returns:
+            dict:
+                OTAWP cookie
+
+        """
+
+        return self._cookie
+
+    # end method definition
+
+    def credentials(self) -> str:
+        """Return the SOAP payload with credentials (username and password).
+
+        Returns:
+            str:
+                SOAP payload with username and password.
+
+        """
+
+        username = self.config()["username"]
+        password = self.config()["password"]
+
+        soap_payload = f"""
+        <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Header>
+                <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+                    <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+                        <wsse:Username>{username}</wsse:Username>
+                        <wsse:Password>{password}</wsse:Password>
+                    </wsse:UsernameToken>
+                    <i18n:international xmlns:i18n="http://www.w3.org/2005/09/ws-i18n">
+                        <locale xmlns="http://www.w3.org/2005/09/ws-i18n">en-US</locale>
+                    </i18n:international>
+                </wsse:Security>
+            </SOAP:Header>
+            <SOAP:Body>
+                <samlp:Request xmlns:samlp="urn:oasis:names:tc:SAML:1.0:protocol" MajorVersion="1" MinorVersion="1">
+                    <samlp:AuthenticationQuery>
+                        <saml:Subject xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion">
+                            <saml:NameIdentifier Format="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified">{username}</saml:NameIdentifier>
+                        </saml:Subject>
+                    </samlp:AuthenticationQuery>
+                </samlp:Request>
+            </SOAP:Body>
+        </SOAP:Envelope>
+        """
+
+        return soap_payload
+
+    # end method definition
+
+    def credential_url(self) -> str:
+        """Return the Credentials URL of OTAWP.
+
+        Returns:
+            str: Credentials URL
+
+        """
+
+        return self.config()["gatewayAuthenticationUrl"]
+
+    # end method definition
+
+    def gateway_url(self) -> str:
+        """Return SOAP gateway URL of OTAWP.
+
+        Returns:
+            str:
+                The SOAP gateway URL.
+
+        """
+
+        return self.config()["soapGatewayUrl"]
+
+    # end method definition
+
+    def create_priority_url(self) -> str:
+        """Return create priority URL of OTAWP.
+
+        Returns:
+            str: createPriority  URL
+
+        """
+
+        return self.config()["createPriority"]
+
+    # end method definition
+
+    def get_all_priorities_url(self) -> str:
+        """Return get all priorities URL of OTAWP.
+
+        Returns:
+            str:
+                The getAllPriorities URL of OTAWP.
+
+        """
+
+        return self.config()["getAllPriorities"]
+
+    # end method definition
+
+    def create_customer_url(self) -> str:
+        """Return create customer URL of OTAWP.
+
+        Returns:
+            str:
+                The create customer URL.
+
+        """
+
+        return self.config()["createCustomer"]
+
+    # end method definition
+
+    def get_all_customeres_url(self) -> str:
+        """Return get all customers URL of OTAWP.
+
+        Returns:
+            str:
+                The get all customers URL.
+
+        """
+
+        return self.config()["getAllCustomers"]
+
+    # end method definition
+
+    def create_casetype_url(self) -> str:
+        """Return create case type URL of OTAWP.
+
+        Returns:
+            str:
+                The create case type URL.
+
+        """
+
+        return self.config()["createCaseType"]
+
+    # end method definition
+
+    def get_all_case_types_url(self) -> str:
+        """Return get all case types URL of OTAWP.
+
+        Returns:
+            str:
+                The get all case types URL.
+
+        """
+
+        return self.config()["getAllCaseTypes"]
+
+    # end method definition
+
+    def create_category_url(self) -> str:
+        """Return create category URL of OTAWP.
+
+        Returns:
+            str:
+                The create category URL.
+
+        """
+
+        return self.config()["createCategory"]
+
+    # end method definition
+
+    def get_all_categories_url(self) -> str:
+        """Return the get all categories URL of OTAWP.
+
+        Returns:
+            str:
+                The get all categories URL.
+
+        """
+
+        return self.config()["getAllCategories"]
+
+    # end method definition
+
+    def get_all_loans_url(self) -> str:
+        """Return get all loans URL of OTAWP.
+
+        Returns:
+            str:
+                The get all loans URL.
+
+        """
+
+        return self.config()["getAllLoans"]
+
+    # end method definition
+
+    def remove_namespace(self, tag: str) -> str:
+        """Remove namespace from XML tag."""
+
+        return tag.split("}", 1)[-1]
+
+    # end method definition
+
+    def parse_xml(self, xml_string: str) -> dict:
+        """Parse XML string and return a dictionary without namespaces."""
+
+        def element_to_dict(element) -> dict:  # noqa: ANN001
+            """Convert XML element to dictionary."""
+            tag = self.remove_namespace(element.tag)
+            children = list(element)
+            if children:
+                return {
+                    tag: {self.remove_namespace(child.tag): element_to_dict(child) for child in children},
+                }
+            return {tag: element.text.strip() if element.text else None}
+
+        root = ET.fromstring(xml_string)
+
+        return element_to_dict(root)
+
+    # end method definition
+
+    def find_key(self, data: dict | list, target_key: str) -> str:
+        """Recursively search for a key in a nested dictionary and return its value.
+
+        Args:
+            data (dict | list):
+                TODO: _description_
+            target_key (str):
+                TODO: _description_
+
+        Returns:
+            _type_: _description_
+
+        """
+
+        if isinstance(data, dict):
+            if target_key in data:
+                return data[target_key]
+            for value in data.values():
+                result = self.find_key(value, target_key)
+                if result is not None:
+                    return result
+        elif isinstance(data, list):
+            for item in data:
+                result = self.find_key(item, target_key)
+                if result is not None:
+                    return result
+
+        return None
+
+    # end method definition
+
+    def parse_request_response(
+        self,
+        response_object: object,
+        additional_error_message: str = "",
+        show_error: bool = True,
+    ) -> dict | None:
+        """Convert the text property of a request response object to a Python dict in a safe way.
+
+        Properly handle exceptions.
+
+        AppWorks may produce corrupt response when it gets restarted
+        or hitting resource limits. So we try to avoid a fatal error and bail
+        out more gracefully.
+
+        Args:
+            response_object (object):
+                This is reponse object delivered by the request call.
+            additional_error_message (str):
+                Print a custom error message.
+            show_error (bool):
+                If True log an error, if False log a warning.
+
+        Returns:
+            dict:
+                Response or None in case of an error.
+
+        """
+
+        if not response_object:
+            return None
+
+        try:
+            dict_object = json.loads(response_object.text)
+        except json.JSONDecodeError as exception:
+            if additional_error_message:
+                message = "Cannot decode response as JSon. {}; error -> {}".format(
+                    additional_error_message,
+                    exception,
+                )
+            else:
+                message = "Cannot decode response as JSon; error -> {}".format(
+                    exception,
+                )
+            if show_error:
+                self.logger.error(message)
+            else:
+                self.logger.warning(message)
+            return None
+        return dict_object
+
+    # end method definition
+
+    def authenticate(self, revalidate: bool = False) -> dict | None:
+        """Authenticate at AppWorks.
+
+        Args:
+            revalidate (bool, optional):
+                Determine if a re-authentication is enforced
+                (e.g. if session has timed out with 401 error).
+
+        Returns:
+            dict:
+                Cookie information. Also stores cookie information in self._cookie
+
+        """
+
+        self.logger.info("SAMLart generation started")
+        if self._cookie and not revalidate:
+            self.logger.debug(
+                "Session still valid - return existing cookie -> %s",
+                str(self._cookie),
+            )
+            return self._cookie
+
+        otawp_ticket = "NotSet"
+
+        response = None
+        try:
+            self.credentials()
+            response = requests.post(
+                url=self.credential_url(),
+                data=self.credentials(),
+                headers=REQUEST_HEADERS,
+                timeout=REQUEST_TIMEOUT,
+            )
+        except requests.exceptions.RequestException as exception:
+            self.logger.warning(
+                "Unable to connect to OTAWP authentication endpoint -> %s; error -> %s",
+                self.credential_url(),
+                str(exception),
+            )
+            self.logger.warning("OTAWP service may not be ready yet.")
+            return None
+
+        if response.ok:
+            self.logger.info("SAMLart generated successfully")
+            authenticate_dict = self.parse_xml(response.text)
+            if not authenticate_dict:
+                return None
+            assertion_artifact_dict = self.find_key(
+                authenticate_dict,
+                "AssertionArtifact",
+            )
+            if isinstance(assertion_artifact_dict, dict):
+                otawp_ticket = assertion_artifact_dict.get("AssertionArtifact")
+                self.logger.debug("SAML token -> %s", otawp_ticket)
+        else:
+            self.logger.error(
+                "Failed to request an OTAWP ticket; error -> %s",
+                response.text,
+            )
+            return None
+
+        self._cookie = {"defaultinst_SAMLart": otawp_ticket, "defaultinst_ct": "abcd"}
+        self._otawp_ticket = otawp_ticket
+
+        return self._cookie
+
+    # end method definition
+
+    def create_workspace(self, workspace_name: str, workspace_id: str) -> dict | None:
+        """Create a workspace in cws.
+
+        Args:
+            workspace_name (str):
+                The name of the workspace.
+            workspace_id (str):
+                The ID of the workspace.
+
+        Returns:
+            dict | None:
+                Response dictionary or error text
+
+        """
+
+        self.logger.info(
+            "Create workspace -> '%s' (%s)...",
+            workspace_name,
+            workspace_id,
+        )
+        unique_id = uuid.uuid4()
+
+        license_post_body_json = f"""<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+    <SOAP:Body>
+        <createWorkspace xmlns="http://schemas.cordys.com/cws/runtime/types/workspace/creation/DevelopmentWorkspaceCreator/1.0" async="false" workspaceID="__CWS System__" xmlns:c="http://schemas.cordys.com/cws/1.0">
+            <instance>
+                <c:Document s="T" path="D43B04C1-CD0B-A1EB-A898-53C71DB5D652">
+                    <c:Header>
+                        <c:System>
+                            <c:TypeID>001A6B1E-0C0C-11DF-F5E9-866B84E5D671</c:TypeID>
+                            <c:ID>D43B04C1-CD0B-A1EB-A898-53C71DB5D652</c:ID>
+                            <c:Name>D43B04C1-CD0B-A1EB-A898-53C71DB5D652</c:Name>
+                            <c:Description>D43B04C1-CD0B-A1EB-A898-53C71DB5D652</c:Description>
+                        </c:System>
+                    </c:Header>
+                    <c:Content>
+                        <DevelopmentWorkspaceCreator type="com.cordys.cws.runtime.types.workspace.creation.DevelopmentWorkspaceCreator" runtimeDocumentID="D43B04C1-CD0B-A1EB-A898-53C71DB61652">
+                            <Workspace>
+                                <uri id="{workspace_id}"/>
+                            </Workspace>
+                        </DevelopmentWorkspaceCreator>
+                    </c:Content>
+                </c:Document>
+            </instance>
+            <__prefetch>
+                <Document xmlns="http://schemas.cordys.com/cws/1.0" path="{workspace_name}" s="N" isLocal="IN_LOCAL">
+                    <Header>
+                        <System>
+                            <ID>{workspace_id}</ID>
+                            <Name>{workspace_name}</Name>
+                            <TypeID>{{4CE11E00-2D97-45C0-BC6C-FAEC1D871026}}</TypeID>
+                            <ParentID/>
+                            <Description>{workspace_name}</Description>
+                            <CreatedBy>sysadmin</CreatedBy>
+                            <CreationDate/>
+                            <LastModifiedBy>sysadmin</LastModifiedBy>
+                            <LastModifiedDate>2021-04-21T06:52:34.254</LastModifiedDate>
+                            <FQN/>
+                            <Annotation/>
+                            <ParentID/>
+                            <OptimisticLock/>
+                        </System>
+                    </Header>
+                    <Content>
+                        <DevelopmentWorkspace xmlns="http://schemas.cordys.com/cws/runtime/types/workspace/DevelopmentWorkspace/1.0" runtimeDocumentID="D43B04C1-CD0B-A1EB-A898-53C71DB59652" type="com.cordys.cws.runtime.types.workspace.DevelopmentWorkspace">
+                            <ExternalID/>
+                            <OrganizationName/>
+                            <SCMAdapter>
+                                <uri id="{unique_id}"/>
+                            </SCMAdapter>
+                            <UpgradedTo/>
+                            <LastWorkspaceUpgradeStep/>
+                            <Metaspace/>
+                        </DevelopmentWorkspace>
+                    </Content>
+                </Document>
+                <Document xmlns="http://schemas.cordys.com/cws/1.0" path="{workspace_name}/Untitled No SCM adapter" s="N" isLocal="IN_LOCAL">
+                    <Header>
+                        <System>
+                            <ID>{unique_id}</ID>
+                            <Name>Untitled No SCM adapter</Name>
+                            <TypeID>{{E89F3F62-8CA3-4F93-95A8-F76642FD5124}}</TypeID>
+                            <ParentID>{workspace_id}</ParentID>
+                            <Description>Untitled No SCM adapter</Description>
+                            <CreatedBy>sysadmin</CreatedBy>
+                            <CreationDate/>
+                            <LastModifiedBy>sysadmin</LastModifiedBy>
+                            <LastModifiedDate>2021-04-21T06:52:34.254</LastModifiedDate>
+                            <FQN/>
+                            <Annotation/>
+                            <OptimisticLock/>
+                        </System>
+                    </Header>
+                    <Content>
+                        <NullAdapter xmlns="http://schemas.cordys.com/cws/runtime/types/teamdevelopment/NullAdapter/1.0" runtimeDocumentID="D43B04C1-CD0B-A1EB-A898-53C71DB51652" type="com.cordys.cws.runtime.types.teamdevelopment.NullAdapter">
+                            <Workspace>
+                                <uri id="{workspace_id}"/>
+                            </Workspace>
+                        </NullAdapter>
+                    </Content>
+                </Document>
+            </__prefetch>
+        </createWorkspace>
+    </SOAP:Body>
+</SOAP:Envelope>"""
+
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.gateway_url(),
+                data=license_post_body_json,
+                headers=REQUEST_HEADERS,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info(
+                    "Successfully created workspace -> '%s' with ID -> %s",
+                    workspace_name,
+                    workspace_id,
+                )
+                return response.text
+            # Check if Session has expired - then re-authenticate and try once more
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return response.text
+
+    # end method definition
+
+    def sync_workspace(self, workspace_name: str, workspace_id: str) -> dict | None:
+        """Synchronize workspace.
+
+        Args:
+            workspace_name (str):
+                The name of the workspace.
+            workspace_id (str):
+                The ID of the workspace.
+
+        Returns:
+            dict | None:
+                Parsed response as a dictionary if successful, None otherwise.
+
+        """
+
+        self.logger.info(
+            "Starting synchronization of workspace -> '%s'...",
+            workspace_name,
+        )
+
+        # SOAP request body
+        license_post_body_json = f"""
+        <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Body>
+                <Synchronize workspaceID="{workspace_id}" xmlns="http://schemas.cordys.com/cws/synchronize/1.0">
+                    <DocumentID/>
+                    <Asynchronous>false</Asynchronous>
+                </Synchronize>
+            </SOAP:Body>
+        </SOAP:Envelope>
+        """
+
+        retries = 0
+        max_retries = 6
+        retry_delay = 60
+
+        while retries < max_retries:
+            try:
+                response = requests.post(
+                    url=self.gateway_url(),
+                    data=license_post_body_json,
+                    headers=REQUEST_HEADERS,
+                    cookies=self.cookie(),
+                    timeout=SYNC_PUBLISH_REQUEST_TIMEOUT,
+                )
+
+                if response.ok:
+                    self.logger.info(
+                        "Workspace -> '%s' synchronized successfully.",
+                        workspace_name,
+                    )
+                    return self.parse_xml(response.text)
+
+                if response.status_code == 401:
+                    self.logger.warning("Session expired. Re-authenticating...")
+                    self.authenticate(revalidate=True)
+                    retries += 1
+                    continue
+
+                if "faultcode" in response.text or "FaultDetails" in response.text:
+                    self.logger.warning("SOAP fault occurred: %s", response.text)
+                    retries += 1
+                    time.sleep(retry_delay)
+                    continue
+
+                self.logger.error("Unexpected error during sync: %s", response.text)
+                time.sleep(retry_delay)
+                retries += 1
+
+            except requests.RequestException:
+                self.logger.error("Sync failed with error. Proceeding with retry...")
+                time.sleep(retry_delay)
+                retries += 1
+
+        self.logger.error(
+            "Synchronization failed for workspace -> '%s' after %d retries.",
+            workspace_name,
+            retries,
+        )
+        return None
+
+    # end method definition
+
+    def publish_project(
+        self,
+        workspace_name: str,
+        project_name: str,
+        workspace_id: str,
+        project_id: str,
+    ) -> dict | bool:
+        """Publish the workspace project.
+
+        Args:
+            workspace_name (str): The name of the workspace.
+            project_name (str): The name of the project.
+            workspace_id (str): The workspace ID.
+            project_id (str): The project ID.
+
+        Returns:
+            dict | bool: Request response (dictionary) if successful, False if it fails after retries.
+
+        """
+
+        self.logger.info(
+            "Publish project -> '%s' in workspace -> '%s'...",
+            project_name,
+            workspace_name,
+        )
+
+        project_publish = f"""<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Body>
+                <deployObject xmlns="http://schemas.cordys.com/cws/internal/buildhelper/BuildHelper/1.0" async="false" workspaceID="{workspace_id}" xmlns:c="http://schemas.cordys.com/cws/1.0">
+                    <object>
+                        <c:uri id="{project_id}"/>
+                    </object>
+                </deployObject>
+            </SOAP:Body>
+        </SOAP:Envelope>"""
+
+        # Initialize retry parameters
+        max_retries = 10
+        retries = 0
+        success_indicator = "deployObjectResponse"
+
+        while retries < max_retries:
+            try:
+                response = requests.post(
+                    url=self.gateway_url(),
+                    data=project_publish,
+                    headers=REQUEST_HEADERS,
+                    cookies=self.cookie(),
+                    timeout=SYNC_PUBLISH_REQUEST_TIMEOUT,
+                )
+
+                # Check if the response is successful
+                if response.ok:
+                    if success_indicator in response.text:
+                        self.logger.info(
+                            "Successfully published project -> '%s' in workspace -> '%s'",
+                            project_name,
+                            workspace_name,
+                        )
+                        return True
+                    else:
+                        self.logger.warning(
+                            "Expected success indicator -> '%s' but it was not found in response. Retrying in 30 seconds... (Attempt %d of %d)",
+                            success_indicator,
+                            retries + 1,
+                            max_retries,
+                        )
+                elif response.status_code == 401:
+                    # Check for session expiry and retry authentication
+                    self.logger.warning("Session has expired - re-authenticating...")
+                    self.authenticate(revalidate=True)
+                else:
+                    self.logger.error(
+                        "Unexpected error (status code %d). Retrying in 30 seconds... (Attempt %d of %d)",
+                        response.status_code,
+                        retries + 1,
+                        max_retries,
+                    )
+                    self.logger.error(
+                        "Error details: %s",
+                        response.text,
+                    )
+                self.sync_workspace(workspace_name, workspace_id)
+                retries += 1
+                time.sleep(30)
+
+            except requests.RequestException:
+                self.logger.error("Sync failed with error. Proceeding with retry...")
+                retries += 1
+                time.sleep(30)
+
+        # After reaching the maximum number of retries, log failure and return False
+        self.logger.error(
+            "Max retries reached. Failed to publish project -> '%s' in workspace -> '%s'.",
+            project_name,
+            workspace_name,
+        )
+        return False
+
+    # end method definition
+
+    def create_priority(self, name: str, description: str, status: int) -> dict | None:
+        """Create Priority entity instances.
+
+        Args:
+            name (str): name
+            description (str): description
+            status (int): status
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails
+
+        """
+        create_priority = {
+            "Properties": {"Name": name, "Description": description, "Status": status},
+        }
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.create_priority_url(),
+                json=create_priority,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Priority created successfully")
+                return self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_priorities(self) -> dict | None:
+        """Get all priorities from entity.
+
+        Args:
+            None
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        retries = 0
+        while True:
+            response = requests.get(
+                url=self.get_all_priorities_url(),
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def create_customer(
+        self,
+        customer_name: str,
+        legal_business_name: str,
+        trading_name: str,
+    ) -> dict | None:
+        """Create customer entity instance.
+
+        Args:
+            customer_name (str):
+                The name of the customer.
+            legal_business_name (str):
+                The legal business name.
+            trading_name (str):
+                The trading name.
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        create_customer = {
+            "Properties": {
+                "CustomerName": customer_name,
+                "LegalBusinessName": legal_business_name,
+                "TradingName": trading_name,
+            },
+        }
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.create_customer_url(),
+                json=create_customer,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Customer record created successfully")
+                return self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_customers(self) -> dict | None:
+        """Get all customer entity imstances.
+
+        Args:
+            None
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails
+
+        """
+
+        retries = 0
+        while True:
+            response = requests.get(
+                url=self.get_all_customeres_url(),
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def create_case_type(self, name: str, description: str, status: int) -> dict | None:
+        """Create case type entity instances.
+
+        Args:
+            name (str):
+                The name of the case type.
+            description (str):
+                The description of the case type.
+            status (str): status
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        create_case_type = {
+            "Properties": {"Name": name, "Description": description, "Status": status},
+        }
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.create_casetype_url(),
+                json=create_case_type,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Case type created successfully")
+                return self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_case_type(self) -> dict | None:
+        """Get all case type entty instances.
+
+        Args:
+            None
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        retries = 0
+        while True:
+            response = requests.get(
+                url=self.get_all_case_types_url(),
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def create_category(
+        self,
+        case_prefix: str,
+        description: str,
+        name: str,
+        status: int,
+    ) -> dict | None:
+        """Create category entity instance.
+
+        Args:
+            case_prefix (str):
+                The prefix for the case.
+            description (str):
+                The description for the category.
+            name (str):
+                The name of the case.
+            status (int):
+                The status code.
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        create_categoty = {
+            "Properties": {
+                "CasePrefix": case_prefix,
+                "Description": description,
+                "Name": name,
+                "Status": status,
+            },
+        }
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.create_category_url(),
+                json=create_categoty,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Category created successfully")
+                return self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_categories(self) -> dict | None:
+        """Get all categories entity intances.
+
+        Args:
+            None
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        retries = 0
+        while True:
+            response = requests.get(
+                url=self.get_all_categories_url(),
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def create_sub_categoy(
+        self,
+        name: str,
+        description: str,
+        status: int,
+        parent_id: int,
+    ) -> dict | None:
+        """Create sub categoy entity instances.
+
+        Args:
+            name (str):
+                The name of the sub-category.
+            description (str):
+                The description for the sub-category.
+            status (int):
+                The status ID.
+            parent_id (int):
+                The parent ID of the category.
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        create_sub_categoty = {
+            "Properties": {"Name": name, "Description": description, "Status": status},
+        }
+        retries = 0
+        while True:
+            base_url = self.baseurl()
+            endpoint = "/app/entityRestService/api/OpentextCaseManagement/entities/Category/items/"
+            child_path = "/childEntities/SubCategory?defaultinst_ct=abcd"
+            response = requests.post(
+                url=base_url + endpoint + str(parent_id) + child_path,
+                json=create_sub_categoty,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Sub category created successfully")
+                return self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_sub_categeries(self, parent_id: int) -> dict | None:
+        """Get all sub categeries entity instances.
+
+        Args:
+            parent_id (int):
+                The parent ID of the sub categories.
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        retries = 0
+        while True:
+            base_url = self.baseurl()
+            endpoint = "/app/entityRestService/api/OpentextCaseManagement/entities/Category/items/"
+            child_path = "/childEntities/SubCategory"
+            response = requests.get(
+                url=base_url + endpoint + str(parent_id) + child_path,
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def create_loan(
+        self,
+        subject: str,
+        description: str,
+        loan_amount: str,
+        loan_duration_in_months: str,
+        category: str,
+        subcategory: str,
+        priority: str,
+        service: str,
+        customer: str,
+    ) -> dict | None:
+        """Create loan entity instance.
+
+        Args:
+            subject (str): subject
+            description (str): description
+            loan_amount (str): loan_amount
+            loan_duration_in_months (str): loan_duration_in_months
+            category (str): category
+            subcategory (str): subcategory
+            priority (str): priority
+            service (str): service
+            customer (str): customer
+        Returns:
+            dict: Request response (dictionary) or None if the REST call fails
+
+        """
+
+        create_loan = f"""<SOAP:Envelope xmlns:SOAP=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n
+  <SOAP:Body>\r\n
+    <CreateCase xmlns=\"http://schemas/OpentextCaseManagement/Case/operations\">\r\n
+      <ns0:Case-create xmlns:ns0=\"http://schemas/OpentextCaseManagement/Case\">\r\n
+        <ns0:Subject>{subject}</ns0:Subject>\r\n
+        <ns0:Description>{description}</ns0:Description>\r\n
+        <ns0:LoanAmount>{loan_amount}</ns0:LoanAmount>\r\n
+        <ns0:LoanDurationInMonths>{loan_duration_in_months}</ns0:LoanDurationInMonths>\r\n
+        \r\n
+        <ns0:CaseType>\r\n
+          <ns1:CaseType-id xmlns:ns1=\"http://schemas/OpentextCaseManagement/CaseType\">\r\n
+            <ns1:Id>{service}</ns1:Id>\r\n
+          </ns1:CaseType-id>\r\n
+        </ns0:CaseType>\r\n
+        \r\n
+        <ns0:Category>\r\n
+          <ns2:Category-id xmlns:ns2=\"http://schemas/OpentextCaseManagement/Category\">\r\n
+            <ns2:Id>{category}</ns2:Id>\r\n
+          </ns2:Category-id>\r\n
+        </ns0:Category>\r\n
+        \r\n
+        <ns0:SubCategory>\r\n
+          <ns5:SubCategory-id xmlns:ns5=\"http://schemas/OpentextCaseManagement/Category.SubCategory\">\r\n
+            <ns5:Id>{category}</ns5:Id>\r\n
+            <ns5:Id1>{subcategory}</ns5:Id1>\r\n
+          </ns5:SubCategory-id>\r\n
+        </ns0:SubCategory>\r\n
+        \r\n
+        <ns0:Priority>\r\n
+          <ns3:Priority-id xmlns:ns3=\"http://schemas/OpentextCaseManagement/Priority\">\r\n
+            <ns3:Id>{priority}</ns3:Id>\r\n
+          </ns3:Priority-id>\r\n
+        </ns0:Priority>\r\n
+\r\n
+        <ns0:ToCustomer>\r\n
+          <ns9:Customer-id xmlns:ns9=\"http://schemas/OpentextCaseManagement/Customer\">\r\n
+            <ns9:Id>{customer}</ns9:Id>\r\n
+          </ns9:Customer-id>\r\n
+        </ns0:ToCustomer>\r\n
+\r\n
+      </ns0:Case-create>\r\n
+    </CreateCase>\r\n
+  </SOAP:Body>\r\n
+</SOAP:Envelope>"""
+
+        retries = 0
+        while True:
+            response = requests.post(
+                url=self.gateway_url(),
+                data=create_loan,
+                headers=REQUEST_HEADERS,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                self.logger.info("Loan created successfully")
+                return self.parse_xml(response.text)
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            self.logger.error(response.text)
+            return None
+
+    # end method definition
+
+    def get_all_loan(self) -> dict | None:
+        """Get all loan entity instances.
+
+        Args:
+           None
+
+        Returns:
+            dict:
+                Request response (dictionary) or None if the REST call fails.
+
+        """
+
+        retries = 0
+        while True:
+            response = requests.get(
+                url=self.get_all_loans_url(),
+                headers=REQUEST_HEADERS_JSON,
+                cookies=self.cookie(),
+                timeout=REQUEST_TIMEOUT,
+            )
+            if response.ok:
+                authenticate_dict = self.parse_request_response(
+                    response_object=response,
+                    additional_error_message="This can be normal during restart",
+                    show_error=False,
+                )
+                if not authenticate_dict:
+                    return None
+                return authenticate_dict
+            if response.status_code == 401 and retries == 0:
+                self.logger.warning("Session has expired - try to re-authenticate...")
+                self.authenticate(revalidate=True)
+                retries += 1
+            else:
+                self.logger.error(response.text)
+                return None
+
+    # end method definition
+
+    def validate_workspace_response(self, response: str, workspace_name: str) -> bool:
+        """Verify if the workspace exists or was created successfully.
+
+        Args:
+            response (str): response to validate
+            workspace_name (str): The name of the workspace.
+
+        Returns:
+            bool: True if the workspace exists or was created successfully, else False.
+
+        """
+
+        if "Object already exists" in response or "createWorkspaceResponse" in response:
+            self.logger.info(
+                "The workspace already exists or was created with the name -> '%s'",
+                workspace_name,
+            )
+            return True
+
+        self.logger.info(
+            "The workspace -> '%s' does not exist or was not created. Please verify configurtion!",
+            workspace_name,
+        )
+        return False
+
+    # end method definition
+
+    def is_workspace_already_exists(self, response: str, workspace_name: str) -> bool:
+        """Verify if workspace exists.
+
+        Args:
+            response (str):
+                The response.
+            workspace_name (str):
+                The name of the workspace.
+
+        Returns:
+            bool:
+                Return True if workspace exist else return false.
+
+        """
+
+        if "Object already exists" in response:
+            self.logger.info(
+                "The workspace already exists with the name -> '%s'",
+                workspace_name,
+            )
+            return True
+        self.logger.info(
+            "The Workspace has been created with the name -> '%s'",
+            workspace_name,
+        )
+        return False
+
+    # end method definition
+
+    def create_workspace_with_retry(
+        self,
+        workspace_name: str,
+        workspace_gui_id: str,
+    ) -> dict | None:
+        """Call create_workspace and retries if the response contains specific error messages.
+
+        Retries until the response does not contain the errors or a max retry limit is reached.
+
+        Args:
+            workspace_name (str):
+                The workspace name.
+            workspace_gui_id (str):
+                The workspace GUI ID.
+
+        Returns:
+            dict | None:
+                The response of the workspace creation or None in case an error occured.
+
+        """
+
+        max_retries = 20  # Define the maximum number of retries
+        retries = 0
+        error_messages = [
+            "Collaborative Workspace Service Container is not able to handle the SOAP request",
+            "Service Group Lookup failure",
+        ]
+
+        while retries < max_retries:
+            response = self.create_workspace(workspace_name, workspace_gui_id)
+
+            # Check if any error message is in the response
+            if any(error_message in response for error_message in error_messages):
+                self.logger.info(
+                    "Workspace service error, waiting 60 seconds to retry... (Retry %d of %d)",
+                    retries + 1,
+                    max_retries,
+                )
+                time.sleep(60)
+                retries += 1
+            else:
+                self.logger.info("Collaborative Workspace Service Container is ready")
+                return response
+
+        # After max retries, log and return the response or handle as needed
+        self.logger.error(
+            "Max retries reached for workspace -> '%s', unable to create successfully.",
+            workspace_name,
+        )
+        return response
+
+    # end method definition
+
+    def loan_management_runtime(self) -> dict | None:
+        """Create all runtime objects for loan management application.
+
+        Args:
+            None
+        Returns:
+            None
+
+        """
+
+        self.logger.debug(" RUNTIME -->> Category instance creation started ........ ")
+        category_resp_dict = []
+        if not self.verify_category_exists("Short Term Loan"):
+            self.create_category("LOAN", "Short Term Loan", "Short Term Loan", 1)
+        if not self.verify_category_exists("Long Term Loan"):
+            self.create_category("LOAN", "Long Term Loan", "Long Term Loan", 1)
+        if not self.verify_category_exists("Flexi Loan"):
+            self.create_category("LOAN", "Flexi Loan", "Flexi Loan", 1)
+        category_resp_dict = self.get_category_lists()
+        self.logger.debug(" RUNTIME -->> Category instance creation ended")
+
+        ############################# Sub category
+        self.logger.debug(
+            " RUNTIME -->> Sub Category instance creation started ........",
+        )
+        stl = 0
+        ltl = 0
+        fl = 0
+        if not self.verify_sub_category_exists("Business", 0, category_resp_dict):
+            response_dict = self.create_sub_categoy(
+                "Business",
+                "Business",
+                1,
+                category_resp_dict[0],
+            )
+            stl = response_dict["Identity"]["Id"]
+            self.logger.info("Sub category id stl:  %s ", stl)
+        else:
+            stl = self.return_sub_category_exists_id("Business", 0, category_resp_dict)
+            self.logger.info("Sub category id stl -> %s ", stl)
+
+        if not self.verify_sub_category_exists("Business", 1, category_resp_dict):
+            response_dict = self.create_sub_categoy(
+                "Business",
+                "Business",
+                1,
+                category_resp_dict[1],
+            )
+            ltl = response_dict["Identity"]["Id"]
+            self.logger.info("Sub category id ltl -> %s ", ltl)
+        else:
+            ltl = self.return_sub_category_exists_id(name="Business", index=1, category_resp_dict=category_resp_dict)
+            self.logger.info("Sub category id ltl -> %s ", ltl)
+        if not self.verify_sub_category_exists(name="Business", index=2, category_resp_dict=category_resp_dict):
+            response_dict = self.create_sub_categoy(
+                "Business",
+                "Business",
+                1,
+                category_resp_dict[2],
+            )
+            fl = response_dict["Identity"]["Id"]
+            self.logger.info("Sub category id fl -> %s ", fl)
+        else:
+            fl = self.return_sub_category_exists_id(name="Business", index=2, category_resp_dict=category_resp_dict)
+            self.logger.info("Sub category id fl -> %s ", fl)
+        self.logger.debug(" RUNTIME -->> Sub Category instance creation ended")
+
+        ############################# Case Types
+        self.logger.debug(" RUNTIME -->> Case Types instance creation started ........")
+        case_type_list = []
+
+        if not self.vverify_case_type_exists("Query"):
+            self.create_case_type("Query", "Query", 1)
+        if not self.vverify_case_type_exists("Help"):
+            self.create_case_type("Help", "Help", 1)
+        if not self.vverify_case_type_exists("Update Contact Details"):
+            self.create_case_type("Update Contact Details", "Update Contact Details", 1)
+        if not self.vverify_case_type_exists("New Loan Request"):
+            self.create_case_type("New Loan Request", "New Loan Request", 1)
+        if not self.vverify_case_type_exists("Loan Closure"):
+            self.create_case_type("Loan Closure", "Loan Closure", 1)
+        case_type_list = self.get_case_type_lists()
+        self.logger.debug(" RUNTIME -->> Case Types instance creation ended")
+
+        ############################# CUSTMOR
+        self.logger.debug(" RUNTIME -->> Customer instance creation stated ........")
+        customer_list = []
+        if not self.verify_customer_exists("InaPlex Limited"):
+            self.create_customer(
+                "InaPlex Limited",
+                "InaPlex Limited",
+                "InaPlex Limited",
+            )
+
+        if not self.verify_customer_exists("Interwoven, Inc"):
+            self.create_customer(
+                "Interwoven, Inc",
+                "Interwoven, Inc",
+                "Interwoven, Inc",
+            )
+
+        if not self.verify_customer_exists("Jones Lang LaSalle"):
+            self.create_customer(
+                "Jones Lang LaSalle",
+                "Jones Lang LaSalle",
+                "Jones Lang LaSalle",
+            )
+
+        if not self.verify_customer_exists("Key Point Consulting"):
+            self.create_customer(
+                "Key Point Consulting",
+                "Key Point Consulting",
+                "Key Point Consulting",
+            )
+
+        customer_list = self.get_customer_lists()
+        self.logger.debug(" RUNTIME -->> Customer instance creation ended")
+
+        ######################################## PRIORITY
+        self.logger.debug(" RUNTIME -->> priority instance creation started ........")
+        prioity_list = []
+        if not self.verify_priority_exists("High"):
+            self.create_priority("High", "High", 1)
+        if not self.verify_priority_exists("Medium"):
+            self.create_priority("Medium", "Medium", 1)
+        if not self.verify_priority_exists("Low"):
+            self.create_priority("Low", "Low", 1)
+        prioity_list = self.get_priority_lists()
+        self.logger.debug(" RUNTIME -->> priority instance creation ended")
+
+        ############################# LOAN
+        loan_for_business = "Loan for Business1"
+        loan_for_corporate_business = "Loan for Corporate Business1"
+        loan_for_business_loan_request = "Loan for Business Loan Request1"
+
+        self.logger.debug(" RUNTIME -->> loan instance creation started ........")
+        loan_resp_dict = self.get_all_loan()
+        names = [item["Properties"]["Subject"] for item in loan_resp_dict["_embedded"]["AllCasesList"]]
+        if loan_for_business in names:
+            self.logger.info("Customer record Loan_for_business exists")
+        else:
+            self.logger.info("Creating customer Record with Loan_for_business ")
+            response_dict = self.create_loan(
+                subject=loan_for_business,
+                description=loan_for_business,
+                loan_amount=1,
+                loan_duration_in_months=2,
+                category=category_resp_dict[0],
+                subcategory=stl,
+                priority=prioity_list[0],
+                service=case_type_list[0],
+                customer=customer_list[0],
+            )
+
+        if loan_for_corporate_business in names:
+            self.logger.info("Customer record Loan_for_Corporate_Business exists")
+        else:
+            self.logger.info(
+                "Creating customer Record with Loan_for_Corporate_Business ",
+            )
+            response_dict = self.create_loan(
+                subject=loan_for_corporate_business,
+                description=loan_for_corporate_business,
+                loan_amount=1,
+                loan_duration_in_months=2,
+                category=category_resp_dict[1],
+                subcategory=ltl,
+                priority=prioity_list[1],
+                service=case_type_list[1],
+                customer=customer_list[1],
+            )
+
+        if loan_for_business_loan_request in names:
+            self.logger.info("Customer record Loan_for_business_Loan_Request exists")
+        else:
+            self.logger.info(
+                "Creating customer Record with loan_for_business_loan_request",
+            )
+            response_dict = self.create_loan(
+                subject=loan_for_business_loan_request,
+                description=loan_for_business_loan_request,
+                loan_amount=1,
+                loan_duration_in_months=2,
+                category=category_resp_dict[2],
+                subcategory=fl,
+                priority=prioity_list[2],
+                service=case_type_list[2],
+                customer=customer_list[2],
+            )
+        self.logger.debug(" RUNTIME -->> loan instance creation ended")
+
+    # end method definition
+
+    def get_category_lists(self) -> list:
+        """Get All category entty instances id's.
+
+        Args:
+            None
+        Returns:
+            list: list of category IDs
+
+        """
+
+        category_resp_dict = []
+        categoy_resp_dict = self.get_all_categories()
+        for item in categoy_resp_dict["_embedded"]["CategoryList"]:
+            first_item_href = item["_links"]["item"]["href"]
+            integer_value = int(re.search(r"\d+", first_item_href).group())
+            self.logger.info("Category created with ID -> %d", integer_value)
+            category_resp_dict.append(integer_value)
+        self.logger.info("All extracted category IDs -> %s", category_resp_dict)
+
+        return category_resp_dict
+
+    # end method definition
+
+    def get_case_type_lists(self) -> list:
+        """Get All CaseType entity instances IDs.
+
+        Args:
+            None
+
+        Returns:
+            list:
+                List of all case type IDs.
+
+        """
+
+        case_type_list = []
+        casetype_resp_dict = self.get_all_case_type()
+        for item in casetype_resp_dict["_embedded"]["AllCaseTypes"]:
+            first_item_href = item["_links"]["item"]["href"]
+            integer_value = int(re.search(r"\d+", first_item_href).group())
+            self.logger.info("Case type created with ID -> %d", integer_value)
+            case_type_list.append(integer_value)
+        self.logger.info("All extracted case type IDs -> %s", case_type_list)
+
+        return case_type_list
+
+    # end method definition
+
+    def get_customer_lists(self) -> list:
+        """Get all customer entity instances id's.
+
+        Args:
+            None
+        Returns:
+            list:
+                A list of all customer IDs.
+
+        """
+
+        customer_list = []
+        customer_resp_dict = self.get_all_customers()
+        for item in customer_resp_dict["_embedded"]["CustomerList"]:
+            first_item_href = item["_links"]["item"]["href"]
+            integer_value = int(re.search(r"\d+", first_item_href).group())
+            self.logger.info("Customer created with ID -> %d", integer_value)
+            customer_list.append(integer_value)
+        self.logger.info("All extracted Customer IDs -> %s ", customer_list)
+
+        return customer_list
+
+    # end method definition
+
+    def get_priority_lists(self) -> list:
+        """Get all priority entity instances IDs.
+
+        Args:
+            None
+        Returns:
+            list:
+                A list with all priority IDs.
+
+        """
+
+        prioity_list = []
+        authenticate_dict = self.get_all_priorities()
+        for item in authenticate_dict["_embedded"]["PriorityList"]:
+            first_item_href = item["_links"]["item"]["href"]
+            integer_value = int(re.search(r"\d+", first_item_href).group())
+            self.logger.info("Priority created with ID -> %d", integer_value)
+            prioity_list.append(integer_value)
+        self.logger.info("All extracted priority IDs -> %s  ", prioity_list)
+
+        return prioity_list
+
+    # end method definition
+
+    def verify_category_exists(self, name: str) -> bool:
+        """Verify category entity instance already exists.
+
+        Args:
+            name (str):
+                The name of the category.
+
+        Returns:
+            bool:
+                Returns True if already record exists with same name, else returns False.
+
+        """
+
+        categoy_resp_dict = self.get_all_categories()
+        names = [item["Properties"]["Name"] for item in categoy_resp_dict["_embedded"]["CategoryList"]]
+        if name in names:
+            self.logger.info("Category record -> '%s' already exists", name)
+            return True
+        self.logger.info("Creating category record -> '%s'", name)
+
+        return False
+
+    # end method definition
+
+    def vverify_case_type_exists(self, name: str) -> bool:
+        """Verify case type entity instance already exists.
+
+        Args:
+            name (str):
+                The name of the case type.
+
+        Returns:
+            bool:
+                Returns True if already record exists with same name, else returns False.
+
+        """
+
+        casetype_resp_dict = self.get_all_case_type()
+        names = [item["Properties"]["Name"] for item in casetype_resp_dict["_embedded"]["AllCaseTypes"]]
+        if name in names:
+            self.logger.info("Case type record -> '%s' already exists", name)
+            return True
+        self.logger.info("Creating case type record -> '%s'", name)
+
+        return False
+
+    # end method definition
+
+    def verify_customer_exists(self, name: str) -> bool:
+        """Verify cusomer entty instance already exists.
+
+        Args:
+            name (str):
+                The name of the customer.
+
+        Returns:
+            bool:
+                Returns True if already record exists with same name, else returns False
+
+        """
+
+        customer_resp_dict = self.get_all_customers()
+        names = [item["Properties"]["CustomerName"] for item in customer_resp_dict["_embedded"]["CustomerList"]]
+        if name in names:
+            self.logger.info("Customer -> '%s' already exists", name)
+            return True
+        self.logger.info("Creating customer -> '%s'", name)
+        return False
+
+    # end method definition
+
+    def verify_priority_exists(self, name: str) -> bool:
+        """Verify priority entity instance already exists.
+
+        Args:
+            name (str):
+                The name of the priority.
+
+        Returns:
+            bool:
+                Returns True if already record exists with same name, else returns False
+
+        """
+
+        authenticate_dict = self.get_all_priorities()
+        names = [item["Properties"]["Name"] for item in authenticate_dict["_embedded"]["PriorityList"]]
+        if name in names:
+            self.logger.info("Priority -> '%s' already exists", name)
+            return True
+        self.logger.info("Creating priority -> '%s'", name)
+
+        return False
+
+    # end method definition
+
+    def verify_sub_category_exists(
+        self,
+        name: str,
+        index: int,
+        category_resp_dict: list,
+    ) -> bool:
+        """Verify sub category entity instance already exists.
+
+        Args:
+            name (str):
+                The name of the sub category.
+            index (int):
+                The index of the sub category.
+            category_resp_dict (list):
+                TODO: add description
+
+        Returns:
+            bool:
+                Returns true if record already exists with same name, else returns false.
+
+        """
+
+        subcategoy_resp_dict = self.get_all_sub_categeries(category_resp_dict[index])
+        names = [item["Properties"]["Name"] for item in subcategoy_resp_dict["_embedded"]["SubCategory"]]
+        stl = 0
+        if name in names:
+            self.logger.info("Sub category -> '%s' already exists", name)
+            for item in subcategoy_resp_dict["_embedded"]["SubCategory"]:
+                stl = item["Identity"]["Id"]
+                self.logger.info("Sub category created with ID -> %s", stl)
+                return True
+        self.logger.info("Creating sub category -> '%s'", name)
+
+        return False
+
+    # end method definition
+
+    def return_sub_category_exists_id(
+        self,
+        name: str,
+        index: int,
+        category_resp_dict: list,
+    ) -> int:
+        """Verify sub category entity instance id already exists.
+
+        Args:
+            name (str):
+                The name of the sub-category.
+            index (int):
+                TODO: add description
+            category_resp_dict (list):
+                TODO: add description!
+
+        Returns:
+            bool:
+                Returns true if record already exists with same name, else returns false.
+
+        """
+
+        subcategoy_resp_dict = self.get_all_sub_categeries(category_resp_dict[index])
+        names = [item["Properties"]["Name"] for item in subcategoy_resp_dict["_embedded"]["SubCategory"]]
+        stl = 0
+        if name in names:
+            self.logger.info("Sub category record -> '%s' already exists", name)
+            for item in subcategoy_resp_dict["_embedded"]["SubCategory"]:
+                stl = item["Identity"]["Id"]
+                self.logger.info("Sub category created with ID -> %s", stl)
+                return stl
+
+        return None
+
+    # end method definition
+
+    def create_users_from_config_file(self, otawpsection: str, _otds: OTDS) -> None:
+        """Read user information from customizer file and call create user method.
+
+        Args:
+            otawpsection (str):
+                YAML block related to appworks
+            _otds:
+                The OTDS object.
+
+        Returns:
+            None
+
+        """
+
+        otds = otawpsection.get("otds", {})
+        if otds is not None:
+            users = otds.get("users", [])
+            if users is not None:
+                for user in users:
+                    _otds.add_user(
+                        user.get("partition"),
+                        user.get("name"),
+                        user.get("description"),
+                        user.get("first_name"),
+                        user.get("last_name"),
+                        user.get("email"),
+                    )
+                    roles = otds.get("roles", [])
+                    if roles is not None:
+                        for role in roles:
+                            _otds.add_user_to_group(
+                                user.get("name") + "@" + user.get("partition"),
+                                role.get("name"),
+                            )
+                    else:
+                        self.logger.error(
+                            "Verifying Users section: roles section not presented in yaml for otds users",
+                        )
+            else:
+                self.logger.error(
+                    "Verifying Users section: user section not presented in yaml",
+                )
+        else:
+            self.logger.error(
+                "Verifying Users section: otds section not presented in yaml",
+            )
+
+    # end method definition
+
+    def create_roles_from_config_file(self, otawpsection: str, _otds: OTDS) -> None:
+        """Read grop information from customizer file and call create grop method.
+
+        Args:
+            otawpsection (str):
+                YAML block related to appworks.
+            _otds (object):
+                The OTDS object used to access the OTDS REST API.
+
+        Returns:
+            None
+
+        """
+
+        otds = otawpsection.get("otds", {})
+        if otds is not None:
+            roles = otds.get("roles", [])
+            if roles is not None:
+                for role in roles:
+                    # Add new group if it does not yet exist:
+                    if not _otds.get_group(group=role.get("name"), show_error=False):
+                        _otds.add_group(
+                            role.get("partition"),
+                            role.get("name"),
+                            role.get("description"),
+                        )
+            else:
+                self.logger.error(
+                    "Verifying roles section: roles section not presented in yaml",
+                )
+        else:
+            self.logger.error(
+                "Verifying roles section: otds section not presented in yaml",
+            )
+
+    # end method definition
+
+    def create_loanruntime_from_config_file(self, platform: str) -> None:
+        """Verify flag and call loan_management_runtime().
+
+        Args:
+            platform (str):
+                YAML block related to platform.
+
+        Returns:
+            None
+
+        """
+
+        runtime = platform.get("runtime", {})
+        if runtime is not None:
+            app_names = runtime.get("appNames", [])
+            if app_names is not None:
+                for app_name in app_names:
+                    if app_name == "loanManagement":
+                        self.loan_management_runtime()
+                    else:
+                        self.logger.error(
+                            "Verifying runtime section: loanManagement not exits in yaml entry",
+                        )
+            else:
+                self.logger.error(
+                    "Verifying runtime section: App name section is empty in yaml",
+                )
+        else:
+            self.logger.error(
+                "Verifying runtime section: Runtime section is empty in yaml",
+            )
+
+    # end method definition
+    def create_cws_config(
+        self,
+        partition: str,
+        resource_name: str,
+        otcs_url: str,
+    ) -> dict | None:
+        """Create a workspace configuration in CWS.
+
+        Args:
+            partition (str): The partition name for the workspace.
+            resource_name (str): The resource name.
+            otcs_url (str): The OTCS endpoint URL.
+
+        Returns:
+            dict | None: Response dictionary if successful, or None if the request fails.
+
+        """
+        self.logger.info("Creating CWS config for partition '%s' and resource '%s'...", partition, resource_name)
+
+        # Construct the SOAP request body
+        cws_config_req_xml = f"""
+        <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Header>
+                <header xmlns="http://schemas.cordys.com/General/1.0/">
+                    <Logger/>
+                </header>
+                <i18n:international xmlns:i18n="http://www.w3.org/2005/09/ws-i18n">
+                    <i18n:locale>en-US</i18n:locale>
+                </i18n:international>
+            </SOAP:Header>
+            <SOAP:Body>
+                <UpdateXMLObject xmlns="http://schemas.cordys.com/1.0/xmlstore">
+                    <tuple lastModified="{int(time.time() * 1000)}"
+                           key="/com/ot-ps/csws/otcs_ws_config.xml"
+                           level="organization"
+                           name="otcs_ws_config.xml"
+                           original="/com/ot-ps/csws/otcs_ws_config.xml"
+                           version="organization">
+                        <new>
+                            <CSWSConfig>
+                                <Partition>{partition}</Partition>
+                                <EndPointUrl>{otcs_url}/cws/services/Authentication</EndPointUrl>
+                                <Resources>
+                                    <Resource type="Cordys">
+                                        <Name>__OTDS#Shared#Platform#Resource__</Name>
+                                        <Space>shared</Space>
+                                    </Resource>
+                                    <Resource type="OTCS">
+                                        <Name>{resource_name}</Name>
+                                        <Space>shared</Space>
+                                    </Resource>
+                                </Resources>
+                            </CSWSConfig>
+                        </new>
+                    </tuple>
+                </UpdateXMLObject>
+            </SOAP:Body>
+        </SOAP:Envelope>
+        """
+
+        retries = 0
+        max_retries = 20  # Maximum retry limit
+        error_messages = [
+            "Collaborative Workspace Service Container is not able to handle the SOAP request",
+            "Service Group Lookup failure",
+        ]
+
+        while retries < max_retries:
+            try:
+                response = requests.post(
+                    url=self.gateway_url(),
+                    data=cws_config_req_xml,
+                    headers=REQUEST_HEADERS,
+                    cookies=self.cookie(),
+                    timeout=None,
+                )
+
+                # Handle successful response
+                if response.ok:
+                    if any(error_message in response.text for error_message in error_messages):
+                        self.logger.warning(
+                            "Service error detected, retrying in 60 seconds... (Retry %d of %d)",
+                            retries + 1,
+                            max_retries,
+                        )
+                        time.sleep(60)
+                        retries += 1
+                    else:
+                        self.logger.info("CWS config created successfully.")
+                        return response.text
+
+                # Handle session expiration
+                if response.status_code == 401 and retries == 0:
+                    self.logger.warning("Session expired. Re-authenticating...")
+                    self.authenticate(revalidate=True)
+                    retries += 1
+                    continue
+
+                # Handle case where object has been changed by another user
+                if "Object has been changed by other user" in response.text:
+                    self.logger.info("CWS config already exists")
+                    return response.text
+
+                # Log errors for failed requests
+                self.logger.error("Failed to create CWS config: %s", response.text)
+                time.sleep(60)
+                retries += 1
+
+            except requests.RequestException:
+                self.logger.error("Request failed during CWS config creation")
+                retries += 1
+
+        # Log when retries are exhausted
+        self.logger.error("Retry limit exceeded. CWS config creation failed.")
+        return None
+
+    # end method definition
+    def verify_user_having_role(self, organization: str, user_name: str, role_name: str) -> bool:
+        """Verify if the user has the specified role.
+
+        Args:
+            organization(str): organization name
+            user_name (str): The username to verify.
+            role_name (str): The role to check for the user.
+
+        Returns:
+            bool: True if the user has the role, False if not, or None if request fails.
+
+        """
+        self.logger.info("Verifying user '%s' has role '%s' started.", user_name, role_name)
+
+        # Construct the SOAP request body
+        cws_config_req_xml = f"""
+        <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Header xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+                <header xmlns="http://schemas.cordys.com/General/1.0/">
+                    <Logger xmlns="http://schemas.cordys.com/General/1.0/"/>
+                </header>
+                <i18n:international xmlns:i18n="http://www.w3.org/2005/09/ws-i18n">
+                    <i18n:locale>en-US</i18n:locale>
+                </i18n:international>
+            </SOAP:Header>
+            <SOAP:Body>
+                <SearchLDAP xmlns:xfr="http://schemas.cordys.com/1.0/xforms/runtime" xmlns="http://schemas.cordys.com/1.0/ldap">
+                    <dn xmlns="http://schemas.cordys.com/1.0/ldap">cn=organizational users,o={organization},cn=cordys,cn=defaultInst,o=opentext.net</dn>
+                    <scope xmlns="http://schemas.cordys.com/1.0/ldap">1</scope>
+                    <filter xmlns="http://schemas.cordys.com/1.0/ldap">&amp;(objectclass=busorganizationaluser)(&amp;(!(cn=SYSTEM))(!(cn=anonymous))(!(cn=wcpLicUser)))(|(description=*{user_name}*)(&amp;(!(description=*))(cn=*{user_name}*)))</filter>
+                    <sort xmlns="http://schemas.cordys.com/1.0/ldap">ascending</sort>
+                    <sortBy xmlns="http://schemas.cordys.com/1.0/ldap"/>
+                    <returnValues xmlns="http://schemas.cordys.com/1.0/ldap">false</returnValues>
+                    <return xmlns="http://schemas.cordys.com/1.0/ldap"/>
+                </SearchLDAP>
+            </SOAP:Body>
+        </SOAP:Envelope>
+        """
+
+        retries = 0
+        max_retries = 6  # Maximum retry limit
+        while retries < max_retries:
+            try:
+                response = requests.post(
+                    url=self.gateway_url(),
+                    data=cws_config_req_xml,
+                    headers=REQUEST_HEADERS,
+                    cookies=self.cookie(),
+                    timeout=None,
+                )
+
+                # Handle successful response
+                if response.ok:
+                    if (
+                        role_name in response.text
+                    ):  # Corrected syntax for checking if 'Developer' is in the response text
+                        self.logger.info("Verifyied user '%s' already has the role '%s'.", user_name, role_name)
+                        return True  # Assuming the user has the role if the response contains 'Developer'
+                    else:
+                        self.logger.info("Verifyied User '%s' not having  role '%s'.", user_name, role_name)
+                        return False
+                # Handle session expiration
+                if response.status_code == 401 and retries == 0:
+                    self.logger.warning("Session expired. Re-authenticating...")
+                    self.authenticate(revalidate=True)
+                    retries += 1
+                    continue
+
+                # Log errors for failed requests
+                self.logger.error("Failed to verify user role: %s", response.text)
+                time.sleep(60)
+                retries += 1
+
+            except requests.RequestException:
+                self.logger.error("Request failed during user role verification")
+                retries += 1
+
+        # Log when retries are exhausted
+        self.logger.error("Retry limit exceeded. User role verification failed.")
+        return False  # Return False if the retries limit is exceeded
+
+    # end method definition
+
+    def assign_developer_role_to_user(self, organization: str, user_name: str, role_name: str) -> bool:
+        """Assign the 'Developer' role to the user and verify the role assignment.
+
+        Args:
+            organization (str): The organization name.
+            user_name (str): The username to verify.
+            role_name (str): The role to be assigned.
+
+        Returns:
+            bool: True if the user has the 'Developer' role, False otherwise.
+
+        """
+        self.logger.info("Assigning 'Developer' role to user '%s' in organization '%s'...", user_name, organization)
+
+        # Check if user already has the role before making the request
+        if self.verify_user_having_role(organization, user_name, role_name):
+            return True
+
+        # Construct the SOAP request body
+        cws_config_req_xml = f"""\
+        <SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+            <SOAP:Header xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
+                <header xmlns="http://schemas.cordys.com/General/1.0/">
+                    <Logger xmlns="http://schemas.cordys.com/General/1.0/"/>
+                </header>
+                <i18n:international xmlns:i18n="http://www.w3.org/2005/09/ws-i18n">
+                    <i18n:locale>en-US</i18n:locale>
+                </i18n:international>
+            </SOAP:Header>
+            <SOAP:Body>
+                <Update xmlns="http://schemas.cordys.com/1.0/ldap">
+                    <tuple>
+                        <old>
+                            <entry dn="cn=sysadmin,cn=organizational users,o={organization},cn=cordys,cn=defaultInst,o=opentext.net">
+                                <role>
+                                    <string>cn=everyoneIn{organization},cn=organizational roles,o={organization},cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                    <string>cn=Administrator,cn=Cordys@Work,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                    <string>cn=OTDS Push Service,cn=OpenText OTDS Platform Push Connector,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                </role>
+                                <description>
+                                    <string>{user_name}</string>
+                                </description>
+                                <cn>
+                                    <string>{user_name}</string>
+                                </cn>
+                                <objectclass>
+                                    <string>top</string>
+                                    <string>busorganizationalobject</string>
+                                    <string>busorganizationaluser</string>
+                                </objectclass>
+                                <authenticationuser>
+                                    <string>cn={user_name},cn=authenticated users,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                </authenticationuser>
+                            </entry>
+                        </old>
+                        <new>
+                            <entry dn="cn={user_name},cn=organizational users,o={organization},cn=cordys,cn=defaultInst,o=opentext.net">
+                                <role>
+                                    <string>cn=everyoneIn{organization},cn=organizational roles,o={organization},cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                    <string>cn=Administrator,cn=Cordys@Work,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                    <string>cn=OTDS Push Service,cn=OpenText OTDS Platform Push Connector,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                    <string>cn=Developer,cn=Cordys@Work,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                </role>
+                                <description>
+                                    <string>{user_name}</string>
+                                </description>
+                                <cn>
+                                    <string>{user_name}</string>
+                                </cn>
+                                <objectclass>
+                                    <string>top</string>
+                                    <string>busorganizationalobject</string>
+                                    <string>busorganizationaluser</string>
+                                </objectclass>
+                                <authenticationuser>
+                                    <string>cn={user_name},cn=authenticated users,cn=cordys,cn=defaultInst,o=opentext.net</string>
+                                </authenticationuser>
+                            </entry>
+                        </new>
+                    </tuple>
+                </Update>
+            </SOAP:Body>
+        </SOAP:Envelope>
+        """
+        retries = 0
+        max_retries = 6
+        retry_delay = 30  # Time in seconds
+
+        while retries < max_retries:
+            try:
+                response = requests.post(
+                    url=self.gateway_url(),
+                    data=cws_config_req_xml,
+                    headers=REQUEST_HEADERS,
+                    cookies=self.cookie(),
+                    timeout=30,
+                )
+
+                if response.ok and role_name in response.text:
+                    self.logger.info("User '%s' successfully assigned the '%s' role.", user_name, role_name)
+                    return True
+
+                # Handle session expiration
+                if response.status_code == 401 and retries == 0:
+                    self.logger.warning("Session expired. Re-authenticating...")
+                    self.authenticate(revalidate=True)
+                    retries += 1
+                    continue  # Retry immediately after re-authentication
+
+                # Log failure response
+                self.logger.error(
+                    "Failed to assign role to user '%s': HTTP %s - %s",
+                    user_name,
+                    response.status_code,
+                    response.text,
+                )
+
+            except requests.RequestException:
+                self.logger.error("Request failed:")
+
+            retries += 1
+            self.logger.info("Retrying... Attempt %d/%d", retries, max_retries)
+            time.sleep(retry_delay)
+
+        self.logger.error("Retry limit exceeded. Role assignment failed for user '%s'.", user_name)
+        return False
+
+        # end method definition