sapiopycommons 2024.3.18a156__py3-none-any.whl → 2025.1.17a402__py3-none-any.whl

sapiopycommons/general/exceptions.py

@@ -1,26 +1,88 @@
+from enum import Enum
+
+
+class MessageDisplayType(Enum):
+    """
+    An enum representing the different ways in which a message can be displayed to the user.
+    """
+    TOASTER_SUCCESS = 0
+    TOASTER_INFO = 1
+    TOASTER_WARNING = 2
+    TOASTER_ERROR = 3
+    OK_DIALOG = 4
+    DISPLAY_INFO = 5
+    DISPLAY_WARNING = 6
+    DISPLAY_ERROR = 7
+
+
 # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
 class SapioException(Exception):
     """
     A generic exception thrown by sapiopycommons methods. Typically caused by programmer error, but may also be from
     extremely edge case user errors. For expected user errors, use SapioUserErrorException.
+
+    CommonsWebhookHandler's default behavior for this and any other exception that doesn't extend SapioException is
+    to return a generic toaster message saying that an unexpected error has occurred.
+    """
+    pass
+
+
+class SapioUserCancelledException(SapioException):
+    """
+    An exception thrown when the user cancels a client callback.
+
+    CommonsWebhookHandler's default behavior is to simply end the webhook session with a true result without logging
+    the exception.
     """
     pass
 
 
-class SapioUserErrorException(SapioException):
+class SapioDialogTimeoutException(SapioException):
+    """
+    An exception thrown when the user leaves a client callback open for too long.
+
+    CommonsWebhookHandler's default behavior is to display an OK popup notifying the user that the dialog has timed out.
+    """
+    pass
+
+
+class DisplayableException(SapioException):
+    """
+    A generic exception that promises to return a user-friendly message explaining the error that should be displayed to
+    the user. Note that it is up to whichever class that catches this exception to actually display the message.
+    """
+    msg: str
+    display_type: MessageDisplayType | None
+    title: str | None
+
+    def __init__(self, msg: str, display_type: MessageDisplayType | None = None, title: str | None = None):
+        """
+        :param msg: The message that should be displayed to the user.
+        :param display_type: The manner in which the message should be displayed. If None, then the display type should
+            be controlled by the class that catches this exception.
+        :param title: If the display type is able to have a title, this is the title that will be displayed. If None,
+            then the title should be controlled by the class that catches this exception.
+        """
+        self.msg = msg
+        self.display_type = display_type
+        self.title = title
+
+
+class SapioUserErrorException(DisplayableException):
     """
     An exception caused by user error (e.g. user provided a CSV when an XLSX was expected), which promises to return a
-    user-friendly message explaining the error that should be displayed to the user. It is the responsibility of the
-    programmer to catch any such exceptions and return the value in e.args[0] as text for the user to see (such as
-    through the display text of a webhook result).
+    user-friendly message explaining the error that should be displayed to the user.
+
+    CommonsWebhookHandler's default behavior is to return the error message in a toaster popup.
     """
     pass
 
 
-class SapioCriticalErrorException(SapioException):
+class SapioCriticalErrorException(DisplayableException):
     """
     A critical exception caused by user error, which promises to return a user-friendly message explaining the error
-    that should be displayed to the user. It is the responsibility of the programmer to catch any such exceptions and
-    return the value in e.args[0] as text for the user to see (such as through a dialog form client callback request).
+    that should be displayed to the user.
+
+    CommonsWebhookHandler's default behavior is to return the error message in a display_error callback.
     """
     pass

sapiopycommons/general/popup_util.py

@@ -1,4 +1,4 @@
-from typing import Any
+import warnings
 
 from sapiopylib.rest.DataMgmtService import DataMgmtServer
 from sapiopylib.rest.pojo.datatype.DataType import DataTypeDefinition
@@ -10,7 +10,7 @@ from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
 from sapiopylib.rest.pojo.webhook.WebhookResult import SapioWebhookResult
 from sapiopylib.rest.utils.FormBuilder import FormBuilder
 
-from sapiopycommons.general.aliases import SapioRecord, AliasUtil
+from sapiopycommons.general.aliases import SapioRecord, AliasUtil, FieldMap
 from sapiopycommons.general.exceptions import SapioException
 
 
@@ -19,19 +19,25 @@ from sapiopycommons.general.exceptions import SapioException
 # and one FormEntryDialogRequest methods.)
 # CR-46332 - For any functions that use temporary data types, set the data type name, display name, and plural display
 # name in the form builder.
+# FR-46716 - Add comments noting that this class is deprecated in favor of CallbackUtil.
 class PopupUtil:
     """
+    DEPRECATED: Make use of CallbackUtil as of 24.5.
+
     Methods for creating boilerplate SapioWebhookResults with client callback requests to create popup dialogs.
     """
     @staticmethod
-    def form_popup(title: str, msg: str, fields: list[AbstractVeloxFieldDefinition], values: dict[str, Any] = None,
+    def form_popup(title: str, msg: str, fields: list[AbstractVeloxFieldDefinition], values: FieldMap = None,
                    column_positions: dict[str, tuple[int, int]] = None, data_type: str = "Default",
                    *, display_name: str | None = None, plural_display_name: str | None = None,
                    request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a basic form entry dialog.
 
         The calling webhook must catch the FormEntryDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display at the top of the form.
         :param fields: The definitions of the fields to display in the form. Fields will be displayed in the order they
@@ -43,10 +49,11 @@ class PopupUtil:
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
         :param plural_display_name: The plural display name for the temporary data type. If not provided, defaults to
-            the plural display name + "s".
+            the display name + "s".
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if display_name is None:
             display_name = data_type
         if plural_display_name is None:
@@ -73,11 +80,14 @@ class PopupUtil:
                           column_positions: dict[str, tuple[int, int]] = None, editable: bool | None = True,
                           *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a basic form dialog for a record with displayed fields from the record data type.
 
         Makes webservice calls to get the data field and type definitions of the given data type.
         The calling webhook must catch the FormEntryDialogResult that the client will send back.
-        :param context: The current webhook context
+
+        :param context: The current webhook context.
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param fields: The data field names of the fields from the record to display in the form. Fields will be
@@ -90,6 +100,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         # Get the field definitions of the data type.
         data_type: str = record.data_type_name
         type_man = DataMgmtServer.get_data_type_manager(context.user)
@@ -121,15 +132,18 @@ class PopupUtil:
         return SapioWebhookResult(True, client_callback_request=callback)
 
     @staticmethod
-    def string_field_popup(title: str, msg: str, field_name: str, default_value: str | None,
+    def string_field_popup(title: str, msg: str, field_name: str, default_value: str | None = None,
                            max_length: int | None = None, editable: bool = True, data_type: str = "Default",
                            *, display_name: str | None = None, plural_display_name: str | None = None,
                            request_context: str | None = None, **kwargs) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a form dialog with a single string field. May take additional parameters to be passed to the string field
         definition.
 
         The calling webhook must catch the FormEntryDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param field_name: The name and display name of the string field.
@@ -141,10 +155,11 @@ class PopupUtil:
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
         :param plural_display_name: The plural display name for the temporary data type. If not provided, defaults to
-            the plural display name + "s".
+            the display name + "s".
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if max_length is None:
             max_length = len(default_value) if default_value else 100
         string_field = VeloxStringFieldDefinition(data_type, field_name, field_name, default_value=default_value,
@@ -154,14 +169,17 @@ class PopupUtil:
 
     @staticmethod
     def integer_field_popup(title: str, msg: str, field_name: str, default_value: int = None, min_value: int = -10000,
-                            max_value: int = 10000, data_type: str = "Default",
+                            max_value: int = 10000, data_type: str = "Default", editable: bool = True,
                             *, display_name: str | None = None, plural_display_name: str | None = None,
                             request_context: str | None = None, **kwargs) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a form dialog with a single integer field. May take additional parameters to be passed to the integer
         field definition.
 
         The calling webhook must catch the FormEntryDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param field_name: The name and display name of the integer field.
@@ -170,31 +188,37 @@ class PopupUtil:
         :param min_value: The minimum allowed value of the input.
         :param max_value: The maximum allowed value of the input.
         :param data_type: The data type name for the temporary data type that will be created for this form.
+        :param editable: Whether the user may edit the contents of the integer field.
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
         :param plural_display_name: The plural display name for the temporary data type. If not provided, defaults to
-            the plural display name + "s".
+            the display name + "s".
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if default_value is None:
             default_value = max(0, min_value)
         integer_field = VeloxIntegerFieldDefinition(data_type, field_name, field_name, default_value=default_value,
-                                                    min_value=min_value, max_value=max_value, **kwargs)
+                                                    min_value=min_value, max_value=max_value, editable=editable,
+                                                    **kwargs)
         return PopupUtil.form_popup(title, msg, [integer_field], data_type=data_type, display_name=display_name,
                                     plural_display_name=plural_display_name, request_context=request_context)
 
     @staticmethod
     def double_field_popup(title: str, msg: str, field_name: str, default_value: float = None,
                            min_value: float = -10000000, max_value: float = 100000000,
-                           data_type: str = "Default", *, display_name: str | None = None,
+                           data_type: str = "Default", editable: bool = True, *, display_name: str | None = None,
                            plural_display_name: str | None = None, request_context: str | None = None, **kwargs) \
             -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a form dialog with a single double field. May take additional parameters to be passed to the double
         field definition.
 
         The calling webhook must catch the FormEntryDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param field_name: The name and display name of the double field.
@@ -203,28 +227,33 @@ class PopupUtil:
         :param min_value: The minimum allowed value of the input.
         :param max_value: The maximum allowed value of the input.
         :param data_type: The data type name for the temporary data type that will be created for this form.
+        :param editable: Whether the user may edit the contents of the double field.
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
         :param plural_display_name: The plural display name for the temporary data type. If not provided, defaults to
-            the plural display name + "s".
+            the display name + "s".
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if default_value is None:
             default_value = min_value
         double_field = VeloxDoubleFieldDefinition(data_type, field_name, field_name, default_value=default_value,
-                                                  min_value=min_value, max_value=max_value, **kwargs)
+                                                  min_value=min_value, max_value=max_value, editable=editable, **kwargs)
         return PopupUtil.form_popup(title, msg, [double_field], data_type=data_type, display_name=display_name,
                                     plural_display_name=plural_display_name, request_context=request_context)
 
     @staticmethod
-    def table_popup(title: str, msg: str, fields: list[AbstractVeloxFieldDefinition], values: list[dict[str, Any]],
+    def table_popup(title: str, msg: str, fields: list[AbstractVeloxFieldDefinition], values: list[FieldMap],
                     *, data_type: str = "Default", display_name: str | None = None,
                     plural_display_name: str | None = None, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a basic table entry dialog.
 
-        The calling webhook must catch the FormEntryDialogResult that the client will send back.
+        The calling webhook must catch the TableEntryDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display at the top of the form.
         :param fields: The definitions of the fields to display as table columns. Fields will be displayed in the order
@@ -234,10 +263,11 @@ class PopupUtil:
         :param display_name: The display name for the temporary data type. If not provided, defaults to the data type
             name.
         :param plural_display_name: The plural display name for the temporary data type. If not provided, defaults to
-            the plural display name + "s".
+            the display name + "s".
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         if display_name is None:
             display_name = data_type
         if plural_display_name is None:
@@ -255,10 +285,13 @@ class PopupUtil:
                            title: str, msg: str, fields: list[str], records: list[SapioRecord],
                            editable: bool | None = True, *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a table dialog for a list of record where the columns are specific fields from the record data type.
 
         Makes webservice calls to get the data field and type definitions of the given data type.
         The calling webhook must catch the TableEntryDialogResult that the client will send back.
+
         :param context: The current webhook context
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
@@ -270,12 +303,15 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
+        if not records:
+            raise SapioException("No records provided.")
         data_types: set[str] = {x.data_type_name for x in records}
         if len(data_types) > 1:
             raise SapioException("Multiple data type names encountered in records list for record table popup.")
         data_type: str = data_types.pop()
         # Get the field maps from the records.
-        field_map_list: list[dict[str, Any]] = AliasUtil.to_field_map_lists(records)
+        field_map_list: list[FieldMap] = AliasUtil.to_field_map_lists(records)
         # Get the field definitions of the data type.
         type_man = DataMgmtServer.get_data_type_manager(context.user)
         type_def: DataTypeDefinition = type_man.get_data_type_definition(data_type)
@@ -305,11 +341,14 @@ class PopupUtil:
                                msg: str, fields: list[str], records: list[SapioRecord], multi_select: bool = True,
                                *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a record selection dialog for a list of record where the columns are specific fields from the record data
         type.
 
         Makes webservice calls to get the data field and type definitions of the given data type.
         The calling webhook must catch the DataRecordSelectionResult that the client will send back.
+
         :param context: The current webhook context
         :param msg: The message to display in the dialog.
         :param records: The records to display as rows in the table.
@@ -319,12 +358,15 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
+        if not records:
+            raise SapioException("No records provided.")
         data_types: set[str] = {x.data_type_name for x in records}
         if len(data_types) > 1:
             raise SapioException("Multiple data type names encountered in records list for record table popup.")
         data_type: str = data_types.pop()
         # Get the field maps from the records.
-        field_map_list: list[dict[str, Any]] = AliasUtil.to_field_map_lists(records)
+        field_map_list: list[FieldMap] = AliasUtil.to_field_map_lists(records)
         # Get the field definitions of the data type.
         type_man = DataMgmtServer.get_data_type_manager(context.user)
         type_def: DataTypeDefinition = type_man.get_data_type_definition(data_type)
@@ -351,15 +393,19 @@ class PopupUtil:
     def list_popup(title: str, options: list[str], multi_select: bool = False,
                    *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create a list dialog with the given options for the user to choose from.
 
         The calling webhook must catch the ListDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param options: The list options that the user has to choose from.
         :param multi_select: Whether the user is able to select multiple options from the list.
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         callback = ListDialogRequest(title, multi_select, options,
                                      callback_context_data=request_context)
         return SapioWebhookResult(True, client_callback_request=callback)
@@ -368,9 +414,12 @@ class PopupUtil:
     def option_popup(title: str, msg: str, options: list[str], default_option: int = 0, user_can_cancel: bool = False,
                      *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create an option dialog with the given options for the user to choose from.
 
         The calling webhook must catch the OptionDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param options: The button options that the user has to choose from.
@@ -381,6 +430,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         callback = OptionDialogRequest(title, msg, options, default_option, user_can_cancel,
                                        callback_context_data=request_context)
         return SapioWebhookResult(True, client_callback_request=callback)
@@ -389,9 +439,12 @@ class PopupUtil:
     def ok_popup(title: str, msg: str, user_can_cancel: bool = False, *, request_context: str | None = None) \
             -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create an option dialog where the only option is "OK".
 
         The calling webhook must catch the OptionDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param user_can_cancel: True if the user is able to click the X to close the dialog, returning
@@ -400,15 +453,19 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, ["OK"], 0, user_can_cancel, request_context=request_context)
 
     @staticmethod
     def yes_no_popup(title: str, msg: str, default_yes: bool = True, user_can_cancel: bool = False,
                      *, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Create an option dialog where the only options are "Yes" and "No".
 
         The calling webhook must catch the OptionDialogResult that the client will send back.
+
         :param title: The title of the dialog.
         :param msg: The message to display in the dialog.
         :param default_yes: If true, "Yes" is the default choice. Otherwise, the default choice is "No".
@@ -418,6 +475,7 @@ class PopupUtil:
         :param request_context: Context that will be returned to the webhook server in the client callback result.
         :return: A SapioWebhookResult with the popup as its client callback request.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, ["Yes", "No"], 0 if default_yes else 1, user_can_cancel,
                                       request_context=request_context)
 
@@ -426,8 +484,11 @@ class PopupUtil:
     def display_form_popup(title: str, field_name: str, msg: str, data_type: str = "Popup",
                            request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Deprecated for PopupUtil.text_field_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.string_field_popup(title, "", field_name, msg, len(msg), False, data_type,
                                             request_context=request_context, auto_size=True)
 
@@ -435,13 +496,19 @@ class PopupUtil:
     def display_option_popup(title: str, msg: str, options: list[str], user_can_cancel: bool = False,
                              request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Deprecated for PopupUtil.option_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.option_popup(title, msg, options, 0, user_can_cancel, request_context=request_context)
 
     @staticmethod
     def display_ok_popup(title: str, msg: str, request_context: str | None = None) -> SapioWebhookResult:
         """
+        DEPRECATED: Make use of CallbackUtil as of 24.5.
+
         Deprecated for PopupUtil.ok_popup.
         """
+        warnings.warn("PopupUtil is deprecated as of 24.5+. Use CallbackUtil instead.", DeprecationWarning)
         return PopupUtil.ok_popup(title, msg, False, request_context=request_context)

sapiopycommons/general/sapio_links.py

@@ -0,0 +1,50 @@
+from sapiopylib.rest.User import SapioUser
+from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
+
+from sapiopycommons.general.aliases import RecordIdentifier, ExperimentIdentifier, AliasUtil, DataTypeIdentifier
+from sapiopycommons.general.exceptions import SapioException
+
+
+class SapioNavigationLinker:
+    """
+    Given a URL to a system's webservice API (example: https://company.exemplareln.com/webservice/api), construct
+    URLs for navigation links to various locations in the system.
+    """
+    base_url: str
+
+    def __init__(self, url: str | SapioUser | SapioWebhookContext):
+        """
+        :param url: A user or context object that is being used to send requests to a Sapio system, or a URL to a
+            system's webservice API.
+        """
+        if isinstance(url, SapioWebhookContext):
+            url = url.user.url
+        elif isinstance(url, SapioUser):
+            url = url.url
+        self.base_url = url.rstrip("/").replace('webservice/api', 'veloxClient')
+
+    def data_record(self, record_identifier: RecordIdentifier, data_type_name: DataTypeIdentifier | None = None) -> str:
+        """
+        :param record_identifier: An object that can be used to identify a record in the system, be that a record ID,
+            a data record, or a record model.
+        :param data_type_name: If the provided record identifier is a record ID, then the data type name of the record
+            must be provided in this parameter. Otherwise, this parameter is ignored.
+        :return: A URL for navigating to the input record.
+        """
+        record_id: int = AliasUtil.to_record_id(record_identifier)
+        if data_type_name:
+            data_type_name = AliasUtil.to_data_type_name(data_type_name)
+        if not isinstance(record_identifier, int):
+            data_type_name = AliasUtil.to_data_type_name(record_identifier)
+        if not data_type_name:
+            raise SapioException("Unable to create a data record link without a data type name. "
+                                 "Only a record ID was provided.")
+        return self.base_url + f"/#dataType={data_type_name};recordId={record_id};view=dataRecord"
+
+    def experiment(self, experiment: ExperimentIdentifier) -> str:
+        """
+        :param experiment: An object that can be used to identify an experiment in the system, be that an experiment
+            object, experiment protocol, or a notebook ID.
+        :return: A URL for navigating to the input experiment.
+        """
+        return self.base_url + f"/#notebookExperimentId={AliasUtil.to_notebook_id(experiment)};view=eln"