SetPoint Button Tool - Configuring a Prompt

The Prompt page is where you define the properties of the prompt dialog box for the SetPoint Button. This prompt is highly customizable, including:

The prompt can be previewed as you work to make sure you get what you expect.

SetPoint Button - Propmpt Page

Click the thumbnail to see
a sample Prompt page

The properties for each section or button on this page are described below.

Prompt Properties

The following table lists and describes Prompt page properties.

Property Description

Prompt for value/confirmation

Indicates that the SetPoint Button will prompt a user for a value or a confirmation. The prompt dialog box will optionally ask you to enter a value (specifically or via an analog slider), optionally specify timestamp options, and optionally what to do with the unreliable status bit when setting a value for the target point.

Caption Specify the title caption of the prompt dialog box.

Message

Specify the instructional message to display on the prompt dialog box.

Background color…

Click Background color… to specify the background color of the prompt dialog box using the Color dialog box.

Confirm button

Caption

Specify the text to use on the Confirm button of the prompt dialog box. The default text is "Set."

Background color…

Click Background color… to specify the background color of the Confirm button using the Color dialog box.

Font…

Click Font… to view the Font dialog box from where you can configure the font to use on the Confirm button. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt).

Cancel button

Caption

Specify the text to use on the Cancel button of the prompt dialog box. The default text is "Cancel."

Background color…

Click Background color… to specify the background color of the Cancel button using the Color dialog box.

Font…

Click Font… to view the Font dialog box from where you can configure the font to use on the Cancel button. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt).

Displayed items

Value

Select the appropriate display setting for the value field on the prompt dialog box. Also see Value on the Default Value page.

Options include:

  • Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
  • Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
  • Hidden — Do not display the settings in the prompt dialog box.

Display units

Click to display the target point's units on the prompt dialog box. The units are displayed next to the value box and are for display purposes only. If selected, there are two options:

  • Use target point units — the units of the target point will be used when updating the point. When pulling units from a target point, the prompt dialog box will show the appropriate Primary or Alternate units determined by the Workspace Units setting. The units will be displayed at runtime.
  • Use specific units — select desired units from the drop-down menu. The default or entered value will be converted to the specified units in the same unit family.

A Note About Unit Conversion

Unit conversion will take place if the target point is of the analog point data type and has configured Primary units. The SetPoint operation will convert units in the same unit family when units are configured to be displayed in the prompt dialog box and a compatible unit is selected from the drop-down menu.

Both the default value and the analog minimum and maximum values will be converted to the selected units.

For any default specific value, analog minimum specific value, and maximum values specific value, the units are assumed to be those of the target point's Primary or Alternate units as determined by the Workspace Units or TheView [Units] setting.

When doing unit conversions checks are performed to see if the default value alternate point, analog minimum (alternate) point, and analog maximum (alternate) point are of the analog point data type. If not, then an error will be raised.

For any initial status point value or status completion value specified by the user, the units are assumed to be those of the status point's Primary units. If status completion is dependent on a target point value match, then appropriate conversions will be done before comparing the values.

Also see Primary units and PNT Engineering Units for more information about point units.

Timestamp

Select the appropriate display setting for the timestamp field on the prompt dialog box. The default Timestamp is configured on the Default Value page.

Options include:

  • Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
  • Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
  • Hidden — Do not display the settings in the prompt dialog box.

Unreliable bit

Select the appropriate display setting for the unreliable status bit field on the prompt dialog box. The default Unreliable bit setting is configured on the Default Value page.

Options include:

  • Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
  • Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
  • Hidden — Do not display the settings in the prompt dialog box.

Analog settings…

Click Analog Settings... to limit data to numerical entry. See Analog Settings below.

Preview prompt

Click to preview the prompt before committing to your choices.

Analog Settings

When prompting for a value, you can limit data to a numerical entry by using analog settings. The valid data range is specified in the Minimum and Maximum value settings. You can optionally provide an incremental slider control to further limit the value setting.

Note: Analog prompt settings can only be used with a target point whose point data type is analog.

SetPoint Analog Settings

Click the thumbnail to see
a sample SetPoint Analog Settings Dialog Box

The properties for each section or button on this dialog box are described below.

Property Description

Use analog settings

Indicate that the SetPoint prompt dialog box will interpret the value entered as numeric and will perform numeric range checking based on the limits provided.

Use analog slider control

Click to include a slider control on the prompt dialog box which can be manipulated to set a numeric value within the specified range. The range of the slider is set by the Minimum and Maximum value properties and the increment is specified by the Increment property.

Increment

Specifies the increment applied to the slider position when the arrow keys are pressed or the slider thumb is dragged. Default is 1.

Minimum value/

maximum value

Indicate the minimum and maximum values to use for the numeric data range. Select from one of the following options:

  • a specific value
  • the minimum and maximum values of the target point stored in its point configuration record on the Analog page.
  • the current value of another point (The alternate point can be explicitly defined allowing a templated point tag, inheriting some or all of the point identifier properties from the button properties or from a reference facility. Alternatively you can specify a fully qualified point tag.)

Use specific value

Click to use a static minimum and maximum value and then specify the value to be used. The default minimum value is 0 and the default maximum value is 100.

Use minimum value/maximum value of target point

Click to use the minimum and maximum values of the value range of the target point stored in its point configuration record on the Analog page. See Value range:minimum and Value range:maximum for more information.

Use current value of another point

Click to use the current value of another point, and then specify the point tag.

For instance, you might not know what the minimum and maximum values are, but you can read those values from a PLC in the plant, so you could configure to get the values from another point in the system.

As in other places, the alternate point can be explicitly defined allowing a templated point tag, inheriting some or all of the point identifier properties from the button properties or from a reference facility. Alternatively a fully qualified point tag may be specified.

  • Inherit point tag from button properties:

Click to inherit the point tag elements from the values configured for the button object. Optionally you can override to inherit some or all of the point tag elements, or choose to use a reference facility. An inherited point tag is the default option for the point.

  • Use reference facility tag — Click to use the Facility ID or facility tag specified in the [ReferenceFacility] property. See Configuring a Reference Facility for more information. Optionally you can override the UDC and further customize the point's UDC.
  • CVS Site.Service — Click to override and browse to further specify the point's Current Value Site.Service using the Select Service dialog box.
  • Facility ID — Click to override and browse to further specify the point's Facility ID using the Select a Facility dialog box.
  • UDC — Click to override and browse to further specify the point's UDC using the Select a Uniform Data Code dialog box.
  • Full point tag — Click ... to open the Select Point dialog box, then select the CVS Site.Service and point to use for the target point.

Note: The prompt settings are also accessible within a scripting environment via the Prompt property.

Back to top