Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeValue (bold = default)Description
id 

Every Action element must have a unique id which is not only unique in the current profile but also with all id's in extended profiles.

Info
The recommended format is profileName-actionGroupType-action.
Ex: oracle-table-drop
icon The name of the icon that should be displayed next to the label in the actions menu
label The label for the action as it should be displayed in the list of actions and in the actions dialog
reloadtrue/falseSpecifies if the parent node (in the objects tree) should be reloaded after successful execution. This is recommended for actions that change the visual appearance of the object, such as remove, add or name change
mode
  • execute
    show the action dialog, process user input and execute the final SQL within the scope of the action window
  • script
    show the action dialog, process user input and send the final SQL to the SQL Commander without executing the command
  • script-immediate
    will not show the action dialog but instead pass the final SQL directly to the SQL Commander without executing the command

Specifies how the action will be prepared and displayed

processmarkers
  • true
    IN parameter markers in the SQL are processed with the JDBC driver. Not all drivers supports this
  • false
    (default) parameter markers are not be processed
 
resulttype
  • resultset
    this is the default and indicates that the result is a standard result set produced by a SQL SELECT statement or stored procedure
  • dbmsoutput
    this is specific for Oracle databases only and specifies that the output is produced by the DBMS_OUTPUT stored procedure

 

resultaction
  • ask
    if the action produced a result according to the setting of resulttype, ask the user whether the result should be displayed in a window or copied as text to the SQL Commander
  • show
    if the action produced a result according to the setting of resulttype, show it in a window. resulttype="resultset" shows the result in a grid while for dbmsoutput the result is displayed in a text viewer
  • showtext if resulttype="resultset" this will show the result set in a text viewer rather than in a grid which is default
  • script
    if the action produced a result according to the resulttype, copy it to the SQL Commander

Is only valid in combination with mode="execute"

hideif There may be situations when an action should be dropped due to a condition. The hideif attribute is used to express a condition which is evaluated when the list of actions is created. Example: hideif="#dataMap.get('actionlevel') neq 'toplevel'"
resetcatalogstrue/falseSetting this attribute to true will reset any cached databases for the actual database connection. Useful when for example the action create, rename or delete a database
resetschemastrue/falseSetting this attribute to true will reset any cached schemas for the actual database connection. Useful when for example the action create, rename or delete a schema
supportsmultipleobjectstrue/false

An action support processing multiple objects if the style attribute for all input elements is one of:

  • check
  • list
  • radio
  • separator
  • read-only text

The supportsmultipleobjects="true" attribute is used to disable multi object processing even if the previous criteria is satisfied

class Used to specify a custom Java class used as the action
classargs Used to pass arguments to a custom action
doclink Relative HTML link to the related chapter in the users guide
actiondropdrop is useful when extending another database profile to remove the Action
order-before Specifies the order of this Action among a collection of Action elements located at the same level. It can either be an index starting at 0 (first) or a node type. Ex. order-before="View" will order this Action before Action elements defined by the type="View" attribute
order-after Specifies the order of this Action among a collection of Action elements located at the same level. It can either be an index starting at 0 (first) or a node type. Ex. order-after="View" will order this Action after Action elements defined by the type="View" attribute

...