Scripting > CxHmiFms > CxFmsJobsCtrl Object > CxFmsJobsCtrl Properties

CxFmsJobsCtrl Properties

The CxFmsJobsCtrl object contains the following properties.

General Properties

Property SubType Read Only Description

Appearance

Integer

No

Returns/sets the appearance of the object boundary.

Possible values for this property are as follows.

  • 0 – Flat
  • 1 – 3D

Default value is 0 - Flat

BeginDate

String

No

Returns/sets the starting date of the FMS Jobs control. 

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is T-7

BorderStyle

Integer

No

Returns/sets the border style.

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed Single

Default value is 0 - None

ChooserAllowMultiSelect

Boolean

No

Returns/sets whether or not the user can select multiple Nodes in the Node chooser. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ChooserFilterString

String

No

Returns/sets the filter to be used when retrieving Nodes.  Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place.

Example

A filter string of “*Test*” will retrieve all Nodes with the word “Test” somewhere in the string, such as “TestDevice” or “MyTestDevice” or “Device001Test”.

Default value is * (multiple character wildcard)

ChooserFilterType

Integer

No

Returns/sets the Node property that will be filtered by the string specified in the ChooserFilterString property. Possible values for this property are as follows.

  • 0 – Name
  • 1 – Description
  • 2 – ID

Default value is 0 - Name

ChooserGroupSelection

String

No

Returns/sets the group currently selected in the Node chooser’s Group combo box.

ChooserNodeCategorySelection

Integer

No

Returns/sets the Node category currently selected in the Node chooser’s Node category combo box. Possible values for this property are as follows.

  • 6 – Node_Category_Any
  • 2 – Node_Category_Group
  • 1 – Node_Category_Device
  • 8 – Node_Category_Gas_Device
  • 9 – Node_Category_Liquid_Device
  • 13 – Node_Category_Accessory
  • 3 – Node_Category_Station

Default value is 8 - Node_Category_Gas_Devices

ChooserNodeCategoryVisible

Boolean

No

Returns/sets whether or not the Node chooser’s Node category combo box is visible. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ChooserPrimarySortColumn

Integer

No

Returns/sets the primary sort column of the Node chooser’s Node list.

Possible values for this property are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Default value is 2 - Name ascending

ChooserSiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the Node chooser’s FMS service combo box.

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS service combo box is visible. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

CmdDefinitionXml

String

No

Returns/sets the XML specifying the custom FMS commands configured for the control.  Another way to configure this property is to use the control’s property page.

DateFormat

Integer

No

Returns/sets the format of the dates shown in the FMS Jobs control.

Possible values for this property are as follows.

  • 0 — Device time
  • 1 — Contract time
  • 2 — Local time

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is 0 — Device time

EndDate

String

No

Returns/sets the ending date of the FMS Jobs control. 

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Default value is T

Font

StdFont

No

Returns/sets the font used by the FMS Jobs control. Click to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

JobTypeFilterView

String

No

Returns/sets the type of jobs to display in the FMS Jobs control. Type the name of a job type into the text box to define the filter view desired.

Options are as follows.

  • <Any>
  • Auto-calibration
  • Calibration
  • Gas Sample
  • [User-supplied value options]

Note: Job types are configured in CygNet Dispatch or in FMS Explorer via the Extended Command Options on the Job Schedule Configuration page.

Default value is <Any> jobs.

PITDateTime

String

No

Returns/sets the Point in Time date and time of the FMS Jobs control. 

This string can be in one of the following forms.

  • Absolute Date/Time (for example, 1/31/2019 7:10:14 AM)
  • Relative Date/Time (for example, y-1 m-2 d=15 H=5 M=30 S=0)
  • Relative Day, which is an offset from the current day T (for example, T-10)

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

Note: This property is only used if the UsePIT property is set to 1 - Yes.

SessionBeginDate

String

No

Returns/sets the Session starting date for the time window displayed in the control. 

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionDateFormat

Integer

No

Returns/sets the Session date/time format for the time window displayed in the control. Possible values for this property are as follows.

  • 0 – Device_Time
  • 1 – Contract_Time
  • 2 – Local_Time

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionEndDate

String

No

Returns/sets the Session ending date for the time window displayed in the control. 

This string can be in one of the following forms.

  • Absolute date, for example, 1/31/2019
  • Relative date, for example, T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionNodeTag

String

No

Returns/sets the Session Node tag, which specifies the active Node in the FMS Jobs control.  This tag must be in the form SITE.SERVICE|ID (for example, TEST.FMS|2540).

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

ShowApprovedJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Approved" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowBlockedJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Blocked" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowChooserPane

Boolean

No

Returns/sets whether or not the Chooser pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowCompletedJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Completed" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowMissingDataJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Missing Data" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowOpenJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Open" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowPendingApprovalJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Pending Approval" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowReviewJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Review" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowVerifiedJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Verified" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

ShowWaitingForEventsJobs

Boolean

No

Returns/sets whether or not jobs with a status of "Waiting for Events" will be displayed in the control.

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

UnitSet

String

No

Returns/sets the unit set used to determine the units of each FMS data item in the FMS Jobs control.  Another way to configure this property is to use either the control’s property page or to use the Options page on the FMS Jobs control.

Default value is the <Default> unit set

UsePIT

Boolean

No

Returns/sets whether or not the PITDateTime property will be used.

Possible values for this property are as follows.

  • 0 – No
  • 1 – Yes

Default value is 0 - No

UseSessionNode

Boolean

No

Returns/sets whether or not the SessionNodeTag property will specify the active Node in the FMS Jobs Grid.  If this property is set to 0 - No, the FMS Jobs Grid will present a Chooser page for selection of the active Node. Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes

Note: The Use Session Node property default value is 1 - Yes/True for Data controls (Alarm, Configuration, History Graph, History Grid, Raw Data). The property default value is 0 - No/False for Summary controls (Dashboard, Exceptions) and Admin controls (Balance, Jobs; not applicable to Close Period, PPA).

UseSessionOptions

Boolean

No

Returns/sets whether or not the SessionBeginDate and SessionEndDate properties will be used in place of the BeginDate and EndDate properties.

Possible values for this property are as follows.

  • 0 – No
  • 1 – Yes

Default value is 0 - No

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.