Application Development

Toolbar Views

Toolbar Views are created in SQL and provide a way to add buttons to the page toolbar. Toolbar buttons can also be created by modifying the Horizontal View and adding a column property. Refer to Add a Toolbar Button for more information.

Refer to Control Views for general information.

Use the following guidelines to determine when to create a Toolbar View and when to modify the Horizontal View to add buttons to the page toolbar:

  • If the button controls a page-level function, create a Toolbar View
  • If the button controls a row-level function, modify the Horizontal View with a column property

Setting up Toolbar Views involves the following steps:

  1. Create the Toolbar View.
  2. Register the Toolbar View.
  3. Define the toolbar buttons

Create the Toolbar View

Toolbar Views are created in SQL Server. Use the following guidelines, which assume basic knowledge of the Stewardship Tier methodology and SQL Server, to create a Toolbar View:

  • Use the naming convention web*Tbv, where * contains the table name of the underlying page, minus any prefix.
  • Do not select a table or a view; the Toolbar View only returns one row when executed for the page.
  • Alias each column as the buttons for the page toolbar.
  • Use column names for the toolbar that are different from the column names on the Horizontal and Vertical Views. Otherwise, setting up the column properties can be difficult. If toolbar column properties need to be the same as Horizontal or Vertical View column properties, append the column name with “Tbv,” for example, “RunTbv.” Then, add a page translation to change the column name to what the button should say, for example, “Run.”
  • Use NULL with an alias in the Toolbar View when not referencing tables or views. This is a good method if the toolbar button is navigating to another page and the toolbar button references the target. This method is also useful to run an event that does not require a key.

Register the Toolbar View

To register the Toolbar View to a page:

  1. Select Admin > WebApps in the Navigation pane.
  2. Click the Pages icon for the desired WEB APP NAME.
  3. Click Vertical View for the page DESCRIPTION.
  4. Click Control Views tab.
  5. Click Edit.
  6. Select the SQL view from the Toolbar View list box.
  7. Click Save.

Define the Toolbar Buttons

Once the view is registered, configure the column properties for the columns that contain the toolbar buttons.

To define the toolbar buttons by assigning column properties:

  1. Return to the Horizontal View of the Pages page.
  2. Click the Column Properties icon for the page DESCRIPTION.
  3. Click Add.
  4. Select the toolbar button from the COLUMN list box. This is a column defined in the view.
  5. Select Toolbar from the CONTROL list box.
  6. Click Save.
  7. Repeat these steps for all the toolbar buttons.

Example of a Toolbar View

In the following example, a Toolbar View is used to add the Target Import button to the Targets page toolbar in Console.

NOTE: Users are unable to update Stewardship Tier pages; this is strictly an example.

Note that the Toolbar View only includes the Target Import field; this button controls a page-leve function while the other two buttons on the page toolbar control row-level functions (and were therefore added to the page’s Horizontal View with column properties).

SQL View

Stewardship Tier Page