Page History
...
| Attribute | Value | Description | |
|---|---|---|---|
| type | This defines what object type the ActionGroup is mapped to. This attribute is required and valid only for top level ActionGroup elements (not nested ActionGroup elements). An example is the Table object type, the corresponding <ActionGroup type="Table"> will only be displayed when the current object is a Table | ||
| label | This attribute is required for nested ActionGroup elements and is the label displayed in the sub menu. (This attribute have no effect on top level ActionGroup elements) | ||
| action | drop | drop is useful when extending another database profile to remove the ActionGroup and all its child elements | |
| order-before | Specifies the order of this ActionGroup among a collection of ActionGroup elements located at the same level. It can either be an index starting at 0 (first) or a node type. Ex. order-before="Views" will order this ActionGroup before ActionGroup elements defined by the type="Views" attribute | ||
| order-after | Specifies the order of this ActionGroup among a collection of ActionGroup elements located at the same level. It can either be an index starting at 0 (first) or a node type. Ex. order-after="Views" will order this ActionGroup after ActionGroup elements defined by the type="Views" attribute |
...
| Attribute | Value (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.
| ||||
| 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 | ||||
| reload | true/false | Specifies 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 |
| Specifies how the action will be prepared and displayed | |||
| resultaction |
|
Default is that result sets are displayed in individual tabs | |||
| resulttarget |
| Only applicable if the resultaction attribute is specified. With the value editor the merged results will be opened in a new SQL Commander tab | |||
| 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'" | ||||
| resetcatalogs | true/false | Setting 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 | |||
| resetschemas | true/false | Setting 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 | |||
| supportsmultipleobjects | true/false | An action support processing multiple objects if the style attribute for all input elements is one of:
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 | ||||
| action | drop | drop 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 |
...
| Attribute | Value (bold = default) | Description | |
|---|---|---|---|
| label | The label for the input component | ||
| name | For editable input this should be the name of the variable holding the value specified by the user | ||
| tip | Message displayed when hovering over the component | ||
| editable | true/false | Enables or disables editing of the component | |
| linebreak | true/false | If set to true, no line break will be made after the input component. This is useful when for example having multiple <Input style="check"> elements in a single row | |
| style | list, radio, text, check, check-list, password, number, text-editor, wrapped-text-editor, grid, separator, label, note | The style of the input element. See following sections for more details | |
| hideif | There may be situations when an Input element should be dropped due to a condition. The hideif attribute is used to express a condition which is evaluated when the action is initialized. Example: hideif="#dataMap.get('actionlevel') neq 'toplevel'" | ||
| runsetdefaultwhenvaluechanged | The runsetdefaultwhenvaluechanged attribute defines what other inputs default command should be triggered when the value for the input is changed |
...
| Info |
|---|
| It is recommended that variables produced via SetVar elements are prefixed with an underline (_) to highlight were they come from. |
| Info |
|---|
A SetVar having "password" in its name attribute will be displayed as "***" in the SQL Preview pane. |
XML element - Confirm
The Confirm element is displayed to the user when a request to Execute the action is made. If there are only read-only input fields in the action, this message is displayed in the body of the action dialog. Otherwise the message is displayed in a confirmation dialog.
...
Overview
Content Tools