diff --git a/source/customizations.rst b/source/customizations.rst index a9949b6c1..5bf5b7b6d 100644 --- a/source/customizations.rst +++ b/source/customizations.rst @@ -415,6 +415,23 @@ If you access the Dashboard, and it crashes, then you may have made a mistake in ``ood.rb`` file, whose code is run during the initialization of the Rails app. +.. _files_select_target_extended: + +Send File Data to Another Application +------------------------------------- + +The file browser application in Open OnDemand may be configured to allow users +to send file data to other applications. This may be convenient for application +developers that don't want to write or maintain their own file browsing implementation +and instead rely on the built in capabilities of Open OnDemand. + +The payload sent to other applications is file metadata like the owner, size, path +and so on, not the file contents. + +Centers may enable this through the :ref:`files_select_target configuration `. +When enabled, the file browser will show a new button for users to press and send data +to the desired URL. + .. include:: customizations/profiles.inc .. include:: customizations/main-navigation.inc diff --git a/source/reference/files/ondemand-d-ymls.rst b/source/reference/files/ondemand-d-ymls.rst index 274040653..f073080ce 100644 --- a/source/reference/files/ondemand-d-ymls.rst +++ b/source/reference/files/ondemand-d-ymls.rst @@ -466,6 +466,31 @@ Configuration Properties with profile support nav_categories: ['Apps', 'Files', 'Jobs'] +.. _files_select_target: +.. describe:: files_select_target (Object, null) + + Default + + This feature is disabled by default. + + .. code-block:: yaml + + files_select_target: null + + Example + + Enable this feature to allow users to send file data payloads to ``/pun/sys/passenger_app`` + with the title, label, icon and expiration (in seconds). + + .. code-block:: yaml + + files_select_target: + endpoint: '/pun/sys/passenger_app' + label: 'Send to App' + icon: 'fas://paper-plane' + title: 'Send selected files to the external application' + expiration: 10 + .. _configuration_properties: Configuration Properties diff --git a/source/release-notes/v4.1-release-notes.rst b/source/release-notes/v4.1-release-notes.rst index 9e2527138..3a0ac4434 100644 --- a/source/release-notes/v4.1-release-notes.rst +++ b/source/release-notes/v4.1-release-notes.rst @@ -501,6 +501,13 @@ This is most relevant to languages that rely on consistent indentation, most not and YAML. For YAML files, only soft tabs are syntactically supported. Python recommends soft tabs for new projects, but will not allow mixing of hard and soft tabs within a project. +File Integration with Other Applications +........................................ + +In version 4.1 we've added the ability to :ref:`files_select_target_extended`. This is enabled +through the :ref:`files_select_target configuration `. More information +is provided in the links above. + .. _project-manager-note: The Project Manager