Raw XML Module Breaking Change for Confluence 9

Step 1: Fill out a form and get the new XML

1. Navigate to General Configuration > ScriptRunner > UI Fragments > Create UI Fragment > Show a web panel.
2. Fill out the fields that appear, as you did for the web item (Web Panels use location in place of the web items' section).
   Warning: The Provider Class/Script

   Please review the following information closely. It differs from the web item process

   1. 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!") 

   2. 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.
3. Click the Preview button to generate the new XML. It will look similar to 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.confluence.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
     <label>Test Panel</label>
     <condition class='com.onresolve.scriptrunner.fragments.ConfluenceScriptRunnerCondition'>
       <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.confluence.fragments.CustomWebPanel"}' />
       <param name='£fragmentParameters' value='{"id":"4bf6f413-f2d0-449b-b07a-4ebdff15d849"}' />
       <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(\"Hello world!\") ","scriptPath":null}]]></param>
     </context-provider>
     <param name='lazy' value='true' />
   </web-panel>

Step 2: Add the missing elements

Please follow the steps shown in Add the missing extra elements in the web item steps above.

Step 3: Add your condition script back to the XML

Please follow the steps shown in Add your condition script back to the XML in the web item steps above.

Step 4: Fix the provider class script

1. Find the panelClassConfig line in the new XML and look for the parameters section that looks like this:
   Copy script

   1

   {"parameters":{},"script":"writer.write(\"Hello world!\")","scriptPath":null}

2. Determine which kind of script your provider class script is and follow the steps:

   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

         14

         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:

   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.confluence.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
     <label>Test Panel</label>
     <condition class='com.onresolve.scriptrunner.fragments.ConfluenceScriptRunnerCondition'>
       <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.confluence.fragments.CustomWebPanel"}' />
       <param name='£fragmentParameters' value='{"id":"4bf6f413-f2d0-449b-b07a-4ebdff15d849"}' />
       <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='atl.confluence.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.confluence.header' weight='1' class='com.onresolve.scriptrunner.fragments.ScriptWebPanel'>
        <label>Test Panel</label>
        <condition class='com.onresolve.scriptrunner.fragments.ConfluenceScriptRunnerCondition'>
          <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.confluence.fragments.CustomWebPanel"}' />
          <param name='£fragmentParameters' value='{"id":"4bf6f413-f2d0-449b-b07a-4ebdff15d849"}' />
          <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>