View Elements

A view is comprised of three key elements:

  • the data displayed in the view (data source element)
  • the presentation of the data (panel element)
  • handling of user actions (action elements)

Data Source

  • Loads records from the database.
  • Filters data records that the user has no permission to see or change.
  • Formats the displayed values according to the field type and the current user locale.
  • Specifies which fields can or cannot be changed, and which field values are required according to the Archibus data dictionary.
  • Provides pick lists from which the user can select values for validated fields.
  • Saves changed records, creates new records or deletes existing records on user request.

The data source is defined by listing the table and field names of the database fields that the view displays or edits. The data source retrieves all other field-related information using the Archibus data dictionary.

For advanced applications, the data source can be extended using custom restrictions or custom SQL queries:

  • Custom restrictions will limit displayed records.
  • Custom SQL queries will allow the application designer the flexibility of using the database's SQL dialect without losing any of the data source benefits.

Panels

Panels define how records retrieved by the data source are displayed. Panel types include edit forms, search consoles and reports. When displayed, any panel acts as a mini-application. It uses the information obtained from the data source to:

  • lay out input controls, buttons, and grid rows
  • turn on sorting and indexing functions available with the Archibus SmartSearch Console.
  • validate and handle user input
  • call server-side business logic.

View Commands

View commands are executable tasks. View commands are elements nested within a user interface control, such as a button or link. View commands can:

  • automate forms: save user changes, create or delete records
  • show, hide, or refresh view panels
  • navigate between views, select tab pages, open or close dialogs
  • invoke workflow rules that implement business logic.

View commands are used to implement standard interactive applications. For advanced applications, JavaScript event handlers can be used to add additional features, such as:

  • custom HTML controls such as radio buttons or dynamically shown/hidden tab pages
  • complex restrictions from custom consoles
  • passing variable number of parameters to workflow rules
  • embedding advanced controls, such as the Timeline control, that expose a Java Script API.