The data browse template is included for users who want to create a page that displays a table of data retrieved from built-in data browse functions. The template includes the Equipment tree view on the left side of the main window. This is used to filter the display list based on the selected equipment node .
When using this template to create a new page within your project, configure the Data Browse pop up form. When configured the new page will display the appropriate data session at runtime.
|
Field |
Description |
|---|---|
|
Equipment Symbol Library (Optional) |
The symbol library for displaying equipment symbol for each item in the equipment tree. The symbol is displayed based on the type of the equipment. It should have the same name as the equipment type assigned to an equipment record. If not specified, it defaults to a symbol library named “Equipment”. |
|
Equipment Default Symbol (Optional) |
The default symbol to be displayed next to the item in the equipment tree if symbol corresponding to the equipment type of the item cannot be found from the supplied Equipment Symbol Library. The symbol should be specified in format of <library name>.<symbol name> |
|
Browse Type |
The type of project configuration to be browsed and displayed, including:
|
|
Clusters (Optional) |
A comma delimited string specifying only items from a subset of clusters to be included in the display. If not specified, items from all clusters will be included. |
|
Filter (Optional) |
A filter expression specifying the records to return during the browse If not specified, all records will be returned. Please see the browse open Cicode function of the selected browse type for the details of filter expression supported. |
|
Fields (Optional) |
A comma delimited string specifying the fields (columns) to be returned during the browse. If it is not specified, all fields of the selected browse type will be displayed: Tag, Tag Item, Value, Comment, Cluster, Equipment, Item, Type, IODev, Addr, Arr_Size, Eng_Zero,Eng_Full, Eng_Units,Format, Deadband, Raw_Zero,Raw_Full, Scaled_Type, Ovr_Mode, Ctrl_Mode, Override, Valid, Status, Field, Num_Subs. |
|
Sort By (Optional) |
A comma delimited string specifying the order of sorting preferences. This is only applicable to TagBrowse. Please see the Sort parameter of the built-in Cicode function TagBrowseOpen for details. |
|
View Name |
A name to represent a view setting about the placement and width of the columns displayed on the browse table. The view name works with the Save view and Restored saved view options at runtime. You can assign a unique view on different data browse pages or share the same view among multiple pages. When user selects the Save view command from the Action tab, the current column settings will be saved under the view name. Once a view is saved, when user re-enters the page, previous saved view settings will be retrieved automatically. The saved view can also be restored on demand by selecting the Restored saved view from the Action tab. User can reset (forget) the view to the default as how it was pre-configured by selecting the Restore view to default command under the Action tab. For system engineers, the information associated with a view name is saved under INI parameters: |
|
Privilege (Optional) |
Only applicable to Browse Type of "TagBrowse", this specifies the privilege required by the logged on user to change the values / operating mode of variable tags displayed on the table. If no privilege is defined, no modification will be allowed. |
Use the equipment tree to filter the data browse table at runtime. Items belonging to selected parent and child branches will be displayed with the exception of 'ServerBrowse' which is not associated with equipment.
Refer to Interactive Data Browse List for list display options available at runtime.
See Also
Published June 2018