Description values not showing

I have been adding new scripts that we use internally to the tool, and I have noticed that when I add description text to a script, it does not display in the UI.

Here is the contents of an example file:
```
<?xml version="1.0" encoding="utf-8"?>
<tool version="1">
  <description name="something" icon="" version="1"><![CDATA[<p>Some Description would go here with some really long descriptions that take up even more characters just to see how much text can go here.</p><br/><p>Here's more descriptions on another line</p><br/><p>Another line</p>]]></description>
  <author name="Bob" />
  <tags>
    <tag>SQLConcepts</tag>
  </tags>
  <ui>
    <output displaytype="Grid | OutputLog" width="500" height="400" />
    <block>
      <control type="header" label="Select server and database" />
      <control type="database" id="connection" />
    </block>
  </ui>
  <script type="Sql"><![CDATA[SELECT 'THIS IS WHERE SQL WOULD GO';]]></script>
  <signature />
</tool>
```

Based on the contents of this `rgtool` file I would expect that when I go to Script Manager, click on the `Script Details` link in the bottom of the script, the box would load and the `Description` tab would load with the full contents of the description that I entered.  However, nothing displays.  I thought this was just something wrong I was doing, but I looked at the exising `rgtool` scripts that were provided from the install and they don't show the full descriptions in the `Description` tab either.  Can this be fixed so that the Descriptions are visible in the UI?

Below is a screenshot from Script Manager showing how the example file displays in the UI.
Tagged:

Answers

  • Hi @adam_hafner

     

    Thank you for reaching out on the Redgate forum regarding your SQL Scripts Manager display concern.

     

    I've replicated this on my test system, the long form of the description field does not appear when you select the script details.

    Documentation does seem to indicate that it is expected to appear here: 

    • The full description is shown on the Description tab of the script details window.

    https://documentation.red-gate.com/ssm/xml-schema-reference-for-script-files/the-sql-scripts-manager-xml-schem

    Along with your other feature requests, I'll escalate this to our development team to see if this is determined to be a bug.

    Jon Kirkwood | Technical Support Engineer | Redgate Software
  • Hi Adam,

    Confirming that this is in our developer's backlog for implementation. There is not yet a confirmed release timeframe for the feature but is being investigated along with other features for their implementation. 

    Will update this forum post should the situation change and/or a release is available that includes this feature request.
    Jon Kirkwood | Technical Support Engineer | Redgate Software
Sign In or Register to comment.