Table Of Contents
 

UDI Attributes

Author : Peter Coppinger Email : peter@digital-crew.com
The following is a list of available attributes used to control the way UDI is presented.
  Name Type Description Required Default
Datasource & Table
  Datasource String The name of the datasource used to retrieve the data. YES  
  Username String The username of the datasource used to retrieve the data. YES  
  Password String The password of the datasource used to retrieve the data. YES  
  Table String The name of the table to display/work with. YES  
Debugging
  showdebug String Show Debugging Option NO No
Display Options
  pagesize Integer The number of records to display on each page NO 100
  Width String The display width. A number or percentage. NO 100%
  Height String The display height. A number or percentage. NO 100%
  showheader Boolean (TRUE | FALSE) If true, the header will be shown. NO TRUE
  showabout Boolean (TRUE | FALSE) If true, an "about" button will display in the toolbar. NO FALSE
  listmode String Sets the default list mode for the interface. Should be either "sidebyside" or "topbottom". When set to "sidebyside", the name of the field and it's associated description are displayed side by side. Otherwise, the display name and interface are stacked. NO sidebyside
  maxshortitems Integer The maximum number of fields to show in the record list. NO 8
  listAll Boolean (TRUE | FALSE) If yes, the record chooser view will ignore the "maxshortitems" value and display all fields. NO FALSE
  maxListTextSize String Maximum Text Width in Record Chooser List. The preview value gets truncated if longer than this value. NO 30
  showSaveButtonOnForm Boolean (TRUE | FALSE) If TRUE, the Save Button is displayed at the bottom of the Form. NO TRUE
  savebuttontext String Text to display on the in-page save button. NO Save Changes
  recordtype String If provided, the interface will use to display the name of the type of record this interface is editing. For example, if managing a list of users, this should be set to "User" - the interface will now say "Editing User x" instead of "Editing Record x". NO  
  customStylesheetURL String Allows you to specify your own stylesheet to use instead of the standard UDI one. Can be used with displayAsForm="yes". NO  
  displayAsForm Boolean (YES | NO) *NEW* If yes, UDI will just display the interface form. This option is ideal for providing a simple on-page Insert/Update form for a website. NO  
  lookup String Used when displayAsForm="yes". If you want to use the form to edit an existing record, then lookup should be something like "userId = 5". NO  
  showFieldset Boolean (YES | NO) If "no", the fieldset around the record being edited is not shown. NO Yes
Dynamic Includes
  includeBeforeUpdate String The name of a file to include before a record is updated. NO  
  includeBeforeInsert String   NO  
  includeBeforeDelete String   NO  
  includeBeforeInsertOrUpdate String   NO  
  includeBeforeInsertOrUpdateOrDelete String   NO  
  includeOnUpdate String   NO  
  includeOnInsert String   NO  
  includeOnDelete String   NO  
  includeOnInsertOrUpdate String   NO  
  includeOnInsertOrUpdateOrDelete String   NO  
Interface
  saveAlert Boolean (YES | NO) If YES, the interface will prompt the user to save the record if he has forgot to do so and is leaving the interface page. NO No
  showConfirm Boolean (YES | NO) If yes, the interface will ask the user to confirm before deleting a record. NO No
Permissions
  allowinsert Boolean (YES | NO) Allow Insert? NO Yes
  allowupdate Boolean (YES | NO) Allow Update NO Yes
  allowdelete Boolean (YES | NO) Allow Delete NO Yes
  allowsearch Boolean (YES | NO) If sey to no, the search option will not be displayed. NO Yes
Record List Extra Options
  startBlank Boolean (YES | NO) This option allows you to specify that the choose record field starts empty and that the user must perform a search to get a list of records to display. NO No
  sqlwhereclause String SQL Where clause to be used when looking up the list of records from the table. Example: "userlastname = 'Murphy' AND userAge < 55". You can use this option to limit the view to a subset of the records. NO  
  orderby String SQL ORDERBY statement to be used when looking up the list of records from the table. Example: "userlastname ASC, userfirstname ASC" NO