Raw XML Module Breaking Change for Bitbucket 9

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. MenuText: 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.
7. Do What: Leave this as the default.

   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

If your broken XML used an inline script condition, meaning the script showed as a string that started with script: For example, the old raw XML condition class value for an inline script would have looked similar to this:

<condition class='script:def someVar = "foo"#10;true'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebItem"}' />
    <param name='£fragmentParameters' value='{"id":"004779ea-8037-4d00-9f49-ee8ead340588"}' />
</condition> 

Make sure you have your new XML, and then follow these steps to migrate your condition script:

1. Take the old XML inline script value, for example: 'script:def test = 1
true' and use our converter script to alter it to the new format.

   Converter script:

   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='conditionConfig' element in the new XML.
3. Find the {"parameters":{},"script":"true","scriptPath":null} value within the element from step 2.
4. Go to the "script":"true" part of your newXML and replace th e "true" with the exact value that was output from the converter script in step 1.

The final converted web item fragment's raw XML would look like this:

<web-item key='test-key' name='ScriptRunner generated web item - test-key' section='header.global.primary' weight='1'>
  <label>Test</label>
  <condition class='com.onresolve.scriptrunner.fragments.ScriptRunnerCondition'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebItem"}' />
    <param name='£fragmentParameters' value='{"id":"3494a88d-8b85-4276-84f2-b1f5e0361ce7"}' />
    <param name='conditionConfig'><![CDATA[{"parameters":{},"script":"def someVar = \"foo\"\ntrue","scriptPath":null}]]></param>
  </condition>
  <styleClass> test-key </styleClass>
  <link linkId='test-key'>http://www.google.com?_=1</link>
</web-item>

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.

For example, the old raw XML condition class value for a script path would have looked like this:

<condition class='path/to/my/groovy/file.groovy'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebItem"}' />
    <param name='£fragmentParameters' value='{"id":"004779ea-8037-4d00-9f49-ee8ead340588"}' />
</condition>  

The new XML would look like this:

<web-item key='test-key' name='ScriptRunner generated web item - test-key' section='header.global.primary' weight='1'>
  <label>Test</label>
   <condition class='com.onresolve.scriptrunner.fragments.ScriptRunnerCondition'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebItem"}' />
    <param name='£fragmentParameters' value='{"id":"3494a88d-8b85-4276-84f2-b1f5e0361ce7"}' />
    <param name='conditionConfig'><![CDATA[{"parameters":{},"script":null,"scriptPath":"path/to/my/groovy/file.groovy"}]]></param>
  </condition>
  <styleClass> test-key </styleClass>
  <link linkId='test-key'>http://www.google.com?_=1</link>
</web-item>

Remember to use double quotes ( "") around the file path.

• 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.
  Copy script

  1

  writer.write("Hello world!") 

• The web panel provider class script migration is similar to conditions, but your script needs to be placed within the parameters of our new context-provider block.

Inline scripts:

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.

   Converter script:

   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 the "writer.write(\"Hello world!\") " part with the exact value that was output from the converter script in 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='bitbucket.notification.banner.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
  <label>Test Panel</label>
  <condition class='com.onresolve.scriptrunner.fragments.ScriptRunnerCondition'>
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebPanel"}' />
    <param name='£fragmentParameters' value='{"id":"da995de7-ea4e-4d9f-82e6-e217bcf3392e"}' />
    <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(\"This is HTML that my web panel generates!\")","scriptPath":null}]]></param>
  </context-provider>
  <param name='lazy' value='true' />
</web-panel>

Script files:

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='bitbucket.notification.banner.header' weight='1' class='myPanels/myPanelScript.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='bitbucket.notification.banner.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
     <label>Test Panel</label>
     <condition class='com.onresolve.scriptrunner.fragments.ScriptRunnerCondition'>
       <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.bitbucket.fragments.CustomWebPanel"}' />
       <param name='£fragmentParameters' value='{"id":"da995de7-ea4e-4d9f-82e6-e217bcf3392e"}' />
       <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>