Raw XML Module Breaking Change for Jira 10

1. Name: Take the name value text from the XML minus the " ScriptRunner generated web item - " text (line 1 in the above XML). e.g: test-key
2. What section should this go in: Take the section value from the XML (line 1 in the above XML)
3. Key: Take the key value from the XML (line 1 from the above XML). e.g: test-key
4. Menu Text: Take the label value from the XML (line 2 from the above XML). e.g: Test
5. Weight: Take the weight value from the XML (line 1 from the above XML). e.g: 1
6. Condition: See the Step 3: Add your condition script back to the XML section below. We will do this after the rest of this task, so leave it blank for now.
   Tip: If you had a file path like path/to/my/groovy/file.groovy for your old XML condition instead of an inline script, you can simply add the file path as the condition form fields value from the file tab now and skip step 3.
7. Do What: Leave this as the default.
   Tip: If you know that your current raw XML was used to create a button that shows a dialog or a flag, choose the related option from the drop-down. All this field does is modify the styleclass output which you can add later as well.
8. Link: Take the link value from the XML (line 8 from the above XML). https://www.google.com

For example, if you added a tooltip like <tooltip>My tool tip</tooltip>, you can add that back.

When filling out the "Show a web panel" form for the Provider Class/Script field, use the following template script to get the new XML. We will replace this later.

writer.write("Hello world!")

1. Take the old XML inline script value for the web-panel class attribute, for example: 'script:writer.write("This is HTML that my web panel generates!")' and use this converter script to alter it to the new format:
   1. Open the ScriptRunner Console.
   2. Paste the following script into the console script area.
      Copy script

      1

      2

      3

      4

      5

      6

      7

      8

      9

      10

      11

      12

      13

      import groovy.json.JsonOutput
      import org.apache.commons.lang.StringEscapeUtils
      
      def scriptStringToConvert = 'script:def test = "hello"

context.space != null && context.user.name == 'admin''
      
      def xmlToJsonEscapedString(String xmlString) {
       if(xmlString.startsWith('script:')) {
              xmlString = xmlString.replaceFirst('script:', '')
          }
       def unescapedXmlString = StringEscapeUtils.unescapeXml(xmlString)
          JsonOutput.toJson(unescapedXmlString)
      }
      "<pre>" + xmlToJsonEscapedString(scriptStringToConvert) + "</pre>"

   3. Set the value of the scriptStringToConvert variable to the exact value from your XML.
   4. Click Run.
   5. Copy the output from the Result tab exactly, including the outer double quotes.
   6. Use that as the value for the " script": property within the conditionConfig or the panelClassConfig XML parameter element.
2. Find the <param name='panelClassConfig' element in the new XML.
3. Find the {"parameters":{},"script":"writer.write(\"Hello world!\") ","scriptPath":null} value in the new XML.
4. Find the "script":"writer.write(\"Hello world!\") " part of your new XML and replace th e "writer.write(\"Hello world!\") " part with the exact value that was output from the converter script it step 1.

The new converted XML moves the script to a new context-provider section. The final converted XML would look like this:

<web-panel key='test-one' name='ScriptRunner generated web panel - test-one' location='atl.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
  <label>Test Panel</label>
  <condition class='com.onresolve.scriptrunner.fragments.JiraScriptRunnerCondition'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.jira.fragments.CustomWebPanel"}' />
    <param name='£fragmentParameters' value='{"id":"60b8111b-a3b5-424f-aec2-de6e481a2b73"}' />
    <param name='conditionConfig'><![CDATA[{"parameters":{},"script":"true","scriptPath":null}]]></param>
  </condition>
  <context-provider class='com.onresolve.scriptrunner.fragments.ScriptRunnerContextProvider'>
    <param name='panelClassConfig'><![CDATA[{"parameters":{},"script":"writer.write(\"My web panel HTML content\")","scriptPath":null}]]></param>
  </context-provider>
  <param name='lazy' value='true' />
</web-panel>

1. If your broken XML used a file path to a script instead of an inline script, you will add your script path as the value for the "scriptPath" section. The old XML web panel class attribute would have looked similar to this:
   Copy script

   1

   <web-panel key='test-one' name='ScriptRunner generated web panel - test-one' location='atl.header' weight='1' class='path/to/my/groovy/file.groovy'>

   The new converted XML moves the scriptPath to a new context-provider section, and therefore, the converted XML would look like this:

   Copy script

   1

   2

   3

   4

   5

   6

   7

   8

   9

   10

   11

   12

   <web-panel key='test-one' name='ScriptRunner generated web panel - test-one' location='atl.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
     <label>Test Panel</label>
     <condition class='com.onresolve.scriptrunner.fragments.JiraScriptRunnerCondition'>
       <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.jira.fragments.CustomWebPanel"}' />
       <param name='£fragmentParameters' value='{"id":"a5791370-0152-46a0-8536-51dd62c9281a"}' />
       <param name='conditionConfig'><![CDATA[{"parameters":{},"script":"true","scriptPath":null}]]></param>
     </condition>
     <context-provider class='com.onresolve.scriptrunner.fragments.ScriptRunnerContextProvider'>
       <param name='panelClassConfig'><![CDATA[{"parameters":{},"script":null,"scriptPath":"path/to/my/groovy/file.groovy"}]]></param>
     </context-provider>
     <param name='lazy' value='true' />
   </web-panel>