pyxecm 3.1.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

pyxecm/otca.py

@@ -2240,9 +2240,14 @@ class OTCA:
                                 }
                             },
                         },
-                        "responseTemplate": {},
-                        "agents": ["retrieverAgent"],
-                    }
+                        "responseTemplate": {
+                            'scratchpad': {
+                                'item': {
+                                    'input': {'where': 'response.context_update.where'}
+                                }
+                            },
+                            "agents": ["retrieverAgent"],
+                        }
 
         Returns:
             dict: Tool details or None in case of an error.

pyxecm/otcs.py

@@ -500,6 +500,7 @@ class OTCS:
         self._use_numeric_category_identifier = use_numeric_category_identifier
         self._executor = ThreadPoolExecutor(max_workers=thread_number)
         self._workspace_type_lookup = {}
+        self._workspace_type_names = []
 
     # end method definition
 
@@ -1018,7 +1019,12 @@ class OTCS:
                     if success_message:
                         self.logger.info(success_message)
                     if parse_request_response and not stream:
-                        return self.parse_request_response(response_object=response)
+                        # There are cases where OTCS returns response.ok (200) but
+                        # because of restart or scaling of pods the response text is not
+                        # valid JSON. So parse_request_response() may raise an ConnectionError exception that
+                        # is handled in the exception block below (with waiting for readiness and retry logic)
+                        parsed_response = self.parse_request_response(response_object=response)
+                        return parsed_response
                     else:
                         return response
                 # Check if Session has expired - then re-authenticate and try once more
@@ -1123,17 +1129,20 @@ class OTCS:
                     else:
                         return None
             # end except Timeout
-            except requests.exceptions.ConnectionError:
+            except requests.exceptions.ConnectionError as connection_error:
                 if retries <= max_retries:
                     self.logger.warning(
-                        "Connection error (%s)! Retrying in %d seconds... %d/%d",
+                        "Cannot connect to OTCS at -> %s; error -> %s! Retrying in %d seconds... %d/%d",
                         url,
+                        str(connection_error),
                         REQUEST_RETRY_DELAY,
                         retries,
                         max_retries,
                     )
                     retries += 1
 
+                    # The connection error could have been caused by a restart of the OTCS pod or services.
+                    # So we better check if OTCS is ready to receive requests again before retrying:
                     while not self.is_ready():
                         self.logger.warning(
                             "Content Server is not ready to receive requests. Waiting for state change in %d seconds...",
@@ -1143,8 +1152,9 @@ class OTCS:
 
                 else:
                     self.logger.error(
-                        "%s; connection error",
+                        "%s; connection error -> %s",
                         failure_message,
+                        str(connection_error),
                     )
                     if retry_forever:
                         # If it fails after REQUEST_MAX_RETRIES retries
@@ -1183,13 +1193,17 @@ class OTCS:
                 The response object delivered by the request call.
             additional_error_message (str):
                 Custom error message to include in logs.
-            show_error (bool):
-                If True, logs an error. If False, logs a warning.
+            show_error (bool, optional):
+                If True, logs an error / raises an exception. If False, logs a warning.
 
         Returns:
             dict | None:
                 Parsed response as a dictionary, or None in case of an error.
 
+        Raises:
+            requests.exceptions.ConnectionError:
+                If the response cannot be decoded as JSON.
+
         """
 
         if not response_object:
@@ -1214,12 +1228,13 @@ class OTCS:
                     exception,
                 )
             if show_error:
-                self.logger.error(message)
-            else:
-                self.logger.debug(message)
+                # Raise ConnectionError instead of returning None
+                raise requests.exceptions.ConnectionError(message) from exception
+            self.logger.warning(message)
             return None
-        else:
-            return dict_object
+        # end try-except block
+
+        return dict_object
 
     # end method definition
 
@@ -1710,9 +1725,9 @@ class OTCS:
         # than creating a list with all values at once.
         # This is especially important for large result sets.
         yield from (
-            item[data_name][property_name]
+            item[data_name][property_name] if property_name else item[data_name]
             for item in response["results"]
-            if isinstance(item.get(data_name), dict) and property_name in item[data_name]
+            if isinstance(item.get(data_name), dict) and (not property_name or property_name in item[data_name])
         )
 
     # end method definition
@@ -5054,9 +5069,9 @@ class OTCS:
             show_hidden (bool, optional):
                 Whether to list hidden items. Defaults to False.
             limit (int, optional):
-                The maximum number of results to return. Defaults to 100.
+                The maximum number of results to return (page size). Defaults to 100.
             page (int, optional):
-                The page of results to retrieve. Defaults to 1 (first page).
+                The page of results to retrieve (page number). Defaults to 1 (first page).
             fields (str | list, optional):
                 Which fields to retrieve.
                 This can have a significant impact on performance.
@@ -5408,11 +5423,10 @@ class OTCS:
                 continue
             category_key = next(iter(category_schema))
 
-            attribute_schema = next(
-                (cat_elem for cat_elem in category_schema.values() if cat_elem.get("name") == attribute),
-                None,
-            )
-            if not attribute_schema:
+            # There can be multiple attributes with the same name in a category
+            # if the category has sets:
+            attribute_schemas = [cat_elem for cat_elem in category_schema.values() if cat_elem.get("name") == attribute]
+            if not attribute_schemas:
                 self.logger.debug(
                     "Node -> '%s' (%s) does not have attribute -> '%s'. Skipping...",
                     node_name,
@@ -5420,73 +5434,81 @@ class OTCS:
                     attribute,
                 )
                 continue
-            attribute_key = attribute_schema["key"]
-            # Split the attribute key once (1) at the first underscore from the right.
-            # rsplit delivers a list and [-1] delivers the last list item:
-            attribute_id = attribute_key.rsplit("_", 1)[-1]
 
-            if attribute_set:
-                set_schema = next(
-                    (
-                        cat_elem
-                        for cat_elem in category_schema.values()
-                        if cat_elem.get("name") == attribute_set and cat_elem.get("persona") == "set"
-                    ),
-                    None,
-                )
-                if not set_schema:
-                    self.logger.debug(
-                        "Node -> '%s' (%s) does not have attribute set -> '%s'. Skipping...",
-                        node_name,
-                        node_id,
-                        attribute_set,
-                    )
-                    continue
-                set_key = set_schema["key"]
-            else:
-                set_schema = None
-                set_key = None
+            # Traverse the attribute schemas with the matching attribute name:
+            for attribute_schema in attribute_schemas:
+                attribute_key = attribute_schema["key"]
+                # Split the attribute key once (1) at the first underscore from the right.
+                # rsplit delivers a list and [-1] delivers the last list item:
+                attribute_id = attribute_key.rsplit("_", 1)[-1]
 
-            prefix = set_key + "_" if set_key else category_key + "_"
-
-            data = node["data"]["categories"]
-            for cat_data in data:
-                if set_key:
-                    for i in range(1, int(set_schema["multi_value_length_max"])):
-                        key = prefix + str(i) + "_" + attribute_id
+                if attribute_set:  # is the attribute_set parameter provided?
+                    set_schema = next(
+                        (
+                            cat_elem
+                            for cat_elem in category_schema.values()
+                            if cat_elem.get("name") == attribute_set and cat_elem.get("persona") == "set"
+                        ),
+                        None,
+                    )
+                    if not set_schema:
+                        self.logger.debug(
+                            "Node -> '%s' (%s) does not have attribute set -> '%s'. Skipping...",
+                            node_name,
+                            node_id,
+                            attribute_set,
+                        )
+                        continue
+                    set_key = set_schema["key"]
+                else:  # no attribute set value provided via the attribute_set parameter:
+                    if "_x_" in attribute_key:
+                        # The lookup does not include a set name but this attribute key
+                        # belongs to a set attribute - so we can skip it:
+                        continue
+                    set_schema = None
+                    set_key = None
+
+                prefix = set_key + "_" if set_key else category_key + "_"
+
+                data = node["data"]["categories"]
+                for cat_data in data:
+                    if set_key:
+                        for i in range(1, int(set_schema["multi_value_length_max"])):
+                            key = prefix + str(i) + "_" + attribute_id
+                            attribute_value = cat_data.get(key)
+                            if not attribute_value:
+                                break
+                            # Is it a multi-value attribute (i.e. a list of values)?
+                            if isinstance(attribute_value, list):
+                                if value in attribute_value:
+                                    # Create a "results" dict that is compatible with normal REST calls
+                                    # to not break get_result_value() method that may be called on the result:
+                                    results["results"].append(node)
+                            elif value == attribute_value:
+                                # Create a results dict that is compatible with normal REST calls
+                                # to not break get_result_value() method that may be called on the result:
+                                results["results"].append(node)
+                    # end if set_key
+                    else:
+                        key = prefix + attribute_id
                         attribute_value = cat_data.get(key)
                         if not attribute_value:
-                            break
+                            continue
                         # Is it a multi-value attribute (i.e. a list of values)?
                         if isinstance(attribute_value, list):
                             if value in attribute_value:
                                 # Create a "results" dict that is compatible with normal REST calls
                                 # to not break get_result_value() method that may be called on the result:
                                 results["results"].append(node)
+                        # If not a multi-value attribute, check for equality:
                         elif value == attribute_value:
                             # Create a results dict that is compatible with normal REST calls
                             # to not break get_result_value() method that may be called on the result:
                             results["results"].append(node)
-                # end if set_key
-                else:
-                    key = prefix + attribute_id
-                    attribute_value = cat_data.get(key)
-                    if not attribute_value:
-                        continue
-                    # Is it a multi-value attribute (i.e. a list of values)?
-                    if isinstance(attribute_value, list):
-                        if value in attribute_value:
-                            # Create a "results" dict that is compatible with normal REST calls
-                            # to not break get_result_value() method that may be called on the result:
-                            results["results"].append(node)
-                    # If not a multi-value attribute, check for equality:
-                    elif value == attribute_value:
-                        # Create a results dict that is compatible with normal REST calls
-                        # to not break get_result_value() method that may be called on the result:
-                        results["results"].append(node)
-                # end if set_key else
-            # end for cat_data, cat_schema in zip(data, schema)
-        # end for node in nodes
+                    # end if set_key ... else
+                # end for cat_data in data:
+            # end for attribute_schema in attribute_schemas:
+        # end for node in self.get_subnodes_iterator()
 
         self.logger.debug(
             "Couldn't find a node with the value -> '%s' in the attribute -> '%s' of category -> '%s' in parent with node ID -> %d.",
@@ -7516,7 +7538,7 @@ class OTCS:
         chunk_size: int = 8192,
         overwrite: bool = True,
     ) -> bool:
-        """Download a document from OTCS to local file system.
+        """Download a document (version) from OTCS to local file system.
 
         Args:
             node_id (int):
@@ -7541,8 +7563,7 @@ class OTCS:
         """
 
         if not version_number:
-            # we retrieve the latest version - using V1 REST API. V2 has issues here.:
-            #            request_url = self.config()["nodesUrlv2"] + "/" + str(node_id) + "/content"
+            # we retrieve the latest version - using V1 REST API. V2 has issues with downloading files:
             request_url = self.config()["nodesUrl"] + "/" + str(node_id) + "/content"
             self.logger.debug(
                 "Download document with node ID -> %d (latest version); calling -> %s",
@@ -7550,10 +7571,7 @@ class OTCS:
                 request_url,
             )
         else:
-            # we retrieve the given version - using V1 REST API. V2 has issues here.:
-            # request_url = (
-            #     self.config()["nodesUrlv2"] + "/" + str(node_id) + "/versions/" + str(version_number) + "/content"
-            # )
+            # we retrieve the given version - using V1 REST API. V2 has issues with downloading files:
             request_url = (
                 self.config()["nodesUrl"] + "/" + str(node_id) + "/versions/" + str(version_number) + "/content"
             )
@@ -7585,6 +7603,14 @@ class OTCS:
         content_encoding = response.headers.get("Content-Encoding", "").lower()
         is_compressed = content_encoding in ("gzip", "deflate", "br")
 
+        self.logger.debug(
+            "Downloading document with node ID -> %d to file -> '%s'; total size -> %s bytes; content encoding -> '%s'",
+            node_id,
+            file_path,
+            total_size,
+            content_encoding,
+        )
+
         if os.path.exists(file_path) and not overwrite:
             self.logger.warning(
                 "File -> '%s' already exists and overwrite is set to False, not downloading document.",
@@ -7617,6 +7643,9 @@ class OTCS:
             )
             return False
 
+        # if we have a total size and the content is not compressed
+        # we can do a sanity check if the downloaded size matches
+        # the expected size:
         if total_size and not is_compressed and bytes_downloaded != total_size:
             self.logger.error(
                 "Downloaded size (%d bytes) does not match expected size (%d bytes) for file -> '%s'",
@@ -9458,7 +9487,7 @@ class OTCS:
         expand_workspace_info: bool = True,
         expand_templates: bool = True,
     ) -> dict | None:
-        """Get all workspace types configured in Extended ECM.
+        """Get all workspace types configured in OTCS.
 
         This REST API is very limited. It does not return all workspace type properties
         you can see in OTCS business admin page.
@@ -9639,11 +9668,11 @@ class OTCS:
 
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="get_workspace_type_name")
     def get_workspace_type_name(self, type_id: int) -> str | None:
-        """Get the name of a workspace type based on the provided type ID.
+        """Get the name of a workspace type based on the provided workspace type ID.
 
-        The name is taken from a OTCS global variable if recorded there.
+        The name is taken from a OTCS object variable self._workspace_type_lookup if recorded there.
         If not yet derived it is determined via the REST API and then stored
-        in the global list.
+        in self._workspace_type_lookup (as a lookup cache).
 
         Args:
             type_id (int):
@@ -9654,6 +9683,10 @@ class OTCS:
                 The name of the workspace type. Or None if the type ID
                 was ot found.
 
+        Side effects:
+            Caches the workspace type name in self._workspace_type_lookup
+            for future calls.
+
         """
 
         workspace_type = self._workspace_type_lookup.get(type_id)
@@ -9663,6 +9696,7 @@ class OTCS:
         workspace_type = self.get_workspace_type(type_id=type_id)
         type_name = workspace_type.get("workspace_type")
         if type_name:
+            # Update the lookup cache:
             self._workspace_type_lookup[type_id] = {"location": None, "name": type_name}
             return type_name
 
@@ -9670,6 +9704,43 @@ class OTCS:
 
     # end method definition
 
+    @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="get_workspace_type_by_name")
+    def get_workspace_type_names(self, lower_case: bool = False, renew: bool = False) -> list[str] | None:
+        """Get a list of all workspace type names.
+
+        Args:
+            lower_case (bool):
+                Whether to return the names in lower case.
+            renew (bool):
+                Whether to renew the cached workspace type names.
+
+        Returns:
+            list[str] | None:
+                List of workspace type names or None if the request fails.
+
+        Side effects:
+            Caches the workspace type names in self._workspace_type_names
+            for future calls.
+
+        """
+
+        if self._workspace_type_names and not renew:
+            return self._workspace_type_names
+
+        workspace_types = self.get_workspace_types_iterator()
+        workspace_type_names = [
+            self.get_result_value(response=workspace_type, key="wksp_type_name") for workspace_type in workspace_types
+        ]
+        if lower_case:
+            workspace_type_names = [name.lower() for name in workspace_type_names]
+
+        # Update the cache:
+        self._workspace_type_names = workspace_type_names
+
+        return workspace_type_names
+
+    # end method definition
+
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="get_workspace_templates")
     def get_workspace_templates(
         self, type_id: int | None = None, type_name: str | None = None
@@ -13998,6 +14069,7 @@ class OTCS:
         apply_action: str = "add_upgrade",
         add_version: bool = False,
         clear_existing_categories: bool = False,
+        attribute_values: dict | None = None,
     ) -> bool:
         """Assign a category to a Content Server node.
 
@@ -14005,6 +14077,7 @@ class OTCS:
         (if node_id is a container / folder / workspace).
         If the category is already assigned to the node this method will
         throw an error.
+        Optionally set category attributes values.
 
         Args:
             node_id (int):
@@ -14025,6 +14098,9 @@ class OTCS:
                 True, if a document version should be added for the category change (default = False).
             clear_existing_categories (bool, optional):
                 Defines, whether or not existing (other) categories should be removed (default = False).
+            attribute_values (dict, optional):
+                Dictionary containing "attribute_id":"value" pairs, to be populated during the category assignment.
+                (In case of the category attributes being set as "Required" in xECM, providing corresponding values for those attributes will resolve inability to assign the category).
 
         Returns:
             bool:
@@ -14050,6 +14126,9 @@ class OTCS:
                 "category_id": category_id,
             }
 
+            if attribute_values is not None:
+                category_post_data.update(attribute_values)
+
             self.logger.debug(
                 "Assign category with ID -> %d to item with ID -> %d; calling -> %s",
                 category_id,
@@ -17286,6 +17365,7 @@ class OTCS:
 
         """
 
+        # If no sub-process ID is given, use the process ID:
         if subprocess_id is None:
             subprocess_id = process_id
 
@@ -17781,8 +17861,8 @@ class OTCS:
             for subnode in subnodes:
                 subnode_id = self.get_result_value(response=subnode, key="id")
                 subnode_name = self.get_result_value(response=subnode, key="name")
-                subnode_type = self.get_result_value(response=subnode, key="type")
-                self.logger.info("Traversing %s node -> '%s' (%s)", subnode_type, subnode_name, subnode_id)
+                subnode_type_name = self.get_result_value(response=subnode, key="type_name")
+                self.logger.info("Traversing %s node -> '%s' (%s)", subnode_type_name, subnode_name, subnode_id)
                 # Recursive call for current subnode:
                 result = self.traverse_node(
                     node=subnode,

{pyxecm-3.1.0.dist-info → pyxecm-3.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyxecm
-Version: 3.1.0
+Version: 3.1.1
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>

{pyxecm-3.1.0.dist-info → pyxecm-3.1.1.dist-info}/RECORD

@@ -3,8 +3,8 @@ pyxecm/avts.py,sha256=NEd1JdJCVmNohp_A-ZxAIMQZX5NCJFMhyKV6cdLFgTw,56960
 pyxecm/coreshare.py,sha256=oz5SASlOC_e4-OIazFUrIA7gB6DfpC7RY4Ck7AHKcvQ,95999
 pyxecm/otac.py,sha256=itsxIkIhIHdAiRCLRegmxCejE3kqpWxgwaJvAGNqzzg,22849
 pyxecm/otawp.py,sha256=9kQghTIrnHP5I_GOmnAlvPhJk433b0dcdVzQHx0fSAM,112962
-pyxecm/otca.py,sha256=8rBAnLGNcEK9UAdRz6bSzDqe5Smvvp0lLl8oaV7yQbE,99352
-pyxecm/otcs.py,sha256=GIXA1BIV8oTZEO3-30MG0eG0TQLNtuvjAzpNmBa2JCE,815063
+pyxecm/otca.py,sha256=_HJG84yFr00CvdgMlvTnmAYNs-6w1APbzUzZb5udkuk,99597
+pyxecm/otcs.py,sha256=5YPdvkl8CBDMRNjVOkUDRce-GnBxaVGF98mAGakrvSM,819480
 pyxecm/otds.py,sha256=gTyHwCSFVJbEia3h-xcPY0UL1fS58VxuI0l9uA3lC6c,191581
 pyxecm/otiv.py,sha256=I5lt4sz7TN3W7BCstCKQY2WQnei-t0tXdM4QjRQRmWI,2358
 pyxecm/otkd.py,sha256=3c37FwQ-KDBN48O1wZVxX46BiQDRtb2-KrXZ7HG54Fg,47488
@@ -27,7 +27,7 @@ pyxecm_api/auth/functions.py,sha256=hdu4XPS975r8LsbH_3OKNQOEMvnbD40zhRh1nO1hIyQ,
 pyxecm_api/auth/models.py,sha256=lKebaIHbALZ10quCCKQ3wf7w8V6k84tFXcPV1zbQsS0,271
 pyxecm_api/auth/router.py,sha256=H58owZMM9lcskUITWSJPZYQr6IM66MyV7h9G36HPpQM,2140
 pyxecm_api/common/__init__.py,sha256=ranS8DEliiC4Mlo-bVva9Maj5q08I0I6NJflUFIvOvw,19
-pyxecm_api/common/functions.py,sha256=-WpWLKkiHzv2WmR3zIBrF2Z1ADcDlC5ifJWLyG7cu-s,8963
+pyxecm_api/common/functions.py,sha256=snu6bFNvky4JUCRbWdeE64wUjIH2NWVihXbf9nfTpsQ,5209
 pyxecm_api/common/metrics.py,sha256=kOJ1DZveZJ7xFd1pB12Zbkq6Z-evaTivpgO_ujVbsxM,2707
 pyxecm_api/common/models.py,sha256=c76ysWUt40A875DirsFMXttxwjHvBYvjuOVEXePSZ9k,456
 pyxecm_api/common/router.py,sha256=BXi3SMvkswCIftoVkJIP_Wx8gd3WKJsE3rq6Pult50I,3482
@@ -54,15 +54,15 @@ pyxecm_api/v1_payload/models.py,sha256=eD9A2K23L_cGhBDTO1FGVGJMQ1COaYWmcr-ELE66t
 pyxecm_api/v1_payload/router.py,sha256=2twiLBeNNDGIEQ6SCZwLFgd8oYOzgbskS-Q3OL-lKe4,15441
 pyxecm_customizer/__init__.py,sha256=x2NhDlNcubRC-jXzqT02j9kQGXBo36QAehjmcQuSbXw,721
 pyxecm_customizer/__main__.py,sha256=QGQlJJAdLmJccArwPT8XEhBOMSJ-Z8gwLrtHPNfL8Ps,1407
-pyxecm_customizer/browser_automation.py,sha256=q1305oZ3a_JI8fLpc0u0T5D_8YSFW0C8-LQpOY0pwXc,69540
+pyxecm_customizer/browser_automation.py,sha256=gWYJVkVMOer7LyQNq_lwyCb0-Ixaf3VaWM7WrpqKMKY,71360
 pyxecm_customizer/customizer.py,sha256=Nzz3wndPp9r5GVpOzLtdNUOuIsCZ2GYdIS1HhWdboBM,84938
 pyxecm_customizer/exceptions.py,sha256=YXX0in-UGXfJb6Fei01JQetOtAHqUiITb49OTSaZRkE,909
-pyxecm_customizer/guidewire.py,sha256=1smNNDW-9FdrpqVu0r74KqgEqtq9M7LgpopUJvRSLrE,67049
+pyxecm_customizer/guidewire.py,sha256=u_mGZU5Nedm-cGf5hUCWE38U-75qoqwi7cq-G3qHty0,67167
 pyxecm_customizer/k8s.py,sha256=DcxLKKuvV3S4DYqP4jUygn32aeGtD0c1FOXumZzqqdY,55837
-pyxecm_customizer/knowledge_graph.py,sha256=9Yu-Y7Co7A54qEayRT9e0SKYHlMfDmDVAH12k5gSf3A,46469
+pyxecm_customizer/knowledge_graph.py,sha256=Jdm-WVftunoLztinWSPUNhRZ8DhRAVIEcQJJz57opGk,46429
 pyxecm_customizer/log.py,sha256=2DmGF3b-ZIOAJCPSmZmxGD7BNxY4-mZm0H_X0HeJedE,916
 pyxecm_customizer/m365.py,sha256=xQGdY9ti44e93c5tPbgCHjvrM-SjQr2F1iApJMb0-Pk,213957
-pyxecm_customizer/payload.py,sha256=JKye3d-ac-Z6IFInFPh50AnI47mREGHZhYdLeyQH8qM,1365927
+pyxecm_customizer/payload.py,sha256=bMyXLMBlio1WuLgKfy9z8LICxFSKg05JDy8qrxRn6M4,1366630
 pyxecm_customizer/payload_list.py,sha256=MCpCzarmQ-5u7FSW7djNOMSjv373Ltx-9rEDIuhEboI,28266
 pyxecm_customizer/salesforce.py,sha256=lGkQcEYg5YIWc7SF2TELT6yfgrn4pnbCrf8wXGk-PMc,64557
 pyxecm_customizer/sap.py,sha256=lD_riOZhYjbZ0_pUZyqhxP6guzBM__TcUjZhSgDowoE,6506
@@ -76,7 +76,7 @@ pyxecm_maintenance_page/app.py,sha256=pTOeZfgPPq6BT7P8naUjW-ZT9dXqwX6DWazIVL-9Fk
 pyxecm_maintenance_page/settings.py,sha256=VRReZeNdza7i7lgnQ3wVojzoPDGXZnzr5rsMJY1EnHk,955
 pyxecm_maintenance_page/static/favicon.avif,sha256=POuuPXKbjHVP3BjNLpFIx8MfkQg5z2LZA7sK6lejARg,1543
 pyxecm_maintenance_page/templates/maintenance.html,sha256=0OAinv7jmj3Aa7GNCIoBLDGEMW1-_HdJfwWmkmb6Cs4,5581
-pyxecm-3.1.0.dist-info/METADATA,sha256=C6gl_je1-QeK7NROKoR0Sm_hk4pQXPuXabc6is81GYA,4566
-pyxecm-3.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyxecm-3.1.0.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
-pyxecm-3.1.0.dist-info/RECORD,,
+pyxecm-3.1.1.dist-info/METADATA,sha256=9ZjC6c_J6K4UBCgohLC_Fz9THffRsXPPq41fPl5Wpoo,4566
+pyxecm-3.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyxecm-3.1.1.dist-info/entry_points.txt,sha256=prc1mDdpd3bQk98VRBozI363mDUgSwDibDKXGNqKqgI,151
+pyxecm-3.1.1.dist-info/RECORD,,

pyxecm_api/common/functions.py

@@ -2,15 +2,12 @@
 
 import logging
 import os
-import time
-from datetime import UTC, datetime
 from typing import Annotated
 
 from fastapi import Depends
 from pyxecm.otca import OTCA
 from pyxecm.otcs import OTCS
 from pyxecm_customizer import K8s, PayloadList, Settings
-from pyxecm_customizer.knowledge_graph import KnowledgeGraph
 
 from pyxecm_api.auth.functions import get_otcsticket
 from pyxecm_api.settings import CustomizerAPISettings, api_settings
@@ -22,100 +19,6 @@ LOGS_LOCK = {}
 # Initialize the globel Payloadlist object
 PAYLOAD_LIST = PayloadList(logger=logger)
 
-# This object is initialized in the build_graph() function below.
-KNOWLEDGEGRAPH_OBJECT: KnowledgeGraph = None
-
-# The following ontology is fed into the knowledge graph tool description.
-# This is currently hard-coded. Ideally this should be derived from OTCM
-# or provided via a payload file:
-
-KNOWLEDGEGRAPH_ONTOLOGY = {
-    ("Vendor", "Material", "child"): ["offers", "supplies", "provides"],
-    ("Vendor", "Purchase Order", "child"): ["supplies", "provides"],
-    ("Vendor", "Purchase Contract", "child"): ["signs", "owns"],
-    ("Material", "Vendor", "parent"): ["is supplied by"],
-    ("Purchase Order", "Material", "child"): ["includes", "is part of"],
-    ("Customer", "Sales Order", "child"): ["has ordered"],
-    ("Customer", "Sales Contract", "child"): ["signs", "owns"],
-    ("Sales Order", "Customer", "parent"): ["belongs to", "is initiated by"],
-    ("Sales Order", "Material", "child"): ["includes", "consists of"],
-    ("Sales Order", "Delivery", "child"): ["triggers", "is followed by"],
-    ("Sales Order", "Production Order", "child"): ["triggers", "is followed by"],
-    ("Sales Contract", "Material", "child"): ["includes", "consists of"],
-    ("Production Order", "Material", "child"): ["includes", "consists of"],
-    ("Production Order", "Delivery", "child"): ["triggers", "is followed by"],
-    ("Production Order", "Goods Movement", "child"): ["triggers", "is followed by"],
-    ("Delivery", "Goods Movement", "child"): ["triggers", "is followed by"],
-    ("Delivery", "Material", "child"): ["triggers", "is followed by"],
-}
-
-
-### Functions
-
-
-def get_ontology() -> dict:
-    """Get the ontology for the knowledge graph.
-
-    Returns:
-        dict: The ontology as a dictionary.
-
-    """
-
-    return KNOWLEDGEGRAPH_ONTOLOGY
-
-
-def get_knowledgegraph_object() -> KnowledgeGraph:
-    """Get the Knowledge Graph object."""
-
-    global KNOWLEDGEGRAPH_OBJECT  # noqa: PLW0603
-
-    if KNOWLEDGEGRAPH_OBJECT is None:
-        KNOWLEDGEGRAPH_OBJECT = KnowledgeGraph(otcs_object=get_otcs_object(), ontology=KNOWLEDGEGRAPH_ONTOLOGY)
-
-    return KNOWLEDGEGRAPH_OBJECT
-
-
-def build_graph() -> None:
-    """Build the knowledge Graph. And keep it updated every hour."""
-
-    def build() -> None:
-        """Build the knowledge graph once."""
-
-        logger.info("Starting knowledge graph build...")
-        start_time = datetime.now(UTC)
-        result = get_knowledgegraph_object().build_graph(
-            workspace_type_exclusions=None,
-            workspace_type_inclusions=[
-                "Vendor",
-                "Purchase Contract",
-                "Purchase Order",
-                "Material",
-                "Customer",
-                "Sales Order",
-                "Sales Contract",
-                "Delivery",
-                "Goods Movement",
-            ],
-            workers=20,  # for multi-threaded traversal
-            filter_at_traversal=True,  # also filter for workspace types if following relationships
-            relationship_types=["child"],  # only go from parent to child
-            strategy="BFS",  # Breadth-First-Search
-            metadata=True,  # don't include workspace metadata
-        )
-        end_time = datetime.now(UTC)
-        logger.info(
-            "Knowledge graph completed in %s. Processed %d workspace nodes and traversed %d workspace relationships.",
-            str(end_time - start_time),
-            result["processed"],
-            result["traversed"],
-        )
-
-    # Endless loop to build knowledge graph and update it every hour:
-    while True:
-        build()
-        logger.info("Waiting for 1 hour before rebuilding the knowledge graph...")
-        time.sleep(3600)
-
 
 def get_k8s_object() -> K8s:
     """Get an instance of a K8s object.

pyxecm_customizer/browser_automation.py

@@ -98,6 +98,12 @@ REQUEST_MAX_RETRIES = 3
 class BrowserAutomation:
     """Class to automate settings via a browser interface."""
 
+    page: Page = None
+    browser: Browser = None
+    context: BrowserContext = None
+    playwright = None
+    proxy = None
+
     logger: logging.Logger = default_logger
 
     def __init__(
@@ -186,7 +192,6 @@ class BrowserAutomation:
         if self.take_screenshots and not os.path.exists(self.screenshot_directory):
             os.makedirs(self.screenshot_directory)
 
-        self.proxy = None
         if os.getenv("HTTP_PROXY"):
             self.proxy = {
                 "server": os.getenv("HTTP_PROXY"),
@@ -197,8 +202,9 @@ class BrowserAutomation:
         self.logger.info("Using browser -> '%s'...", browser)
 
         if not self.setup_playwright(browser=browser):
-            self.logger.error("Failed to initialize Playwright browser automation!")
-            return
+            msg = "Failed to initialize Playwright browser automation!"
+            self.logger.error(msg)
+            raise RuntimeError(msg)
 
         self.logger.info("Creating browser context...")
         self.context: BrowserContext = self.browser.new_context(
@@ -378,19 +384,21 @@ class BrowserAutomation:
 
     # end method definition
 
-    def take_screenshot(self) -> bool:
+    def take_screenshot(self, suffix: str = "") -> bool:
         """Take a screenshot of the current browser window and save it as PNG file.
 
+        Args:
+            suffix (str, optional):
+                Optional suffix to append to the screenshot filename.
+
         Returns:
             bool:
                 True if successful, False otherwise
 
         """
 
-        screenshot_file = "{}/{}-{:02d}.png".format(
-            self.screenshot_directory,
-            self.screenshot_names,
-            self.screenshot_counter,
+        screenshot_file = "{}/{}-{:02d}{}.png".format(
+            self.screenshot_directory, self.screenshot_names, self.screenshot_counter, suffix
         )
         self.logger.debug("Save browser screenshot to -> %s", screenshot_file)
 
@@ -681,6 +689,12 @@ class BrowserAutomation:
             wait_state (str, optional):
                 Defines if we wait for attached (element is part of DOM) or
                 if we wait for elem to be visible (attached, displayed, and has non-zero size).
+                Possible values are:
+                * "attached" - the element is present in the DOM.
+                * "detached" - the element is not present in the DOM.
+                * "visible" - the element is visible (attached, displayed, and has non-zero size).
+                * "hidden" - the element is hidden (attached, but not displayed).
+                Default is "visible".
             exact_match (bool | None, optional):
                 If an exact matching is required. Default is None (not set).
             regex (bool, optional):
@@ -705,14 +719,17 @@ class BrowserAutomation:
 
         """
 
-        failure_message = "Cannot find page element with selector -> '{}' ({}){}{}{}".format(
+        failure_message = "Cannot find {} page element with selector -> '{}' ({}){}{}{}{}".format(
+            "occurence #{} of".format(occurrence) if occurrence > 1 else "any",
             selector,
             selector_type,
             " and role type -> '{}'".format(role_type) if role_type else "",
             " in iframe -> '{}'".format(iframe) if iframe else "",
             ", occurrence -> {}".format(occurrence) if occurrence > 1 else "",
+            ", waiting for state -> '{}'".format(wait_state),
         )
-        success_message = "Found page element with selector -> '{}' ('{}'){}{}{}".format(
+        success_message = "Found {} page element with selector -> '{}' ('{}'){}{}{}".format(
+            "occurence #{} of".format(occurrence) if occurrence > 1 else "a",
             selector,
             selector_type,
             " and role type -> '{}'".format(role_type) if role_type else "",
@@ -811,6 +828,7 @@ class BrowserAutomation:
         is_page_close_trigger: bool = False,
         wait_until: str | None = None,
         wait_time: float = 0.0,
+        wait_state: str = "visible",
         exact_match: bool | None = None,
         regex: bool = False,
         hover_only: bool = False,
@@ -858,8 +876,17 @@ class BrowserAutomation:
                   This seems to be the safest one for OpenText Content Server.
                 * "domcontentloaded" - waits for the DOMContentLoaded event (HTML is parsed,
                   but subresources may still load).
-            wait_time (float):
-                Time in seconds to wait for elements to appear.
+            wait_time (float, optional):
+                Time in seconds to wait for elements to appear. Default is 0.0 (no wait).
+            wait_state (str, optional):
+                Defines if we wait for attached (element is part of DOM) or
+                if we wait for elem to be visible (attached, displayed, and has non-zero size).
+                Possible values are:
+                * "attached" - the element is present in the DOM.
+                * "detached" - the element is not present in the DOM.
+                * "visible" - the element is visible (attached, displayed, and has non-zero size).
+                * "hidden" - the element is hidden (attached, but not displayed).
+                Default is "visible".
             exact_match (bool | None, optional):
                 If an exact matching is required. Default is None (not set).
             regex (bool, optional):
@@ -896,6 +923,14 @@ class BrowserAutomation:
 
         """
 
+        if not selector:
+            failure_message = "Missing element selector! Cannot find page element!"
+            if show_error:
+                self.logger.error(failure_message)
+            else:
+                self.logger.warning(failure_message)
+            return False
+
         success = True  # Final return value
 
         # If no specific wait until strategy is provided in the
@@ -909,18 +944,14 @@ class BrowserAutomation:
             self.logger.info("Wait for %d milliseconds before clicking...", wait_time * 1000)
             self.page.wait_for_timeout(wait_time * 1000)
 
-        if not selector:
-            failure_message = "Missing element selector! Cannot find page element!"
-            if show_error:
-                self.logger.error(failure_message)
-            else:
-                self.logger.warning(failure_message)
-            return False
+            if self.take_screenshots:
+                self.take_screenshot(suffix="_wait_before_click")
 
         elem = self.find_elem(
             selector=selector,
             selector_type=selector_type,
             role_type=role_type,
+            wait_state=wait_state,
             exact_match=exact_match,
             regex=regex,
             occurrence=occurrence,
@@ -1222,7 +1253,7 @@ class BrowserAutomation:
             self.logger.error("Download failed; error -> %s", str(e))
             return None
 
-        self.logger.info("Download file to -> %s", save_path)
+        self.logger.info("Downloaded file to -> %s", save_path)
 
         return save_path
 
@@ -1273,13 +1304,13 @@ class BrowserAutomation:
                 Is the element in an iFrame? Then provide the name of the iframe with this parameter.
             min_count (int):
                 Minimum number of required matches (# elements on page).
-            wait_time (float):
-                Time in seconds to wait for elements to appear.
+            wait_time (float, optional):
+                Time in seconds to wait for elements to appear. Default is 0.0 (no wait).
             wait_state (str, optional):
                 Defines if we wait for attached (element is part of DOM) or
                 if we wait for elem to be visible (attached, displayed, and has non-zero size).
-            show_error (bool):
-                Whether to log warnings/errors.
+            show_error (bool, optional):
+                Whether to log warnings/errors. Default is True.
 
         Returns:
             bool | None:
@@ -1306,10 +1337,9 @@ class BrowserAutomation:
             iframe=iframe,
         )
         if not locator:
-            if show_error:
-                self.logger.error(
-                    "Failed to check if elements -> '%s' (%s) exist! Locator is undefined.", selector, selector_type
-                )
+            self.logger.error(
+                "Failed to check if elements -> '%s' (%s) exist! Locator is undefined.", selector, selector_type
+            )
             return (None, 0)
 
         self.logger.info(
@@ -1369,8 +1399,9 @@ class BrowserAutomation:
             return (None, 0)
 
         self.logger.info(
-            "Found %s elements matching selector -> '%s' (%s%s).",
+            "Found %d element%s matching selector -> '%s' (%s%s).",
             count,
+            "s" if count > 1 else "",
             selector,
             "selector type -> '{}'".format(selector_type),
             ", role type -> '{}'".format(role_type) if role_type else "",
@@ -1386,7 +1417,7 @@ class BrowserAutomation:
 
         matching_elems = []
 
-        # Iterate over all elements found by the locator and checkif
+        # Iterate over all elements found by the locator and check if
         # they comply with the additional value conditions (if provided).
         # We collect all matching elements in a list:
         for i in range(count):
@@ -1424,8 +1455,9 @@ class BrowserAutomation:
         else:
             success = True
             self.logger.info(
-                "Found %d matching elements.%s",
+                "Found %d matching element%s.%s",
                 matching_elements_count,
+                "s" if matching_elements_count > 1 else "",
                 " This is {} the minimum {} element{} probed for.".format(
                     "exactly" if matching_elements_count == min_count else "more than",
                     min_count,
@@ -1542,9 +1574,9 @@ class BrowserAutomation:
 
         """
 
-        self.logger.debug("Setting default timeout to -> %s seconds...", str(wait_time))
+        self.logger.debug("Setting default timeout to -> %.2f seconds...", wait_time)
         self.page.set_default_timeout(wait_time * 1000)
-        self.logger.debug("Setting navigation timeout to -> %s seconds...", str(wait_time))
+        self.logger.debug("Setting navigation timeout to -> %.2f seconds...", wait_time)
         self.page.set_default_navigation_timeout(wait_time * 1000)
 
     # end method definition

pyxecm_customizer/guidewire.py

@@ -358,44 +358,44 @@ class Guidewire:
         index: int = 0,
         show_error: bool = True,
     ) -> str | None:
-        """Read an item value from the REST API response.
+        """Read an item value from the Guidewire REST API response.
 
         Args:
             response (dict):
-                REST API response object.
+                Guidewire REST API response object.
             key (str):
                 Key to find (e.g., "id", "name").
             index (int, optional):
                 Index to use if a list of results is delivered (1st element has index 0).
                 Defaults to 0.
             show_error (bool, optional):
-                Whether an error or just a warning should be logged.
+                Whether an error or just a warning should be logged. Defaults to True.
 
         Returns:
-            str:
+            str | None:
                 Value of the item with the given key, or None if no value is found.
 
         """
 
         # First do some sanity checks:
         if not response:
-            self.logger.debug("Empty response - no results found!")
+            self.logger.debug("Empty Guidewire response - no results found!")
             return None
 
         # To support also iterators that yield from results,
-        # we wrap an attributea element into a data element
+        # we wrap an "attributes" element into a "data" element
         # to make the following code work like for direct REST responses:
         if "attributes" in response:
             response = {"data": response}
 
         if "data" not in response:
             if show_error:
-                self.logger.error("No 'data' key in REST response - returning None")
+                self.logger.error("No 'data' key in Guidewire REST response -> %s. Returning None.", str(response))
             return None
 
         results = response["data"]
         if not results:
-            self.logger.debug("No results found! Empty data element.")
+            self.logger.debug("No results found in the Guidewire response! Empty 'data' element.")
             return None
 
         # check if results is a list or a dict (both is possible - iterator responses will be dict):

pyxecm_customizer/knowledge_graph.py

@@ -267,14 +267,14 @@ class KnowledgeGraph:
         """
 
         if not self._attribute_schemas:
-            self.build_attributes()
+            self.build_categories()
 
         return list(self._attribute_schemas.get(category, {}).get("attributes", {}).keys())
 
     # end method definition
 
     def get_category_id(self, category: str) -> str | None:
-        """Return the attribute schemas dictionary.
+        """Return the category ID for a category name.
 
         Args:
             category (str):
@@ -288,7 +288,7 @@ class KnowledgeGraph:
     def get_attribute_id(
         self, category: str, attribute: str | None = None, set_attribute: str | None = None, row: int | None = None
     ) -> str | None:
-        """Return the attribute schemas dictionary.
+        """Return the attribute ID (or category ID if attribute is None).
 
         Args:
             category (str):
@@ -307,21 +307,18 @@ class KnowledgeGraph:
         """
 
         if not self._attribute_schemas:
-            self.build_attributes()
+            self.build_categories()
 
         # Lookup the category schema by the category name:
         category = self._attribute_schemas.get(category, {})
         if not category:
             return None
         if not attribute:
-            # If now specific attribute is requested return the category ID:
+            # If no specific attribute is requested return the category ID:
             return category.get("id", None)
         attributes = category.get("attributes", {})
         # Construct the attribute lookup key. For set attributes we use the format "Set:Attribute".
         lookup_key = attribute if not set_attribute else f"{set_attribute}:{attribute}"
-        if lookup_key not in attributes:
-            return None
-
         if lookup_key not in attributes:
             self.logger.error("Attribute '%s' not found in category '%s'!", lookup_key, category.get("id", "unknown"))
             return None
@@ -1065,8 +1062,8 @@ class KnowledgeGraph:
     # end method definition
 
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="build_attribute")
-    def build_attribute(self, node: dict, **kwargs: dict) -> tuple[bool, bool]:  # noqa: ARG002
-        """Build a dictionary of all attribute schemas in OTCS.
+    def build_attributes(self, node: dict, **kwargs: dict) -> tuple[bool, bool]:  # noqa: ARG002
+        """Build a dictionary of all attributes in a given category in OTCS.
 
         Args:
             node (dict):
@@ -1101,11 +1098,11 @@ class KnowledgeGraph:
         if success:
             # Initialize the entry on the category level:
             self._attribute_schemas[node_name] = {"id": node_id, "attributes": {}}
-            personal_volume = self._otcs.get_volume(volume_type=self._otcs.VOLUME_TYPE_PERSONAL_WORKSPACE)
-            personal_volume_id = self._otcs.get_result_value(response=personal_volume, key="id")
             # Retrieve the attribute schema for the given category.
-            # We use the Enterprise Vault (2000) as node_id to have a predictable
+            # We use the Personal Volume as node_id to have a predictable
             # node ID that is always available:
+            personal_volume = self._otcs.get_volume(volume_type=self._otcs.VOLUME_TYPE_PERSONAL_WORKSPACE)
+            personal_volume_id = self._otcs.get_result_value(response=personal_volume, key="id")
             attributes = self._otcs.get_node_category_form(
                 node_id=personal_volume_id, category_id=node_id, operation="create"
             )
@@ -1144,7 +1141,7 @@ class KnowledgeGraph:
     # end method definition
 
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="build_attributes")
-    def build_attributes(self) -> dict:
+    def build_categories(self) -> dict:
         """Build a dictionary of all attribute schemas in OTCS.
 
         This method populates the `self._attribute_schemas` dictionary with
@@ -1186,14 +1183,14 @@ class KnowledgeGraph:
 
         """
 
-        self.logger.info("Starting attribute data lookup build...")
+        self.logger.debug("Start building attribute data lookup...")
 
         result = self._otcs.traverse_node(
             node=self._otcs.get_volume(volume_type=self._otcs.VOLUME_TYPE_CATEGORIES_VOLUME),
-            executables=[self.build_attribute],
+            executables=[self.build_attributes],
         )
 
-        self.logger.info("Attributes data lookup build completed.")
+        self.logger.debug("Attribute data lookup completed.")
 
         return result
 

pyxecm_customizer/payload.py

@@ -12127,7 +12127,7 @@ class Payload:
                 )
         else:  # BO found
             self.logger.debug(
-                "Retrieved ID -> %s for Salesforce object type -> '%s' (looking up -> '%s' in field -> '%s')",
+                "Retrieved business object ID -> %s for Salesforce object type -> '%s' (looking up -> '%s' in field -> '%s')",
                 bo_id,
                 object_type,
                 search_value,
@@ -12223,7 +12223,7 @@ class Payload:
             )
         else:  # BO found
             self.logger.info(
-                "Retrieved ID -> %s for Guidewire object type -> '%s' (looking up -> '%s' in field -> '%s').",
+                "Retrieved business object ID -> %s for Guidewire object type -> '%s' (looking up -> '%s' in field -> '%s').",
                 bo_id,
                 object_type,
                 search_value,
@@ -13570,24 +13570,27 @@ class Payload:
             for result in results:
                 if not result["success"]:
                     self.logger.info(
-                        "Thread -> '%s' had %s failures and completed %s workspaces successfully.",
+                        "Thread -> '%s' had %s failure%s and completed %s workspace%s successfully.",
                         result["thread_name"],
                         result["failure_counter"],
+                        "s" if result["failure_counter"] != 1 else "",
                         result["success_counter"],
+                        "s" if result["success_counter"] != 1 else "",
                     )
                     success = False  # mark the complete processing as "failure" for the status file.
                 else:
                     self.logger.info(
-                        "Thread -> '%s' completed %s workspaces successfully.",
+                        "Thread -> '%s' completed %s workspace%s successfully.",
                         result["thread_name"],
                         result["success_counter"],
+                        "s" if result["success_counter"] != 1 else "",
                     )
         else:  # no multi-threading
             for workspace in self._workspaces:
                 try:
                     result = self.process_workspace(workspace=workspace)
                 except Exception:
-                    self.logger.exception("Failed process workspace -> %s", workspace)
+                    self.logger.error("Failed to process workspace -> %s", workspace)
                     result = False
                 success = success and result  # if a single result is False then mark this in 'success' variable.
 
@@ -18558,8 +18561,8 @@ class Payload:
                     node_name=document_name,
                 )
                 if response["results"]:
-                    self.logger.warning(
-                        "Node -> '%s' does already exist in workspace folder with ID -> %s",
+                    self.logger.info(
+                        "Document -> '%s' does already exist in workspace folder with ID -> %s. Skipping...",
                         document_name,
                         workspace_folder_id,
                     )
@@ -18589,6 +18592,8 @@ class Payload:
                         workspace_id,
                         exec_as_user,
                     )
+            # end for workspace_instance in workspace_instances:
+        # end for doc_generator in self._doc_generators:
 
         if authenticated_user != "admin":
             # Impersonate as the admin user:
@@ -19185,18 +19190,19 @@ class Payload:
                     automation_type,
                     wait_until,
                 )
-            browser_automation_object = BrowserAutomation(
-                base_url=base_url,
-                user_name=user_name,
-                user_password=password,
-                automation_name=name,
-                take_screenshots=debug_automation,
-                headless=browser_automation.get("headless", self._browser_headless),
-                logger=self.logger,
-                wait_until=wait_until,
-                browser=browser_automation.get("browser"),  # None is acceptable
-            )
-            if not browser_automation_object:
+            try:
+                browser_automation_object = BrowserAutomation(
+                    base_url=base_url,
+                    user_name=user_name,
+                    user_password=password,
+                    automation_name=name,
+                    take_screenshots=debug_automation,
+                    headless=browser_automation.get("headless", self._browser_headless),
+                    logger=self.logger,
+                    wait_until=wait_until,
+                    browser=browser_automation.get("browser"),  # None is acceptable
+                )
+            except Exception:
                 self.logger.error(
                     "Cannot execute browser automation -> '%s'. Initialization of browser automation object failed!",
                     name,
@@ -19212,9 +19218,9 @@ class Payload:
             browser_automation_object.set_timeout(wait_time=wait_time)
             if "wait_time" in browser_automation:
                 self.logger.info(
-                    "%s automation wait time -> '%s' configured.",
+                    "%s automation wait time -> %.2f seconds.",
                     automation_type,
-                    str(wait_time),
+                    wait_time,
                 )
 
             # Initialize overall result status:
@@ -19392,6 +19398,7 @@ class Payload:
                         checkbox_state = automation_step.get("checkbox_state", None)
                         wait_until = automation_step.get("wait_until", None)
                         wait_time = automation_step.get("wait_time", 0.0)
+                        wait_state = automation_step.get("wait_state", "visible")
                         role_type = automation_step.get("role_type", None)
                         occurrence = automation_step.get("occurrence", 1)
                         scroll_to_element = automation_step.get("scroll_to_element", True)
@@ -19417,6 +19424,7 @@ class Payload:
                             is_page_close_trigger=close_window,
                             wait_until=wait_until,
                             wait_time=wait_time,
+                            wait_state=wait_state,
                             exact_match=exact_match,
                             regex=regex,
                             hover_only=hover_only,
@@ -19441,8 +19449,10 @@ class Payload:
                                 self.logger.warning(message)
                             continue
                         self.logger.info(
-                            "Successfully %s %s element selected by -> '%s' (%s%s).",
+                            "Successfully %s%s %s%s element selected by -> '%s' (%s%s).",
+                            "force " if force else "",
                             "clicked" if not hover_only else "hovered over",
+                            "occurrence #{} of ".format(occurrence) if occurrence > 1 else "",
                             "navigational" if navigation else "non-navigational",
                             selector,
                             "selector type -> '{}'".format(selector_type),
@@ -19555,7 +19565,7 @@ class Payload:
                             iframe=iframe,
                             min_count=min_count,
                             wait_time=wait_time,  # time to wait before the check is actually done
-                            show_error=not want_exist,  # if element is not found that we do not want to find it is not an error
+                            show_error=want_exist,  # if element is not found that we do not want to find it is not an error
                         )
                         # Check if we didn't get what we want:
                         if (not result and want_exist) or (result and not want_exist):