cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Add-In Guidelines
Ryan_Gilmore
Community Manager Community Manager

Add-in guidelines are intended to ensure consistency and integrity with the add-ins available in the File Exchange. 

 

  1. Use best practices for scoping and namespaces. Review the “Advanced Scoping and Namespaces” section in JMP help for more information.
  2. Do not use any code that would modify existing symbols, e.g., Clear Symbols, Delete Symbols, Clear Globals.
  3. Do not modify user preferences (unless it is the purpose of the add-in).
  4. Do not use Quit or Exit.
  5. Avoid adding scripts directly to the add-in/toolbar. A better practice is to have all code in .jsl files.
  6. Comment the code.
  7. If the add-in will be included in a menu other than Add-Ins, make it clear the menu item is not part of the standard menu.

 

When posting an article about the add-in,

 

  • Explain the purpose
  • Provide instructions/examples on how to use it
  • Specify the operating system and JMP version used for development/testing
  • Identify any connections to services/databases, file system manipulation, etc.
  • Include acknowledgments if using others' code

 

The author is responsible for the support and maintenance of the add-in. Do not contact JMP Support.

 

Add-ins not updated in five years will be subject to review and possible archival from the exchange.

Comments
jthi

@Ryan_Gilmore 

I would consider adding a new guideline due to the Python Integration for addins which require JMP18+. Some suggestions:

  • It should tell users that the Python Integration is being used
  • Which packages are being utilized (at least the "highest level" ones)
  • If packages are being installed automatically inform user in the documentation (or should this even be allowed?)
  • If packages aren't being installed automatically, there should be some sort of instructions on how to install packages as installation of some of the packages isn't that easy
  • And most likely the packages/versions should be handled with requirements.txt or something similar.

Recommended Articles