[Format]FormatName

Defines a display format for tabular data and identifies it with a specified name. This allows you to name a customized display format that you can then apply to a list.

The way the format name is applied depends on the Starter project from which a project was originally created.

Allowable Values:

Any valid format string.

Default Values:

• Situational Awareness projects

  In a project based on the Situational Awareness the display format can be used for alarm, interlock and equipment reference lists.

  Alarm List Display Formats

  The display format can be used for alarms lists such as those on alarms pages, the Information Zone on the Operator Dashboard, and the Top Alarms list.

  Note: The syntax of the format string is the same as the standard alarm display format string, with the exception of the width attribute being interpreted as pixels instead of characters.

  The default values are:

  [Format]
  Top5Alarm = {PriorityAndState,24}{OnDate,90}{OnTime,90}{Name,220}{Desc,300}{State,50}

  This is the alarm list format for the Top 5 alarm pop-up box in the Header Bar.

  [Format]
  TopActiveAlarms_UHD4K = {PriorityAndState,24}{Date,120}{Time,130}{Name,190}{Desc,180}{State,50}

  This is the alarm list format for the Active Alarms Zone pane in a 4K resolution workspace.

  [Format]
  InfoAlarm_HD1080 = {PriorityandState,24}{OnTime,90}{Item,160}{Name,180}

  This is the alarm list format for the Information Zone in 1080 resolution.

  [Format]
  InfoAlarm_UHD4K = {PriorityandState,24}{OnTime,130}{Item,300}{Name,328}

  This is the alarm list format for the Information Zone in 4K resolution.

  [Format]
  Alarm = {PriorityAndState,25}{OnDate,80}{OnTime,90}{Name,250}{State,40}{Cluster,70}{Equipment,220}{Item,160}{UserName,100}{Comment,250}{Category,60}

  This is the alarm list format for the generic alarm page.

  [Format]
  Summary = {PriorityAndState,25}{Name,250}{SumState,40}{OnDate,80}{OnTime,90}{OffDate,80}{OffTime,90}{DeltaTime,90}{Cluster,70}{Equipment,150}{Item,100}{Comment,250}{Category,60}

  This is the alarm list format for the generic alarm summary page.

  [Format]
  SOE = {PriorityAndState,25}{Date,80}{Time,90}{Message,250}{Name,250}{State,40}{Cluster,70}{Equipment,150}{Item,100}{UserName,100}{UserLocation,100}{Category,60}

  This is the alarm list format for the generic sequence of events page.

  [Format]
  Disabled={PriorityAndState,25}{OnDate,80}{OnTime,90}{Name,250}{State,40}{Cluster,70}{Equipment,150}{Item,100}{DisableEndDate,80}{DisableEndTime,90}{DisableComment,250}{UserName,100}{UserLocation,100}{Category,60}

  This is the alarm list format for the generic disabled alarms page.

  [Format]
  AlarmPageSOE_HD1080 = {PriorityAndState,24}{Date,90}{Time,90}{Message,165}{State,50}{UserName,100}{UserLocation,100}

  This is the alarm list format for the historical events side panel on the default alarm pages (in HD1080 resolution).

  [Format]
  AlarmPageSOE_UHD4K = {PriorityAndState,24}{Date,120}{Time,130}{Message,325}{State,50}{UserName,100}{UserLocation,100}

  This is the alarm list format for the historical events side panel on the default alarm pages (in UHD4K resolution).

  Note: If you use the AlarmListCreate() function to create an alarms list and do not specify a format name, the "Alarm", "Summary", "SOE", or "Disabled" format will be used by default, based on the type of alarm list being created.

  Interlocks

  The default values are:

  [Format]Interlock_HD1080 = {Interlock,25}{Bypass,25}{Description,370}

  This is the Interlock list format for the information zone in 1080HD format.

  [Format]Interlock_UHD4K = {Interlock,25}{Bypass,25}{Description,720}

  This is the Interlock list format for the information zone in UHD4K resolution.

  Equipment References

  The default values are:

  [Format]EquipRef_HD1080 = {Checked,24}{Equipment,240}{Category,120}

  This is the Eqipment Reference List format for alarm page in 1080 format.

  [Format]EquipRef_UHD4K = {Checked,24}{Equipment,240}{Category,120}

  This is the Eqipment Reference List format for alarm page in UHD4K resolution.

• Tab_Style and StruxureWare projects

  Note: The syntax of the format string is the same as the standard alarm display format string, with the exception of the width attribute being interpreted as pixels instead of characters.

  The Tab_Style alarm templates assume the alarm display format is defined under the following names if no specified format name is specified for an alarm page:

  • Alarm - for normal alarm display type except Summary and Hardware

  • LastAlarm - for alarm banner

  • Summary - for summary alarm display type

  • SOE – for Sequence Of Event (SOE) alarm display type

    The default values are:

    [Format]
    Alarm = {Date,80}{Time,80}{Tag,120}{Name,120}{Desc,120}

    [Format]
    LastAlarm = {Date,80}{Time,80}{Tag,120}{Name,120}{Desc,120}

    [Format]
    Summary = {Date,80}{Time,80}{Tag,120}{Name,120}{Desc,120}

    [Format]
    SOE = {Date,80}{Time,80}{Tag,120}{Name,120}{Desc,120}

    This will show the alarm fields Date, Time, Tag, Name and Desc with each field taking up the specified pixel width on the active / disabled alarm pages.

    You can assign a format name to an alarm page by opening the page in the Graphics Builder, then double-clicking on the alarm template and entering the name in the pop-up form.

    Tab-style templates do not support text-justification operators because the templates already support proper column handling.

See Also

Alarm Parameters