Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-1868

Investigate BioViz Connect Plugin

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      2
    • Sprint:
      Summer 3: 6 Jul - 17 Jul, Summer 4: 14 Jul - 28 Jul, Summer 5: 3 Aug - 14 Aug

      Description

      Task: Investigate what changes would need to be made to the IGB code base in order to create a CyVerse plugin that would have feature parity with the BioViz-CyVerse web app currently in development.

        Attachments

          Activity

          nfreese Nowlan Freese created issue -
          nfreese Nowlan Freese made changes -
          Field Original Value New Value
          Epic Link IGBF-1482 [ 17568 ]
          nfreese Nowlan Freese made changes -
          Rank Ranked higher
          stiwari8 Srishti Tiwari (Inactive) made changes -
          Assignee Srishti Tiwari [ stiwari8 ]
          stiwari8 Srishti Tiwari (Inactive) made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Hide
          stiwari8 Srishti Tiwari (Inactive) added a comment -

          Please have a look at this link from Oracle which talks about how we can add HTML Content to JavaFX Applications. As we are already using JavaFX in our IGB code, we can build a plugin which will only wrap the BioViz-CyVerse web app inside IGB.

          https://docs.oracle.com/javafx/2/webview/jfxpub-webview.htm

          https://dzone.com/articles/htmlcssjavascript-gui-java-0

          Show
          stiwari8 Srishti Tiwari (Inactive) added a comment - Please have a look at this link from Oracle which talks about how we can add HTML Content to JavaFX Applications. As we are already using JavaFX in our IGB code, we can build a plugin which will only wrap the BioViz-CyVerse web app inside IGB. https://docs.oracle.com/javafx/2/webview/jfxpub-webview.htm https://dzone.com/articles/htmlcssjavascript-gui-java-0
          stiwari8 Srishti Tiwari (Inactive) made changes -
          Status In Progress [ 3 ] Open [ 1 ]
          Hide
          nfreese Nowlan Freese added a comment -

          This sounds like a great idea, as it would allow users to access their CyVerse data from a browser or from within IGB, and we would only have to maintain a single site. Once the cyverse.bioviz.org site is near enough to completion, we should examine this idea further and attempt to implement it.

          Show
          nfreese Nowlan Freese added a comment - This sounds like a great idea, as it would allow users to access their CyVerse data from a browser or from within IGB, and we would only have to maintain a single site. Once the cyverse.bioviz.org site is near enough to completion, we should examine this idea further and attempt to implement it.
          ann.loraine Ann Loraine made changes -
          Workflow Loraine Lab Workflow [ 18591 ] Fall 2019 Workflow Update [ 18993 ]
          nfreese Nowlan Freese made changes -
          Assignee Srishti Tiwari [ stiwari8 ]
          ann.loraine Ann Loraine made changes -
          Workflow Fall 2019 Workflow Update [ 18993 ] Revised Fall 2019 Workflow Update [ 21109 ]
          Status Open [ 1 ] In Progress [ 3 ]
          nfreese Nowlan Freese made changes -
          Status In Progress [ 3 ] To-Do [ 10305 ]
          ann.loraine Ann Loraine made changes -
          Epic Link IGBF-1482 [ 17568 ] IGBF-2376 [ 18533 ]
          karthik Karthik Raveendran made changes -
          Epic Link IGBF-2376 [ 18533 ] IGBF-1665 [ 17755 ]
          karthik Karthik Raveendran made changes -
          Sprint Summer 3: 6 Jul - 17 Jul [ 98 ]
          Assignee Karthik Raveendran [ karthik ]
          karthik Karthik Raveendran made changes -
          Epic Link IGBF-1665 [ 17755 ] IGBF-2376 [ 18533 ]
          karthik Karthik Raveendran made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          karthik Karthik Raveendran made changes -
          Epic Link IGBF-2376 [ 18533 ]
          karthik Karthik Raveendran made changes -
          Epic Link IGBF-2376 [ 18533 ]
          ann.loraine Ann Loraine made changes -
          Sprint Summer 3: 6 Jul - 17 Jul [ 98 ] Summer 3: 6 Jul - 17 Jul, Summer 4: 14 Jul - 28 Jul [ 98, 99 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          karthik Karthik Raveendran made changes -
          Summary Investigate CyVerse Plugin Investigate BioViz Connect Plugin
          Hide
          karthik Karthik Raveendran added a comment - - edited

          This module can possibly be implemented in JavaFX WebView and WebEngine. However, in the preliminary testing with WebView, BootStrap 4 (embedded to the website) is not being rendered. May need to investigate the possibilities to implement that. One of the possibilities may include downloading the bootstrap 4 library to the Bioviz Connect project. The image shows basic WebView connecting to connect.bioviz.org

          Show
          karthik Karthik Raveendran added a comment - - edited This module can possibly be implemented in JavaFX WebView and WebEngine. However, in the preliminary testing with WebView, BootStrap 4 (embedded to the website) is not being rendered. May need to investigate the possibilities to implement that. One of the possibilities may include downloading the bootstrap 4 library to the Bioviz Connect project. The image shows basic WebView connecting to connect.bioviz.org
          karthik Karthik Raveendran made changes -
          Attachment WebView.png [ 14783 ]
          karthik Karthik Raveendran made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          Hide
          ann.loraine Ann Loraine added a comment -

          Regarding bootstrap 4 rendering:

          • I think it would be worthwhile looking into that a bit more. Could you investigate a bit further on that?
          Show
          ann.loraine Ann Loraine added a comment - Regarding bootstrap 4 rendering: I think it would be worthwhile looking into that a bit more. Could you investigate a bit further on that?
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          ann.loraine Ann Loraine made changes -
          Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
          ann.loraine Ann Loraine made changes -
          Sprint Summer 3: 6 Jul - 17 Jul, Summer 4: 14 Jul - 28 Jul [ 98, 99 ] Summer 3: 6 Jul - 17 Jul, Summer 4: 14 Jul - 28 Jul, Summer 5: 29 Jul - 12 Aug [ 98, 99, 100 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          karthik Karthik Raveendran made changes -
          Rank Ranked lower
          karthik Karthik Raveendran made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          karthik Karthik Raveendran made changes -
          Comment [ Upon further investigation, in JavaFX WebView application, I was not able to render Bootstrap 4 from a CDN into the application but upon downloading the bootstrap to the BioViz Connect project the css is rendered correctly. However, we also rely on FontAwesome library for our icon needs which is accessed from a CDN as well. Downloading FontAwesome libraries entirely will not be necessary for our purposes. In IGB, App Manager GUI is rendered by injecting css from a downloaded bootstrap library as well in the App Manager plugin.
          The best possible option is JxBrowser library for IGB as mentioned in Shristi Tiwari's comment above. It renders CDN served libraries. The JxBrowser library is however licensed and only has a 30-day trail period before payment starts.

          Please refer to Images above.

          https://www.teamdev.com/jxbrowser
            ]
          Hide
          karthik Karthik Raveendran added a comment -

          Upon further investigation, in JavaFX WebView application, I was not able to render Bootstrap 4 from a CDN into the application but upon downloading the bootstrap to the BioViz Connect project the css is rendered correctly. However, we also rely on FontAwesome library for our icon needs which is accessed from a CDN as well. Downloading FontAwesome libraries entirely will not be necessary for our purposes. In IGB, App Manager GUI is rendered by injecting css from a downloaded bootstrap library as well in the App Manager plugin.
          The best possible option is JxBrowser library for IGB as mentioned in Shristi Tiwari's comment above. It renders CDN served libraries. The JxBrowser library is however licensed and only has a 30-day trail period before payment starts.

          Please refer to Images above.

          https://www.teamdev.com/jxbrowser

          Show
          karthik Karthik Raveendran added a comment - Upon further investigation, in JavaFX WebView application, I was not able to render Bootstrap 4 from a CDN into the application but upon downloading the bootstrap to the BioViz Connect project the css is rendered correctly. However, we also rely on FontAwesome library for our icon needs which is accessed from a CDN as well. Downloading FontAwesome libraries entirely will not be necessary for our purposes. In IGB, App Manager GUI is rendered by injecting css from a downloaded bootstrap library as well in the App Manager plugin. The best possible option is JxBrowser library for IGB as mentioned in Shristi Tiwari's comment above. It renders CDN served libraries. The JxBrowser library is however licensed and only has a 30-day trail period before payment starts. Please refer to Images above. https://www.teamdev.com/jxbrowser
          karthik Karthik Raveendran made changes -
          Attachment JxBrowser-.png [ 14827 ]
          Attachment JavaFX Webview (Bootstrap from CDN).png [ 14828 ]
          Attachment JavaFX Webview (Bootstrap within Project).png [ 14829 ]
          Attachment JxBrowser Pricing.png [ 14830 ]
          karthik Karthik Raveendran made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          karthik Karthik Raveendran made changes -
          Assignee Karthik Raveendran [ karthik ]
          nfreese Nowlan Freese made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          nfreese Nowlan Freese made changes -
          Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
          nfreese Nowlan Freese made changes -
          Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
          nfreese Nowlan Freese made changes -
          Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
          nfreese Nowlan Freese made changes -
          Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
          nfreese Nowlan Freese made changes -
          Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
          nfreese Nowlan Freese made changes -
          Resolution Done [ 10000 ]
          Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
          nfreese Nowlan Freese made changes -
          Assignee Karthik Raveendran [ karthik ]
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          I checked the licenses. If we purchase a license, it is a "perpetual license" which means we get to use the code forever. If we want updates, we pay again, I guess. If we do this, probably the "project" license is the right option for us, since it is meant for a team working on a single product - IGB, in this case.

          However, I think we are going to need more than 30 days to evaluate whether this is right for our use cases.

          I have a couple questions:

          • Is there API documentation we can look at?
          • How would the "view in IGB" aspect work?

          cc: Nowlan Freese and Karthik Raveendran

          Show
          ann.loraine Ann Loraine added a comment - - edited I checked the licenses. If we purchase a license, it is a "perpetual license" which means we get to use the code forever. If we want updates, we pay again, I guess. If we do this, probably the "project" license is the right option for us, since it is meant for a team working on a single product - IGB, in this case. However, I think we are going to need more than 30 days to evaluate whether this is right for our use cases. I have a couple questions: Is there API documentation we can look at? How would the "view in IGB" aspect work? cc: Nowlan Freese and Karthik Raveendran

            People

            • Assignee:
              karthik Karthik Raveendran
              Reporter:
              nfreese Nowlan Freese
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: