Responder Developer Guide
Field Display

Resource Center Home

You may modify aspects of how fields or records are displayed such as which fields are shown, the background color, and font style. This page also includes information about how to designate from where records may be dragged and to where they may be dropped.

Make these modifications in ControlStylesConfig.xml (Responder Explorer) or ArchiveStylesConfig.xml (Archive Explorer).

Drag Sources

The <DragSource> tag indicates from where data may be dragged. In the example below, the <DragSources> tag falls between the <ControlStyle> tag for the Incidents tab. This means that information dragged from other sources may be dropped onto records residing on the Incidents tab, more specifically in the Incidents table. This means you may drop information onto an incident, but not a device (wrong table).

The example below lists three drag sources for incidents on the Incident tab: CrewTree, SwitchingOrderTree, and UserTree. For instance, you may drag a crew from the Crews tab and drop it onto an incident on the incidents tab.

XML Snippet
Copy Code
<ControlStyle Key="IncidentGrid" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Incidents" Editable="false">
      <DragSources Key="">
        <DragSource Represents="Crews" StyleKey="CrewTree"/>
        <DragSource Represents="SwitchingOrders" StyleKey="SwitchingOrderTree"/>
        <DragSource Represents="Users" StyleKey="UserTree"/>
      </DragSources>
    </Table>
  </Tables>
</ControlStyle>

 

Visible Fields and Data Sorting

By default, fields are displayed in the various grids throughout the Responder Explorer and Archive Explorer interfaces. If you wish to hide a field, use the <Column> key to set its Visibility attribute to false. In the example below, the two of the fields shown (moniker and snoozeuntil) are not displayed in the user interface. The IsSortColumn attribute allows you to determine by which column the data is sorted. In the example below, the data is sorted by Key.

XML Snippet
Copy Code
<ControlStyle Key="AlertsGrid" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Alerts" Editable="false">
      <Columns Key="">
        <Column Represents="Key" Visible="true" IsSortColumn="true"/>
        <Column Represents="Category" Visible="true" IsSortColumn="false"/>
        <Column Represents="Moniker" Visible="false"/>
        <Column Represents="SnoozeUntil" Visible="false"/>
      </Columns>
    </Table>
  </Tables>
</ControlStyle>

 

Display Properties

You may modify aspects of a row such as the background color, font color, and font style. Which tags you use and the aspects that may be modified depends on whether you're modifying records in the Alerts window or elsewhere in Responder Explorer or Archive Explorer.

Use the <Appearance> tag to determine how a row looks when displayed in the user interface. The table at the bottom of this page describes each display element that may be modified. The XML sample below shows only a single row (Critical Incident) in order to illustrate how you might adjust the display properties.

XML Snippet
Copy Code
<ControlStyle Key="IncidentGrid" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Incidents" Editable="false">
      <Appearances>
        <Appearance Key="IncidentGrid_CriticalIncident">
          <Evaluator>Vbs:[CriticalCustomer]= 1</Evaluator>
          <Description>[RemarksDispatch] [RemarksField]</Description>
          <BackColor>Yellow</BackColor>
          <ForeColor>Blue</BackColor>
        </Appearance>
      </Appearances>
    </Table>
  </Tables>
</ControlStyle>

If you're working with alerts in the Alerts Grid, use the <Alerts> tag. The table at the bottom of this page describes each display element that may be modified. The XML sample below shows only a single row (Critical Incident) in order to illustrate how you might adjust the display properties.

XML Snippet
Copy Code
<ControlStyle Key="AlertsGrid" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Alerts" Editable="false">
      <Alerts>
        <Alert Key="Alert_Hazard" DisplayCategory="IncidentActivation">
          <Sound>SystemExclamation</Sound>
          <BackColor>LightBlue</BackColor>
          <Font Bold="true"/>
        </Alert>
      </Alerts>
    </Table>
  </Tables>
</ControlStyle>

Items that appear in the Alerts grid, must also have an <Appearance> tag in the IncidentAlerts control style. Elements in the <Alerts> tag indicate what that row will look like (color, font). Elements in the corresponding <Appearance> tag contain information about when that Alert should be displayed and the message that should be shown.

XML Snippet
Copy Code
<ControlStyle Key="AlertsGrid" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Alerts" Editable="false">
      <Alerts>
        <Alert Key="Alert_CriticalIncidentExpired" DisplayCategory="IncidentActivation">
          <Sound>SystemExclamation</Sound>
          <ForeColor>Red</ForeColor>
          <BackColor>Yellow</BackColor>
          <Font Bold="true"/>
        </Alert>
      </Alerts>
    </Table>
  </Tables>
</ControlStyle>
<ControlStyle Key="IncidentAlerts" ResourceAssembly="Miner.Responder.Explorer">
  <Tables Key="">
    <Table Represents="Incidents">
      <Appearances>

        <Appearance Key="Alert_CriticalIncidentExpired">
          <Evaluator>Vbs:(Now &gt;= [TimeRestoredEst]) AND ([CriticalCustomer] = 1) AND ([Status] &lt; 2)</Evaluator>
          <Caption>Critical Incident Expired: [ID]</Caption>
          <Description>The estimated time of restoration for critical incident [ID] has expired.</Description>
        </Appearance>
      </Appearances>
    </Table>
  </Tables>
</ControlStyle>

In the example above, the <Alerts> tag indicates that an alert for an expired critical incident should have a yellow background and bold, red text. A sound called SystemExclamation is also played. The <Appearance> tag indicates when an incident of this type should be considered expired. According to the <Evaluator> element: Now = Estimated Restoration Time and Critical Customer Count = 1 and Status = Created (0) or Crew Assigned (1).

Appearance Priority: The priority for a row's coloring/font appearance depends on the order in which the <Appearance> tags are listed in the ControlStylesConfig.xml or ArchiveStylesConfig.xml file. An appearance listed last will override all prior appearances. For example, if an incident is both critical and read-only, and the read-only appearance tag is listed after the critical appearance tag, then the row will be displayed as read-only.

 

Element

Description

Use With Tags

<Sound>

Indicates the sound played for the alert. This sound is not repeating.

<Alerts>

<Forecolor>

Determines the color of the text.

<Alerts> and <Appearance>

<Backcolor>

Determines the color of the background.

<Alerts> and <Appearance>

<Font>

Determines the style of the text (e.g., Bold="True", Italic="True").

<Alerts> and <Appearance>

<Evaluator>

A VB Script that defines the field.

<Appearance>

<Caption>

Caption is used in the Incident Alerts control style. This is the text that appears in the Type field on the Alerts tab.

<Appearance>

<Description>

The database fields that are displayed. These fields are defined in DatabaseSchemaConfig.xml. For incident alerts, this is the text that is displayed in the Description field (e.g., Hazard: Wires burning at Incident 123456) on the Alerts tab.

<Appearance>

 

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com