Customizing the Well Test Configuration Screen

The Well Test Configuration sample screen (Well Test Configuration.can) is a Canvas screen that can be used to easily load, configure, and save the XML required by the CygNet Well Test module using a friendly user interface. The sample screen contains several Canvas controls, including a Text tool, Edit Box, Combo Box, Buttons, and a Well Test Control.

This file can be customized to suit the needs of your enterprise.

The Well Test Control has three optional sections (Templates, Headers, and General). You can decide which sections are visible allowing for the creation of an operator-focused screen that can limit well test configurations.

Perform the following steps to customize the well test configuration screen.

  1. Start Canvas.
  2. Install and enable the CygNet.API.WellTest.Controls.dll plugin via the Backstage view.
  3. Open the Well Test Configuration.can sample screen in Design mode.
  4. Click on the Well Test Control, access the Property pane, and configure any properties as necessary. The following tables describe the property names visible in the Properties pane and the corresponding script property name. See the CygNet Canvas section for user assistance on designing Canvas screens.
    Tip: You can change the background color of the screen, hide the Alarm Notifier, or change other screen properties in Design mode.
  5. Save the screen.
  6. Run the screen (F5) to test your configuration.
UI Property Script Property Description
Name Type Style

Name

ControlName

The Name property specifies the unique identifier for this control.

Naming standards are as follows:

Component Valid Character Set Limits

Control Name

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z (uppercase)
0 1 2 3 4 5 6 7 8 9
_(underscore)

Cannot begin with a number; an underscore will be prefixed if the control name begins with a number

No special characters

No spaces

The default value is the object name and the numeric instance

Type

ControlType

The read-only Type property displays the type for the control: Chart, Grid, Heat Map, Object Container, Tag Chooser, View, etc. …

Style

 

The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type.

  • Click the down arrow to reveal a drop-down menu of predetermined styles configured for the selected control.
  • Select a desired style and its properties will be applied to the control.
  • Alternately, you can create a new style based on other property values configured for the control.
  • Or you can select <None> to remove subscription to any style.
Location

Height

Height

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

Tip: You can also change the height of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode).

Horizontal resize mode

HorizontalResizeMode

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.

Layer

Layer

The Layer property specifies the layer for this control. Layers are 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.
  • All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode.

Tip: You can also edit a control's Layer on the Controls view of the Screen pane.

Lock

IsLocked

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.

Tip: You can also toggle the lock setting of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode).

Vertical resize mode

VerticalResizeMode

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

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

The default value is None.

Visible

IsVisible

The Visible check box indicates whether the control is visible in run mode.

Tip: You can also change a control's Visible setting on the Controls view of the Screen pane.

Width

Width

The Width property specifies the width of the control (or screen).

Tip: You can also change the width of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode).

X

X

The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

Y

Y

The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels.

Tip: You can also change the location of the control using the Settings pane; click on the Settings icon (Settings) to the right of the control in design mode.

Z index

ZIndex

The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer).

Tip: You can also change the Z index of a control using the Settings pane (click on the Settings icon (Settings) to the right of the control in design mode).
Script

Include in script

IncludeInScript

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.

Tip: You can also change the Include in Script setting on the Controls view of the Screen pane.
General

Path

Path

The Path property specifies the path to the well test configuration XML. To avoid having to repeat this every time you open the file you can add the path in design mode and save the screen.

Path type

PathType

The Path type property specifies the default path type of the well test configuration XML. Options include: Local, BSS, or Point.

The well test configuration XML can be written to a configuration point in the PNT as PNT HyperPoint script text.

Show general

ShowGeneral

The Show general check box indicates whether to show the General page on the Well Test Configuration screen. The default value is true: show the page.

Show headers

ShowHeaders

The Show headers check box indicates whether to show the Headers page on the Well Test Configuration screen. The default value is true: show the page.

Show templates

ShowTemplates

The Show templates check box indicates whether to show the Templates page on the Well Test Configuration screen. The default value is true: show the page.
Generic

String

String

The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary.

Yes/No

YesNo

The Yes/No property specifies a generic Boolean yes/no property that can be used when scripting this control. Click the check box to enable the property and reference it in your script as necessary.