Raw XML Module Built-In Script

Find information on working around XML limitations here.

All of the built-in scripts produce XML that is similar, but not interchangeable with, XML found in theplugin descriptor. You will notice that, for usability reasons, the forms do not include all the possible configuration elements available in plugins. For example, the web item script does not give you the option to provide a tooltip for the web item link, a velocity context provider, or an icon URL.

You can work around this limitation by using RawXML Module Item by following these steps:

Get the required XML from one of the other fragment scripts by filling out the form, then clicking the Preview button.
Warning: Do not click the Save/Update button.
Copy the XML into the Raw XML Module script.
Make modifications as required.

Example

If you wanted to show a Google button with a tooltip that only shows on personal Confluence spaces, follow these steps:

Fill out the custom web item form.
1. Navigate to General Configurationr → ScriptRunner → UI Fragments → Custom Web Item.
2. Fill out the form with the following content:
  1. Name: custom-web-item
  2. What Section Should This Go In: system.header/left
  3. Key: custom-web-item
  4. Menu Text: Google something
  5. Weight: 70
  6. Condition:
    context.space && context.space.isPersonal()
  7. Do What: Navigate to a link
  8. Link: https://www.google.com
3. Click Preview.
  The following XML is generated:
Copy the XML.
Fill out the raw XML module form:
1. Navigate to General Configuration → ScriptRunner → UI Fragments → Raw XML Module Item.
2. Enter a Name like custom-web-item with added tooltip.
3. Enter the XML you copied for the XML field.
4. Make the following modifications to the XML:
  1. Remove lines 4 and 5:
    <param name='£trackingParameters' value='{"scriptName":"com.onresolve.scriptrunner.canned.confluence.fragments.CustomWebItem"}' /> <param name='£fragmentParameters' value='{"id":"590d3bd9-54b6-4550-aa66-c2279100b6b1"}' />
  2. Remove line 8:
    <styleClass> custom-web-item </styleClass>
  3. Add the following code after </link>:
    <tooltip>Click here to Google something</tooltip>
  The modified XML should look like this:
5. Click Add.

This is how the button and tooltip will appear in your Confluence instance: