Command List

The commands supported for 2.0 format views are listed below.

Command type Description Properties other than standard
showPanel Displays or hides the specified panel. If the panel is to be displayed, refreshes its data content.

newRecord : if set to true , and the panel is a form, it will be set to edit the new record;

show : if true and the panel was hidden, displays the panel; if false and the panel was displayed, hides it; defaults to true ;

includeHeader : if true , the panel title bar is also displayed or hidden; defaults to false ;

clearPanel Clears the data content displayed in the panel. Form panels will display the default empty record (with optional default values as defined in the AXVW). Grid and tree panels will display no records at all.
exportPanel Exports grid panel data into DOC, PDF, Excel, or DATA format. The export is done on the server by re-querying the database using the current Smart Search parameters chosen by the user in the grid. The export results can be displayed in the new window (default) or saved to a file.

outputType : ' docx ', ' pdf ', ' xls ' or ' txfr ';

file : optional name of custom XSL-FO file used to format the outputted file;

openDialog : whether to display the export results in a new browser window; defaults to true ;

printRestriction : include the client-side (soft) parsed restriction in effect at the top of the DOCX report;

orientation : output a DOCX report in landscape or portrait model; defaults to portrait ;

openDialog Opens a dialog window and loads the specified view into it. If the command carries a restriction, the loaded view will apply the restriction to its first panel.

viewName : the name of the AXVW view file to be loaded;

newRecord : if set to true , and the loaded view contains a standalone form, the form will be set to edit the new record;

width : optional, defines the dialog window width in pixels;

height : optional, defines the dialog window height in pixels;

closeButton : optional, if true, the dialog will display the Close button; default value is true;

maximize : optional, if true, the dialog will be displayed in maximized state; default value is false;

openDialog Opens a dialog window and shows a hidden panel defined in the current view file in the dialog.

panelId : the ID of the panel to be displayed;

newRecord : if set to true , and the loaded view contains a standalone form, the form will be set to edit the new record;

width : optional, defines the dialog window width in pixels;

height : optional, defines the dialog window height in pixels;

closeButton : optional, if true, the dialog will display the Close button; default value is true;

maximize : optional, if true, the dialog will be displayed in maximized state; default value is false;

closeDialog Closes the currently opened dialog window.
loadView Loads the specified view into a view panel. viewName : the name of the AXVW view file to be loaded;
showRegion Expands, collapses, or toggles visibility of specified layout region.

layout : ID of the view layout; optional if the view has only one layout;

region : name of the layout region: north|south|east|west|center;

action : show|hide|toggle;

showHelp Opens a dialog showing a specific help topic.

file file reference of a help file. This can refer to either User help or System Management Help.

Example of the user help reference:

file="/help/user/Subsystems/webc/Content/fim/managing_wc/bpr_over.htm"

Example of the System Management help reference:

file="/help/system/Content/licensing/levels.htm"

To reference a User help topic, copy the part of the URL beginning with "Subsystems" and prepend "/help/user/".

To reference a System Administration help topic, copy the part of the URL after "#" and prepend "/help/system/Content".

width : optional, width of dialog;

height : optional, height of dialog;

selectTabPage Selects the specified tab page. If the tab panel tabRefreshPolicy property is set to refreshOnSelect, the selected page content will be refreshed by applying the command restriction.

tabPageName : the name property of the tab page;

tabPanelId : the id property of the tab panel; defaults to the tab panel in which the command is defined;

newRecord : if set to true , and the loaded tab page contains standalone form, the form will be set to edit new record;

createTabPage

Creates a new tab page and loads the specified view into it. Applies the command restriction to the view content.

If one of the existing tab pages has the view and the same restriction as a command, this tab page is selected and refreshed instead.

viewName : the name of the AXVW view file to be loaded;

tabPanelId : the id property of the tab panel; defaults to the tab panel in which the command is defined;

newRecord : if set to true , and the loaded view contains standalone form, the form will be set to edit the new record;

closeTabPage

Closes specified dynamic tab page, previously opened using <command type="createTabPage"> .

tabPageName : the name property of the tab page;

tabPanelId : optional, defaults to the parent tab panel.

saveForm Saves the database record that is displayed, and possibly edited, in the specified form panel.

formId : the id property of the form panel; defaults to the form panel in which the command is defined;

workflowRuleId : WFR ID that will be used to save the record; the WFR must accept the same parameters as the AbCommonResources-saveDataRecord WFR; if the table has auto-generated primary key, the WFR should return the DataRecord containing the primary key values for the new record to the view.

clearForm Clears the form and displays default field values. Default field values are defined in the Archibus schema and can be overwritten using a field/@value attribute in AXVW. formId : the id property of the form panel; defaults to the form panel in which the command is defined;
deleteRecord Deletes the database record that is displayed in the specified form panel. formId : the id property of the form panel; defaults to the form panel in which the command is defined;
deleteSelectedRows Deletes the database records selected in the grid with multiple-selection enabled. If the user has not selected any records, no records are deleted.
workflowRule

Calls the specified workflow rule. The WFR input parameters vary depending on the parent panel type and the command location:

  • Commands defined inside panels of type form , console , columnReport : the displayed record as a record parameter.
  • Commands defined inside panels of type grid : the primary keys of selected records as records parameter.
  • Commands defined inside fields in panels of type grid : the primary keys of the current record as record parameter.

The WFR result properties are added to the command context:

  • context.message ;
  • context.data ;
  • context.dataSet .
ruleId : a WFR ID in the activityId-workflowRuleId format;
callFunction Calls the specified JavaScript function. functionName : JavaScript function name;
selectValue Opens a Select Value dialog and allows the user to select values for one or more form fields.

multiple : For information, see Select Multiple Values .

selectValueType : Select Value dialog type: ' grid ', ' tree ', or ' hierTree '; defaults to ' grid ';

fieldNames : a comma-separated list of fully-qualified names of fields on the form to be filled in; for custom HTML fields use id instead of field name;

sortFieldNames a comma-separated list of fully-qualified names of fields on which you want to sort.

selectFieldNames : a comma-separated list of fully-qualified names of fields to be selected from; this list must contain the same number of fields as the fieldNames list, in the same order;

visibleFieldNames : a comma-separated list of fully-qualified names of fields to be displayed in the dialog; this list may contain more or fewer fields than the selectFieldNames list;

applyFilter : whether to use current values in the form fields to filter records displayed in the dialog; defaults to true ;

showIndex : whether to display the Smart Search Index in the dialog; defaults to true ;

restriction : optional SQL restriction for the Select Value records;

recordLimit : optional record limit for Select Value records;

actionListener : the name of the JavaScript function that will be called after the user selects the value; the function will be called for each field in the fieldNames list; the function arguments are:

  • field name on the form;
  • new value;
  • old value;


The function can return false to prevent the field value being inserted into the form field;

applyVpaRestriction : apply the datasource VPA restriction to the Select Value dialog; default is true ;

Document field commands

These commands work with document fields on edit forms. The form must contain:

  • the field that contains the document file name
  • all primary key fields, visible or hidden
Common document properties

tableName : table that contains document field;

fieldName : document field name;

checkInNewDocument Opens a Check In New Document dialog
checkInNewDocumentVersion Opens a Check In New Document Version dialog
checkOutDocument Opens a Check Out Document dialog
lockDocument Opens a Lock Document dialog
deleteDocument Opens a Delete Document dialog
showDocument If the document is an image, and the displayFieldName property is specified, displays the last version of the document in the specified image control. Otherwise retrieves the last version of the document from the database and displays standard Open or Save As browser dialog. displayFieldName : the name or id of the image control field; used only if the document is an image;