diff --git a/source/how-tos/app-development/interactive.rst b/source/how-tos/app-development/interactive.rst index 10f09e0e..c1133e19 100644 --- a/source/how-tos/app-development/interactive.rst +++ b/source/how-tos/app-development/interactive.rst @@ -46,3 +46,4 @@ Each of these files/directories are described below in their respective stage. interactive/sub-apps interactive/conn-params interactive/additional-info + interactive/saved-settings diff --git a/source/how-tos/app-development/interactive/saved-settings.rst b/source/how-tos/app-development/interactive/saved-settings.rst new file mode 100644 index 00000000..81a7b3ed --- /dev/null +++ b/source/how-tos/app-development/interactive/saved-settings.rst @@ -0,0 +1,63 @@ +.. _interactive-app-saved-settings: + +Saving interactive application settings +======================================= + +If enabled, users can save and manage saved settings for their +interactive applications. + +Enabling +-------- + +This feature is controlled by the :ref:`ondemand.d configuration bc_saved_settings `. +Set it to ``true`` to enable this feature. + +It is disabled by default. + +Demonstration +------------- + +Here's a demonstration of how this feature works and what it will do. + +Saving Settings +............... + +When this feature is enabled, users will begin to see this checkbox above +the ``Launch`` button to save these choices currently in the form. + +.. figure:: /images/bc_saved_settings_select.png + +Checking this checkbox will open a modal where the user can give these +settings a name. + +Once the name is specified users can ``Launch`` and that will +save the settings along with launching the job. They can also choose +to simply save the settings and close. + +Using Settings +.............. + +When a user has saved settings for a given interactive application, +they'll now see a dropdown menu to choose those settings. Note that +when a given saved setting is chosen, the form updates the values +automatically. + +.. figure:: /images/bc_saved_settings_form.png + +.. _edit-save-interactive-app-saved-settings: + +Editing and deleting settings +............................. + +You may have seen in the image above that there's a new section +on the left panel entitled ``Saved Settings``. + +Clicking on the icons in this panel will open a page much like the +image below. + +Here you can delete the saved setting by pressing the Delete button. +You can also edit the settings by pressing the pencil icon at the top +right of the card. You can also submit a job using these settings +with the play icon. + +.. figure:: /images/bc_saved_settings_edit.png \ No newline at end of file diff --git a/source/images/bc_saved_settings_edit.png b/source/images/bc_saved_settings_edit.png new file mode 100644 index 00000000..fc2524f8 Binary files /dev/null and b/source/images/bc_saved_settings_edit.png differ diff --git a/source/images/bc_saved_settings_form.png b/source/images/bc_saved_settings_form.png new file mode 100644 index 00000000..5001f6da Binary files /dev/null and b/source/images/bc_saved_settings_form.png differ diff --git a/source/images/bc_saved_settings_select.png b/source/images/bc_saved_settings_select.png new file mode 100644 index 00000000..dbdedd94 Binary files /dev/null and b/source/images/bc_saved_settings_select.png differ diff --git a/source/reference/files/ondemand-d-ymls.rst b/source/reference/files/ondemand-d-ymls.rst index 9071a4c8..8408a84e 100644 --- a/source/reference/files/ondemand-d-ymls.rst +++ b/source/reference/files/ondemand-d-ymls.rst @@ -1010,3 +1010,25 @@ Configuration Properties .. code-block:: yaml status_poll_delay: 30000 + +.. _bc_saved_settings: + +.. describe:: bc_saved_settings (Boolean, false) + + Enabled or disable saving batch connect settings. + When users fill out a form for an interactive application, + they can choose to save those settings to easily reuse later. + + Default + Disabled by default. + + .. code-block:: yaml + + bc_saved_settings: false + + Example + Enable saving batch connect settings. + + .. code-block:: yaml + + bc_saved_settings: true diff --git a/source/release-notes/v4.0-release-notes.rst b/source/release-notes/v4.0-release-notes.rst index 4f1e564a..43d50c92 100644 --- a/source/release-notes/v4.0-release-notes.rst +++ b/source/release-notes/v4.0-release-notes.rst @@ -22,6 +22,7 @@ New Features - `Interactive apps can have a text header`_ - `Remove runtime dependency on SCL`_ - `XDMoD efficiency widget update`_ +- `Edit and delete interactive application saved settings`_ Thanks! ------- @@ -383,3 +384,13 @@ XDMoD efficiency widget update XDMoD job efficiency panels now show efficiency calculations for CPU usage, memory and time. + +Edit and delete interactive application saved settings +...................................................... + +Since launching saved settings for interactive applications +in version 3.1, 4.0 now offers the ability to edit and delete +these saved settings. + +See :ref:`edit-save-interactive-app-saved-settings` for more +details.