HTML Query Result View

HTMLQueryResultView is a way to query for a list of objects to be displayed.

The template contains three ways of defining the view of the data: Explorer, Select, and MultiLink.

The Explorer is what we usually call a QRV. It is a table in the web solution that is often accessed from the leftmenu, or in the HTMLContentTab. The Select and MultiLink settings are used by Client Side WebForms.

Explorer Settings

Explorer Settings are used to configure how data is displayed in a table on web. The Explorer QRV is a table meant for being displayed using the full size of the page. So the table will be the main content. It can also be used as an embedded content table for displaying content related to the main content, e.g. show an overview of Risks related to a BusinessProcessNetwork.

Buttons

Buttons can be used to add options for handling the content of the table. There is a set of standard buttons available to quickly add functionality for the most common actions. It is also possible to create custom functionality.

Available settings for buttons:

  • Buttons
    • Client Side Grid: Create, Edit, Delete, Rename, Visualization 2D, Visualization 3D, Cluster, Custom.
    • Server Side QRV: Create, Edit, Delete, Rename, Export, Custom (For Client Side Grid: Export functionality is handled by grid settings)
  • Text: The text displayed on the button.
  • Tooltip: Tooltip with more information to the user.
  • Display Mode: Where to display the button.
    • Empty value: Button is displayed same as Toolbar.
    • Toolbar value: Button is displayed in the toolbar of the QRV.
    • Inline: Button is displayed in a column in the right side of the QRV. One button is displayed per row (object) of the table.
  • Command: Command associated with the button
  • Command Arg:  Argument associated with the command
  • Role: You can configure the button to be available for one or more roles in the repository
  • Condition: You can specify a condition for when the button shoudl be available
  • Image: You can configure an icon for the button.
  • Export Type: Defines if it should be possible to export the content of the table.
    • Possible values: Csv, Excel, Custom

Standard buttons

  • Create: Enables the user to create a new object of the template associated to the QRV in the filter settings
  • Edit: displays an Edit button to the right of each object in the QRV
  • Delete: displays a Delete button to the right of each object in the QRV
  • Rename: displays a Rename button to the right of each object in the QRV
  • 3D Visualize: add a visulisation button to the QRV.

Columns

Right click the window to add a column. Press F2 to get available option (see figure above).

  • Custom input…: choose this option to intert text
  • Audit attribute…: choose this to select an audit attribute from the attribute list

  • Template attribute…: select a template from the list to choose a template specific attribute for the Query

It is possible to configure which columns are in the table along with basic settings for content of the column is displayed.

  • Column header: The text of the header for the column.
  • Column attribute: The attribute of the column. This one is combined with the column filter in Explorer Filter to define the content for the column.
  • Width: Width of the column. It can be defined using pixels or percentages.
    • Using pixels can produce a horizontal scrollbar if total width of all columns exceed the content width.
    • Percentages will be the percentage of the total width of the table. If all column widths are defined in percentages, the total width of the table will not exceed 100%.
  • Format: If cells of the column can contain more than one link (MultiLink or multiple SingleLinks), then the format can be defined as List to diplay the links in list format.
    • Possible values: Default, List
  • Vertical align: Vertical alignment of the content of each cell in the column.
    • Possible values: Top, Middle, Bottom.
  • Plain text: If the content of each cell in the column should be displayed as plain text. This can be used in cases where the content is links. When content is plain text it is not clickable.
  • Filtering: specifies if the column is filterable
  • Filters:
    • Between; NotBetween; Contains; DoesNotContain; EqualTo; NotEqualTo; StartsWith; EndsWith; IsEmpty; NotIsEmpty; GreaterThan; GreaterThanOrEqualTo; LessThan; LessThanOrEqualTo
  • Filter type:
    • Default; Date; Number
  • Sort/Filter by:
    • Value; Auto; LinkedObjectName
  • Data format: Define the format for the content of the cells in the column.
    • For simple formats, define the format directly in this field.
    • For advanced formatting, define which value mapping should be used. Read more about value mapping in the Explorer Grid Settings.
  • Script: You can insert a script
  • Link value / Ref. attr: 

Explorer Parameters

Parameter settings

  • Use script: Select to use script
  • Filter command:
    • Client Side options: Choose ClientSide.GridControl to display data in a client side table. This is the recommended setting. When choosing ClientSide.GridControl, the Explorer Filter options will be enabled.
    • Server Side options: There are a list of predefined commands available for fetching and displaying data in a server side table.
  • Fill command: Commands for the different actions. (Disabled for Client Side Grid)
  • Filter settings: Here you specify Template filter and Query parameters (Disabled for Client Side Grid.)
  • Initial sorting order: Defines the initial sort order of the data in the table. Available options are calculated from the columns set in Explorer Settings.
  • Allow paging: Allows dividing the result in multiple pages
  • Paging size: The number of items on each page of the table.
  • Show icon column: The first column of the QRV will show an icon for the object of the row. (Disabled for Client Side Grid.)
  • On doubleclick: Defines which action will be executed on double clicking a row. Options are calculated based on buttons defined for the QRV. (Disabled for Client Side Grid.)