View Quick Reference

This topic is a quick reference when creating views to register within the framework amd speaks to simple examples. Each view type can have greater complexity and may have alternative configurations.

• Include the key in views, as a general rule. If a key is not included, add a control to a column in Syniti Construct and mark it as a key.

• Include boaStatus on the table for it to appear in Syniti Construct. It is not required to include boaStatus in the view as well.

• Create columns for button/images/tabs/labels/toolbar controls, or any other columns that should not be updated, by aliasing a column on a view. These columns cannot be edited in Syniti Construct.

• Order the columns on a page by setting the column order in the view. The column order on a view dictates the column order on a page.

• Match prefixes and suffixes with the naming conventions set for the targeted WebApp.

• Include the underlying page table and be descriptive when naming views.

• Use the strict naming feature when possible.

• Make views as simple as possible. It’s better to create several simple views and join them into a separate view.

Horizontal View

• Default Naming Convention: web*Hor

• Registered on the Pages page

• Most common default view for Dynamic pages

• View required for Header Detail pages, both parent and child

Vertical View

• Default Naming Convention: web*Ver

• Registered on the Pages page

• Displays on selection of Vertical icon on Horizontal pages and on Vertical Only pages

• If a page has a Horizontal and Vertical View, they typically reference the same table or view as source (but the views can reference other sources as needed)

• Can be used to show key-bound detail data for the Horizontal view. In this case, select a table or view that shares the primary key. For example, Order can be the Horizontal, Order Details can be the Vertical, binding on OrderID.

Toolbar View

• Default Naming Convention: web*Tbv

• Registered on the Pages page

• Used to create custom buttons at the page toolbar level in 6.1 and later; can also be applied to the site toolbar in 6.0 and previous

• Do not need to select a table or view

• View may only return one row when executed for the page

• Each Alias on the view will be available for selection as a toolbar control on the Page Columns page

• Can contain multiple values

• Use a unique name (different than Horizontal and Vertical columns). Using non-unique names is allowed, but may result in confusion when assigning controls and when designing the page.

• Use NULL with an alias on the Horizontal or Vertical to create row buttons or row images

• Use plain text, as the control allows for configuration of an image and page link.

Refer to Add a Toolbar Button for more information.

List View

• Default Naming Convention: web*List

• Registered on the Page Columns page Vertical view when Control is a List or Combo Box

• Used as the list source for list box and combo box

• Select columns that are available on list boxes and combo boxes

• Select a table or view that contains the desired columns and values

• When configuring a column, the Key is the List Value and the Descriptor for the Key is the List Display

• Do not use the underlying page table for the source

Refer to Add List Boxes and Combo Boxes for more information.

Validation View

• Default Naming Convention: web*Val

• Registered on the Page Validation Rules page Vertical view when Validation Type is View

• Used to run data validation rules against page data for any Event type, both page and row level, though most validations are row level and require a key

• Validations can be run as a page event and do not require a key, but the event is run against the whole table or view. It is important to understand your page views in this scenario.

• Select only the columns required to run the rule, or the columns helpful to the user on the notifications

• If a key is not selected, the rule is applied at the page level and run against all records

Refer to Validation Rules for more information.

Default View

• Default Naming Convention: web*Def

• Registered on the Page Columns page Vertical view

• Sets default value for column in insert mode

• Do not select the base table or view; the default view must return one row when executed in add mode

• Column is the default value to be used

• Alias is column name affected; name must be exact

• Note, this is different from the below default methods:

  • CranSoft column property default

  • Set default on table

Refer to Defaults Views for more information.

Hover View

• Default Naming Convention: web*Hov

• Registered on the Pages page or Page Columns page Vertical view for List and Combo Boxes

• Returns the column values from a view for the selected row on the data grid

• When assigned to a page, the hover text appears when hovering the cursor over the page title

• When assigned to a column, the hover text appears when hovering the cursor over the column value

Refer to Hover Views fore more information.

Data Control View

• Default Naming Convention: web*Dcv

• Registered on the Pages page

• Controls how data is presented on a row on a page based on data in the row

• Include the table key, as the view must return only zero or one row per row in the data grid.

• Select columns from table

• 0=Disable, 1=Enable, 2=Hide

Refer to Data Control Views for more information.

User Control View

• Default Naming Convention: web*Ucv

• Registered on the Pages page

• Controls column availability based on the session UserEmail

• 0=Disable, 1=Enable, 2=Hide

• Alias the desired state (0, 1, 2) as boaControlStatus

• Alias the affected column names as boaColumn

• Also works well for disabling boa reserved columns, such as:

  • boaAudit

  • boaInsert

  • boaUpdate

  • boaDelete

• Filters on the current user listed in the boaUserEmail column

Refer to User Control Views for more information.

Page Control View

• Default Naming Convention: web*Pcv

• Registered on the Pages page

• Controls column availability based on data from a parent page

• Select columns from child table (registered to child page during configuration)

• This control view must be on the child page, and is only effective if drilled from parent to child page. Example would be from Orders > OrderDetails.

• 0=Disable, 1=Enable, 2=Hide

Refer to Page Control View for more information.

Parameter View

• Default Naming Convention: web*PV

• Registered on the Page Business Rules page Vertical view when Procedure Type is WebApp Event

• Provides the parameters needed for WebApp Events and External Events

• This is the page that is calling the public event

• Select columns from a table

• Selected columns can be selected as event parameters

• Required when the event runs at the row level

Refer to Set Parameters for a Public WebApp Event for more information.

Watermark View

• Default naming convention: web*Dwv

• Registered on the Page Columns page

• Provides the text displayed in the column registered

• Limited to 30 characters

• No need to select table or view

• Alias desired text as 'boaWatermark '

Refer to Add a Watermark for more information.

Tooltip View

• Default naming convention: web*Dtv

• Provides the tooltip text displayed in the column registered

• Limited to 30 characters

• No need to select table or view

• Alias desired text as 'boaTooltip'

Refer to Add a Tooltip for more information.