< command />
View Element Reference
< command />
Commands are simple XML elements that handle user actions. Standard commands can refresh form fields, save user-entered values to the database, delete
database records, select a tab page, or call workflow rules that implement custom business
logic. Commands are used inside
action
or
field
elements. These tasks can be triggered when a button or link is selected.
Each command is run synchronously, and so
when multiple commands are used within an
action
or
field
element,
each process is run to completion before the next one is begun. If any command
in the chain fails, the entire set of command processes
is terminated. When a report field runs a command, the primary key of the selected record is sent as part of the command process context.
When
a panel’s
action
runs a
command and the panel is a report that allows
multipleSelection
, the primary keys of all selected records are sent as part of the command
process context.
<command type="saveForm"/>
<command type="showPanel"
panelId="projects" applyParentRestriction="false"/>
Enclosing Element: This tag is a direct child of an <action> , <field controlType=”link”>, or <field controlType=”button”> element.
Encloses: This tag does not enclose any child elements.
Partial List of Command Attributes: Command List for a complete list of command properties.
| Attribute | Description | Valid Values | Optional |
|---|---|---|---|
| type | Specifies which standard process should be run | saveForm, clearForm, openDialog, closeDialog, showPanel, clearPanel, selectTabPage, createTabPage, closeTabPage, selectValue, callFunction, deleteRecord, deleteSelectedRows, workflowRule, exportPanel, loadView, checkInNewDocument, checkInNewDocumentVersion, checkOutDocument, lockDocument, deleteDocument, showDocument | no |
| panelId | This standard command attribute specifies which panel in the target frame is to be shown. If this attribute is not accompanied by the target attribute, the panel must be in the same frame as the command. For a command of type exportPanel , this attribute specifies which panel is the source of the data for the export | an id of an existing panel | yes |
| formId |
For a command of type
saveForm, deleteRecord,
or
clearForm
,
this attribute specifies the
id
property of the form panel; defaults to the form panel in which the command is defined
|
an id of an existing panel | yes |
| includeHeader |
For a command of type
showPanel
. If
true
, the panel title bar is also displayed or hidden; defaults to
false
|
|
yes |
| newRecord |
For a command of type
showPanel, selectTabPage, createTabPage,
or
openDialog
, used with forms. If set to
true
, the form will be set to edit the new record
|
'true'
or
'false'
, defaulting to
false
|
yes |
| tabPageName |
For a command of type
selectTabPage
this attribute specifies the
name
property of the tab page
|
the name of an existing tab | yes |
| tabPanelId |
For a command of type
selectTabPage
or
createTabPage
,
this attribute specifies the
id
property of the tab panel
|
the id of an existing tab, defaulting to the tab panel in which the command is defined | yes |
| viewName |
For a command of type
openDialog, loadView,
or
createTabPage
, this attribute specifies the name of the view to be opened in the new
window
|
the name of an existing axvw view file. | yes |
| applyParentRestriction | This standard command attribute specifies that the target panel or tab should adopt the selected value of the source panel as its restriction. This is useful when the target panel shows information related to the record selected in the source panel. However, this is not desirable when the target panel should contain information that is independent of the parent, for example when creating a new record that is not necessarily using the parent’s primary key data or when refreshing the opener of a panel |
'true'
or
'false'
, defaulting to
true
|
yes |
| applyMultipleSelectionRestriction | This standard command attribute specifies that the target panel or tab should adopt the selected values of the source panel as its restriction |
'true'
or
'false'
, defaulting to
true
|
yes |
| applySelectionRestriction | If true, this standard command attribute will apply the current grid row restriction (row primary key values) to its target |
'true'
or
'false'
, defaulting to
true
for commands that are defined in grid panel fields
|
yes |
| clearRestriction | This standard command attribute specifies that the target panel or tab should have an existing restriction deleted and not adopt the restriction of the caller. Therefore the target panel or tab will be formed without any filtering |
'true'
or
'false'
, defaulting to
false
.
|
yes |
| functionName | For a command of type callFunction , this attribute specifies the name of the JavaScript function to be run | the name of an existing JavaScript function | |
| ruleId | For a command of type workflowRule , this attribute specifies the name of the workflow rule to be run | a name of an existing workflow rule of the form activity_id – rule_id | yes |
| show | For a command of type showPanel , this attribute specifies whether the panel contents should be visible or hidden. A value of show=`false’ , in effect, hides the contents of the panel. Alternately, it may be easier to visualize its affect as clearing the panel of all its contents including field labels, values, etc |
'true'
or
'false'
, defaulting to
true
.
|
yes |
| outputType | For a command of type exportPanel , this attribute specifies the external program used to display the report in a separate dialog window |
‘pdf’
or
‘xls’
|
yes |
| file | For a command of type exportPanel , this attribute specifies a custom XSL-FO file used to format the outputted file | the name of an XSL-FOfile | yes |
| target | This standard command attribute denotes the target window or frame on which the command will operate. For 2.0 views, frames are typically used only to include legacy views (XSL-based or MDX) or third-party web content |