Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Button handy
blanktrue
color#0052CC
nameSend Feedback
linkhttps://docs.google.com/forms/d/e/1FAIpQLScmToBe3vynAlb5fdKwCGxYqnTbDc66sIBgeecG2BuFDuHc7g/viewform?entry.2002826954=General+Best+Practices+-+491001485
widthauto

The purpose of this document is to describe general best practices to follow while scripting.

...

  • Develop as much as possible from the SIL Manager. Developing from the SIL Manger tends to give the user a better sense of what the code does and is much faster.

  • Start with one routine function as a proof of concept.

  • Add loops and if statements after.

  • Hardcode at first to get a result.

  • Refactor hardcoded values with with variables.

  • If possible, test Live Fields in the edit screen before trying in Jira Service Desk portal or create screen. The JSD portal tends to be more complicated and more can go wrong.

...

  • Often other users have already done something similar to what you would like to do. Find an example on the Atlassian Community?

  • Look for routinesfunctions.

  • If the routine function you are looking for does not exist, consider implementing a script which consumes an Atlassian REST API (Jira Server/DC), (Cloud).

    • When developing SIL scripts which consume REST API, try using getting results with httpGet().

Info

You are highly encouraged to use a SIL routine function if at all possible. Atlassian Java methods (and to a lesser extent, REST API) change all the time and can break your code. When using SIL, we take care of deprecated Java methods for you, so if you use SIL routinesfunctions, you will not need to update your code.

...

Page Properties
hiddentrue


Related issues




We've encountered an issue exporting this macro. Please try exporting this page again later.