pyxecm 2.0.2__py3-none-any.whl → 2.0.4__py3-none-any.whl

pyxecm/customizer/payload.py

@@ -67,9 +67,9 @@ from dateutil.parser import parse
 from lark import exceptions as lark_exceptions  # used by hcl2
 
 # OpenText specific modules:
-from pyxecm import AVTS, OTAC, OTAWP, OTCS, OTDS, OTIV, OTMM, OTPD, CoreShare
+from pyxecm import AVTS, OTAC, OTAWP, OTCA, OTCS, OTDS, OTIV, OTKD, OTMM, OTPD, CoreShare
 from pyxecm.customizer.browser_automation import BrowserAutomation
-from pyxecm.customizer.exceptions import StopOnError
+from pyxecm.customizer.exceptions import PayloadImportError, StopOnError
 from pyxecm.customizer.k8s import K8s
 from pyxecm.customizer.m365 import M365
 from pyxecm.customizer.pht import PHT
@@ -160,23 +160,18 @@ def load_payload(
         except (
             lark_exceptions.UnexpectedToken,
             lark_exceptions.UnexpectedCharacters,
-        ):
-            logger.error(
-                "Syntax error while reading Terraform payload file -> '%s'!",
-                payload_source,
-            )
-            payload = {}
+        ) as exc:
+            exception = f"Syntax error while reading Terraform payload file -> '{payload_source}'! --> {traceback.format_exception_only(exc)}"
+            raise PayloadImportError(exception) from exc
+
         except (
             FileNotFoundError,
             ImportError,
             ValueError,
             SyntaxError,
-        ):
-            logger.error(
-                "Error while reading Terraform payload file -> '%s'",
-                payload_source,
-            )
-            payload = {}
+        ) as exc:
+            exception = f"Error while reading Terraform payload file -> '{payload_source}'! --> {traceback.format_exception_only(exc)}"
+            raise PayloadImportError(exception) from exc
 
     elif payload_source.endswith(".yml.gz.b64"):
         logger.info("Open payload from base64-gz-YAML file -> '%s'", payload_source)
@@ -239,9 +234,11 @@ class Payload:
     _successfactors: SuccessFactors | None
     _salesforce: Salesforce | None
     _servicenow: ServiceNow | None
-    _browser_automation: BrowserAutomation | None
     _custom_settings_dir = ""
     _otawp: OTAWP | None
+    _otca: OTCA | None
+    _otkd: OTKD | None
+    _avts: AVTS | None
 
     # _payload_source (string): This is either path + filename of the yaml payload
     # or an path + filename of the Terraform HCL payload
@@ -411,6 +408,7 @@ class Payload:
     - title (str, optional, default = "")
     - email (str, optional, default = "")
     - base_group (str, optional, default = "DefaultGroup")
+    - user_type (str, optional, default = "User") - possible values are "User" and "ServiceUser"
     - company (str, optional, default = "Innovate") - currently used for Salesforce users only
     - privileges (list, optional, default = ["Login", "Public Access"])
     - groups (list, optional)
@@ -567,7 +565,12 @@ class Payload:
       * role (name)
       * users (list, optional, default = [])
       * groups (list, optional, default = [])
-    - relationships (list, optional, default = []) - list of strings with logical workspace IDs
+    - relationships (list, optional, default = []) - list of related workspaces.
+      The elements of the list can be:
+      * string or integer with logical workspace ID
+      * string with nickname of the related workspace
+      * dictionaries with keys "type" and "name" of the related workspace
+      * list of strings with the top-down path in the Enterprise volume
     """
     _workspaces = []
 
@@ -636,6 +639,8 @@ class Payload:
     - name (str, mandatory)
     - nodeid (int, mandatory if no volume is specified) - this is the technical OTCS ID - typically only known for some preinstalled items
     - volume (int, mandatory if no nodeid is specified)
+    - path (list, optional) - can be combined with volume - to specify a top-down path in the volume to the item to be renamed
+    - nickname (str, optional) - the nickname of the node to rename - alternative to to volume/path or nodeid
     """
     _renamings = []
 
@@ -747,7 +752,7 @@ class Payload:
     - base_url (str, mandatory)
     - user_name (str, optional)
     - password (str, optional)
-    - wait_time (float, optional, default = 15.0) - wait time in seconds
+    - wait_time (float, optional, default = 30.0) - wait time in seconds
     - wait_until (str, optional) - the page load / navigation `wait until` strategy. Possible values: `load`, `networkidle`, `domcontentloaded`
     - debug (bool, optional, default = False) - if True take screenshots and save to container
     - automations (list, mandatory)
@@ -1058,7 +1063,7 @@ class Payload:
     - sort (list, optional, default = []) - list of fields to sort the data frame by
     - operations (list, optional, default = ["create"])
     - update_operations (list, optional, default = ["name", "description", "categories", "nickname", "version"]) - possible values:
-      "name", "description", "categories", "nickname", "version"
+      "name", "description", "categories", "nickname", "version", "purge"
     - name (str, mandatory) - can include placeholder surrounded by {...}
     - name_alt (str, optional, default = None) - can include placeholder surrounded by {...}
     - name_regex (str, optional, default = r"") - regex replacement for document names. The pattern and replacement are separated by pipe character |
@@ -1137,7 +1142,7 @@ class Payload:
     - unique (list, optional, default = []) - list of column names which values should be unique -> deduplication
     - sort (list, optional, default = []) - list of fields to sort the data frame by
     - operations (list, optional, default = ["create"])
-    - update_operations (list, optional, default = ["name", "description", "categories", "nickname", "version"]) - possible values:
+    - update_operations (list, optional, default = ["name", "description", "categories", "nickname"]) - possible values:
       "name", "description", "categories", "nickname", "url"
     - name (str, mandatory) - can include placeholder surrounded by {...}
     - name_alt (str, optional, default = None) - can include placeholder surrounded by {...}
@@ -1189,6 +1194,8 @@ class Payload:
 
     _bulk_classifications = []
 
+    _nifi_flows = []
+
     _placeholder_values = {}
 
     # Link to the method in customizer.py to restart the Content Server pods.
@@ -1224,7 +1231,6 @@ class Payload:
         otpd_object: OTPD | None,
         m365_object: M365 | None,
         core_share_object: CoreShare | None,
-        browser_automation_object: BrowserAutomation | None,
         placeholder_values: dict,
         log_header_callback: Callable,
         browser_headless: bool = True,
@@ -1232,6 +1238,8 @@ class Payload:
         aviator_enabled: bool = False,
         upload_status_files: bool = True,
         otawp_object: OTAWP | None = None,
+        otca_object: OTCA | None = None,
+        otkd_object: OTKD | None = None,
         avts_object: AVTS | None = None,
         logger: logging.Logger = default_logger,
     ) -> None:
@@ -1266,8 +1274,6 @@ class Payload:
                 The M365 object to talk to Microsoft Graph API.
             core_share_object (CoreShare | None):
                 The Core Share object.
-            browser_automation_object (BrowserAutomation):
-                The BrowserAutomation object to automate things which don't have a REST API.
             placeholder_values (dict):
                 A dictionary of placeholder values to be replaced in admin settings.
             log_header_callback:
@@ -1284,6 +1290,10 @@ class Payload:
                 of the admin user in Content Server.
             otawp_object (OTAWP):
                 An optional AppWorks Platform object.
+            otca_object (OTCA):
+                An optional Content Aviator object.
+            otkd_object (OTKD):
+                An optional Knowledge Discovery object.
             avts_object (AVTS):
                 An optional Aviator Search object.
             logger (logging.Logger, optional):
@@ -1316,8 +1326,9 @@ class Payload:
         self._otcs_source = None
         self._pht = None  # the OpenText prodcut hierarchy
         self._nhc = None  # National Hurricane Center
-        self._avts = avts_object
-        self._browser_automation = browser_automation_object
+        self._otca = otca_object  # Content Aviator
+        self._otkd = otkd_object  # Knowledge Discovery
+        self._avts = avts_object  # Aviator Search
         self._browser_headless = browser_headless
         self._custom_settings_dir = custom_settings_dir
         self._placeholder_values = placeholder_values
@@ -1504,6 +1515,7 @@ class Payload:
         self._avts_repositories = self.get_payload_section("avtsRepositories")
         self._avts_questions = self.get_payload_section("avtsQuestions")
         self._embeddings = self.get_payload_section("embeddings")
+        self._nifi_flows = self.get_payload_section("nifi")
 
         return self._payload
 
@@ -2153,7 +2165,7 @@ class Payload:
             case "customer":
                 customer = self._otawp.get_customer_by_name(name=entity.get("name"))
                 if customer:
-                    customer_id = self._otawp.get_entity_value(entity=case_type, key="id")
+                    customer_id = self._otawp.get_entity_value(entity=customer, key="id")
                     self.logger.info(
                         "Customer -> '%s' (%s) does already exist. Skipping...", entity.get("name"), str(customer_id)
                     )
@@ -2763,7 +2775,7 @@ class Payload:
             return group["id"]
         else:
             self.logger.debug(
-                "Did not find an existing group with name -> '%s'",
+                "Cannot find an existing group -> '%s'",
                 group_name,
             )
             return 0
@@ -2814,7 +2826,7 @@ class Payload:
             return group["m365_id"]
         else:
             self.logger.debug(
-                "Did not find an existing M365 group with name -> '%s'",
+                "Cannot find an existing M365 group -> '%s'",
                 group_name,
             )
             return None
@@ -2868,7 +2880,7 @@ class Payload:
             return group["core_share_id"]
         else:
             self.logger.debug(
-                "Did not find an existing Core Share group with name -> '%s'",
+                "Cannot find an existing Core Share group -> '%s'",
                 group["name"],
             )
             return None
@@ -2903,7 +2915,10 @@ class Payload:
             self.logger.error("User needs a login name to lookup the ID!")
             return 0
 
-        response = self._otcs.get_user(name=user_name)
+        user_type = 17 if user.get("type", "User") == "ServiceUser" else 0
+
+        response = self._otcs.get_user(name=user_name, user_type=user_type)
+
         # We use the lookup method here as get_user() could deliver more
         # then 1 result element (in edge cases):
         user_id = self._otcs.lookup_result_value(
@@ -2920,7 +2935,7 @@ class Payload:
             return user["id"]
         else:
             self.logger.debug(
-                "Did not find an existing user with name -> '%s'!",
+                "Cannot find an existing user -> '%s'!",
                 user_name,
             )
             return 0
@@ -2969,7 +2984,7 @@ class Payload:
             return user["m365_id"]
         else:
             self.logger.debug(
-                "Did not find an existing M365 user with name -> '%s'",
+                "Did not find an existing M365 user -> '%s'",
                 user_name,
             )
             return None
@@ -3029,11 +3044,17 @@ class Payload:
             user["core_share_id"] = core_share_user_id
             return user["core_share_id"]
         else:
-            self.logger.debug(
-                "Did not find an existing Core Share user with name -> '%s %s'",
-                user["firstname"],
-                user["lastname"],
-            )
+            if "email" in user:
+                self.logger.debug(
+                    "Did not find an existing Core Share user with email -> '%s'",
+                    user["email"],
+                )
+            else:
+                self.logger.debug(
+                    "Cannot find an existing Core Share user -> '%s %s'",
+                    user.get("firstname"),
+                    user.get("lastname"),
+                )
             return None
 
     # end method definition
@@ -3650,6 +3671,9 @@ class Payload:
                     if not self._business_object_types:
                         self._log_header_callback(text="Process Business Object Types")
                         self.process_business_object_types()
+                case "nifi":
+                    self._log_header_callback("Process Knowledge Discovery Nifi Flows")
+                    self.process_nifi_flows()
                 case _:
                     self.logger.error(
                         "Illegal payload section name -> '%s' in payloadSections!",
@@ -5397,7 +5421,7 @@ class Payload:
                 self.logger.error("Group -> '%s' does not have an ID.", group["name"])
                 success = False
                 continue
-            parent_group_names = group["parent_groups"]
+            parent_group_names = group.get("parent_groups", [])
             for parent_group_name in parent_group_names:
                 # First, try to find parent group in payload by parent group name:
                 parent_group = next(
@@ -5460,8 +5484,9 @@ class Payload:
                         member_id=group["id"],
                         group_id=parent_group_id,
                     )
+            # end for parent_group_name in parent_group_names:
 
-            # Assign application roles to the new user:
+            # Assign application roles to the new group:
             application_roles = group.get("application_roles", [])
             for role in application_roles:
                 group_partition = self._otcs.config()["partition"]
@@ -5999,7 +6024,7 @@ class Payload:
                 )
                 continue
             self.logger.info(
-                "Did not find an existing user with name '%s' - creating a new user...",
+                "Cannot find an existing user -> '%s' - creating a new user...",
                 user_name,
             )
 
@@ -6355,7 +6380,7 @@ class Payload:
                 user_name,
                 rfc_name,
                 rfc_description,
-                rfc_params,
+                str(rfc_params),
             )
 
             result = self._sap.call(
@@ -6837,7 +6862,7 @@ class Payload:
                 )
                 if not group:
                     self.logger.error(
-                        "Cannot find group with name -> '%s'. Cannot establish membership in Salesforce. Skipping to next group...",
+                        "Cannot find group -> '%s'. Cannot establish membership in Salesforce. Skipping to next group...",
                         user_group,
                     )
                     success = False
@@ -7305,7 +7330,7 @@ class Payload:
                 )
                 if not group:
                     self.logger.error(
-                        "Cannot find group with name -> '%s'. Cannot establish membership in Core Share. Skipping to next group...",
+                        "Cannot find group -> '%s'. Cannot establish membership in Core Share. Skipping to next group...",
                         user_group,
                     )
                     success = False
@@ -7649,6 +7674,7 @@ class Payload:
                 group_names,
                 user_department,
             )
+
             # Go through all group names:
             for group_name in group_names:
                 # Find the group payload item to the parent group name:
@@ -7748,7 +7774,7 @@ class Payload:
                                 )
                                 success = False
 
-                # As M365 groups are flat (not nested) we also add the
+                # As M365 groups are flat (not nested), we also add the
                 # user as member to the parent groups of the current group
                 # if the parent group is enabled for M365:
                 parent_group_names = group.get("parent_groups")
@@ -7859,13 +7885,17 @@ class Payload:
                             response = self._m365.follow_sharepoint_site(site_id=group_site_id, user_id=m365_user_id)
                             if not response:
                                 self.logger.warning(
-                                    "User -> '%s' cannot follow SharePoint site -> '%s'. ",
+                                    "User -> '%s' cannot follow SharePoint site -> '%s'.",
                                     user["email"],
                                     group_site_name,
                                 )
                                 success = False
-            # end for group name
+                        # end if group_site_id:
+                    # end if group_id:
+                # end if group_name == user_department and user["m365_skus"]:
+            # end for group name in group_names:
         # end for user
+
         self.write_status_file(
             success=success,
             payload_section_name=section_name,
@@ -7880,8 +7910,8 @@ class Payload:
         """Process groups in payload and create matching Teams in Microsoft 365.
 
         We need to do this after the creation of the M365 users as we require
-        Group Owners to create teams. These are NOT the teams for Extended ECM
-        workspaces! Those are created by Scheduled Bots (Jobs) from Extended ECM!
+        Group Owners to create teams. These are NOT the teams for OTCS
+        workspaces! Those are created by Scheduled Bots (Jobs) from OTCS!
 
         Args:
             section_name (str, optional):
@@ -8285,7 +8315,7 @@ class Payload:
 
                 workspace_name = workspace["name"]
                 self.logger.info(
-                    "Check if stale Microsoft 365 Teams with name -> '%s' exist...",
+                    "Check if stale Microsoft 365 Teams -> '%s' exist...",
                     workspace_name,
                 )
                 self._m365.delete_teams(name=workspace_name)
@@ -8381,12 +8411,22 @@ class Payload:
     def process_sites_m365(self, section_name: str = "sitesM365") -> bool:
         """Process M365 groups in payload and configure SharePoint sites in Microsoft 365.
 
-        These are NOT the SharePoint sites for Extended ECM workspaces which are created
-        by Scheduled Bots (Jobs) from Extended ECM via the creation of MS teams
+        These are NOT the SharePoint sites for Business Workspaces which are created
+        by Scheduled Bots (Jobs) from OTCS via the creation of MS teams
         (each MS Team has a SharePoint site behind it)!
 
-        The are the SharePoint sites for the departmental groups such as "Sales",
+        These are the SharePoint sites for the departmental groups such as "Sales",
         "Procurement", "Enterprise Asset Management", ...
+        Only departmental group that have a top-level folder with the exact same
+        name as the Department are configured.
+
+        For each departmental group:
+        1. Determine a departmental folder in the Enterprise Workspace
+        2. Determine the M365 Group
+        3. Determine the SharePoint Site (based on the M365 group ID)
+        4. Determine the Page in the SharePoint site
+        5. Determine or create the SharePoint webpart for the OTCS browser
+        6. Create URL object pointing to SharePoint site inside top level department folder
 
         Args:
             section_name (str, optional):
@@ -8744,7 +8784,7 @@ class Payload:
             # end else
 
             #
-            # 6. Create URL object pointing to SharePoint site inside top level ddepartment folder
+            # 6. Create URL object pointing to SharePoint site inside top level department folder
             #
 
             item_name = (
@@ -8882,6 +8922,19 @@ class Payload:
                         "A restart of the Content Server service is required.",
                     )
                     restart_required = True
+
+                    if admin_setting.get("restart", False):
+                        self.logger.info(
+                            "Immediate restart requested - restart of OTCS services...",
+                        )
+                        # Restart OTCS frontend and backend pods:
+                        self._otcs_restart_callback(
+                            backend=self._otcs_backend,
+                            frontend=self._otcs_frontend,
+                        )
+
+                        restart_required = False
+
             else:
                 self.logger.error(
                     "Admin settings file -> '%s' not found.",
@@ -9026,6 +9079,11 @@ class Payload:
                 continue
             system_type = external_system["external_system_type"]
 
+            self._log_header_callback(
+                text="Process External System -> '{}' ({})".format(system_name, system_type),
+                char="-",
+            )
+
             # Check if external system has been explicitly disabled in payload
             # (enabled = false). In this case we skip the element:
             if not external_system.get("enabled", True):
@@ -9538,6 +9596,11 @@ class Payload:
                 )
                 continue
 
+            # We skip also user of type "ServiceUser":
+            if user.get("type", "User") == "ServiceUser":
+                self.logger.info("Skipping service user -> '%s'...", user_name)
+                continue
+
             user_id = user.get("id")
             if not user_id:
                 self.logger.error(
@@ -9978,23 +10041,23 @@ class Payload:
         # we assume the nickname of the photo item equals the login name of the user
         # we also assume that the photos have been uploaded / transported into the target system
         for user in self._users:
-            if "lastname" not in user or "firstname" not in user:
+            if "name" not in user:
                 self.logger.error(
-                    "User is missing last name or first name. Skipping to next user...",
+                    "User is missing login name. Skipping to next user...",
                 )
                 success = False
                 continue
             user_login = user["name"]
-            user_last_name = user["lastname"]
-            user_first_name = user["firstname"]
-            user_name = user_first_name + " " + user_last_name
+            user_last_name = user.get("lastname", "")
+            user_first_name = user.get("firstname", "")
+            user_name = "{} {}".format(user_first_name, user_last_name).strip()
 
             # Check if user has been explicitly disabled in payload
             # (enabled = false). In this case we skip the element:
             if not user.get("enabled", True):
                 self.logger.info(
                     "Payload for user -> '%s' is disabled. Skipping...",
-                    user_name,
+                    user_login,
                 )
                 continue
 
@@ -10005,7 +10068,7 @@ class Payload:
             if not user.get("enable_core_share", False):
                 self.logger.info(
                     "User -> '%s' is not enabled for Core Share. Skipping...",
-                    user_name,
+                    user_login,
                 )
                 continue
 
@@ -10520,7 +10583,7 @@ class Payload:
 
         if not self._business_object_types:
             self.logger.warning(
-                "List of business object types is empty / not initialized! Cannot lookup type with name -> '%s'",
+                "List of business object types is empty / not initialized! Cannot lookup type -> '%s'",
                 bo_type_name,
             )
             return None
@@ -10532,7 +10595,7 @@ class Payload:
         )
         if not business_object_type:
             self.logger.warning(
-                "Cannot find business object type with name -> '%s'",
+                "Cannot find business object type -> '%s'",
                 bo_type_name,
             )
             return None
@@ -10851,7 +10914,7 @@ class Payload:
                 if role_id is None:
                     #    if member_role is None:
                     self.logger.error(
-                        "Workspace template -> '%s' does not have a role with name -> '%s'",
+                        "Workspace template -> '%s' does not have a role -> '%s'",
                         template_name,
                         member_role_name,
                     )
@@ -12998,7 +13061,7 @@ class Payload:
             workspace["type_name"],
         )
 
-        # now determine the actual node IDs of the workspaces (has been created before):
+        # now determine the actual node ID of the workspace (which should have been created before):
         workspace_node_id = int(self.determine_workspace_id(workspace=workspace))
         if not workspace_node_id:
             self.logger.warning(
@@ -13016,64 +13079,97 @@ class Payload:
 
         success: bool = True
 
-        for related_workspace_id in workspace["relationships"]:
+        for related_workspace in workspace["relationships"]:
             # Initialize variable to determine if we found a related workspace:
             related_workspace_node_id = None
+            found_by = ""
 
-            #
-            # 1. Option: Find the related workspace with the logical ID given in the payload:
-            #
-            related_workspace = next(
-                (item for item in self._workspaces if item["id"] == related_workspace_id),
-                None,
-            )
-            if related_workspace:
-                if not related_workspace.get("enabled", True):
-                    self.logger.info(
-                        "Payload for Related Workspace -> '%s' is disabled. Skipping...",
-                        related_workspace["name"],
+            if isinstance(related_workspace, (str, int)):
+                #
+                # 1. Option: Find the related workspace with the logical ID given in the payload:
+                #
+                related_workspace_payload = next(
+                    (item for item in self._workspaces if str(item["id"]) == str(related_workspace)),
+                    None,
+                )
+                if related_workspace_payload:
+                    if not related_workspace_payload.get("enabled", True):
+                        self.logger.info(
+                            "Payload for Related Workspace -> '%s' is disabled. Skipping...",
+                            related_workspace_payload["name"],
+                        )
+                        continue
+
+                    related_workspace_node_id = self.determine_workspace_id(
+                        workspace=related_workspace_payload,
                     )
-                    continue
+                    if not related_workspace_node_id:
+                        self.logger.warning(
+                            "Related Workspace -> '%s' (type -> '%s') has no node ID (workspaces creation may have failed or name is different from payload). Skipping to next workspace...",
+                            related_workspace_payload["name"],
+                            related_workspace_payload["type_name"],
+                        )
+                        continue
+                    found_by = "logical ID -> '{}' in payload".format(related_workspace)
+                # end if related_workspace_payload:
 
-                related_workspace_node_id = self.determine_workspace_id(
-                    workspace=related_workspace,
-                )
-                if not related_workspace_node_id:
-                    self.logger.warning(
-                        "Related Workspace -> '%s' (type -> '%s') has no node ID (workspaces creation may have failed or name is different from payload). Skipping to next workspace...",
-                        related_workspace["name"],
-                        related_workspace["type_name"],
+                #
+                # 2. Option: Find the related workspace with nickname:
+                #
+                else:
+                    # See if a nickname exists the the provided related_workspace:
+                    response = self._otcs.get_node_from_nickname(nickname=related_workspace)
+                    related_workspace_node_id = self._otcs.get_result_value(
+                        response=response,
+                        key="id",
                     )
-                    continue
-                self.logger.debug(
-                    "Related Workspace with logical ID -> %s has node ID -> %s",
-                    related_workspace_id,
-                    related_workspace_node_id,
-                )
-            # end if related_workspace is not None
+                    if related_workspace_node_id:
+                        found_by = "nickname -> '{}'".format(related_workspace)
+            # end if isinstance(related_workspace_id, (str, int)):
 
             #
-            # 2. Option: Find the related workspace with nickname:
+            # 3. Option: Find the related workspace type and name:
             #
-            else:
-                # See if a nickname exists the the provided related_workspace_id:
-                response = self._otcs.get_node_from_nickname(nickname=related_workspace_id)
+            elif isinstance(related_workspace, dict):
+                related_workspace_type = related_workspace.get("type", None)
+                related_workspace_name = related_workspace.get("name", None)
+                if related_workspace_type and related_workspace_name:
+                    response = self._otcs.get_workspace_by_type_and_name(
+                        type_name=related_workspace_type, name=related_workspace_name
+                    )
+                    related_workspace_node_id = self._otcs.get_result_value(
+                        response=response,
+                        key="id",
+                    )
+                    if related_workspace_node_id:
+                        found_by = "type -> '{}' and name -> '{}'".format(
+                            related_workspace_type, related_workspace_name
+                        )
+            #
+            # 4. Option: Find the related workspace volume and path:
+            #
+            elif isinstance(related_workspace, list):
+                response = self._otcs.get_node_by_volume_and_path(
+                    volume_type=self._otcs.VOLUME_TYPE_ENTERPRISE_WORKSPACE, path=related_workspace
+                )
                 related_workspace_node_id = self._otcs.get_result_value(
                     response=response,
                     key="id",
                 )
+                if related_workspace_node_id:
+                    found_by = "path -> {}".format(related_workspace)
 
             if related_workspace_node_id is None:
                 self.logger.error(
-                    "Related Workspace with logical ID or nickname -> %s not found.",
-                    related_workspace_id,
+                    "Related Workspace -> %s not found.",
+                    related_workspace,
                 )
                 success = False
                 continue
 
             self.logger.debug(
-                "Related Workspace with logical ID or nickname -> %s has node ID -> %s",
-                related_workspace_id,
+                "Related Workspace with %s has node ID -> %s",
+                found_by,
                 related_workspace_node_id,
             )
 
@@ -13345,10 +13441,6 @@ class Payload:
                 continue
 
             workspace_id = workspace["id"]
-            self.logger.info(
-                "Workspace -> '%s' has memberships in payload - establishing...",
-                workspace_name,
-            )
 
             workspace_node_id = int(self.determine_workspace_id(workspace=workspace))
             if not workspace_node_id:
@@ -13357,6 +13449,10 @@ class Payload:
                 )
                 continue
 
+            self.logger.info(
+                "Workspace -> '%s' (%s) has memberships in payload - establishing...", workspace_name, workspace_node_id
+            )
+
             # now determine the actual node IDs of the workspaces (have been created by process_workspaces()):
             workspace_node = self._otcs.get_node(node_id=workspace_node_id)
             workspace_owner_id = self._otcs.get_result_value(
@@ -13373,21 +13469,29 @@ class Payload:
             )
             if workspace_roles is None:
                 self.logger.debug(
-                    "Workspace with ID -> %s and node Id -> %s has no roles. Skipping to next workspace...",
-                    workspace_id,
+                    "Workspace -> '%s' (%s) has no roles. Skipping to next workspace...",
+                    workspace_name,
                     workspace_node_id,
                 )
                 continue
 
             # We don't want the workspace creator to be in the leader role
             # of automatically created workspaces - this can happen because the
-            # creator gets added to the leader role automatically:
-            leader_role_id = self._otcs.lookup_result_value(
-                response=workspace_roles,
-                key="leader",
-                value=True,
-                return_key="id",
-            )
+            # creator gets added to the leader role automatically if
+            # the workspace type advanved configuration setting
+            # "Add the creator of a business workspace to the Lead role" is
+            # enabled:
+            roles_iterator = self._otcs.get_result_values_iterator(response=workspace_roles)
+            for role in roles_iterator:
+                # We can have two leader roles if in a sub-workspaces a leader
+                # roles is inherited from the parent workspace. As we want
+                # don't want to consider leader role of the parent workspace
+                # we check that 'inherited_from_id' is not set:
+                if role["leader"] and role["inherited_from_id"] is None:
+                    leader_role_id = role["id"]
+                    break
+            else:
+                leader_role_id = None
 
             if leader_role_id:
                 leader_role_name = self._otcs.lookup_result_value(
@@ -13412,6 +13516,16 @@ class Payload:
                         workspace_name,
                         workspace_node_id,
                     )
+                else:
+                    self.logger.info(
+                        "Creator user -> '%s' (%s) is not in leader role -> '%s' (%s) of workspace -> '%s' (%s). No need to remove it.",
+                        workspace_owner_name,
+                        workspace_owner_id,
+                        leader_role_name,
+                        leader_role_id,
+                        workspace_name,
+                        workspace_node_id,
+                    )
 
             self.logger.info(
                 "Adding members to workspace -> '%s' (%s) defined in payload...",
@@ -13428,7 +13542,7 @@ class Payload:
 
                 if member_role_name == "":  # role name is required
                     self.logger.error(
-                        "Members of workspace -> '%s' is missing the role name.",
+                        "Members of workspace -> '%s' is missing the role name in the payload.",
                         workspace_name,
                     )
                     success = False
@@ -13443,12 +13557,29 @@ class Payload:
                 if role_id is None:
                     #    if member_role is None:
                     self.logger.error(
-                        "Workspace -> '%s' does not have a role with name -> '%s'",
+                        "Workspace -> '%s' does not have a role -> '%s'",
                         workspace_name,
                         member_role_name,
                     )
                     success = False
                     continue
+                inherited_role_id = self._otcs.lookup_result_value(
+                    response=workspace_roles,
+                    key="name",
+                    value=member_role_name,
+                    return_key="inherited_from_id",
+                )
+                if inherited_role_id is not None:
+                    self.logger.error(
+                        "The role -> '%s' (%s) of workspace -> '%s' (%s) is inherited from role with ID -> %d and members cannot be set in this sub-workspace.",
+                        member_role_name,
+                        role_id,
+                        workspace_name,
+                        workspace_node_id,
+                        inherited_role_id,
+                    )
+                    success = False
+                    continue
                 self.logger.debug(
                     "Role -> '%s' has ID -> %s",
                     member_role_name,
@@ -13502,20 +13633,22 @@ class Payload:
                     )
                     if response is None:
                         self.logger.error(
-                            "Failed to add user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s'",
+                            "Failed to add user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s' (%s)",
                             member_user,
                             user_id,
                             member_role_name,
                             workspace_name,
+                            workspace_node_id,
                         )
                         success = False
                     else:
                         self.logger.info(
-                            "Successfully added user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s'",
+                            "Successfully added user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s' (%s)",
                             member_user,
                             user_id,
                             member_role_name,
                             workspace_name,
+                            workspace_node_id,
                         )
 
                 # Process groups as workspaces members:
@@ -13719,7 +13852,7 @@ class Payload:
                 )
                 if role_id is None:
                     self.logger.error(
-                        "Workspace -> '%s' does not have a role with name -> '%s'",
+                        "Workspace -> '%s' does not have a role -> '%s'",
                         workspace_name,
                         member_role_name,
                     )
@@ -14197,7 +14330,12 @@ class Payload:
                 )
                 continue
 
-            user_partition = self._otcs.config()["partition"]
+            self._log_header_callback(
+                text="Process settings for user -> '{}'".format(user_name),
+                char="-",
+            )
+
+            user_partition = self._otcs.config().get("partition", None)
             if not user_partition:
                 self.logger.error("User partition not found!")
                 success = False
@@ -14312,9 +14450,6 @@ class Payload:
         # The following code (for loop) will change the authenticated user - we need to
         # switch it back to admin user later so we safe the admin credentials for this:
 
-        # save admin credentials for later switch back to admin user:
-        #        admin_credentials = self._otcs.credentials() if self._users else {}
-
         for user in self._users:
             user_name = user.get("name")
             if not user_name:
@@ -14323,6 +14458,11 @@ class Payload:
                 )
                 continue
 
+            self._log_header_callback(
+                text="Process Favorites and Profile for user -> '{}'".format(user_name),
+                char="-",
+            )
+
             # Check if user has been explicitly disabled in payload
             # (enabled = false). In this case we skip the element:
             if not user.get("enabled", True):
@@ -14332,6 +14472,11 @@ class Payload:
                 )
                 continue
 
+            # We skip also user of type "ServiceUser":
+            if user.get("type", "User") == "ServiceUser":
+                self.logger.info("Skipping service user -> '%s'...", user_name)
+                continue
+
             # Impersonate as the user:
             self.logger.info("Impersonate user -> '%s'...", user_name)
             result = self.start_impersonation(username=user_name)
@@ -15499,17 +15644,37 @@ class Payload:
             if "name" not in renaming:
                 self.logger.error("Renamings require the new name!")
                 continue
-            if "nodeid" not in renaming:
-                if "volume" not in renaming:
-                    self.logger.error(
-                        "Renamings require either a node ID or a volume! Skipping to next renaming...",
+            if "nodeid" in renaming:
+                node_id = renaming["nodeid"]
+            elif "volume" in renaming:
+                path = renaming.get("path")
+                volume = renaming.get("volume")
+                if path:
+                    self.logger.info(
+                        "Found path -> '%s' in renaming payload. Determine node ID by volume and path...",
+                        path,
                     )
-                    continue
-                # Determine object ID of volume:
-                volume = self._otcs.get_volume(volume_type=renaming["volume"])
-                node_id = self._otcs.get_result_value(response=volume, key="id")
+                    node = self._otcs.get_node_by_volume_and_path(
+                        volume_type=volume,
+                        path=path,
+                    )
+                else:
+                    # Determine object ID of volume:
+                    node = self._otcs.get_volume(volume_type=volume)
+                node_id = self._otcs.get_result_value(response=node, key="id")
+            elif "nickname" in renaming:
+                nickname = renaming["nickname"]
+                self.logger.info(
+                    "Found nickname -> '%s' in renaming payload. Determine node ID by nickname...",
+                    nickname,
+                )
+                node = self._otcs.get_node_from_nickname(nickname=nickname)
+                node_id = self._otcs.get_result_value(response=node, key="id")
             else:
-                node_id = renaming["nodeid"]
+                self.logger.error(
+                    "Renamings require either a node ID or a volume (with an optional path) or a nickname! Skipping to next renaming...",
+                )
+                continue
 
             # Check if renaming has been explicitly disabled in payload
             # (enabled = false). In this case we skip this payload element:
@@ -15625,7 +15790,7 @@ class Payload:
                     )
                     success = False
                     continue
-            else:
+            elif parent_path is not None:  # parent_path can be [] which is valid for top-level items!
                 parent_volume = item.get("parent_volume", self._otcs.VOLUME_TYPE_ENTERPRISE_WORKSPACE)
                 parent_node = self._otcs.get_node_by_volume_and_path(
                     volume_type=parent_volume,
@@ -15636,11 +15801,17 @@ class Payload:
                 if not parent_id:
                     # if not parent_node:
                     self.logger.error(
-                        "Item -> '%s' has a parent path that does not exist. Skipping...",
+                        "Item -> '%s' has a parent path -> %s that does not exist and couldn't be created in volume -> %d. Skipping...",
                         item_name,
+                        parent_path,
+                        self._otcs.VOLUME_TYPE_ENTERPRISE_WORKSPACE,
                     )
                     success = False
                     continue
+            else:
+                self.logger.error("The parent for the item -> '%s' is not specified by nickname nor path!", item_name)
+                success = False
+                continue
 
             # Handling for shortcut items that have an orginal node:
             original_nickname = item.get("original_nickname")
@@ -15663,9 +15834,10 @@ class Payload:
                     )
                     success = False
                     continue
-            elif original_path:
+            elif original_path is not None:  # original_path can be [] which is valid for top-level items!
+                original_volume = item.get("original_volume", self._otcs.VOLUME_TYPE_ENTERPRISE_WORKSPACE)
                 original_node = self._otcs.get_node_by_volume_and_path(
-                    volume_type=self._otcs.VOLUME_TYPE_ENTERPRISE_WORKSPACE,
+                    volume_type=original_volume,
                     path=original_path,
                 )
                 original_id = self._otcs.get_result_value(
@@ -15704,7 +15876,7 @@ class Payload:
                         success = False
                         continue
                 case self._otcs.ITEM_TYPE_SHORTCUT:  # Shortcut
-                    if original_id == 0:
+                    if not original_id:
                         self.logger.error(
                             "Item -> '%s' has type Shortcut but the original item is not in the payload. Skipping...",
                             item_name,
@@ -15759,14 +15931,23 @@ class Payload:
             )
             node_id = self._otcs.get_result_value(response=response, key="id")
             if not node_id:
-                self.logger.error("Failed to create item -> '%s'.", item_name)
+                self.logger.error(
+                    "Failed to create item -> '%s' under parent%s.",
+                    item_name,
+                    " with nickname -> '{}'".format(parent_nickname)
+                    if parent_nickname
+                    else " path -> {} in volume -> {}".format(parent_path, parent_volume),
+                )
                 success = False
                 continue
 
             self.logger.info(
-                "Successfully created item -> '%s' with ID -> %s.",
+                "Successfully created item -> '%s' with ID -> %s under parent%s.",
                 item_name,
                 node_id,
+                " with nickname -> '{}'".format(parent_nickname)
+                if parent_nickname
+                else " path -> {} in volume -> {}".format(parent_path, parent_volume),
             )
 
             # Special handling for scheduled bot items:
@@ -15829,14 +16010,20 @@ class Payload:
                     success = False
                     continue
 
-                # If the Job has start mode manual we start it now:
-                if start_mode == "manual":
-                    self.logger.info("Run scheduled bot -> '%s' now...", item_name)
-                    response = self._otcs.update_item(node_id=node_id, body=False, actionName="Runnow")
+                # Check if we want to execute an action immediately after creation, like "Runnow":
+                actions = item_details.get("actions", [])
+                for action in actions:
+                    self.logger.info("Execute action -> '%s' for scheduled bot -> '%s'...", action, item_name)
+                    response = self._otcs.update_item(node_id=node_id, body=False, actionName=action)
                     if not response:
-                        self.logger.error("Failed to run scheduled bot item -> '%s'.", item_name)
+                        self.logger.error(
+                            "Failed to execute action -> '%s' for scheduled bot item -> '%s'.", action, item_name
+                        )
                         success = False
                         continue
+                if not actions:
+                    self.logger.info("No immediate actions specified for scheduled bot -> '%s'.", item_name)
+
             # end if item_type == self._otcs.ITEM_TYPE_SCHEDULED_BOT:
 
             # Special handling for collection items:
@@ -16035,7 +16222,7 @@ class Payload:
             user_id = self._otcs.get_result_value(response=response, key="id")
             if not user_id:
                 self.logger.error(
-                    "Cannot find user with name -> '%s'; cannot set user permissions. Skipping user...",
+                    "Cannot find user -> '%s'; cannot set user permissions. Skipping user...",
                     user_name,
                 )
                 return False
@@ -16090,7 +16277,7 @@ class Payload:
             group_id = self._otcs.get_result_value(response=otcs_group, key="id")
             if not group_id:
                 self.logger.error(
-                    "Cannot find group with name -> '%s'; cannot set group permissions. Skipping group...",
+                    "Cannot find group -> '%s'; cannot set group permissions. Skipping group...",
                     group_name,
                 )
                 return False
@@ -16149,7 +16336,7 @@ class Payload:
             )
             if not role_id:
                 self.logger.error(
-                    "Cannot find role with name -> '%s'; cannot set role permissions.",
+                    "Cannot find role -> '%s'; cannot set role permissions.",
                     role_name,
                 )
                 return False
@@ -17473,6 +17660,11 @@ class Payload:
                 continue
             workspace_type = doc_generator["workspace_type"]
 
+            self._log_header_callback(
+                text="Process Document Generator for workspace type -> '{}'".format(workspace_type),
+                char="-",
+            )
+
             # Check if doc generator has been explicitly disabled in payload
             # (enabled = false). In this case we skip the element:
             if not doc_generator.get("enabled", True):
@@ -17715,7 +17907,7 @@ class Payload:
                 )
                 if response["results"]:
                     self.logger.warning(
-                        "Node with name -> '%s' does already exist in workspace folder with ID -> %s",
+                        "Node -> '%s' does already exist in workspace folder with ID -> %s",
                         document_name,
                         workspace_folder_id,
                     )
@@ -17730,7 +17922,7 @@ class Payload:
                 )
                 if not response:
                     self.logger.error(
-                        "Failed to generate document -> '%s' in workspace -> '%s' (%s) as user -> %s",
+                        "Failed to generate document -> '%s' in workspace -> '%s' (%s) as user -> '%s'",
                         document_name,
                         workspace_name,
                         workspace_id,
@@ -18288,10 +18480,9 @@ class Payload:
             # (enabled = false). In this case we skip this payload element:
             if not browser_automation.get("enabled", True):
                 self.logger.info(
-                    "Payload for %s automation -> '%s'%s is disabled. Skipping...",
+                    "Payload for %s automation -> '%s' is disabled. Skipping...",
                     automation_type.lower(),
                     name,
-                    " ({})".format(description) if description else "",
                 )
                 continue
 
@@ -18300,6 +18491,7 @@ class Payload:
                 self.logger.error(
                     "%s automation -> '%s' is missing 'base_url' parameter. Skipping...", automation_type, name
                 )
+                browser_automation["result"] = "failure"
                 success = False
                 continue
 
@@ -18318,6 +18510,7 @@ class Payload:
                     automation_type,
                     name,
                 )
+                browser_automation["result"] = "failure"
                 success = False
                 continue
 
@@ -18340,21 +18533,22 @@ class Payload:
                 user_password=password,
                 automation_name=name,
                 take_screenshots=debug_automation,
-                headless=self._browser_headless,
+                headless=browser_automation.get("headless", self._browser_headless),
                 logger=self.logger,
                 wait_until=wait_until,
+                browser=browser_automation.get("browser"),  # None is acceptable
             )
-            # Wait time is a global setting (for whole brwoser session)
+            # Wait time is a global setting (for whole browser session)
             # This makes sure a page is fully loaded and elements are present
-            # before accessing them. We set 15.0 seconds as default if not
+            # before accessing them. We set 30.0 seconds as default if not
             # otherwise specified by "wait_time" in the payload.
-            wait_time = browser_automation.get("wait_time", 15.0)
+            wait_time = float(browser_automation.get("wait_time", 30.0))
             browser_automation_object.set_timeout(wait_time=wait_time)
             if "wait_time" in browser_automation:
                 self.logger.info(
                     "%s Automation wait time -> '%s' configured.",
                     automation_type,
-                    wait_time,
+                    str(wait_time),
                 )
 
             # Initialize overall result status:
@@ -18362,11 +18556,17 @@ class Payload:
             first_step = True
 
             for automation_step in automation_steps:
-                if "type" not in automation_step:
-                    self.logger.error("%s automation step is missing type. Skipping...", automation_type)
+                automation_step_type = automation_step.get("type", "")
+                if not automation_step_type:
+                    self.logger.error(
+                        "%s automation step -> %s in browser automation -> '%s' is missing 'type' parameter. Stopping automation -> '%s'.",
+                        automation_type,
+                        str(automation_step),
+                        name,
+                        name,
+                    )
                     success = False
                     break
-                automation_step_type = automation_step.get("type", "")
                 dependent = automation_step.get("dependent", True)
                 if not dependent and not result:
                     self.logger.warning(
@@ -18384,7 +18584,7 @@ class Payload:
                     )
                     continue
                 elif not first_step:
-                    self.logger.info(
+                    self.logger.debug(
                         "Current step -> '%s' is %s on proceeding step.",
                         automation_step_type,
                         "dependent" if dependent else "not dependent",
@@ -18422,6 +18622,7 @@ class Payload:
                                 "Cannot log into -> %s. Skipping to next automation step...",
                                 base_url + page,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             continue
                         self.logger.info(
@@ -18436,6 +18637,7 @@ class Payload:
                                 "Automation step type -> '%s' requires 'page' parameter. Stopping automation.",
                                 automation_step_type,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             break
                         volume = automation_step.get("volume", OTCS.VOLUME_TYPE_ENTERPRISE_WORKSPACE)
@@ -18454,6 +18656,7 @@ class Payload:
                                     automation_type,
                                     name,
                                 )
+                                automation_step["result"] = "failure"
                                 success = False
                                 continue
                             self.logger.info(
@@ -18479,6 +18682,7 @@ class Payload:
                                 "Cannot load page -> %s. Skipping this step...",
                                 page,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             continue
                         self.logger.info(
@@ -18494,17 +18698,22 @@ class Payload:
                                 "Automation step type -> '%s' requires 'selector' parameter. Stopping automation.",
                                 automation_step_type,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             break
                         # We keep the deprecated "find" syntax supported (for now)
                         selector_type = automation_step.get("selector_type", automation_step.get("find", "id"))
                         show_error = automation_step.get("show_error", True)
+                        # Do we navigate away from the current page with the click?
                         navigation = automation_step.get("navigation", False)
+                        # Do we open a new browser (popup) window with the click?
+                        popup_window = automation_step.get("popup_window", False)
+                        # De we close the current (popup) window with the click?
+                        close_window = automation_step.get("close_window", False)
+                        # Do we have a 'desired' state for clicking a checkbox?
                         checkbox_state = automation_step.get("checkbox_state", None)
-                        # Do we have a step-specific wait mechanism? If not, we pass None
-                        # then the browser automation will take the default configured for
-                        # the whole browser automation (see BrowserAutomation() constructor called above):
                         wait_until = automation_step.get("wait_until", None)
+                        wait_time = automation_step.get("wait_time", 0.0)
                         role_type = automation_step.get("role_type", None)
                         result = browser_automation_object.find_elem_and_click(
                             selector=selector,
@@ -18512,7 +18721,10 @@ class Payload:
                             role_type=role_type,
                             desired_checkbox_state=checkbox_state,
                             is_navigation_trigger=navigation,
+                            is_popup_trigger=popup_window,
+                            is_page_close_trigger=close_window,
                             wait_until=wait_until,
+                            wait_time=wait_time,
                             show_error=show_error,
                         )
                         if not result:
@@ -18521,15 +18733,17 @@ class Payload:
                             )
                             if show_error:
                                 self.logger.error(message)
+                                automation_step["result"] = "failure"
                                 success = False
                             else:
                                 self.logger.warning(message)
                             continue
                         self.logger.info(
-                            "Successfully clicked %s element selected by -> '%s' (%s)",
+                            "Successfully clicked %s element selected by -> '%s' (%s%s)",
                             "navigational" if navigation else "non-navigational",
                             selector,
-                            selector_type,
+                            "selector type -> '{}'".format(selector_type),
+                            ", role type -> '{}'".format(role_type) if role_type else "",
                         )
                     case "set_elem":
                         # We keep the deprecated "elem" syntax supported (for now)
@@ -18539,6 +18753,7 @@ class Payload:
                                 "Automation step type -> '%s' requires 'selector' parameter. Stopping automation.",
                                 automation_step_type,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             break
                         # We keep the deprecated "find" syntax supported (for now)
@@ -18552,11 +18767,13 @@ class Payload:
                                 selector,
                                 selector_type,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             break
                         # we also support replacing placeholders that are
                         # enclosed in double % characters like %%OTCS_RESOURCE_ID%%:
-                        value = self.replace_placeholders(value)
+                        if isinstance(value, str):
+                            value = self.replace_placeholders(value)
                         show_error = automation_step.get("show_error", True)
                         result = browser_automation_object.find_elem_and_set(
                             selector=selector,
@@ -18566,19 +18783,24 @@ class Payload:
                             show_error=show_error,
                         )
                         if not result:
-                            message = "Cannot set element selected by -> '{}' ({}) to value -> '{}'. Skipping this step...".format(
-                                selector, selector_type, value
+                            message = "Cannot set element selected by -> '{}' ({}{}) to value -> '{}'. Skipping this step...".format(
+                                selector,
+                                "selector type -> '{}'".format(selector_type),
+                                ", role type -> '{}'".format(role_type) if role_type else "",
+                                value,
                             )
                             if show_error:
                                 self.logger.error(message)
+                                automation_step["result"] = "failure"
                                 success = False
                             else:
                                 self.logger.warning(message)
                             continue
                         self.logger.info(
-                            "Successfully set element selected by -> '%s' (%s) to value -> '%s'.",
+                            "Successfully set element selected by -> '%s' (%s%s) to value -> '%s'.",
                             selector,
-                            selector_type,
+                            "selector type -> '{}'".format(selector_type),
+                            ", role type -> '{}'".format(role_type) if role_type else "",
                             value,
                         )
                     case "check_elem":
@@ -18589,6 +18811,7 @@ class Payload:
                                 "Automation step type -> '%s' requires 'selector' parameter. Stopping automation.",
                                 automation_step_type,
                             )
+                            automation_step["result"] = "failure"
                             success = False
                             break
                         # We keep the deprecated "find" syntax supported (for now)
@@ -18613,20 +18836,33 @@ class Payload:
                             substring=substring,
                             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
                         )
                         # Check if we didn't get what we want:
                         if (not result and want_exist) or (result and not want_exist):
                             self.logger.error(
                                 "%s %s%s%s on current page. Test failed.%s",
-                                "Cannot find" if not result else "Found",
-                                "{} elements with selector -> '{}' ({})".format(min_count, selector, selector_type)
-                                if min_count > 1
-                                else "an element with selector -> '{}' ({})".format(selector, selector_type),
+                                "Cannot find" if not result and want_exist else "Found",
+                                "{} elements with selector -> '{}' ({}{})".format(
+                                    min_count if want_exist else count,
+                                    selector,
+                                    "selector type -> '{}'".format(selector_type),
+                                    ", role type -> '{}'".format(role_type) if role_type else "",
+                                )
+                                if (min_count > 1 and want_exist) or (count > 1 and not want_exist)
+                                else "an element with selector -> '{}' ({}{})".format(
+                                    selector,
+                                    "selector type -> '{}'".format(selector_type),
+                                    ", role type -> '{}'".format(role_type) if role_type else "",
+                                ),
                                 " with {}value -> '{}'".format("substring-" if substring else "", value)
                                 if value
                                 else "",
                                 " in attribute -> '{}'".format(attribute) if attribute else "",
-                                " Found {}{} occurences.".format(count, " undesirable" if not want_exist else ""),
+                                " Found {}{} occurences.".format(
+                                    count,
+                                    " undesirable" if not want_exist else " from a minimum of {}".format(min_count),
+                                ),
                             )
                             success = False
                             continue
@@ -18646,12 +18882,20 @@ class Payload:
                             automation_step_type,
                             automation_type.lower(),
                         )
+                        automation_step["result"] = "failure"
                         success = False
                         break
                 # end match automation_step_type:
                 first_step = False
             # end for automation_step in automation_steps:
+
+            # Cleanup session and and remove reference to the object:
             browser_automation_object.end_session()
+            browser_automation_object = None
+
+            browser_automation["result"] = (
+                "failure" if any(step.get("result", "success") == "failure" for step in automation_steps) else "success"
+            )
         # end for browser_automation in browser_automations:
 
         if check_status:
@@ -21630,14 +21874,9 @@ class Payload:
                 )
                 result["skipped_counter"] += 1
                 continue
-            # Workspace names for sure are not allowed to have ":":
-            workspace_name = workspace_name.replace(":", "")
-            # Workspace names for sure should not have leading or trailing spaces:
-            workspace_name = workspace_name.strip()
-            # Truncate the workspace name to 254 characters which is the maximum
-            # allowed length in Content Server
-            if len(workspace_name) > 254:
-                workspace_name = workspace_name[:254]
+
+            # Cleanse the workspace name (allowed characters, maximum length):
+            workspace_name = OTCS.cleanse_item_name(workspace_name)
 
             # Check if workspace has been created before (either in this run
             # or in a former run of the customizer):
@@ -22053,7 +22292,7 @@ class Payload:
                     if response["results"]:
                         # We add the suffix with the key which should be unique:
                         self.logger.warning(
-                            "Workspace with name -> '%s' does already exist in folder with ID -> %s and we need to handle the name clash by using name -> '%s'",
+                            "Workspace -> '%s' does already exist in folder with ID -> %s and we need to handle the name clash by using name -> '%s'",
                             workspace_name,
                             parent_id,
                             workspace_name + " (" + key + ")",
@@ -22534,8 +22773,8 @@ class Payload:
             # If not, we load the data source on the fly:
             data_source_data: Data = data_source.get("data")
             if not data_source_data:
-                self.logger.warning(
-                    "Lookup data source -> '%s' has no data yet. Trying to reload...",
+                self.logger.info(
+                    "Lookup data source -> '%s' has no data yet. Reloading...",
                     data_source_name,
                 )
                 data_source_data = self.process_bulk_datasource(
@@ -24814,14 +25053,8 @@ class Payload:
             # We keep success = True as this is a data problem and not a config problem!
             return None, success
 
-        # Workspace names for sure are not allowed to have ":":
-        workspace_name = workspace_name.replace(":", "")
-        # Workspace names for sure should not have leading or trailing spaces:
-        workspace_name = workspace_name.strip()
-        # Truncate the workspace name to 254 characters which is
-        # the maximum allowed length in Content Server
-        if len(workspace_name) > 254:
-            workspace_name = workspace_name[:254]
+        # Cleanse the workspace name (allowed characters, maximum length):
+        workspace_name = OTCS.cleanse_item_name(workspace_name)
 
         # Check if all data conditions to create the workspace are met
         conditions = workspace.get("conditions")
@@ -25151,7 +25384,7 @@ class Payload:
 
             # Create Business Relationship between workspace and sub-workspace:
             if workspace_id and sub_workspace_id:
-                # Check if workspace relationship does already exist in Extended ECM
+                # Check if workspace relationship does already exist in OTCS
                 # (this is an additional safety measure to avoid errors):
                 response = self._otcs_frontend.get_workspace_relationships(
                     workspace_id=workspace_id,
@@ -25590,14 +25823,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Document names for sure are not allowed to have ":":
-            document_name = document_name.replace(":", "")
-            # Document names for sure should not have leading or trailing spaces:
-            document_name = document_name.strip()
-            # Truncate the document name to 254 characters which is
-            # the maximum allowed length in Content Server
-            if len(document_name) > 254:
-                document_name = document_name[:254]
+            # Cleanse the document name (allowed characters, maximum length):
+            document_name = OTCS.cleanse_item_name(document_name)
 
             download_name = ""
             if download_name_field:
@@ -25835,6 +26062,8 @@ class Payload:
                                 att_name,
                                 parent_id,
                             )
+                            # Keep track that we need to handle a name clash as based on the key
+                            # the document should not exist.
                             handle_name_clash = True
                     else:
                         self.logger.error(
@@ -25870,7 +26099,7 @@ class Payload:
                     else:
                         # Case 4: no key given + name not found = item does not exist
                         self.logger.info(
-                            "No existing document with name -> '%s' in parent with ID -> %s",
+                            "Cannot find document -> '%s' in parent with ID -> %s",
                             document_name,
                             parent_id,
                         )
@@ -25937,7 +26166,7 @@ class Payload:
 
                             # We add the suffix with the key which should be unique:
                             self.logger.warning(
-                                "Document with name -> '%s' does already exist in workspace folder with ID -> %s and we need to handle the name clash and use name -> '%s'",
+                                "Document -> '%s' does already exist in workspace folder with ID -> %s and we need to handle the name clash and use name -> '%s'",
                                 document_name,
                                 parent_id,
                                 document_name + " (" + key + ")",
@@ -25956,11 +26185,6 @@ class Payload:
                             categories=categories,
                             replacements=replacements,
                         )
-                        # document_category_data = self.prepare_item_create_form(
-                        #     parent_id=parent_id,
-                        #     categories=worker_categories,
-                        #     subtype=self._otcs_frontend.ITEM_TYPE_DOCUMENT,
-                        # )
                         document_category_data = self.prepare_category_data(
                             categories_payload=worker_categories,
                             source_node_id=parent_id,
@@ -26062,7 +26286,8 @@ class Payload:
                     )
                 ):
                     # get the specific update operations given in the payload
-                    # if not specified we do all 4 update operations (name, description, categories and version)
+                    # if not specified we do the following update operations.
+                    # The 'purge' operation needs to be specified explicitly.
                     update_operations = bulk_document.get(
                         "update_operations",
                         ["name", "description", "categories", "nickname", "version"],
@@ -26129,6 +26354,21 @@ class Payload:
                             )
                             success = False
                             continue
+                    if "purge" in update_operations:
+                        max_versions = bulk_document.get("max_versions", 1)
+                        response = self._otcs_frontend.purge_document_versions(
+                            node_id=document_id, versions_to_keep=max_versions
+                        )
+                        if not response:
+                            self.logger.error(
+                                "Failed to purge versions of document -> '%s' (%s) to %d version%s!",
+                                (document_old_name if document_old_name else document_name),
+                                document_id,
+                                max_versions,
+                                "s" if max_versions > 1 else "",
+                            )
+                            success = False
+                            continue
                     response = self._otcs_frontend.update_item(
                         node_id=document_id,
                         parent_id=None,  # None = do not move item
@@ -26874,14 +27114,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Document names for sure are not allowed to have ":":
-            item_name = item_name.replace(":", "")
-            # Document names for sure should not have leading or trailing spaces:
-            item_name = item_name.strip()
-            # Truncate the item name to 254 characters which is
-            # the maximum allowed length in Content Server
-            if len(item_name) > 254:
-                item_name = item_name[:254]
+            # Cleanse the item name (allowed characters, maximum length):
+            item_name = OTCS.cleanse_item_name(item_name)
 
             # This is an optimization. We check if the item was created
             # in a former run. This helps if the customizer is re-run:
@@ -27113,7 +27347,8 @@ class Payload:
                         )
                         success = False
                         continue
-                # end if key
+                    # end if key_attribute:
+                # end if key:
                 else:
                     # If we haven't a key we try by parent + name
                     response = self._otcs_frontend.get_node_by_parent_and_name(
@@ -27140,7 +27375,7 @@ class Payload:
                     else:
                         # Case 4: no key given + name not found = item does not exist
                         self.logger.info(
-                            "No existing item with name -> '%s' in parent with ID -> %s",
+                            "No existing item -> '%s' in parent with ID -> %s",
                             item_name,
                             parent_id,
                         )
@@ -27207,7 +27442,7 @@ class Payload:
 
                             # We add the suffix with the key which should be unique:
                             self.logger.warning(
-                                "Item with name -> '%s' does already exist in workspace folder with ID -> %s and we need to handle the name clash and use name -> '%s'",
+                                "Item -> '%s' does already exist in workspace folder with ID -> %s and we need to handle the name clash and use name -> '%s'",
                                 item_name,
                                 parent_id,
                                 item_name + " (" + key + ")",
@@ -27499,111 +27734,116 @@ class Payload:
 
         success: bool = True
 
-        self._avts.authenticate()
-
-        for payload_repo in self._avts_repositories:
-            if not payload_repo.get("enabled", True):
-                continue
-
-            repository = self._avts.get_repo_by_name(name=payload_repo["name"])
-
-            if repository is None:
-                self.logger.info(
-                    "Repository -> '%s' does not exist, creating it...",
-                    payload_repo["name"],
-                )
+        token = self._avts.authenticate()
+        if not token:
+            self.logger.error("Cannot authenticate at Aviator Search!")
+            success = False
+        else:
+            for payload_repo in self._avts_repositories:
+                if not payload_repo.get("enabled", True):
+                    continue
 
-                if payload_repo.get("type", "Extended ECM") == "Extended ECM":
-                    repository = self._avts.create_extended_ecm_repo(
-                        name=payload_repo["name"],
-                        username=payload_repo["username"],
-                        password=payload_repo["password"],
-                        otcs_url=payload_repo["otcs_url"],
-                        otcs_api_url=payload_repo["otcs_api_url"],
-                        node_id=int(payload_repo["node_id"]),
-                    )
-
-                elif payload_repo["type"] == "Documentum":
-                    self.logger.warning("Not yet implemented")
-                elif payload_repo["type"] == "MSTeams":
-                    repository = self._avts.create_msteams_repo(
-                        name=payload_repo["name"],
-                        client_id=payload_repo["client_id"],
-                        tenant_id=payload_repo["tenant_id"],
-                        certificate_file=payload_repo["certificate_file"],
-                        certificate_password=payload_repo["certificate_password"],
-                        index_attachments=payload_repo.get("index_attachments", True),
-                        index_call_recordings=payload_repo.get(
-                            "index_call_recordings",
-                            True,
-                        ),
-                        index_message_replies=payload_repo.get(
-                            "index_message_replies",
-                            True,
-                        ),
-                        index_user_chats=payload_repo.get("index_user_chats", True),
-                    )
-                elif payload_repo["type"] == "SharePoint":
-                    repository = self._avts.create_sharepoint_repo(
-                        name=payload_repo["name"],
-                        client_id=payload_repo["client_id"],
-                        tenant_id=payload_repo["tenant_id"],
-                        certificate_file=payload_repo["certificate_file"],
-                        certificate_password=payload_repo["certificate_password"],
-                        sharepoint_url=payload_repo["sharepoint_url"],
-                        sharepoint_url_type=payload_repo["sharepoint_url_type"],
-                        sharepoint_mysite_url=payload_repo["sharepoint_mysite_url"],
-                        sharepoint_admin_url=payload_repo["sharepoint_admin_url"],
-                        index_user_profiles=payload_repo.get(
-                            "index_message_replies",
-                            False,
-                        ),
-                    )
-                else:
-                    self.logger.error(
-                        "Invalid repository type -> '%s' specified. Valid values are: Extended ECM, Documentum, MSTeams, SharePoint",
-                        payload_repo["type"],
-                    )
-                    success = False
-                    break
+                repository = self._avts.get_repo_by_name(name=payload_repo["name"])
 
                 if repository is None:
-                    self.logger.error(
-                        "Creation of Aviator Search repository -> '%s' failed!",
-                        payload_repo["name"],
-                    )
-                    success = False
-                else:
                     self.logger.info(
-                        "Successfully created Aviator Search repository -> '%s'",
+                        "Repository -> '%s' does not exist, creating it...",
                         payload_repo["name"],
                     )
-                    self.logger.debug("%s", repository)
 
-            else:
-                self.logger.info(
-                    "Aviator Search repository -> '%s' already exists.",
-                    payload_repo["name"],
-                )
+                    if payload_repo.get("type", "Extended ECM") == "Extended ECM":
+                        repository = self._avts.create_extended_ecm_repo(
+                            name=payload_repo["name"],
+                            username=payload_repo["username"],
+                            password=payload_repo["password"],
+                            otcs_url=payload_repo["otcs_url"],
+                            otcs_api_url=payload_repo["otcs_api_url"],
+                            node_id=int(payload_repo["node_id"]),
+                        )
 
-            # Start Crawling
-            start_crawling = payload_repo.get("start", False)
+                    elif payload_repo["type"] == "Documentum":
+                        self.logger.warning("Not yet implemented")
+                    elif payload_repo["type"] == "MSTeams":
+                        repository = self._avts.create_msteams_repo(
+                            name=payload_repo["name"],
+                            client_id=payload_repo["client_id"],
+                            tenant_id=payload_repo["tenant_id"],
+                            certificate_file=payload_repo["certificate_file"],
+                            certificate_password=payload_repo["certificate_password"],
+                            index_attachments=payload_repo.get("index_attachments", True),
+                            index_call_recordings=payload_repo.get(
+                                "index_call_recordings",
+                                True,
+                            ),
+                            index_message_replies=payload_repo.get(
+                                "index_message_replies",
+                                True,
+                            ),
+                            index_user_chats=payload_repo.get("index_user_chats", True),
+                        )
+                    elif payload_repo["type"] == "SharePoint":
+                        repository = self._avts.create_sharepoint_repo(
+                            name=payload_repo["name"],
+                            client_id=payload_repo["client_id"],
+                            tenant_id=payload_repo["tenant_id"],
+                            certificate_file=payload_repo["certificate_file"],
+                            certificate_password=payload_repo["certificate_password"],
+                            sharepoint_url=payload_repo["sharepoint_url"],
+                            sharepoint_url_type=payload_repo["sharepoint_url_type"],
+                            sharepoint_mysite_url=payload_repo["sharepoint_mysite_url"],
+                            sharepoint_admin_url=payload_repo["sharepoint_admin_url"],
+                            index_user_profiles=payload_repo.get(
+                                "index_message_replies",
+                                False,
+                            ),
+                        )
+                    else:
+                        self.logger.error(
+                            "Invalid repository type -> '%s' specified. Valid values are: Extended ECM, Documentum, MSTeams, SharePoint",
+                            payload_repo["type"],
+                        )
+                        success = False
+                        break
 
-            if repository is not None and start_crawling:
-                response = self._avts.start_crawling(repo_name=payload_repo["name"])
+                    if repository is None:
+                        self.logger.error(
+                            "Creation of Aviator Search repository -> '%s' failed!",
+                            payload_repo["name"],
+                        )
+                        success = False
+                    else:
+                        self.logger.info(
+                            "Successfully created Aviator Search repository -> '%s'",
+                            payload_repo["name"],
+                        )
+                        self.logger.debug("%s", repository)
 
-                if response is None:
-                    self.logger.error(
-                        "Aviator Search start crawling on repository failed -> '%s'",
-                        payload_repo["name"],
-                    )
-                    success = False
                 else:
                     self.logger.info(
-                        "Aviator Search crawling started on repository -> '%s'",
+                        "Aviator Search repository -> '%s' already exists.",
                         payload_repo["name"],
                     )
-                    self.logger.debug("%s", response)
+
+                # Start Crawling
+                start_crawling = payload_repo.get("start", False)
+
+                if repository is not None and start_crawling:
+                    response = self._avts.start_crawling(repo_name=payload_repo["name"])
+
+                    if response is None:
+                        self.logger.error(
+                            "Aviator Search start crawling on repository failed -> '%s'",
+                            payload_repo["name"],
+                        )
+                        success = False
+                    else:
+                        self.logger.info(
+                            "Aviator Search crawling started on repository -> '%s'",
+                            payload_repo["name"],
+                        )
+                        self.logger.debug("%s", response)
+            # end for payload_repo in self._avts_repositories:
+        # end else:
 
         self.write_status_file(
             success=success,
@@ -27646,26 +27886,28 @@ class Payload:
 
         success: bool = True
 
-        self._avts.authenticate()
-
         if not self._avts_questions.get("enabled", True):
             self.logger.info(
                 "Payload section -> '%s' is not enabled. Skipping...",
                 section_name,
             )
             return True
-
         questions = self._avts_questions.get("questions", [])
         self.logger.info("Sample questions -> %s", questions)
 
-        response = self._avts.set_questions(questions=questions)
-
-        if response is None:
-            self.logger.error("Aviator Search setting questions failed")
+        token = self._avts.authenticate()
+        if not token:
+            self.logger.error("Cannot authenticate at Aviator Search!")
             success = False
         else:
-            self.logger.info("Aviator Search questions set succesfully")
-            self.logger.debug("%s", response)
+            response = self._avts.set_questions(questions=questions)
+
+            if response is None:
+                self.logger.error("Aviator Search setting questions failed")
+                success = False
+            else:
+                self.logger.info("Aviator Search questions set succesfully")
+                self.logger.debug("%s", response)
 
         self.write_status_file(
             success=success,
@@ -28701,14 +28943,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Classification names for sure are not allowed to have ":":
-            classification_name = classification_name.replace(":", "")
-            # Classification names for sure should not have leading or trailing spaces:
-            classification_name = classification_name.strip()
-            # Truncate the classification name to 254 characters which is the maximum
-            # allowed length in Content Server
-            if len(classification_name) > 254:
-                classification_name = classification_name[:254]
+            # Cleanse the classification name (allowed characters, maximum length):
+            classification_name = OTCS.cleanse_item_name(classification_name)
 
             # Check if classification has been created before (either in this run
             # or in a former run of the customizer):
@@ -29126,7 +29362,7 @@ class Payload:
                     if response and response["results"]:
                         # We add the suffix with the key which should be unique:
                         self.logger.warning(
-                            "Classification with name -> '%s' does already exist in folder with ID -> %s and we need to handle the name clash by using name -> '%s'",
+                            "Classification -> '%s' does already exist in folder with ID -> %s and we need to handle the name clash by using name -> '%s'",
                             classification_name,
                             parent_id,
                             classification_name + " (" + key + ")",
@@ -29457,3 +29693,160 @@ class Payload:
         return bool(response)
 
     # end method definition
+
+    def process_nifi_flows(self, section_name: str = "nifi") -> bool:
+        """Process Knowledge Discovery Nifi flows in payload and create them in Nifi.
+
+        Args:
+            section_name (str, optional):
+                The name of the payload section. It can be overridden
+                for cases where multiple sections of same type
+                are used (e.g. the "Post" sections).
+                This name is also used for the "success" status
+                files written to the Admin Personal Workspace.
+
+        Returns:
+            bool:
+                True, if payload has been processed without errors, False otherwise
+
+        """
+
+        if not self._nifi_flows:
+            self.logger.info(
+                "Payload section -> '%s' is empty. Skipping...",
+                section_name,
+            )
+            return True
+
+        # If this payload section has been processed successfully before we
+        # can return True and skip processing it once more:
+        if self.check_status_file(payload_section_name=section_name):
+            return True
+
+        success: bool = True
+
+        for nifi_flow in self._nifi_flows:
+            if "name" not in nifi_flow:
+                self.logger.error(
+                    "Knowledge Discovery Nifi flow needs a name! Skipping to next Nifi flow...",
+                )
+                success = False
+                continue
+            name = nifi_flow["name"]
+
+            # Check if element has been disabled in payload (enabled = false).
+            # In this case we skip the element:
+            if not nifi_flow.get("enabled", True):
+                self.logger.info(
+                    "Payload for Knowledge Discovery Nifi flow -> '%s' is disabled. Skipping...",
+                    name,
+                )
+                continue
+
+            if "file" not in nifi_flow:
+                self.logger.error(
+                    "Knowledge Discovery Nifi flow -> '%s' needs a file! Skipping to next Nifi flow...", name
+                )
+                success = False
+                continue
+            filename = nifi_flow["file"]
+
+            parameters = nifi_flow.get("parameters", [])
+
+            if not self._otkd:
+                self.logger.error("Knowledge Discovery is not initialized. Stop processing Nifi flows.")
+                success = False
+                break
+
+            # Optional layout positions of the flow:
+            position_x = nifi_flow.get("position_x", 0.0)
+            position_y = nifi_flow.get("position_y", 0.0)
+            start = nifi_flow.get("start", False)
+
+            self.logger.info("Processing Knowledge Discovery Nifi flow -> '%s'...", name)
+
+            existing = self._otkd.get_process_group_by_name(name=name)
+            if existing:
+                self.logger.warning("Nifi flow -> '%s' does already exist. Updating parameters only...", name)
+                # We better don't start existing flows!? Otherwise this may produce errors.
+                start = False
+            else:
+                response = self._otkd.upload_process_group(
+                    file_path=filename, name=name, position_x=position_x, position_y=position_y
+                )
+                if not response:
+                    self.logger.error("Failed to upload new Nifi flow -> '%s' for Knowledge Discovery!", name)
+                    success = False
+                    continue
+                self.logger.info("Sucessfully uploaded new Nifi flow -> '%s' for Knowledge Discovery!", name)
+
+            for parameter in parameters:
+                component = parameter.get("component", None)
+                if not component:
+                    self.logger.error("Missing component in parameter of Nifi flow -> '%s'!", name)
+                    success = False
+                    continue
+                parameter_name = parameter.get("name", None)
+                if not parameter_name:
+                    self.logger.error(
+                        "Missing name in parameter of Nifi flow -> '%s', component -> '%s'!", name, component
+                    )
+                    success = False
+                    continue
+                parameter_description = parameter.get("description", "")
+                parameter_value = parameter.get("value", None)
+                if not parameter_value:
+                    self.logger.error(
+                        "Missing value in parameter of Nifi flow -> '%s', component -> '%s'", name, component
+                    )
+                    success = False
+                    continue
+                parameter_sensitive = parameter.get("sensitive", False)
+
+                response = self._otkd.update_parameter(
+                    component=component,
+                    parameter=parameter_name,
+                    value=parameter_value,
+                    sensitive=parameter_sensitive,
+                    description=parameter_description,
+                )
+                if not response:
+                    self.logger.error("Failed to update parameter -> '%s' of Nifi flow -> '%s'!", parameter_name, name)
+                    success = False
+                    continue
+                self.logger.info(
+                    "Successfully updated parameter -> '%s' of component -> '%s' in Nifi flow -> '%s' to value -> '%s'.",
+                    parameter_name,
+                    component,
+                    name,
+                    parameter_value if not parameter_sensitive else "<sensitive>",
+                )
+            # end for parameter in parameters:
+            if start:
+                response = self._otkd.start_all_processors(name=name)
+                if response:
+                    self.logger.info("Successfully started Nifi flow -> '%s'.", name)
+                else:
+                    self.logger.error("Failed to start Nifi flow -> '%s'!", name)
+                    success = False
+
+                response = self._otkd.set_controller_services_state(name=name, state="ENABLED")
+                if response:
+                    self.logger.info("Successfully enabled Nifi Controller Services for Nifi flow -> '%s'.", name)
+                else:
+                    self.logger.error("Failed to enable Nifi Controller Services for Nifi flow -> '%s'!", name)
+                    success = False
+
+            else:
+                self.logger.info("Don't (re)start Nifi flow -> '%s'.", name)
+        # end for nifi_flow in self._nifi_flows:
+
+        self.write_status_file(
+            success=success,
+            payload_section_name=section_name,
+            payload_section=self._nifi_flows,
+        )
+
+        return success
+
+    # end method definition