The Accepts return check box indicates that the Edit Box will accept the return key to create a new line in the text block in run mode.

The Alarm attribute property specifies the alarm attribute that will be displayed in the column. Click to reveal a drop-down menu of available CygNet alarm attributes supported by the Alarm Grid:

• Alarm Condition
• Set / Reset State
• Alarm Hidden
• Alarm Suppression State
• Point State
• Reported Time
• Alarm Priority Highest
• Alarm Priority Highest Since Ack
• Alarm Priority Highest Category
• Alarm Priority Highest Category Desc.
• Alarm Priority Highest Since Ack Cat.
• Alarm Priority Highest Since Ack Cat. Desc.
• Facility Tag (CAS)
• Alarm Priority
• Primary Value
• Secondary Value
• Alarm Acknowledgment Status

An alarm column presents data for a point by an alarm attribute.

The Alarm filter property is used to limit the data that is presented in the Alarm Grid by configuring alarm filtering rules. Click to open the Alarm Filter dialog box, where you can create a custom alarm filter rule. The filter rule is displayed in the property label; you do need to open the Alarm Filter dialog box to edit the rule.

The Alarm icon column property is used to indicate whether a column and icon will be displayed as the first column of the Alarm Grid. A customizable icon can be configured to change color based on point state and change image based on alarm priority. Icons will display only when there is an unacknowledged alarm. Click to configure the column, the icon color source, the associated priority ranges, and the icon image used for each priority in the Alarm Priority Icon Ranges dialog box.

The Alarm icon configuration property is used to configure the alarm icon that can optionally be included in the upper right corner of the Detail control. If enabled in the Show alarm icon property, a customizable icon can be configured to change color based on point state and change image based on alarm priority. Icons will display only when there is an unacknowledged alarm.

Click to configure the icon color source, the associated priority ranges, and the icon image used for each priority in the Configure Alarm Icons dialog box.

The Alarm filter property specifies the filter rules for each toolbar filter. Configure the filter rule using the standard CygNet Alarm Filter dialog box.

The Animate Marker check box indicates whether to animate the marker movement. When enabled the Value Indicator's marker will move smoothly from one value to the next value.

The Arrow size property specifies the size of the arrowheads at the end of the line shapes. Select a number using the spin control. The default value is 20. The Shape type must be one of the arrow shapes to take effect.

The Auto close property hides the Tag Chooser when any node in the hierarchy is selected. Click the header row to show the Tag Chooser again to make a new selection. The Auto close property is visible and configurable only when the Collapsible mode is enabled.

The Auto range x-axis check box indicates whether the sparkline's x-axis is constrained to the range of values for the associated point or fixed to the configured time range (default). Configure the date and time range in the Range properties below.

The Auto range y-axis check box indicates whether the sparkline's y-axis is constrained to the range of values for the associated points (default) or fixed to the configured minimum and maximum values. Configure the y-axis scale in the Maximum Y value and Minimum Y value below.

The Background color property specifies the color used for the background of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is BackgroundColor. Options include:

For each color property select the Source and Color:

• Source — Click to reveal five options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • BackgroundColor — Select BackgroundColor to specify that the source of the grid cell's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the grid cell's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the grid cell's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Background color property specifies the color used for the background of the grid cell.

For a Facility and Generic column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the color used for the background of the control.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

Note Grid —

The Background color property specifies the color used for the background of the Note Grid cell.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the color used for the background of the control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Background color property specifies the background color of the screen, object, or control. Click to customize the color using the color picker.

Combo Box —

The Background color property specifies the background color of the Combo Box header. Click to customize the color using the color picker.

The Background color source property specifies the color source for the background color of the screen, object, or control. Two options are available:

• Auto — Overrides the background color with a theme-appropriate color (default).

  Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

• <Self> — The color selected in the Background color property will be used.

The default option is Auto.

The Bar color property specifies the color used for the bar that represents the point value in the Linear Gauge control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Base node property specifies the group node to use as the base (or bottom) of the Tag Chooser hierarchy. Click to select the desired node from the Select Group Hierarchy Node dialog box. Note that you must set up a group hierarchical structure with levels of nodes in your CygNet system prior to selecting a base node in the Tag Chooser.

The Begin date or Start or Start date property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

Tree Map —

The Begin date property specifies the start date and time to use when rolling up historical data. Data between the Begin relative date and the Begin date will be rolled up and displayed in the Tree Map. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to a screen. Click to change the date using the date picker.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

Tree Map —

The Begin relative date property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

See Display alarm acknowledgment

The Border color property specifies the color used for the border of the grid cell. The color can be sourced from one of several options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto); b) the color will be sourced from the point state of the associated alarm (by selecting BackgroundColor, ForegroundColor, or SingleColor); or c) the color can be customized (by selecting Self). The default value is Auto. Options include:

For each color property select the Source and Color:

• Source — Click to reveal five options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • BackgroundColor — Select BackgroundColor to specify that the source of the grid cell's color corresponds to the alarm's point state background color (%pointstatebackcolor%).
  • ForegroundColor — Select ForegroundColor to specify that the source of the grid cell's color corresponds to the alarm's point state foreground color (%pointstateforecolor%)
  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
  • SingleColor — Select SingleColor to specify that the source of the grid cell's color corresponds to the alarm's point state single color (%pointstatesinglecolor%)
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Border color property specifies the color used for the border of the grid cell.

For a Generic and Facility column

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

For a Point column

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Border color property specifies the color used for the background of the Note Grid cell.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

Button, Navigation Button, SetPoint Button, Text Tool, UIS Command Button —

The Border color property specifies the color used for the border of the control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

Media Viewer, Nested View —

The Border color property specifies the color used for the border of the Media Viewer or the Nested View. Click to customize the color using the color picker.

The Border width property specifies the width of the Text Tool's border.

The Bottom information text property specifies the text that will appear on the bottom information area on the control. The control can display a static text string, such as a label, legend, tooltip, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value. Click to configure the static text and/or property tokens using the CygNet Property String dialog box. The default value is the %Units% token.

The Broadcast facilities check box indicates whether to notify other screens when this screen's facility selection changes. When enabled, and when a screen's facility selection changes, Canvas will broadcast the list of facilities out to all other screens open in the application that are configured to source their facility from <Broadcast>.

The Broadcast SiteService check box indicates whether to notify other screens when this screen's SiteService selection changes. When enabled, and when a screen's SiteService selection changes, Canvas will broadcast the SiteService out to all other screens open in the application that are configured to source their SiteService from <Broadcast>.

The Card view property determines which dynagraph card types to display. Options include:

• Surface — Limit the card view to show only surface card(s).

• Downhole — Limit the card view to show only downhole card(s).

• Both — Show both surface and downhole cards. Intuitively, the surface card displays above the downhole card.

The default value is Surface.

The Cell padding property specifies the size of the padding around each Heat Map cell in pixels.

The Center property represents the center point of the map view when first displayed in run mode and is indicated by location coordinates. If no value is entered (default), the map is centered at 0°N 0°E, a point where the Prime Meridian intersects with the Equator, in the Gulf of Guinea off the coast of West Africa. Type the desired latitude and longitude location coordinates, for example, 29.76045,-95.36978, which represents the city of Houston, TX.

The Chart drop mode property specifies how the chart should handle the facility from a dropped point. Two options are available:

• Use dropped facility — Create a series using the full point tag, including the facility tag from the point dropped on the chart (default).
• Use control facility — Create a series using the UDC from the dropped point but drive the facility tag at the control level.

The default value is Use dropped facility.

The Checked property indicates whether the check box initially displays as checked.

Map —

The Click mode property determines the type of click to use when clicking on an image or a shape visual item on a map. Any associated facility will be passed to the specified screen (or script). Options are:

• None — No hyperlink action is taken, however if a script is coded on the control’s Click event, the script will be executed.
• Single click — A single click will open the specified screen, and the control’s Click event is disabled.

None is the default value.

Text Tool —

The Click mode property determines the type of click to use when clicking on a control. Any associated facility will be passed to the specified screen (or script). Options are:

• None — No hyperlink action is taken, however if a script is coded on the control’s Click event, the script will be executed.
• Single click — A single click will open the specified screen, and the control’s Click event is disabled.
• Double click — A double click will open the specified screen, and the control’s Double Click event is disabled. Additionally, if a script is coded on the control’s Click event, the script will be executed.

None is the default value.

The Collapsible mode property configures a collapsible Tag Chooser. When enabled the Tag Chooser will collapse or hide from view when a node in the hierarchy is selected, and the selected node will be displayed in a header row above the Tag Chooser. The Collapsible mode works with the Auto close property, which appears only when the Collapsible mode is enabled. If Collapsible mode is enabled is enabled without Auto close, the Tag Chooser remains visible at all times. Click the header row to collapse the Tag Chooser.

The Color property specifies the color of the point in the chart series. The Show points property must be enabled to change the point color. Click to customize the color using the color picker.

The Color property specifies the color of the chart series. Click to customize the color using the color picker.

The Sparkline color (or Color) property specifies the color of the sparkline. Click to customize the color using the color picker.

The Color configuration drop-down contains all options required to specify the color properties of the control. Click to reveal a set of color options where you can specify the source of the color to be used for the elements of the control. The Color configuration box consists of the following options.

See each control for more information about configuring color properties.

The Color palette property specifies the color palette to use for the CygNet-aware controls on this screen. Select the desired palette from the drop-down menu. Select None to use the default CygNet point state colors. This is the default value.

See Configuring Color Palettes for more information.

Alarm Grid —

The Grid Column Configuration dialog box contains all properties required to configure columns in your grid. There are five types of columns that can be configured in an Alarm Grid: an Alarm icon column (configured separately), an Alarm column, a Facility column, a Generic column, and a Point column. The number of defined columns is listed on the property label once defined.

You can create your own columns or select from 11 default columns: four Alarm columns (Alarm Priority, Alarm Acknowledge, Primary Value, Timestamp), and seven Point columns (Alarm Condition, SiteService, Long Point ID, Primary Units, Description, Facility ID, Uniform Data Code).

Click to open Grid Column Configuration dialog box.

CygNet Grid —

The Grid Column Configuration dialog box contains the properties required to configure each column in your grid. There are five types of columns that can be configured in a CygNet Grid: a Facility column, a Generic column, a History column, a Point column, and an Image column. The number of defined columns is listed on the property label once all are configured.

Click to open Grid Column Configuration dialog box.

Note Grid —

The Grid Column Configuration dialog box contains the properties required to configure each column in your Note Grid. There are two types of columns that can be configured in a Note Grid: a Facility column and a Note column. The number of defined columns is listed on the property label once all are configured.

Click to open Grid Column Configuration dialog box.

The Command prompt drop-down box contains the properties required to configure the prompt for value popup optionally required by the UIS Command Button: the type of prompt to display, whether to set a default value, the default value, and whether to display a confirmation that the command is sent.

Click to reveal a set of options where you can configure the general command options and the optional command prompt options. The UIS Command Configuration box consists of the following options.

The Configuration drop-down box contains the properties required to configure the Tag Chooser using a Facility hierarchy: Collapsible mode and Auto close, a Facility service, an optional Facility filter, and the facility attribute hierarchy levels.

The Configuration drop-down box contains the properties required to configure the Tag Chooser using Group service node hierarchy: Collapsible mode and Auto close, a Group service, Base node, and the Facility type filter.

The Custom Context Menu Configuration dialog box is where you configure any custom context menu items that will appear in the right-click context menu for the screen or control. Each custom context menu item will call an event into script so that you can customize screen or control behavior.

The custom context menu options will appear at the bottom of the fixed context menu options, separated by a line.

Each custom context menu item has a title and an event script ID; items can be designated as a separator; and custom context menus support nested menu items.

Click to open the Custom Context Menu Configuration dialog box.

The Control margin property specifies the size of the whitespace between displayed objects in pixels.

The Custom line style property specifies a special abbreviated syntax that defines the line's pattern. If you want to manually modify these values, set the Line style type to Custom. For example, 1 3 1 renders a dot-dash-dot effect.

The CygNet connection property is used to configure the facility and SiteService associated with this control or screen. Two selection modes are available: a) by Facility tag or b) by SiteService / Facility. This split configuration allows for the inheritance of these properties from other controls, or the specific configuration of the SiteService or the facility, while dynamically changing the other. This use case may be rare; therefore, the Facility tag option is the default.

Click to reveal a drop-down area where you can configure the Selection mode, source SiteService, and source Facility. Each option is described below.

See each control for more information about configuring the CygNetconnection.

All CygNet communication to and from a remote device is performed using data groups. A data group is a collection of data group elements (DEIDs) logically grouped together for a specific purpose. Its primary function is to organize data received from and sent to field devices. All remote device and data group configuration information is stored in the CygNet DDS.

The Data group configuration property is used to configure the source facility and the CygNet data group to be polled when the DDS Button is clicked.

Click to reveal a drop-down area where you can configure the Selection mode, the source Facility tag, or the source SiteService and source Facility, to which the data group belongs, and the Data group(s). Each option is described below.

The Data group property is where you specify the data group(s) to be polled for transaction data by the DDS Button. Click to open the Configure Device Types and Data Groups dialog box, where you specify the Device type, Data group, and Ordinal. Multiple device types are supported.

The Data group property specifies the data group(s) to poll to get data from or to send data to a remote device.

DDS Edit Box —

The Data element Id property specifies the DEID(s) (value or description) to be displayed and edited. Click to open the Configure Device Types and Device Element Ids dialog box, where you specify the Device type, Data element Id, Min value, and Max value for the DEID. Each option is described below.

DDS Text Tool —

The Data element Id property specifies a single data group element as defined in the device template file. The DDS Text Tool supports two DEID types: Value and Description.

Chart —

The Data source property specifies the source of the data used in a selected series. The options are as follows:

• CygNet — The series will display native CygNet data. This is the default value.
• Script — The series will display non-CygNet data from a custom script. For example, you might display data with a generic SQL query from an external database. See Scripting a Chart Series for more information and examples.

Map —

The Data source specifies the source of the data used in the map layer. Only one option is available:

• CygNet — The data used in the map layer will be sourced from the facility coordinates specified in the Facility service attributes. See Configuring Map Settings for more information.

The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to any point's timestamp property. Use this property to override the Default date format, which is configured in the Application settings page of the Backstage view. The default date format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2024/01/01 10:20:30.0001. All timestamps are local client time.

If an invalid format is configured for the Date and time format, the control will automatically use the format configured for the Default date format saved in the global settings file, and configured in the Backstage view.

The Date range configuration property is used to configure the range of dates to be trended in the chart or sparkline, whether to enable live data updates, the live update rate, the starting time for a trend, whether to use relative or absolute dates, and the actual date range. Click to open the Configure Time Range dialog box, where you can configure these properties. You can change the date and time range settings for any chart in run mode via an icon on the chart toolbar.

The Default chart file property specifies the path to the chart file associated with this screen.

• Click to access the Open dialog box and select either:
• Click BSS to access an APPS or BSS folder.
  • Browse to the folder and file you want to open.
• Click Local to access a local or network file-system folder.
  • Browse to the folder and file you want to open.
• Click OK to save the file path.
• Or click Cancel to abort and close the Open dialog box.

This property specifies the source of the file, object file, screen file, image file, or video file. Options include:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

The Default to first item check box indicates whether the first item configured will be the default selected item when starting a screen, instead of showing the Watermark.

The Default value property is used to optionally specify the default value for the prompt. This can be a static value or the current value of a point. If specifying a current value it must be a fully qualified tag string. Enter a default value in the field.

Chart —

The Delay loading property indicates whether to delay data loading for the chart. Use this to stop unwanted messaging to the service, for example, if you don't want the chart to load when the screen first opens. This is necessary when using scripted data sources for a series, to give the script time to set the delegates before data retrieval begins.

Relative Facility Tree —

The Delay loading property indicates whether to delay data loading for the control. Use this to stop unwanted messaging to the service, for example, if you don't want the control to load when the screen first opens. You can turn off the DelayLoading flag via script, then use Refresh to trigger data loading after the delay.

Tag Chooser —

The Delay loading property indicates whether to delay data loading for the Tag Chooser. Use this to stop unwanted messaging to the service, for example, if you don't want the control to load when the screen first opens. You can turn off the DelayLoading flag via script, then use RefreshTagChooser to trigger data loading after the delay.

DDS Button —

The Device type property specifies the device type of the remote field device. This corresponds to the deviceType attribute in the device template’s device definition, and is the same value that appears in the Device Type column in the DDS view in CygNet Explorer.

DDS Edit Box —

The Device type property specifies the device type of the remote field device. This corresponds to the deviceType attribute in the device template’s device definition, and is the same value that appears in the Device Type column in the DDS view in CygNet Explorer.

DDS Text Tool —

The Device type property specifies the device type of the remote field device. This corresponds to the deviceType attribute in the device template’s device definition, and is the same value that appears in the Device Type column in the DDS view in CygNet Explorer.

The Dialog box configuration box contains the options required to specify a title and instructional message on the dialog box that appears when you click the SetPoint button, and where you can enter a new point value. The title and message can display a static text string, such as a label, legend, tooltip, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value.

Click to reveal options for specifying a Title and Message for your dialog box. Click to configure the static text and/or property tokens using the CygNet Property String dialog box.

Alarm Grid, CygNet Grid, Text Tool —

The Display alarm acknowledgment property enables the cell or Text Tool's background, text, and border to blink when the associated point is in alarm. Check each box to configure the:

• Background — The background of the cell or Text Tool will blink when the associated point is in alarm.
• Text — The text in the cell or Text Tool will blink when the associated point is in alarm.
• Border — The border of the cell or Text Tool will blink when the associated point is in alarm.

If none of these options are selected, no visual indication of a point in alarm will be presented. However, if the point is in alarm, an Acknowledge alarm option will be available from the context menu in run mode.

Button —

The Display alarm acknowledgment property enables the button's background, text, and border to blink when the associated point is in alarm. Check each box to configure the:

• Background — The background of the button will blink when the associated point is in alarm
• Text — The text on the button will blink when the associated point is in alarm
• Border — The border of the button will blink when the associated point is in alarm.

If none of these options are selected, no visual indication of a point in alarm will be presented. However, if the point is in alarm, an Acknowledge alarm option will be available from the context menu in run mode.

The Display alarm ranges check box indicates whether to display alarm ranges for the setpoints for the associated point on the Donut. The colors depicted for the ranges are randomly chosen from a predefined set of colors.

The Display mode property specifies how to display the navigation menu when the screen is in run mode. By default, the navigation menu and the control's contents will adapt depending on the amount of available space. Options include:

• Minimal — The navigation menu shows and hides as you click the Navigator icon () and all menu items are hidden when clicked
• Compact — Only the top-level menu icons display and sub-menu items are hidden when clicked
• Expanded — The top-level menu items always on display and sub-menu items are hidden when clicked

The default value is Compact.

The Display mode property specifies the method for displaying the data elements in the Tile View. Options include:

• Single UDC — Data for a single UDC is displayed and a tile will be created for each child of a parent facility
• Each UDC for facility — Facilities are queried for their associated UDCs and a tile will be created for each one

The default value is Single UDC.

The Display mode property specifies the method for displaying the data elements in the Tree Map. Options include:

• Best fit — Elements are sized based on value and arranged in rectangles to best fit within the control's space. Best fit is the default value.
• Stacked — Elements are sized based on value and stacked vertically to fit within the control's space.

The default value is Best fit.

The Distance unit property specifies the distance units (or scale) to use for the map. Options are Kilometers or Miles (default).

The Double click mode property determines the action to take when you double-click a row in run mode. The Facility sender mode must be set to Double click. Options are:

• Hyperlink — A double click will link to a screen in a new window via the hyperlink navigation option selected in the Hyperlink mode property. This control supports hyperlinking to other screens via configuration or scripting. A single click or double-click action will send any configured facility to the receiving screen. Hyperlink supports the following operational modes: Open, Modal open (a subordinate popup window), Open and close, Replace, Replace with navigation, and Close. Any configured script is disabled.

• Script — A double click will disable hyperlink navigation and run any specified script.

The default value is Hyperlink.

The Drag mode property determines the drag action for the chart in run mode. Setting it to Pan will start panning, instead of zooming when you drag the mouse over the plot area. To forbid any drag actions you can set the Drag mode to None. Options include:

• None — Turn off all dragging actions. Neither panning nor zooming is enabled.
• Pan — Enable panning only, zooming is disabled.
• Zoom — Enable zooming only, panning is disabled.

The default value is None.

The Earliest (span) property specifies the starting date for a trend; that is, the amount of time in the past from when to start the trend. Enter a number in the text box and select a time period from the drop-down menu. For example, 8 Hours ago or 2 Days ago.

The Earliest (unit) property specifies the unit of time in the past from when to start the trend. After entering a number in the text box, select a time period from the drop-down menu. The options include: Seconds, Minutes, Hours, Days, and Years. For example, 60 Seconds ago or 2 Hours ago. The default value is Hours.

The Empty bar color property specifies the color used for the empty or inner background bar in the Linear Gauge control.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Empty ring color property specifies the color used for the empty or unused ring in the Donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Enable live updates check box indicates whether this chart or sparkline will request new data at a specified interval allowing the chart to trend data at a real-time pace. When live updates are enabled and the next poll occurs, the series line will update to reflect the slope change, if any. The interval at which the trend moves forward is defined in the Update rate. If disabled, a trend is populated once with data from the Value History Service (VHS). You can disable live updates /enable live updates for any chart in run mode via an icon on the chart toolbar. See Live Update Changed for related event.

The Enabled check box indicates whether the control is enabled. The default value is True. When set to False, the control is visible in run mode, but grayed out and disabled from use.

DDS Button, DDS Edit Box, Navigation Button, UIS Command Button —

The Enabled check box indicates whether the control is enabled. The default value is True. When set to False, the control is visible in run mode, but grayed out and disabled from use.

Image —

The Enabled check box indicates whether the image on the control is enabled. The default value is True.

The End date or End property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click to change the date using the date picker.

The End relative date or Relative end date or End property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Facility property specifies the facility for which the control (or screen) is to display data. Click to select a facility using the Select Facility dialog box.

The Facility property specifies the source facility for the CygNet Grid's rows. Options include:

• Source — Options include <Self>, Screen (default), or a list of Sender controls.
  • <Self> — Select <Self> to explicitly configure the facility for this control, which can be further filtered,.
  • Screen — Select Screen to inherit the facility from the screen for this control. By default, the sender is the Screen control if no other senders have been configured. Once Screen is selected Inherited from Screen will display for the Facility property.
  • Sender — A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.
• Filter — Only visible is the Source is <Self>.

  Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

The Facility attribute property specifies the facility attribute that will displayed in the column. Click to reveal a drop-down menu of all available CygNet facility attributes categorized by type:

• Facility: General Attributes (The default value is Facility Description.)
• Facility: Text Attributes
• Facility: Table-driven Attributes
• Facility: Yes/No Attributes

Click to expand each category and select the desired facility attribute.

The Facility attribute: Primary property specifies the facility attribute that will be displayed as text in the left position of a search result. Click to reveal a drop-down menu of all available facility attributes. Select an attribute from the list. The default attribute is Facility Description.

The Facility attribute: Secondary property specifies the facility attribute that will be displayed as text in the right position of a search result. Click to reveal a drop-down menu of all available facility attributes. Select an attribute from the list. The default attribute is Facility Site.Service.

A facility column presents data for a point by a facility attribute. You can choose to resolve the facility to a relative facility if desired.

Grids, Map —

The Facility filter option is visible only if the Facility Source is <Self>.

Use the Facility filter property to limit the data presented in the control (or row or layer) to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

Facility Emitter, Object Container, Relative Facility Tree, Tag Chooser —

Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

Search Box —

Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. A search will be executed against the facilities that are described by this filter. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

The Facility mode property specifies how to handle facilities provided to the Object Container. Options include:

• Facility list — The Object Container will use the facilities provided and make an object for each one.
• Resolve children — The Object Container will use the Facility filter to resolve the children of the provided facility and create an object for each one.

The default value is Resolve children.

The Facility navigation mode (FacilityNavigationMode) property is included on the screen object to determine how a screen will handle a request to navigate to another screen via a facility. This property is used with the NavigateByFacility or OpenedViaHyperlink events to link to a facility's associated screen or replace a current screen in a Navigator control with a facility's associated screen. Click to reveal a drop-down menu of options:

• Script event —

  Fires a NavigateByFacility script event on the screen that provides the associated screen path, as well as any optional facility record properties, to send when this navigation is triggered. The EventArgs type for this event is:

  NavigateByFacility event Canvas.Shared.Events.NavigateByFacilityEventArgs

  The associated screen path for the facility is configured in the facility record in CygNet Explorer. The screen path facility attribute, and any optional facility record properties to be included when this navigation is triggered, is configured in the Backstage view.

• Hyperlink - Open — Opens the facility's associated screen in a new window.
• Hyperlink - Replace — Replaces the current screen with the facility's associated screen.
• Hyperlink - Replace with navigation — Replaces the current screen with the facility's associated screen and adds a navigation toolbar.
• Navigator - Replace — Notifies any Navigator controls on the current screen to replace the active screen with the facility's associated screen.
• Navigator - Replace with navigation — Notifies any Navigator controls on the current screen to replace the active screen with the facility's associated screen and add a navigation toolbar.

The default value is Hyperlink - Open.

See Navigation by Facility for more information about using this property.

A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.

The Facility sender mode property determines how facilities are sent to other controls. There are four options:

• None — No facilities are sent. This is the default value.
• Single click — A single click on a row will send a single facility to a receiving control on the same screen.
• Double click — A double click on a row will send a single facility to a receiving control on the same screen. This option supports two actions when a row is double-clicked: 1. Sending a facility to anther control on the same screen; and 2. Sending a facility to another screen. See the note below.
• All facilities — As soon as all facilities are received they will be sent to the receiving control on the screen. No click is required.

Sending and receiving facility tags

Some controls on the same screen allow for the sending of facility information from one control to another.

1. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
2. On the receiving control configure the Selection mode property (in either CygNet connection or Point configuration section) to Facility tag and select the Facility Source to the sending control.
3. On the receiving control configure a display tag that associates to a facility property, e.g., %FacilityTag%.

Example

Add a control to a screen (e.g., a Tag Chooser or Grid) and configure it as a facility sender to send a facility to the screen. Add another control to the screen (e.g., a Text Tool or Donut) and configure it to receive the facility from the screen. In this scenario the Tag Chooser or Grid will send a facility to the screen and the screen will then send the facility to a Text Tool or the Donut.

The Facility service property specifies the service to use for this Tag Chooser. Click to select a Facility service using the Select Service dialog box.

The Facility property specifies the facility source for the map layer. Options include:

• Source — Options include <Self> or Screen.
  • <Script> — Select <Script> to indicate that the facility coordinates will come from script.
  • <Self> — Select <Self> to explicitly configure the facility for this layer, which can be further filtered. An override SiteService source and service can also be configured. <Self> is the default value.
  • Screen — Select Screen to inherit the facility from the screen for this map layer.
  • Sender — A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.

The Facility tag property specifies the full facility tag identifier for which the control (or screen) is to display data. Click to select a facility using the Select Facility Tag dialog box.

The Facility type filter property specifies the facility type on which to filter the group hierarchy, in all UPPERCASE letters. The nodes in the hierarchy will correspond to the Facility Type column in the Facility service. This must be a valid facility type for your system. The types are stored in the SYSFCTYP table in the Table Reference Service (TRS). For example, common facility types include REMDEV, MTRRUN, WELL, PLNGR, TANK, PUMP, etc.

• Type a single facility type to filter the hierarchy by that type, for example: WELL
• Type a semicolon-separated list of facility types to filter the hierarchy by those types, for example, WELL; METER; TANK
• Leave the Facility type filter blank to include all facility types.

This property specifies the path to the file, image file, video file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Select File dialog box —To access an APPS or BSS folder
• Open File dialog box — To access a local or network file-system folder

This property specifies the source of the file, object file, screen file, image file, or video file. Options include:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

The Fill color property specifies the color used for the internal body of the Shape.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Filter Type property allows you to limit the number of facilities displayed in the Tree Map. By configuring a value in the Items to filter property, and selecting Top or Bottom in this property, only the top or bottom number of facilities will be displayed, no matter how many facilities are sent to the Tree Map from the sending control. Options include:

• None — No filtering occurs.
• Top — Only show the top number of items in the Tree Map.
• Bottom — Only show the bottom number of items in the Tree Map.

The default value is None.

Filtering Values

The Tree Map will not display a rectangle for negative, zero, and non-numeric values. These unsupported values are converted to a value of 0.0 prior to being added to the Tree Map, effectively removing them from the control’s display, but not from the underlying data set. If the facilities in a Tree Map are driven by another control (such as a Tag Chooser or CygNet Grid) the source control will still display the facilities and their unsupported values, even though the facilities will not be displayed in the Tree Map. This might lead to some confusion when filtering a Tree Map by Top or Bottom values because the filter will consider all available values, including those that may not be visible in the control.

For example, if a Tree Map is filtered to show the bottom 5 facilities, and 2 of the facilities have unsupported values, the control will only display 3 facilities.

The Flip enabled property indicates whether to enable flipping of the Detail control when clicked.

The Font size property specifies the font size of the text on the control or map visual.

The Font size (bottom) property specifies the font size of the bottom text on the control. Only applies if Font size mode is set to Fixed.

The Font size (main) property specifies the font size of the main text on the control. Only applies if Font size mode is set to Fixed.

The Font size (top) property specifies the font size of the top text on the control. Only applies if Font size mode is set to Fixed.

The Font size mode property specifies the method used to size the text on the control. Options include:

• Auto — Automatically size the text relative to the size of control.
• Fixed — Size the text using the values specified in the Font size property.

The default value is Auto. The default value for the Text Tool is Fixed.

The Foreground color property specifies the color used for some of the foreground elements of the Dynagraph control. For the Dynagraph this includes the axis legends and labels. Foreground color configuration does not include the axis lines, tic marks, or grid lines. Nor does it include the card plot lines, POC point, dotted lines (max load, mean load, stroke length), which are auto-colored.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

Alarm Grid —

A generic column can display any kind of scripted data of your choosing using C# or VB.NET at runtime. First configure the column in Canvas and then reference the column by name to pull in CygNet or other values. A generic column can be used to discover data defined in a supporting script. If the column is defined, but no data is defined, then the column is hidden by default.

The cells in a generic column can be configured to be editable in run mode, so that, for example, users could make quick data changes to facilities in a grid format. Changed values are not saved anywhere but in the grid, but they can be saved or otherwise manipulated via script.

CygNet Grid —

A generic column can display any kind of scripted data of your choosing using C# or VB.NET at runtime. First configure the column in Canvas and then reference the column by name to pull in CygNet or other values. A generic column can be used to discover data defined in a supporting script. If the column is defined, but no data is defined, then the column is hidden by default.

The cells in a generic column can be configured to be editable in run mode, so that, for example, users could make quick data changes to facilities in a grid format. Changed values are not saved anywhere but in the grid, but they can be saved or otherwise manipulated via script. Note that when a generic column is set to editable the Color properties are not configurable.

The Get transaction on facility change check box indicates whether to get new transaction data whenever a source facility changes.

The Grid background color property specifies the color used for grid's background. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Grid color property specifies the color of the lines in the layout grid.

Click to customize the color using the color picker.

The Grid color source property specifies the color source for the layout grid on the screen. Two options are available:

• Auto — Overrides the grid layout color with a theme-appropriate color (default).

  Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

• <Self> — The color selected in the Grid color property will be used.

The default options is Auto.

The Grid height property specifies the height of the layout grid. The default is 10 pixels high.

The Grid width property specifies the width of the layout grid. The default is 10 pixels wide.

The Group name property specifies the name of the group that indicates which Radio Buttons are mutually exclusive.

The Group service property specifies the service to use for this Tag Chooser. Click to select a Group service using the Select Service dialog box.

The Header background color property specifies the color used for the background of the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Header text color property specifies the color used for the text on the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Height property specifies the height of the control (or screen).

The Image height property indicates the height of the configurable image to be displayed on the map layer.

Donut —

The Hide invalid bounds property specifies whether to hide the value ring and alarm ranges on the Donut if any misconfiguration is detected. By selecting this property you can choose to hide the value ring and alarm ranges and show a warning label if invalid value bounds are detected. The options are:

• If Hide invalid bounds is not selected, Canvas will hide the Donut’s value ring and alarm ranges and show an "Invalid bounds" label under the control. This is the default setting.
• If Hide invalid bounds is selected, Canvas will hide the Donut’s value ring and alarm ranges and hide the "Invalid bounds" label.

Invalid bounds can include any of the following conditions: the lower bound value is greater than the upper bound value, the lower bound value is equal to the upper bound value, the lower bound value and upper bound value are zero, either the lower bound value or the upper bound value is non-numeric, or if a Point Attribute is selected as the Source but no Attribute is selected in the Value.

Linear Gauges —

The Hide invalid bounds property specifies whether to hide the value bar and scales (primary and secondary) on the Linear Gauge if any misconfiguration is detected. By selecting this property you can choose to hide the value bar and scales and show a warning label if invalid value bounds are detected. The options are:

• If Hide invalid bounds is not selected, Canvas will hide the Linear Gauge’s value bar and scales and show an "Invalid bounds" label along the hidden bar. This is the default setting.
• If Hide invalid bounds is selected, Canvas will hide the Linear Gauge’s value bar and scales and hide the "Invalid bounds" label.

Invalid bounds can include any of the following conditions: the lower bound value is greater than the upper bound value, the lower bound value is equal to the upper bound value, the lower bound value and upper bound value are zero, either the lower bound value or the upper bound value is non-numeric, or if a Point Attribute is selected as the Source but no Attribute is selected in the Value.

Value Indicator —

The Hide invalid bounds property specifies whether to hide the value bar, alarm ranges, and marker on the Value Indicator if any misconfiguration is detected. By selecting this property you can choose to hide the value bar, alarm ranges, and marker and show a warning label if invalid value bounds are detected. The options are:

• If Hide invalid bounds is not selected, Canvas will hide the Value Indicator’s value bar, alarm ranges, and marker and show an "Invalid bounds" label along the hidden bar. This is the default setting.
• If Hide invalid bounds is selected, Canvas will hide the Value Indicator’s value bar, alarm ranges, and marker and hide the "Invalid bounds" label.

Invalid bounds can include any of the following conditions: the lower bound value is greater than the upper bound value, the lower bound value is equal to the upper bound value, the lower bound value and upper bound value are zero, either the lower bound value or the upper bound value is non-numeric, or if a Point Attribute is selected as the Source but no Attribute is selected in the Value.

The Hide invalid tag check box indicates whether to hide the element (a control, button, image, or map visual item) if it resolves to an invalid or unknown tag.

The Hide unreliable points property indicates whether to hide a point in the chart series based on its unreliable point state. The UNRELIABLE status bit is set when a point is deemed unreliable. When enabled data points marked as unreliable will be hidden in the chart. When disabled, unreliable data points will be shown in the chart.

The Hierarchy type property is used to select the service type by which the Tag Chooser's facilities will be organized: by Facility service or by Group service.

The High range color property specifies the color to be used at the high end of the value range. Click to customize the color using the color picker.

A history column is used to add a Sparkline chart in each cell for a specified UDC. You can choose to resolve the point to a relative facility, or use absolute or relative dates, if desired.

The Horizontal alignment property specifies the horizontal position of the text within the boundary of the control. Click to select from the following options: Left, Right, Center, or Justify. The default value is Center.

The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include:

• None — No resizing occurs.
• Shift — The object will shift horizontally.
• Expand — The object will expand or shrink horizontally the same number of pixels as the screen.
• Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

The Hover mode property specifies the mode when hovering over a series in the chart. Two options are available:

• None — No change to the other series in the chart.
• Fade other series — When hovering over a series, all other series in the chart are faded.

The default value is None.

You can use this setting to highlight a particular series in a chart in run mode.

The Hyperlink mode property specifies how to handle navigation when clicking an element (e.g., row in a grid, Navigation Button, Shape, or Text Tool). Specify the Screen file source to open in the Screen path property. Several hyperlink navigation options are available:

• Open — Open a designated screen in a new window (default).
• Modal open — Open a designated screen in a new modal window. A modal window is a type of popup that is subordinate to a parent window that appears in front of the parent and usurps the parent’s control. You cannot interact with the parent window until the modal window has been closed. This type of window is used when you want a user to focus on or interact with information in the popup.
• Open and close — Open a designated screen in a new window and close the current screen.
• Replace — Replace the current screen with the designated screen.
• Replace with navigation — Replace the current screen with the specified screen and add a navigation toolbar to the top of the screen.
• Close — Close the current screen.

The default value is Open.

See Hyperlinking Screens for more information about this functionality.

Map —

The Hyperlink mode property specifies how to handle navigation when clicking an image or shape on a Map. Specify the Screen file source to open in the Screen path property. Three hyperlink navigation options are available:

• Open — Open a designated screen in a new window (default).
• Modal open — Open a designated screen in a new modal window. A modal window is a type of popup that is subordinate to a parent window that appears in front of the parent and usurps the parent’s control. You cannot interact with the parent window until the modal window has been closed. This type of window is used when you want a user to focus on or interact with information in the popup.
• Replace — Replace the current screen with the designated screen.

The default value is Open.

See Hyperlinking Screens for more information about this functionality.

The Icon path property specifies the icon to display to the left of a top-level menu item. The Icon path field is read-only; you must use the Open Files dialog box to select a new icon. This option is not available for sub-menu items.

The Icon preview property displays a preview of the selected icon. This option is not available for sub-menu items.

The Icon size property is used to set the dimensions of the menu icon. The range is 8 to 40 pixels. The default is 16 by 16 pixels.

The Ignore UDCs property specifies a comma-separated list of UDCs to hide when displaying points in the Tag Chooser. Type any UDCs you wish to hide, e.g., SYFACDESC, SYFACINFO.

The Image property indicates the file path and file name of the image that will be substituted when the point state changes to the selected point state. Browse and select the desired image file. Click to select a path and file from the Open / Open File / Select File dialog box, where you can access: A thumbnail of the selected image, and its dimensions are displayed for each point state.

An image column presents a point-state image — a CygNet-aware image that will dynamically change based on the point state of the associated point. A default image is displayed if you configure point-state-aware images and no matching state exists.

This property specifies the path to the file, image file, video file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Select File dialog box —To access an APPS or BSS folder
• Open File dialog box — To access a local or network file-system folder

Map —

If the item on the map layer is an image, you can specify an image to represent facility locations on the map layer, for example, wells could show an oil droplet image. The common image types are supported (.svg, .bmp, .jpg, .png, etc…). Browse for the image file.

Click to select a path and file from the Open / Open File / Select File dialog box, where you can access:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

This property specifies the source of the file, object file, screen file, image file, or video file. Options include:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

Image —

The read-only Image height property specifies the height of the image used in the control if no point-state-aware image is displayed.

Map —

The Image height property indicates the height of the configurable image to be displayed on the map layer.

The Image size property indicates the size of the item on the map layer.

Image —

The read-only Image width property specifies the width of the source image used in the control if no point-state-aware image is displayed.

Map —

The Image width property indicates the width of the configurable image to be displayed on the map layer.

The Image Selection dialog box is where you configure CygNet-aware images that will dynamically change based on the point state of the associated point. The point state preference is configured in the Resolution mode property. A default image is displayed if you configure point-state-aware images and no matching state exists.

Click to open the Image Selection dialog box.

Map Layer image visual item —

The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True.

The Initial cards to show property determines the initial cards to display for the device. Different types of cards can be polled from the device, though not all devices support all card types. Each card displays one complete stroke in a load versus position graph. Load is displayed in pounds, and surface position is displayed in inches.

Click the desired check box(es) to display the available card(s) at the startup of the dynagraph screen. If other cards are also selected to show initially, the cards overlay. The available card types include:

• Alarm card — An alarm card from the associated remote device, if one is available. An alarm card is created whenever an alarm condition is met in a field device. Such a condition is typically treated as less severe than a fault, which creates a failure card.

• Current card — A current card describes the most recent stroke stored in associated remote device. This card type is used for analyzing real-time pump information. Typical devices maintain five current cards in their registers, although some hold only one. Current card information is displayed by default in a surface position plot. It is also possible to display it as a downhole card, or show both the surface and downhole plots at once. To display a downhole card, be sure that the DDS is configured to retrieve downhole information from the device.

• Failure card — A failure card from the associated remote device, if one is available. A failure card is created whenever a fault condition is met in a field device. Such a condition is typically treated as more severe than an alarm, which creates an alarm card.

• Ideal card — A card returned from an external system. This card calculates an ideal rod pump stroke card based on a set of configuration items. it can be used as a way to compare actual and ideal strokes, and to adjust current configuration to a more ideal state.

• Pumpup card — A pumpup card is generated when the pump fully starts again after having been shut down.

• Reference card — A quick reference or snapshot of a dynagraph card, or any type of card from the associated remote device, if one is available, that is stored for reference in the CygNet system, and sometimes in the device itself.

• Shutdown card— A shutdown card, or pumpoff card, is generated when the pump is turned off, usually to wait for the reservoir to fill. Most devices store the previous five shutdown cards in two card sets.

The Is logarithmic property indicates whether the gauge scale is linear or logarithmic.

The Is pan zoom control visible check box indicates whether to display the pan and zoom control on the screen in run mode. Pan and zoom are always enabled in design mode; the control is optional in run mode.

The Is pan/zoom enabled check box indicates whether the user can pan horizontally and vertically or zoom in and out of the screen. Both panning and zooming change the view — the current location and magnification of the screen. Every time you zoom or pan, you establish a new view. Pan and zoom are always enabled in design mode; the control is optional in run mode.

The Is separator check box indicates whether this menu item will be a separator line in the menu at runtime. Once saved the separator has no configuration and no children. Separators do not have event IDs. Any event ID on a menu item when it’s converted to a separator is deleted. You can give it a title of 'Separator" or "----------" if desired.

The Combo Box Items dialog box displays all the item labels that will appear in the Combo Box and their corresponding values.

Click to open Combo Box Items dialog box.

The Items property is a read-only collection of all map items contained in the control, independent of visibility. This property is only accessible via script.

The Items to filter property specifies the number of items to filter if the Filter type is set to Top or Bottom.

Chart —

The Label property specifies the identifier displayed on the quick range button.

Check Box —

The Label property specifies the text label to display next to the check box. By default, the label appears to the right of the check box.

Combo Box —

The Label property specifies the label for an item in the Combo Box drop-down menu.

Facility Emitter —

The Label property specifies the text label to display on the face of the Facility Emitter.

Radio Button —

The Label property specifies the text label to display next to the Radio Button.

Chart —

The Label background color property specifies the background color of the label associated with the point in the chart series. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label background color property specifies the background color of the label associated with the point in the default chart series.

Click to customize the color using the color picker.

The Y-axis Label color property specifies the color of the y-axis label text. Click to customize the color using the color picker.

Scripting Note

Prior to v9.5 the script property name for LabelColor was YAxisLabelColor, which is now obsolete, although it is retained for backwards compatibility.

Use Chart.AxisY LabelColor string to manipulate a y-axis in script. For example:

1
2
3
var axis = Objects.Chart1.AxisY.First();
 
axis.LabelColor = System.Windows.Media.Colors.Yellow.ToString();

Note that

Chart —

The Label connector color property specifies the color of the label border and the connector line linking the label to the point in the chart series. The Show labels property must be enabled to change the color of the label connector. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label connector color property specifies the color of the label border and the connector line linking the label to the point in the default chart series.

Click to customize the color using the color picker.

The Label on Left check box indicates if the label should be shown on the left side of the check box.

Chart —

The Label text color property specifies the color of the text on the label associated with the point in the chart series. The text color is sometimes known as the foreground color. The Show labels property must be enabled to change the text color on the label. Click to customize the color using the color picker.

Screen (Default Chart) —

The Label text color property specifies the color of the text on the label associated with the point in the default chart series. The text color is sometimes known as the foreground color.

Click to customize the color using the color picker.

The Layer property specifies the name of the layer to which this object is assigned. Layers can be used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.

• Type the name of the layer into the Layer field (the name can be a previously created layer or a new layer).
• All layers are listed on the Layers pane, where you can manage the layers for the screen in design mode and run mode.

The Layers property is where you configure the properties required to display the layers that will appear on your map. Layer properties include its name, visibility, data source, facility source, and visuals, which can be an image, a geometric shape, or a Canvas object. You can add as many layers and items as you want to your map. Click to open the Map Layer Configuration dialog box.

The Legend date format property specifies the format for the dates used in the chart legend. Use this property to override the Default date format, which is configured in the Application settings page of the Backstage view. The default date format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2024/01/01 10:20:30.0001.

The Legend format property specifies the format for the text used in the chart legend. The text can display a static text string, such as a label, legend, tooltip, or a dynamic text string based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. In run mode, the tokens are replaced with the attribute's value. Click to configure the static text and/or property tokens using the CygNet Property String dialog box. The default format is %SiteService%:%PointIdLong%. For example, CYGDEMO.UIS: <FACILITY_UDC>.

Thin Web Client

This is the only chart legend property supported by TWC. If configured (to use a dynamic text string), or left empty (to use the series Name), the other legend properties will apply their default values: Legend date format: YYYY/MM/DD HH:MM:SS.fff; Legend location: bottom; Legend value format: #,##0.00; and Show legend: Yes.

The Legend location property specifies where the chart legend should appear, if it is shown. Options include: Left, Top, Right, or Bottom. The default value is Bottom.

The Legend value format property specifies the format for the legend's point value using any of the valid .NET standard or custom numeric format strings. The value format applies to a point's value, primary value, and alternate value properties. The default value format is #,##0.00, which corresponds to 123,456,789.12. Formats use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. Add additional zeros to show more decimal places.

The Line color property specifies the color used for the border line of the Shape.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Line style property specifies the style of the Shape's border line. Click to select from the following options: Custom, Solid, Dashed, and Dotted. The default value is Solid. Select Custom to define your own line style and enter the values in the Custom line style property.

The Line width property specifies the width of the Shape's border line.

The Lock property indicates whether the control is locked to the current position. A locked control cannot be moved via click and drag, or nudged with the arrow keys, or resized.

The Long point ID property specifies the long point ID of the CygNet point for which the control is to display data. Type the tag into the field.

The Low range color property specifies the color to be used at the low end of the value range. Click to customize the color using the color picker.

The Lower value bound property specifies the lower value to use when filling the control.

The value bound can be explicitly configured (by selecting <Self>) or the value can be sourced from an attribute of the associated point (by selecting Point Attribute). The following fields are available to store an attribute that can be used to indicate the value bound.

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the value bound in the Value field.
  • Point Attribute — Select Point Attribute to specify that the source of the value bound corresponds to a point attribute of the associated point represented in the control.
• Value — Configuration depends on the source:
  • If the Source is <Self>, select a number using the spin control. The default value is 0.
  • If the Source is Point Attribute, click to select from the following point attribute options:
    • Indexed 1, 2, 3 attributes — An application-specific point property of the associated point. The property that is included in a defined PNT index. This can be free-form text up to 15 characters. Three indexed fields are available for configuration on the Application page of the PNT Editor.
    • General 1, 2, 3 data field attributes — An application-specific property of the associated point. The point property can be free-form text up to 20 characters. Three data fields are available for configuration on the Application page of the PNT Editor.
    • Minimum setpoint — Note: Applies only to Analog points types.
      • For Analog Output points, this specifies the minimum allowable setpoint for the associated point.
      • For Analog Input points, this specifies the low range for point values for the associated point.
      • Configured on the Analog page of the PNT Editor.
    • Maximum setpoint — Note: Applies only to Analog points types.
      • For Analog Output points, this specifies the maximum allowable setpoint for the associated point.
      • For Analog Input points, this specifies the high range for point values for the associated point.
      • Configured on the Analog page of the PNT Editor.

See Value bounds and Upper value bounds.

The Main screen path property specifies the path to the Canvas file that will be displayed when you click (Maximize) to maximize the tile and display a screen at the top of the Tile View when in run mode. Click (Minimize) again to return to the tiled view.

To configure the screen path click to open the Open Files dialog box, where you can access:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

The Marker border color property specifies the color used for the border of the triangular marker in the Value Indicator.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker color property specifies the color used for the value marker on the Donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker fill color property specifies the color used for the interior of the triangular marker in the Value Indicator.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal three options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme.
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is <Self>. Click to customize the color using the color picker.

The Marker height property specifies the height of the triangular marker for the point value on the Donut.

The Marker width property specifies the width of the triangular marker for the point value on the Donut.

The Max value property specifies the maximum acceptable value for the DEID. The value entered at runtime is validated that it falls within the configured range.

The Maximum Y value property specifies the maximum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

The Maximum zoom level where this visual item will be displayed on the map layer. For reference, the following values approximate the zoom levels: World = 2, State = 4, Region = 10, City = 14, Neighborhood = 18.

The Navigator Menu Configuration dialog box displays all the menu items that will appear in the Navigator's menu, and each menu item's properties: label, screen path, whether this screen is the start screen, icon path, and an icon preview.

Click to open the Navigator Menu Configuration dialog box.

The Menu item label property specifies the label for an item in the Navigator menu.

The Menu width property specifies the width of the main Navigator menu in expanded mode. The default value is 150 pixels. The minimum width is 40 pixels.

The Message property specifies the instructional message that will appear at the top of the SetPoint button dialog box. Click to configure the static text and/or property tokens using the CygNet Property String dialog box.

The Min value property specifies the minimum acceptable value for the DEID. The value entered at runtime is validated that it falls within the configured range.

The Minimum Y value property specifies the minimum value to use on the sparkline's y-axis when the Auto range - y-axis property is set to fixed (disabled).

The Minimum zoom level where this visual item will be displayed on the map layer. For reference, the following values approximate the zoom levels: World = 2, State = 4, Region = 10, City = 14, Neighborhood = 18.

The Mode property indicates the map view mode to use when the map is first displayed. Options include:

• Road — Displays road imagery with labels, which is a set of static tiles generated ahead of time and then stored and served. Road is the default mode and is supported by all map providers.
• Aerial — Displays worldwide orthographic aerial and satellite imagery with labels. You can hide the labels at runtime using the map toolbar. Note that the Aerial mode is only supported by Bing Maps in Canvas and by Azure Maps in TWC. See Using a Map in Run Mode.

The Mouse cursor property determines which mouse cursor will appear when the mouse hovers over this control or map visual. Select an option from the drop-down menu: Arrow (), Hand (), Wait (), or Help (). The default cursor is the Arrow ().

DDS Button, Image, Navigation Button, UIS Command Button —

The Mouse cursor property determines which mouse cursor will appear when the mouse hovers over this control or map visual. Select an option from the drop-down menu: Arrow (), Hand (), Wait (), or Help (). The default cursor is the Arrow ().

The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Special characters and spaces are not permitted. Names cannot start with a number; an underscore will be prefixed if the control name starts with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane.

The Name specifies the name that appears in the column header.

The Name property specifies the name of the alarm filter that appears on the Alarm Grid's toolbar.

The Name property specifies the label for the selected chart series, which is displayed in the upper right corner of the chart.

The Name specifies the name of the map layer.

The Name specifies the name of the visual item on the map layer.

The Note attribute property specifies the note attribute that will displayed in the column. Click to reveal a drop-down menu of all available CygNet note attributes categorized by type:

• Note: General Attributes (The default value is Note Summary.)
• Note: Text Attributes
• Note: Table-driven Attributes
• Note: Yes/No Attributes

Click to expand each category and select the desired note attribute.

The Note SiteService property specifies the Note service to use for this Note Grid. Click to select a Note service using the Select Service dialog box.

The Note type property specifies the user-defined note type to be displayed in the Note Grid. Notes can be categorized by type to provide a way to define the kinds of notes appropriate to your organization, to more easily filter existing notes, and to comprise an entire note when only a simple label adequately describes a note. Type the note type defined in your NOTE service. Leave empty to display all notes.

The Number of cards property determines the maximum number of cards to be displayed on a control for each card type. Select a number between 1 and 5.

The Object limit property specifies the maximum number of objects to be added to each page of the container. Use this value to limit the number of objects and improve performance when loading an unexpectedly large number of objects.

If the visual item on the map layer is an object, you can specify a Canvas object file (.cob) to represent facility locations on the map layer, for example, a small object could display details about a facility location on the map. Browse for the object file (.cob).

Click to select a path and file from the Open / Open File / Select File dialog box, where you can access:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

This property specifies the source of the file, object file, screen file, image file, or video file. Options include:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

The Override chart dates check box indicates whether to use the screen's dates, when displaying charts for this screen.

Select the Override chart's facility check box to specify a different facility for this chart series. Once checked a facility field is revealed where you can override the facility configured for the chart. The chart's facility is specified in the CygNet Connection property group.

If Override chart's facility is selected the Resolve to a relative facility option is removed.

Select the Override chart's SiteService check box to specify a different SiteService for this chart series. Once checked a SiteService field is revealed where you can override the SiteService configured for the chart. The chart's SiteService is specified in the CygNet Connection property group.

The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

The data group Ordinal property specifies the ordinal or instance of the data group type specified on the Data Group Properties page of the remote device editor. Each data group added to a remote device is identified by a number called an ordinal. If a remote device requires multiple instances of a data group, the group is defined only once in the device template file, but multiple instances of the data group, each with a unique ordinal, can be added in the device in the DDS.

The Paging enabled check box indicates whether to enable a navigation interface to page through the remainder of the objects that exceed the Object limit property.

• If paging is enabled a pagination toolbar is added to the bottom of the Object Container, indicating the total number of pages, with buttons for paging through the objects. In run mode use the arrows and page numbers to click through the pages of objects.

• If paging is disabled a message displays indicating that the maximum number of objects is reached (as specified in the Object limit property) and the total number of objects available.

The Pan mode property allows users to pan in the chart plot area when there is a dense area of data points that cannot be seen clearly at the normal chart scale. With Pan enabled you can reduce or expand the area you want to examine using the scroll bars, and then drag the chart within the pan region horizontally, vertically, or in both directions. Options include:

• None — Panning with the mouse is disabled.
• Horizontal — Panning with the mouse is enabled only on the horizontal axis.
• Vertical — Panning with the mouse is enabled only on the vertical axis.
• Both — Panning with the mouse is enabled both on the horizontal and vertical axes. You can use this value to remove any restrictions, thus the chart can be panned on both the horizontal and vertical axes.

The default value is None.

See Pan Offset Changed for related event.

The Parameters property specifies the command’s parameter(s) and their values. That is, the component parameter for which the button is going to set a value. Typical parameters include values, start dates, end dates, and counts.

• Set the parameter value to a literal value (e.g., Value=100, where Value is the parameter name and 100 is its value).

The Path property specifies the path to the global settings file (.gsf) for the screen or object. When a new screen is configured, the path to the global settings file specified in the General Settings is copied to the screen. See Configuring Global Settings for more information about this file. The global settings file must be saved in the BSS. Click to access the Select File dialog box to access an APPS or BSS folder.

The Rollup period property works in conjunction with the Rollup unit to define the interval by which a specified Rollup type takes place. For example, if you selected Minutes from the Rollup unit drop-down menu, then typed 3 in the Rollup period field, rollups for the control would occur every three minutes. Enter only whole numbers.

The Play mode property determines how the video will play in run mode. Click to select from the following options:

• Auto — The video will play in a continuously loop. You have no control over play and pause as those buttons are invisible.
• Manual — The video playback is handled using (play) and (pause) buttons. This is the default option.

The Point property is used to determine how the CygNet point will be configured. Click the appropriate radio button to reveal the desired field.

• UDC — The UDC property specifies the UDC for which the control is to display data. Click to select a UDC using the Select UDC dialog box.
• Long point ID — The Long point ID property specifies the long point ID of the CygNet point for which the control is to display data. Type the tag into the field.

The Point attribute property specifies the CygNet point attribute that will be displayed in the column. Click to reveal a drop-down menu of all available CygNet point attributes categorized by type:

• Current Values (The default value is Value.)
• Point: General
• Point: Alarm
• Point: Point Reference
• Point: Application
• Point: Scaling
• Point: Hyperpoint
• Point: Alarm (Scheme 0)
• Point: History
• Current Value Status Bits

Click to expand each category and select the desired point attribute.

Alarm Grid —

A point column presents data for a point by UDC and point attribute. You can choose to resolve the point to a relative facility if desired. The property sheet displays Common and Point properties. Point column types also support a Summary row at the bottom of the grid that can show the following values for the data in the column: a total Count, a Sum, the Min value, the Max value, the Min and Max values, and the Mean value.

CygNet Grid —

A point column presents data for a point by UDC and point attribute. You can choose to resolve the point to a relative facility if desired.

Point column types also support a Summary row at the bottom of the grid that can show the following values for the data in the column: a total Count, a Sum, the Min value, the Max value, the Min and Max values, and the Mean value.

The Point configuration property is used to configure the CygNet point associated with the control. Click to reveal a drop-down area where you can configure the Selection mode, source Facility tag, source SiteService, source Facility, and the UDC or Long Point ID for the point. Each option is described below.

See each control for more information about configuring points.

The point scheme defines the point types, point alarms, point statuses, and default colors for a CygNet domain.

The Point size property specifies the size of the point displayed on the default chart series. The default value is 5.

Point state is the highest precedented state for a point record as defined for each point scheme. The point state for a point record is based on 48 System, Configuration, and User status bits, which are associated with the four point types (Analog, Digital, String, Enumeration). A point record may contain up to 48 status bits, which are used to provide point status information about the point record in a CVS and the ELSALM. A point can be in multiple states at the same time, for example, in High Warning and High Alarm; however, the state defined to be the most severe is the one that is used for the point state (i.e., High Alarm, in this case).

The point types are configured for the selected point scheme for your CygNet system. The default CygNet Standard Point Scheme has eight point types: Analog Input & Analog Output, Digital Input & Digital Output, Enumeration Input & Enumeration Output, and String Input & String Output.

The Y-axis Position property specifies the location of the y-axis on the chart. Options include: Left or Right. The default value is Left.

Scripting Note

Prior to v9.5 the script property name for Position was YAxisLabelPosition, which is now obsolete, although it is retained for backwards compatibility.

Use Chart.AxisY Position to manipulate a y-axis in script. For example:

1
2
3
var axis = Objects.Chart1.AxisY.First();
 
axis.Position = HorizontalPosition.Right;

Note that

The Prompt type property contains three radio buttons to indicate what type of prompt to display. Select the desired option:

• No prompt — No prompt will show and the UIS command will be sent when the button is clicked. This is the default option.
• Prompt for confirmation — A prompt will show asking the user to Confirm that they want to send the UIS command. If the user clicks Cancel the command is not sent.
• Prompt for value — A prompt will show asking the user to enter a parameter value for the command and then click Send to execute the command.

Use the Properties to Search property to select the facility properties (attributes) that will be searched in the Search Box. Click to open the Properties to Search dialog box and select the facility attributes to use. Searching many attributes and searching non-indexed attributes may negatively impact performance. The default attributes are Facility Description and Facility ID.

See Use point state color?

The Read only property indicates whether the cells in a Generic column are editable. (Generic column only)

The End relative date or Relative end date or End property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.

Relative Facility Tree —

The Relative link property is where you configure the relative facility link for the Relative Facility Tree. Click to reveal a drop-down menu of all available relative links. Select a link from the list.

The Begin relative date or Relative start date or Start property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time.

The Resolution mode property determines how a point's status should be used to select images to display. The image will display based on the point state or the alarm condition of the associated point. The point state of the associated point is evaluated to determine which image to display. Options include:

• Point state — all possible point states are included
• Alarm condition — only point states marked explicitly as an alarm condition in the CVSMetadata are included (point states with the alarm condition attribute set to "true")

The default option is Point state. Point-state-aware images are configured in the Images property.

The Resolve filter if no facility check box indicates whether to use the facility filter to resolve against all facilities if no facility is provided. If a facility is set for the Object Container, then it will search the child facilities of that facility using the provided facility filter. By enabling Resolve filter if no facility, the Object Container will use the provided facility filter against all facilities for the specified SiteService.

The Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed.

See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.

The Ring color property specifies the color used for the outer ring that represents the point value in the Donut.

The color can be sourced from one of three options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color will be sourced from the point state of the associated point (by selecting Point State).
3. The color can be customized (by selecting <Self>).