Home > WebEOC > Admin Guide > HTML Conventions > Display Tags

Display Tags

These WebEOC-specific tags are intended for use in display views of a board. They can be used to add attachments, include calendars, and more.

You may wish to review the allowed values and requirements so as to better understand the tags listed and how to properly implement them on your boards.

Tags

<attachment>

Displays/downloads an attached file; rendered as <a> or <img>. The name attribute holds the field. The table attribute is used for <attachment> tags defined within a <relatedlists> tag.

Attribute

Allowed Values

Requirements

Description

filetype

(image)

Optional

Renders the tag as an image with the file as the source.

name

%fieldname

Required

Name of the field.

table

%table

Optional

Name of the table.

*

*

Optional

Passes any HTML attribute, except src and href, through to the rendered tag.

Example

<attachment name="fieldname">Download</attachment>
<input type="file" name="fieldname" size="30"></input>

<boardname>

Displays the name of the board. If you change the board name in the admin interface, it is updated anywhere the <boardname/> tag is used. This tag is usually located within the display view of a board and can be passed within a <viewlink> tag to dynamically name the text.

<viewlink name="Input New" type="link">Add a new record to <boardname/></viewlink>

<boardpermission>

Placed around anything in a board view, it allows or denies access based on whether the board permission has been assigned to the group. Use this tag to set group permissions for actions, such as adding or updating a record. Only users who belong to groups that are granted that permission can perform the action.

For example, an "edit" permission can be applied to an Edit button in the board by placing the <viewlink> button tag inside the <boardpermission> tag. Only groups that are assigned the board permission can access the view link within the <boardpermission> tag and have the ability to edit the record.

A board's <boardpermission> tags appear as permission options within the group administration page. An option must be selected for that group to have permission to use that feature.

Attribute

Allowed Values

Requirements

Description

name

%boardpermissionname

 

Board permission name that will appear in the board permission section of the group assignment.

Examples

Using the name attribute:

<boardpermission name="Edit">
<viewlink name="Input" type="button"/>Edit</viewlink>
</boardpermission>

The board permission tag also has a sub-tag called <notapplied> that renders its contents when the board permission has not been applied. In the example below, a Delete button would display when a user has been granted this board permission. However, if the user has not been granted the permission, the button will not render. Instead, the text specified for <notapplied> is displayed.

<boardpermission name="delete">
<viewlink name="delete" type="button"/>Delete</viewlink>
<notapplied>
You do not have permission to delete.
<notapplied>
</boardpermission>

<calendar>

In WebEOC version 7.4+, this tag can be used to place an interactive calendar on a status board. Rendered as an <iframe>, the calendar has a day, week, month, and year view that users can navigate through. Additionally, users can use the attributes below to create appointments that are tied to a WebEOC record in a WebEOC table identified in the tag.

Attribute

Allowed Values

Requirements

Description

appointmentnamefield

%fieldname

Required

Appointment name on the calendar.

appointmenttypefield

%fieldname

Required

Appointment type on the calendar; must use a WebEOC list for input values.

starttimefield

%fieldname

Required

Appointment start time on the calendar.

endtimefield

%fieldname

Required

Appointment end time on the calendar.

commentsfield

%fieldname

Required

Appointment comments on the calendar.

displayview

%viewname

Required

Display view to be shown when the user clicks on an appointment.

Note: The <eocrepeatallrecords> tag cannot exist on the display view that the calendar is on.

Example

<tr>
<td>Name:<input type="text" name="name" /></td>
</tr>
<tr>
<td>Type of Appointment<input type="text" name="type"/></td>
</tr>
<tr>
<td>Start Time<input type="text" name="starttime" value="_currentdatetime"/>
</td>
</tr>
<tr>
<td>End Time<input type="text" name="endtime" value="_currentdatetime"/>
</td>
</tr>
<tr>
<td>Comments: <textarea name="comments" id="" cols="30" rows="10"></textarea></td>
</tr>

To create a calendar on the display view:

<calendar width="500px" height="500px" appointmentnamefield="name"
appointmenttypefield="type" commentsfield="comments"
endtimefield="endtime" starttimefield="starttime" displayview="Test"/>

<embedview>

Mechanism to allow one view, from the same or a different board, to be embedded in another; rendered as <iframe>. The embedded view works like any other view to include view lining, automatic refreshing when new data is added, and so forth. However, the new data indicator on the control panel does not appear for the board when new data is added to an embedded view.

Remember, if you are placing this tag in a display view, make sure it is outside the <eocrepeatallrecords> tags. If inside the tags, the embedded view may not show up or, in contrast, may show up too many times.

Attribute

Allowed Values

Requirements

Description

board

%boardname

Optional

Name of the board that contains the view to be embedded. If not specified, the current board is used.

class

CDATA

Optional

CSS class identifiers; a pass-through attribute that allows the resulting HTML container's class to be specified.

enablefooter

(false|true)false

Optional

Specifies whether or not to display the board footer as part of the embedded view to allow paging. The default is false.

frameborder

(1|0)1

Implied

Request frame borders.

height

LENGTH

Optional

Frame height of the embedded view, in pixels or percentage.

id

CDATA

Optional

ID of the rendered <iframe>. This attribute is used in conjunction with the <targetId> attribute and <viewlink> tag.

scrolling

(auto|no|yes)auto

Implied

Determines whether or not to allow scrolling if the content does not fit in the defined embedded view. The default is auto.

style

CDATA

Optional

Inline style information; a pass-through attribute that allows the resulting HTML container's style to be specified.

view

%viewname

Required

Name of the view to be embedded.

width

LENGTH

Optional

Frame width of the embedded view, in pixels or percentage.

Example

<embedview board="Significant Events" view="Display"
 enablefooter="false" width="100%" height="50" scrolling="true"></embedview>

<eocfield>

Mechanism to display field data. Note the following about this particular tag:

  • It must nest within an <eocrepeatallrecords> tag

  • It can only be used once per field name per view.

  • If the field was created with a <feature>, or its type is geography, it renders as a Map button and opens the map specified as the default in the WebEOC Admin window.

  • The name in the <eocfield> tag must match the name in the input tag exactly.

  • Built-in eocfields available on every board include dataid, entrydate, username, positionname, and incident.

Attribute

Allowed Values

Requirements

Description

name

(%fieldname|%systemfield)

Required

Name of the field.

filetype

(image)none

Implied

Displays the image if uploaded from an input view. Use filetype="image".

disableclick

(false|true)false

Implied

If true, disables the field from linking to the input view.

type

(fk|rl)none

Implied

Source of the field; fk=foreign key and rl=related list.

table

%tablename

Implied

Table attribute is required for type fk or type rl.

<eocrepeatallrecords> 

Mechanism to repeat a section of a board's display for each record.

Display views show the data collected in the input view. Every display view should contain an <eocrepeatallrecords> tag. The contents of the tag are repeated for each board entry shown.

Attribute

Allowed Values

Requirements

Description

rowcount

NUMBER

#optional

Default number of returned records per page (0=all records). If not defined, the default is 25.

Note: If a display view where rowcount is set to zero is returning a large set of data entries (for example, 1000+), WebEOC performance could be adversely affected. Thus, avoid setting the rowcount to zero where large data input is expected.

sort

CDATA of (%fieldname|%systemfield)

ASC

DESC

#optional

Comma-separated list of field names by which the results are ordered. The default sort is by entry date.

Values of this attribute consist of status board fields defined in the input views of the board. Multi-level sorts are done by including the desired sort fields separated by commas.

Example

<table>
<tr>
<td>Data ID</td>
<td>Location</td>
<td>Description</td>
</tr>
<eocrepeatallrecords>
<tr>
<td><dataid /></td>
<td><eocfield name="location" /></td>
<td><eocfield name="description" /></td>
</tr>
</eocrepeatallrecords>
</table>

<exportbutton>

Generates a button that exports an Excel®-compatible set of data for this view. Data Manager is required, and the inner HTML for this attribute is the text of the link.

Attribute

Allowed Values

Requirements

Description

admin

(false|true)

Optional

When set to true, authorized users are allowed to use certain export features. Clicking the button opens the administrator interface for the  export function.

Example

<exportbutton admin="true" />
<field>

Specify the order of the fields, along with their labels, by including <field> tags. The fields appear in the exported file in the order in which the <field> tags appear within the <exportbutton> tag. When the <field> tag is used, only the fields specified will be included in the exported file. The parent of a <field> tag must be an <exportbutton> tag.

Example

<exportbutton>
   <field name="datetime" label="Date/Time" />
   <field name="address_name" label="Address" />
</exportbutton>

Note: You can use the <exportbutton> tag if you are a WebEOC Enterprise 7.7+ or WebEOC Professional 7.7+ user and have a license for the Data Manager add-on.

<exportlink>

Generates a link that exports an Excel®-compatible set of data for this view. Data Manager is required, and the inner HTML for this attribute is the text of the link.

<expression>

Returns a calculation on numerical data. If outside of an <eocrepeatallrecords> tag, calculations are made on all records (aggregate functions). If inside, calculations are performed on only one record at a time.

Attribute

Allowed Values

Requirements

Description

name

CDATA

Required

Name of the expression.

omitalias

(false|true)false

Implied

Whether to omit the SQL alias (as Name) for the expression.

useboardlevelfilters

(false|true)false

Optional

Whether view filters applied at the board level are respected when calculating an expression.

usegrouplevelfilters

(false|true)false

Optional

Whether view filters applied at the group level are respected when calculating an expression.

userlevelfilters

(false|true)false

Optional

Whether view filters applied at the user level are respected when calculating an expression.

filter

SQL

Optional

SQL WHERE clause; used when doing aggregate functions.

shownexpression

shownexpression is added inside the <eocrepeatallrecords> tags and only impacts what is displayed in Mapper. This way, you can display all data in the WebEOC status board but still restrict the amount of data that is shown in Mapper itself. Only records where shownexpression evaluates to 1 are resulted. 

You can combine criteria in the shownexpression. This attribute supports standard syntax, including status=Open, status=Closed, and status !=Open.

For example, to hide data from the map based on a field's value in a status board:

<expression name="shownexpression">case when status='Open' then 1 else 0 end</expression>

In another example, to limit the number of days in which points from a board are shown on the map:

<expression name="shownexpression">case when datediff(d,dbo.convert2Local(getUTCDate(),@TIMEZONE,@DAYLIGHT),dbo.convert2Local(entrydate,@TIMEZONE,@DAYLIGHT))>-3 then 1 else 0 end</expression>
Filtered Expressions

Filtered expressions are useful for excluding certain criteria from calculations or finding totals based on something other than a number field.

In the example below, the expression is placed outside the <eocrepeatallrecords> tag. In this way, if the shelter's status is Open, it's assigned 1. Otherwise, it's assigned 0. Since this is a sum, all records in the SQL table are looped, assigned either a 0 or a 1, and then totaled up.

<expression name="TotalOfOpenShelters">sum(case when Shelter_Status = 'OPEN' then 1 else 0 end)</expression>   
Common Expressions

The following is a basic count expression that will return a total.

Note: This does not respect filters. Instead, a count of all records in the table is returned, regardless of whether these records are shown on the display view.

<expression name="totalcount" count(*)></expression>

<externalexpression>

Pulls data from a table within the same board that is unrelated to the current table; returns a calculation on the data. If outside of an <eocrepeatallrecords> tag, calculations are made on all records (aggregate functions).

Attribute

Allowed Values

Requirements

Description

name

CDATA

Required

Name of the external expression.

table

%tablename

Required

Name of the table to pull data from.

Example

<externalexpression name="extExpr" table="Other Table"/>count(*)</externalexpression>

You can also pull data from another board's table by using the board attribute, introduced with version 8.4, in conjunction with the existing table attribute.

Attribute

Allowed Values

Requirements

Description

board

CDATA

Required

Name of the board that contains the table.

Example

<externalexpression name="extExpr" board="BoardName" table="TableinBoardName"/>count(*)</externalexpression>

<filter> (notification)

Displays the text "Filter Applied" or "Filter On" if the board has a filter set applied to the current board.

<listitemicon>

Displays standard or custom icons from a WebEOC list view.

Attribute

Allowed Values

Requirements

Description

field

%fieldname

Required

Name of the field linked to a WebEOC list.

color

COLOR

Optional

Overrides the background color of the icon. Must be a known color or hex value.

<sortlink>

Enables the clicking of column headers to sort records in ascending and descending order by the defined field.

Example

<td>
    <sortlink field="fieldName">Column Name</sortlink>
</td>

Stylesheet Tip

For any board created in WebEOC 7.x, reference the WebEOC CSS file to ensure column headers do not render as blue hyperlinks. To do this, place the following line of code inside the <head> tag:

<link href="suit/5.3.2/css/boards.css" rel="stylesheet" media="screen"/>

From version 8.3, the stylesheet link is as follows:

<link href="css/8.3.0.0/boards.css" rel="stylesheet" media="screen"/>

When complete, the <head> tag may look something like:

<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
    <link href="css/8.3.0.0/boards.css" rel="stylesheet" media="screen"/>
You must to post a comment.
Last modified

Tags

Classifications

This page has no classifications.