Interactive Apps

Interactive apps can be developed and deployed using the same tools that are currently provided for all Open OnDemand applications but requires further Setup Interactive Apps.

An Interactive App is a plugin that follows a custom file/directory structure and API that can be described by the five stages: Manifest yml files, User Form (form.yml.erb), Render Template, Job Submission (submit.yml.erb) and Connection View.

Additionally, there is Adding Additional Information to the session cards.

A typical file/directory structure for an Interactive App can look like:

my_app/
├── form.yml
├── manifest.yml
├── submit.yml.erb
├── template
│   ├── before.sh.erb
│   └── script.sh.erb
├── view.html.erb
├── info.{md,html}.erb
└── completed.{md,html}.erb

Each of these files/directories are described below in their respective stage.

Stages of an Interactive App

• Manifest yml files
• User Form (form.yml.erb)
  • Configuration
  • Attributes
    • Predefined Attributes
    • Automatic Predefined Attributes
    • Customizing Attributes
  • Examples
    • User-defined Attributes
    • Hard-coded Attributes
    • Customize User-defined Attributes
    • Caching form items
    • Displaying form items in the session card
  • Configuring which cluster to submit to
  • Global Batch Connect Form Items
• Form Widgets
• Dynamic Form Widgets
  • Your own form.js
  • Hiding select options
  • Hiding entire elements
  • Dynamic Element Labels
  • Dynamic Min and Maxes
  • Setting values based on other elements
• Render Template
  • ERB Objects
    • Session
    • Context
  • Template Files
    • Before Hook
    • Main Script
    • After Hook
    • Cleanup Hook
• Job Submission (submit.yml.erb)
  • Configuration
    • Batch Connect Template types
    • Configure Script
  • Examples
    • VNC Server
    • Change Executable for Main Script
    • Specify Job Submission Parameters
    • Dynamically Set Submission Parameters
  • Setting Batch Connect Options Globally
• Connection View
  • Session Information
  • Reverse Proxy
  • Stylizing
  • Examples
    • POST Password
  • Adding Native VNC instructions to the panel
• Sub-Apps and Reconfiguring existing apps
  • Quick Launch Apps
• Connection Parameters conn_params
  • Jupyter Notebook Example
• Adding Additional Information to the session cards
  • info.{md,html}.erb
  • completed.{md,html}.erb
• Saving interactive application settings
  • Enabling
  • Demonstration
    • Saving Settings
    • Using Settings
    • Editing and deleting settings
• Advanced Interactive Application Configurations
  • Displaying choices made in Session Card