Archive Trac license notes

License Notes

Legacy Trac archive page imported from license_notes. Source: https://genapp.rocks/wiki/wiki/license_notes. Review age, links, and examples before treating as current.

charmm license notes

• in menu.json, there is a section with "id":"license" with the module CHARMM.json

  • this section has no "label" defined, so it will not appear on the screen menu but the module code will still be generated
  • you can change modules/CHARMM.json to modify appearance functionality
    • in CHARMM.json (or any license file) required is an "approvalemail" : ","
  • currently in sassie2test under Build->testarea
  • this module requires the "CHARMM" license
    • e.g. in modules/testarea.json you will see a line "license" : "CHARMM"
    • note, if you have multiple licenses they should be comma separated
      • e.g. "license" : "CHARMM,SOMEOTHER" etc.
  • to register a license, you submit on the module, e.g. testarea
  • a window will pop up with license requirements if not approved
  • press "CHARMM Management" to start the process
  • when you submit the info, an email will be sent to the license "approvalemail"'s
    • when they press the Approve or Deny links, the status will be updated
    • these links stay active, so the approvalemail users can later approve or deny again
  • to reload the user license info, the user must reload the webpage
    • we only currently read the license status on reload

• a lot of this can be modified or expanded upon, but I think this is a basically workable system

  • e.g. an additional license management link (perhaps in user config) etc.

charmm example

• i have the prototype for the charmm license screen at sassie2-test -> build -> charmm license proto
  • the point is to give you early access to adjust the content/layout
  • it will later be in a "messagebox", but we can test here for now
  • this is a regular module => modules/charmm.json which you can edit & % genapptest to update the code
  • builds and send the email
  • links are active and working
  • you can adjust until it gives you the info as you like or let me know if we need to adjust the body of the email
  • right now, the email will contain aligned "label" : value pairs as per the module json.
    • we can add email specific labels or whatever, but it will all be defined within the module json
    • i was thinking we may want to add more data (optional?) in the user file to enable auto population for fields such as
    • real name
    • institution
    • etc.

general licensing scheme

• use standard module json to define the modules
• special top-level module tags

   ,"prefix"        : "license"
   ,"approvalemail" : "<redacted-email>"

• special field "info"

  • this field only shows up on the emails

• the labels will appear in the email as generated for the user interface

• special executable created (prefix-)

  • logs request and status in mongo, sends email (reminder: if already sent?)
  • job uuid as request id ?
  • email
    • embedded links
    • choices
      • approve url
      • deny url
      • ? provide comment space g
      • ? request more details
    • destination
      • lightweight interface
      • don't want to require advanced browser capabilities
        • i.e. no javascript etc.

• also need to build admin page (php?) for summary

• "modal" ized and connected to license.js for approval