GlobalFunctions Methods

Global methods can be used in HyperPoints or in CygNet Studio without importing the library. To use them in other environments, create a COM component from the CxScript.GlobalFunctions library. Global methods include the following:

AcknowledgeAlarm

The AcknowledgeAlarm method acknowledges an alarm for a specified point.

Syntax

AcknowledgeAlarm(Tag As String)

Parameters

Remarks

This method will only work in Live Mode. Enable or disable Live Mode using EnableLiveMode.

Example

The following example acknowledges an alarm.

1
2
3
4
5
6
Sub ackAlarm()
    EnableLiveMode True
    AcknowledgeAlarm "CYGDEMO.UIS.00000042"
    edtMessageBox.Text = "Alarm acknowledged"
    EnableLiveMode False
End Sub

AddAuditTransactionComment

The AddAuditTransactionComment method adds a comment for an Audit Transaction in the specified Service.

Syntax

AddAuditTransactionComment(SiteService As String, AuditTransactionId as Unsigned Long, TransactionComment As String)

Parameters

Remarks

If the AuditTransactionId is invalid, no error will display.

Example

The following example adds a comment to transaction 1337 in CYGDEMO.UIS.

1
2
3
4
Sub addAuditComment()
    AddAuditTransactionComment "CYGDEMO.UIS", 1337, "This is a generic comment."
    edtMessageBox.Text = "Comment added"
End Sub

AdjustTime

The AdjustTime method adjusts a date time by the specified adjustment string.

Syntax

AdjustTime(ReferenceTime As Date, Adjustment as String) As Date

Parameters

Example

The following example displays the current time and the adjusted time.

1
2
3
4
5
6
7
8
9
10
11
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim dtNow, dtThen
    dtNow = Now()
    dtThen = GlobalFunctions.AdjustTime(dtNow, "y-1 m-1 d-1 H-1 M-1 S-1")
     
    MsgBox dtNow
    MsgBox dtThen
End Sub

ConvertLocalTimeToUTCTime

The ConvertLocalTimeToUTCTime method converts a local time to UTC.

Syntax

ConvertLocalTimeToUTCTime(LocalTime As Date) As Date

Parameters

Example

The following example converts the current local time to UTC and displays both.

1
2
3
4
5
6
7
8
9
10
11
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim dtLocal, dtUtc
    dtLocal = Now()
    dtUtc = GlobalFunctions.ConvertLocalTimeToUTCTime(dtLocal)
     
    MsgBox dtLocal
    MsgBox dtUtc
End Sub

ConvertUTCTimeToLocalTime

The ConvertUTCTimeToLocalTime method converts a UTC time to local time.

Syntax

ConvertUTCTimeToLocalTime(UTCTime As Date) As Date

Parameters

Example

The following example converts the current local time to UTC and back to local, and displays both.

1
2
3
4
5
6
7
8
9
10
11
12
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim dtLocal, dtUtc
    dtLocal = Now()
    dtUtc = GlobalFunctions.ConvertLocalTimeToUTCTime(dtLocal)
    dtLocal = GlobalFunctions.ConvertUTCTimeToLocalTime(dtUtc)
     
    MsgBox dtUtc
    MsgBox dtLocal
End Sub

CreateAuditTransaction

The CreateAuditTransaction method creates an Audit Transaction in the specified Service.

Syntax

CreateAuditTransaction(SiteService As String, OperationId As String, OperationDescription As String, TransactionComment As String) As Long

Parameters

Remarks

Return Value: The Audit Transaction ID of the new transaction.

Example

The following example creates an Audit transaction and displays its ID to the user.

1
2
3
4
5
Sub createTransaction()
    Dim iAudit
    iAudit = CreateAuditTransaction("CYGDEMO.UIS", "UISCMD_PERFORM", "Perfrm UIS Command", "")
    edtMessageBox.Text = "Transaction " & iAudit & " created"
End Sub

CreateWaitCursor

The CreateWaitCursor method creates a scoped WaitCursor object, changing the cursor to a wait cursor (for example, hourglass or other image) for the duration of the current scope.

When a WaitCursor object is instantiated via script, screens will "remember" that the cursor needs to be set back to the wait cursor if other components modify the cursor state for any reason. The cursor is set back to normal after the wait cursor object goes out of scope.

Syntax

CreateWaitCursor() As WaitCursor

Remarks

This method will only work when called within a process with user-visible windows (not command-line windows), such as CygNet Studio.

Example

The following example displays a wait cursor for the duration of a process.

1
2
3
4
5
6
7
8
9
10
Sub doCalculation()
    Dim objWaitCursor
    Set objWaitCursor = CreateWaitCursor()
     
    Dim bDone
    bDone = False
    While Not(bDone)
    'do some work
    Wend
End Sub

EnableLiveMode

The EnableLiveMode method enables or disables live mode.

Syntax

EnableLiveMode(Enable As Boolean)

Parameters

Remarks

Live mode must be enabled prior to using potentially harmful functions, like SendUISCommand and SetPoint. Live mode is enabled by default in HSS, but is disabled by default in CygNet Studio.

Example

This following method demonstrates enabling live mode in CygNet Studio before issuing a SetPoint command.

1
2
3
4
5
Sub SetPointValue(newValue)
    'Enable live mode before calling a setpoint
    EnableLiveMode(True)
    SetPoint "CYGDEMO.UIS:POINT1", newValue, Now, 0
End Sub

EncryptString

The EncryptString method encrypts a string.

Syntax

EncryptString(Source As Date, DestString as String) As Boolean

Parameters

Remarks

This method will always return true.

Example

The following example encrypts a string and displays it in a message box.

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strEncrypted
    GlobalFunctions.EncryptString "My string", strEncrypted
     
    MsgBox strEncrypted
End Sub

GetAlarmState

The GetAlarmState method returns the alarm state.

Syntax

GetAlarmState(Status As Integer) As AlarmState

Parameters

Remarks

Return Value: The state of the alarm as an integer. See Alarm State Enumeration Constants for what these integers mean.

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example gets the alarm state for point 00000123.

1
2
3
4
5
Sub getAlarmState()
    Dim iState
    iState = GetAlarmState(00000123)
    edtMessageBox.Text = "Alarm state integer is " & iState
End Sub

GetAssociatedAcsName

The GetAssociatedAcsName method gets the associated ACS name.

Syntax

GetAssociatedAcsName(SiteService As String) As String

Parameters

Example

The following example displays a message box containing the ACS name.

1
2
3
Sub getAcs()
    MsgBox GetAssociatedAcsName("CYGDEMO.UIS")
End Sub

GetAssociatedAudName

The GetAssociatedAudName method gets the associated AUD service name.

Syntax

GetAssociatedAudName(SiteService As String) As String

Parameters

Example

The following example displays a message box containing the AUD service name.

1
2
3
Sub getAcs()
    MsgBox GetAssociatedAudName("CYGDEMO.UIS")
End Sub

GetAssociatedFacName

The GetAssociatedFacName method gets the associated FAC service name.

Syntax

GetAssociatedFacName(DdsCvsUisSiteService As String) As String

Parameters

Example

The following example displays a message box containing the FAC service name.

1
2
3
Sub getAcs()
    MsgBox GetAssociatedFacName("CYGDEMO.UIS")
End Sub

GetAssociatedPointCfgName

The GetAssociatedPointCfgName method gets the associated PNT service name.

Syntax

GetAssociatedPointCfgName(CvsUisSiteService As String) As String

Parameters

Example

The following example displays a message box containing the PNT service name.

1
2
3
Sub getAcs()
    MsgBox GetAssociatedPointCfgName("CYGDEMO.UIS")
End Sub

GetAssociatedServiceName

The GetAssociatedServiceName method returns the Site.Service of the specified type associated with the specified Site.Service.

Syntax

GetAssociatedServiceName(SiteService As String, ServiceType as String) As String

Parameters

Example

The following example encrypts a string and displays it in a message box.

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strSiteService
    strSiteService = GlobalFunctions.GetAssociatedServiceName("CYGDEMO.DDS", "TRS")
     
    MsgBox strSiteService
    End Sub

GetAssociatedTrsName

The GetAssociatedTrsName method gets the associated TRS name.

Syntax

GetAssociatedTrsName(SiteService As String) As String

Parameters

Example

The following example displays a message box containing the TRS name.

1
2
3
Sub getAcs()
    MsgBox GetAssociatedTrsName("CYGDEMO.UIS")
End Sub

GetAuditLevelGenserveInfoKeywords

The GetAuditLevelGenserveInfoKeywords method gets a list of valid audit level keywords for a service.

Syntax

GetAuditLevelGenserveInfoKeywords(SiteService As String) As Variant

Parameters

Remarks

Return Value: An array of keywords for the given service.

Example

The following example gets the audit level keywords for CYGDEMO.UIS and displays them in a list box.

1
2
3
4
5
6
7
8
Sub getGenserveKeywords()
    Dim arrList, item
    arrList = GetAuditLevelGenserveInfoKeywords("CYGDEMO.UIS")
     
    For Each item In arrList
        lstFacilities.AddString(item)
    Next
End Sub

GetCommandLineString

The GetCommandLineString method returns the command-line supplied to the calling application.

Syntax

GetCommandLineString As String

GetElapsedTime

The GetElapsedTime method returns the fractional seconds since the module load time.

Syntax

GetElapsedTime() As Double

Remarks

This method can be used in lieu of the VBScript Timer() method.

Example

The following example displays the elapsed time since the module load in a message box.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Sub
    WScript.Sleep(2000)
     
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim dSeconds1
    dSeconds1 = GlobalFunctions.GetElapsedTime()
     
    WScript.Sleep(2000)
     
    Dim dSeconds2
    dSeconds2 = GlobalFunctions.GetElapsedTime()
     
    MsgBox dSeconds1 'should display ~0 seconds
    MsgBox dSeconds2 'should display ~2 seconds
End Sub

GetEnumerationTable

The GetEnumerationTable method retrieves an enumeration table from a Table Reference Service.

Syntax

GetEnumerationTable(SiteService As String, TableName As String, EnumTable As Variant)

Parameters

Remarks

To view a list of all available table names, navigate to the specified TRS in CygNet Explorer. The returned array will include one blank record following the returned values (see example).

Example

The following method displays the table entries in the CMPTYPE table in a message box.

1
2
3
4
5
6
7
8
9
10
11
12
13
Sub ShowTableEntries ()
    Dim arrEntries, strDisplay, i
    strDisplay = ""
     
    'Get the table entries
    GetEnumerationTable "CYGDEMO.TRS", "CMPTYPE", arrEntries
     
    'Display each table entry
    For i=lbound(arrEntries) To ubound(arrEntries)-1
        strDisplay = strDisplay & arrEntries(i,0) & ":  " & arrEntries(i,1) & vbCr
    Next  
    MsgBox strDisplay
End Sub

GetFacilityInfo

The GetFacilityInfo method gets facility information from the DDS.

Syntax

GetFacilityInfo(DdsSiteService As String, Descriptor As String, FacilityInfo As Variant)

Parameters

Remarks

Possible descriptors:  DEVICE_ID, DEVICE_CATEGORY, DEVICE_TYPE, DEVICE_DESC, DEVICE_MANUF, DEVICE_MODEL, DEVICE_CLASS, DEVICE_REV, DEVICE_ENABLED, DEVICE_FACILITY, FACILITY_ID, FACILITY_DESC, FACILITY_TYPE, FACILITY_LOCATION, FACILITY_CONTACT. You can use CygNet Explorer, specifically the DDS and FAC service panes, to find possible values of the above parameters.

Example

The following function populates a list box, lstFacilities, with the facility names in the "CYGDEMO.UIS" service. The device descriptor, "DEVICE_CATEGORY=RD," restricts the returned list to remote devices that are enabled.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Sub ListFacilities ()
    Dim arrFacInfo, strDescriptor, strFacId
     
    'Get only enabled remote devices (RD)
    strDescriptor = "DEVICE_CATEGORY=RD;DEVICE_ENABLED=YES"
    GetFacilityInfo "CYGDEMO.UIS", strDescriptor, arrFacInfo
     
    'Extract each facility ID (the first field in the array) and
    'place in a list box
    For i = lbound(arrFacInfo) To ubound(arrFacInfo)
        strFacId = arrFacInfo(i, 0)
        lstFacilities.AddString(strFacId)
    Next
     
    'Leave the first item selected
    lstFacilities.Selection = 0
    lstFacilities.RunChange
End Sub

GetFacilityList

The GetFacilityList method returns a list of facility IDs in a CVS.

Syntax

GetFacilityList(CvsSiteService As String, FacilityList As Variant)

Parameters

Example

The following example fills a list box with facility names on the CYGDEMO.UIS.

1
2
3
4
5
6
7
8
9
10
11
12
Sub ListFacilities ()
    Dim arrFacs, i
    lstFacilities.ResetContent
     
    'Get facilities
    GetFacilityList "CYGDEMO.UIS", arrFacs
     
    'Display results in list box
    For i=lbound(arrFacs) To ubound(arrFacs)
        lstFacilities.AddString arrFacs (i)
    Next
End Sub

GetGenserveInfo

The GetGenserveInfo method gets a list of general information about a service.

Syntax

GetGenserveInfo(SiteService As String, Request As String, GenserveInfo As Variant)

Parameters

Example

The following method displays all executable-related parameters for a given service in a message box. The returned array will include one blank record following the returned values (see example).

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Sub ShowServInfo (strService)
    Dim arrServinfo, strRequest, i, strDisplay
    strDisplay = ""
     
    strRequest = "EXE_NAME;EXE_SIZE;EXE_TIME;EXE_VER"
     
    'Get the service information
    GetGenserveInfo strService, strRequest, arrServInfo
     
    'Display each service parameter
    For i=lbound(arrServInfo) To ubound(arrServInfo)
        strDisplay = strDisplay & arrServinfo(i,2) & ":  " & arrServInfo(i,1) & vbCr
    Next
    MsgBox strDisplay
End Sub

GetODBCConnectionString

The GetODBCConnectionString method returns the ODBC connection string for a given service filter.

Syntax

GetODBCConnectionString(SiteServiceFilter As String) As String

Parameters

Example

The following example retrieves the ODBC connection string for service filter "CYGDEMO.*".

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strOdbcConn
    strOdbcConn = GlobalFunctions.GetODBCConnectionString("CYGDEMO.*")
     
    MsgBox strOdbcConn
End Sub

GetServiceDef

The GetServiceDef method retrieves site service definition for a single specified service.

Syntax

GetServiceDef(SiteService As String, ServiceDef As Variant)

Parameters

Remarks

This method allows the retrieval of a service definition of a single service.  To retrieve service definitions of multiple services, use GetServiceDefs method.

Example

The following example retrieves the service definition for CYGDEMO.UIS and displays the service description in a message box.

1
2
3
4
5
6
7
8
9
Sub ShowUISDefs ()
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim aryServDef
    GlobalFunctions.GetServiceDef "CYGDEMO.UIS", aryServDef
     
    MsgBox aryServDef(4)
End Sub

GetServiceDefs

The GetServiceDefs method retrieves multiple service definitions for services within a specified ARS.

Syntax

GetServiceDefs(ArsSiteService As String, ServiceTypeFilter As String, ServiceStatusFilter As String, ServiceNameFilter As String, SiteNameFilter As String, ServiceDefs As Variant)

Parameters

Remarks

This method allows the retrieval of the service definitions of multiple services.  To retrieve the service definition of a single service, use GetServiceDef.

Example

The following method shows a message box listing the names and descriptions of all UIS, DDS, and FAC services in the system with status "OK".

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim aryServDefs
    GlobalFunctions.GetServiceDefs "PFAKE.ARS", "UIS;DDS;FAC", "OK", "", "", aryServDefs
     
    Dim strResp, i
    For i=lbound(aryServDefs) To ubound(aryServDefs)
    strResp = strResp & aryServDefs(i,0) & "  " & aryServDefs(i,4) & vbCr
    Next
     
    MsgBox strResp 
End Sub

GetTagList

The GetTagList method returns a list of point tags from a Point Service.

Syntax

GetTagList(PointCfgOrCvsSiteService As String, Filter As String, GetLongId As Boolean, TagList As Variant)

Parameters

Remarks

The returned tag list is an array of Point IDs in "Site.Service.PointID" format.

Example

The following example fills a list box, lstTags, with tags from the provided facility.

1
2
3
4
5
6
7
8
9
10
11
12
Sub DisplayTagList (facility)
    Dim arrTagList, i
    lstTags.ResetContent
     
    'Get tags from the facility
    GetTagList "CYGDEMO.PNT", "FACILITY=" & facility, False, arrTagList
     
    'Display results in list box
    For i=lbound(arrTagList) To ubound(arrTagList)
        lstTags.AddString arrTagList(i)
    Next
End Sub

GetUdcDescription

The GetUdcDescription method gets a UDC description based on a UDC name and service.

Syntax

GetUdcDescription(SiteService As String, Udc As String) As String

Parameters

Remarks

The returned value is the UDC description string.

Example

The following method demonstrates the usage of GetUdcDescription for a sample UDC, PSTATIC.

1
2
3
4
5
Sub ShowUDCDesc ()
    Dim desc
    desc = GetUdcDescription("CYGDEMO.UIS", "PSTATIC")
    MsgBox "PSTATIC Description: " & desc
End Sub

GetUdcFormatInfo

The GetUdcFormatInfo method gets the format of a UDC.

Syntax

GetUdcFormatInfo(SiteService As String, Udc As String) As String

Parameters

Remarks

Return Value: A string containing the format info for the UDC.

Example

The following example gets the format of a UDC and stores it in a text box.

1
2
3
4
5
6
Sub getFormat()
    Dim strRet
    strRet = GetUdcFormatInfo("CYGDEMO.UIS", "SVMSVST")
        edtMessageBox.Text = strRet
    End If
End Sub

GetUdcList

The GetUdcList method gets a list of UDCs in the specified facility.

Syntax

GetUdcList(FacilityTag As String, UdcList As Variant) As Type

Parameters

Example

The following example displays all the UDCs in CYG_METER.

1
2
3
4
5
6
7
Sub getUdc()
    Dim arrUDC, item
    GetUdcList "CYGDEMO.UIS::CYG_METER", arrUDC
    For Each item In arrUDC
        lstUDC.AddString(item)
    Next
End Sub

GetUisCommandList

The GetUisCommandList method gets a list of UIS commands for the specified facility.

Syntax

GetUisCommandList(UisOrDdsSiteService As String, FacilityID As String, SelectionMask As Integer, UisCmdInfo As Variant)

Parameters

Remarks

If you have more than one type of command you wish to retrieve, "OR" the constants from the CmdSelectionBits together and use the resulting value as the selection mask.

Example

The following function retrieves UIS command information for the METER206 facility and displays the command descriptions in a list box. The selection mask enables retrieval of parent and hidden data group information (1 + 4 = 5 = 00000101).

1
2
3
4
5
6
7
8
9
10
11
12
Sub ListUisCommands()
    Dim arrCmds, i
    lstCommands.ResetContent
     
    'Get command list
    GetUisCommandList "CYGDEMO.UIS", "METER206", 5, arrCmds
     
    'Display each command description in a list box
    For i=lbound(arrCmds) To ubound(arrCmds)
        lstCommands.AddString arrCmds(i, 2)
    Next
End Sub

GetUisFromDds

The GetUisFromDds method gets the UIS name from a DDS.

Syntax

GetUisFromDds(DdsSiteService As String) As String

Parameters

Remarks

Return Value: The name of the UIS, in "Site.Service" format. If DdsSiteService is invalid, an empty string is returned.

Example

The following example gets the UIS from CYGDEMO.DDS.

1
2
3
4
5
Sub getUIS()
    Dim strUIS
    strUIS = GetUisFromDds("CYGDEMO.DDS")
    edtMessageBox.Text = strUIS
End Sub

IsAnalogPoint

The IsAnalogPoint method returns true if the point type is analog.

Syntax

IsAnalogPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is an analog point.

1
2
3
4
5
6
7
Sub isAnalog()
    If IsAnalogPoint(277) Then
        edtMessageBox.Text = "Point 277 is an analog point"
    Else
        edtMessageBox.Text = "Point 277 is not an analog point"
    End If
End Sub

IsDigitalAlarm

The IsDigitalAlarm method returns true if the digital point is in the digital alarm state.

Syntax

IsDigitalAlarm(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in digital alarm.

1
2
3
4
5
6
7
Sub isDigAlarm()
    If IsDigitalAlarm(277) Then
        edtMessageBox.Text = "Point 277 is in digital alarm"
    Else
        edtMessageBox.Text = "Point 277 is not in digital alarm"
    End If
End Sub

IsDigitalChattering

The IsDigitalChattering method returns true if the digital point is chattering.

Syntax

IsDigitalChattering(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is chattering.

1
2
3
4
5
6
7
Sub isChattering()
    If IsDigitalChattering(277) Then
        edtMessageBox.Text = "Point 277 is chattering"
    Else
        edtMessageBox.Text = "Point 277 is not chattering"
    End If
End Sub

IsDigitalPoint

The IsDigitalPoint method returns true if the point type is digital.

Syntax

IsDigitalPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is a digital point.

1
2
3
4
5
6
7
Sub isDigital ()
    If IsDigitalPoint(277) Then
        edtMessageBox.Text = "Point 277 is a digital point"
    Else
        edtMessageBox.Text = "Point 277 is not a digital point"
    End If
End Sub

IsDigitalWarning

The IsDigitalWarning method returns true if the digital point is in the digital warning state.

Syntax

IsDigitalWarning(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in digital warning.

1
2
3
4
5
6
7
Sub isDigWarning()
    If IsDigitalWarning(277) Then
        edtMessageBox.Text = "Point 277 is in digital warning"
    Else
        edtMessageBox.Text = "Point 277 is not in digital warning"
    End If
End Sub

IsEnumAlarm1

The IsEnumAlarm1 method returns true if the enumeration point is in Alarm 1.

Syntax

IsEnumAlarm1(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 1.

1
2
3
4
5
6
7
Sub isEnum1()
    If IsEnumAlarm1(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 1"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 1"
    End If
End Sub

IsEnumAlarm2

The IsEnumAlarm2 method returns true if the enumeration point is in Alarm 2.

Syntax

IsEnumAlarm2(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 2.

1
2
3
4
5
6
7
Sub isEnum2()
    If IsEnumAlarm2(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 2"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 2"
    End If
End Sub

IsEnumAlarm3

The IsEnumAlarm3 method returns true if the enumeration point is in Alarm 3.

Syntax

IsEnumAlarm3(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 3.

1
2
3
4
5
6
7
Sub isEnum3()
    If IsEnumAlarm3(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 3"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 3"
    End If
End Sub

IsEnumAlarm4

The IsEnumAlarm4 method returns true if the enumeration point is in Alarm 4.

Syntax

IsEnumAlarm4(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 4.

1
2
3
4
5
6
7
Sub isEnum4()
    If IsEnumAlarm4(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 4"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 4"
    End If
End Sub

IsEnumAlarm5

The IsEnumAlarm5 method returns true if the enumeration point is in Alarm 5.

Syntax

IsEnumAlarm5(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 5.

1
2
3
4
5
6
7
Sub isEnum5()
    If IsEnumAlarm5(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 5"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 5"
    End If
End Sub

IsEnumAlarm6

The IsEnumAlarm6 method returns true if the enumeration point is in Alarm 6.

Syntax

IsEnumAlarm6(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in enumeration alarm 6.

1
2
3
4
5
6
7
Sub isEnum6()
    If IsEnumAlarm6(277) Then
        edtMessageBox.Text = "Point 277 is in enumeration alarm 6"
    Else
        edtMessageBox.Text = "Point 277 is not in enumeration alarm 6"
    End If
End Sub

IsEnumPoint

The IsEnumPoint method returns true if the point type is enumeration.

Syntax

IsEnumPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is an enumeration point.

1
2
3
4
5
6
7
Sub isEnum()
    If IsEnumPoint(277) Then
        edtMessageBox.Text = "Point 277 is an enumeration point"
    Else
        edtMessageBox.Text = "Point 277 is not an enumeration point"
    End If
End Sub

IsHighAlarm

The IsHighAlarm method returns true if the analog point is in High Alarm.

Syntax

IsHighAlarm(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in high alarm.

1
2
3
4
5
6
7
Sub isHiAlarm()
    If IsHighAlarm(277) Then
        edtMessageBox.Text = "Point 277 is in high alarm"
    Else
        edtMessageBox.Text = "Point 277 is not in high alarm"
    End If
End Sub

IsHighDeviation

The IsHighDeviation method returns true if the analog point is in High Deviation.

Syntax

IsHighDeviation(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in high deviation.

1
2
3
4
5
6
7
Sub isHighDev ()
    If IsHighDeviation(277) Then
        edtMessageBox.Text = "Point 277 is in high deviation"
    Else
        edtMessageBox.Text = "Point 277 is not in high deviation"
    End If
End Sub

IsHighOutOfRange

The IsHighOutOfRange method returns true if the analog point is High Out-of-Range.

Syntax

IsHighOutOfRange(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is high out-of-range.

1
2
3
4
5
6
7
Sub isHighOOR()
    If IsHighOutOfRange(277) Then
        edtMessageBox.Text = "Point 277 is out-of-range"
    Else
        edtMessageBox.Text = "Point 277 is not out-of-range"
    End If
End Sub

IsHighWarning

The IsHighWarning method returns true if the analog point is in High Warning.

Syntax

IsHighWarning(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point in high warning.

1
2
3
4
5
6
7
Sub isHiWarning()
    If IsHighWarning(277) Then
        edtMessageBox.Text = "Point 277 is in high warning"
    Else
        edtMessageBox.Text = "Point 277 is not in high warning"
    End If
End Sub

IsInitialized

The IsInitialized method returns true if the point is initialized.

Syntax

IsInitialized(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is initialized.

1
2
3
4
5
6
7
Sub isInitialized()
    If IsInitialized(277) Then
        edtMessageBox.Text = "Point 277 is initialized"
    Else
        edtMessageBox.Text = "Point 277 is not initialized"
    End If
End Sub

IsInputPoint

The IsInputPoint method returns true if the point is an input point.

Syntax

IsInputPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is an input point.

1
2
3
4
5
6
7
Sub isInput()
    If isInputPoint(277) Then
        edtMessageBox.Text = "Point 277 is an input point"
    Else
        edtMessageBox.Text = "Point 277 is not an input point"
    End If
End Sub

IsLowAlarm

The IsLowAlarm method returns true if the analog point is in Low Alarm.

Syntax

IsLowAlarm(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in low alarm.

1
2
3
4
5
6
7
Sub isLoAlarm()
    If IsLowAlarm(277) Then
        edtMessageBox.Text = "Point 277 is in low alarm"
    Else
        edtMessageBox.Text = "Point 277 is not in low alarm"
    End If
End Sub

IsLowOutOfRange

The IsLowOutOfRange method returns true if the analog point is Low Out-of-Range.

Syntax

IsLowOutOfRange(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is low out-of-range.

1
2
3
4
5
6
7
Sub isLowOOR()
    If IsLowOutOfRange(277) Then
        edtMessageBox.Text = "Point 277 is low out-of-range"
    Else
        edtMessageBox.Text = "Point 277 is not low out-of-range"
    End If
End Sub

IsLowWarning

The IsLowWarning method returns true if the analog point is in the Low Warning state.

Syntax

IsLowWarning(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in low warning.

1
2
3
4
5
6
7
Sub isLoWarning()
    If IsLowWarning(277) Then
        edtMessageBox.Text = "Point 277 is in low warning"
    Else
        edtMessageBox.Text = "Point 277 is not in low warning"
    End If
End Sub

IsOutputPoint

The IsOutputPoint method returns true if the point type is an output point.

Syntax

IsOutputPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is an output point.

1
2
3
4
5
6
7
Sub isOutput()
    If IsOutputPoint(277) Then
        edtMessageBox.Text = "Point 277 is an output point"
    Else
        edtMessageBox.Text = "Point 277 is not an output point"
    End If
End Sub

IsSetPointAuthorized

The IsSetPointAuthorized method determines whether or not setpoints are authorized for a given service.

Syntax

IsSetPointAuthorized(Tag As String) As Boolean

Parameters

Remarks

This method can be used to check whether a setpoint is authorized before proceeding with the setpoint. Setpoints are not authorized when the ACS associated with the specified CVS has not granted the script 'setpoint' privileges.

Example

The following example tests if the given point is an output point.

1
2
3
4
5
6
7
Sub isAuthorized()
    If IsSetPointAuthorized(CYGDEMO.UIS.00000277) Then
        edtMessageBox.Text = "Point 277 is authorized for setpoints"
    Else
        edtMessageBox.Text = "Point 277 is not authorized for setpoints"
    End If
End Sub

IsStringAlarm1

The IsStringAlarm1 method returns true if the string point is in Alarm 1.

Syntax

IsStringAlarm1(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 1.

1
2
3
4
5
6
7
Sub isString1()
    If IsStringAlarm1(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 1"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 1"
    End If
End Sub

IsStringAlarm2

The IsStringAlarm2 method returns true if the string point is in Alarm 2.

Syntax

IsStringAlarm2(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 2.

1
2
3
4
5
6
7
Sub isString2()
    If IsStringAlarm2(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 2"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 2"
    End If
End Sub

IsStringAlarm3

The IsStringAlarm3 method returns true if the string point is in Alarm 3.

Syntax

IsStringAlarm3(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 3.

1
2
3
4
5
6
7
Sub isString3()
    If IsStringAlarm3(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 3"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 3"
    End If
End Sub

IsStringAlarm4

The IsStringAlarm4 method returns true if the string point is in Alarm 4.

Syntax

IsStringAlarm4(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 4.

1
2
3
4
5
6
7
Sub isString4()
    If IsStringAlarm4(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 4"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 4"
    End If
End Sub

IsStringAlarm5

The IsStringAlarm5 method returns true if the string point is in Alarm 5.

Syntax

IsStringAlarm5(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 5.

1
2
3
4
5
6
7
Sub isString5()
    If IsStringAlarm5(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 5"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 5"
    End If
End Sub

IsStringAlarm6

The IsStringAlarm6 method returns true if the string point is in Alarm 6.

Syntax

IsStringAlarm6(Status As Integer) As Boolean

Parameters

Remarks

This method is a hidden legacy script function, and will not work if a Point Scheme other than CygNet Standard Point Scheme (0) is defined. See Legacy Script Functions for more information.

Example

The following example tests if the given point is in alarm 6.

1
2
3
4
5
6
7
Sub isString6()
    If IsStringAlarm6(277) Then
        edtMessageBox.Text = "Point 277 is in alarm 6"
    Else
        edtMessageBox.Text = "Point 277 is not in alarm 6"
    End If
End Sub

IsStringPoint

The IsStringPoint method returns true if the point type is string.

Syntax

IsStringPoint(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is an analog point.

1
2
3
4
5
6
7
Sub isString()
    If IsStringPoint(277) Then
        edtMessageBox.Text = "Point 277 is a string point"
    Else
        edtMessageBox.Text = "Point 277 is not a string point"
    End If
End Sub

IsUnreliable

The IsUnreliable method returns true if the point is unreliable.

Syntax

IsUnreliable(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is unreliable.

1
2
3
4
5
6
7
Sub isUnreliableTest()
    If IsUnreliable(277) Then
        edtMessageBox.Text = "Point 277 is unreliable"
    Else
        edtMessageBox.Text = "Point 277 is reliable"
    End If
End Sub

IsUpdated

The IsUpdated method returns true if the point is updated.

Syntax

IsUpdated(Status As Integer) As Boolean

Parameters

Example

The following example tests if the given point is updated.

1
2
3
4
5
6
7
Sub isUpdatedTest()
    If IsUpdated(277) Then
        edtMessageBox.Text = "Point 277 is updated"
    Else
        edtMessageBox.Text = "Point 277 is not an updated"
    End If
End Sub

ParseCygNetDateTimeStringToLocalTime

The ParseCygNetDateTimeStringToLocalTime method parses a CygNet date time string (YYYYMMDDhhmmsssnnn) into a local time.

Syntax

ParseCygNetDateTimeStringToLocalTime(CygNetDateTimeString As String, TimeIsLocal As Boolean) As Date

Parameters

Example

The following example parses a UTC CygNet date time to a local VBScript date time and displays the result in a message box.

1
2
3
4
5
6
7
8
9
Sub removeSuppression()
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim dtLocal
    dtLocal = GlobalFunctions.ParseCygNetDateTimeStringToLocalTime("20230103085230")
     
    MsgBox dtLocal
End Sub

PrepUdcForLoad

The PrepUdcForLoad method adds the UDC to the list of UDCs to refresh when calling GetUdcDescription. It is useful when making multiple subsequent calls to GetUdcDescription.

Syntax

PrepUdcForLoad(SiteService As String, Udc As String)

RemoveAlarmSuppression

The RemoveAlarmSuppression method removes alarm suppression on the provided point.

Syntax

RemoveAlarmSuppression(PointTag As String)

Parameters

Example

The following example removes suppression for point 00000063.

1
2
3
4
Sub removeSuppression()
    RemoveAlarmSuppression "CYGDEMO.UIS.00000063"
    edtMessageBox.Text = "Alarm suppression removed"
End Sub

ResolvePoints

The ResolvePoints method resolves a list of facility UDCs or Long Point IDs to Short Point IDs.

Syntax

ResolvePoints(CvsSiteService As String, TagList As Variant, PointList As Variant)

Parameters

Remarks

This function is generally used in situations where the client application only handles Short Point IDs.

Example

The following function serves as a wrapper for the ResolvePoints method by taking an array of Long Point ID strings or UDC strings and returning an array of Short Point IDs.

1
2
3
4
5
6
7
8
Function ToShortId (arrPoints)
    Dim arrShort
     
    'Resolve points
    ResolvePoints "CYGDEMO.UIS", arrPoints, arrShort
     
    ToShortId = arrShort
End Function

ResolvePointTags

The ResolvePointTags method resolves a list of Site.Service::Facility.Udc tags or Site.Service:LongPointId tags to Site.Service.ShortPointId tags.

Syntax

ResolvePointTags(TagListIn As Variant, TagListOut As Variant)

Parameters

Example

The following example resolves three point tags and displays them in a message box.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim vTagsIn
    ReDim vTagsIn(2)
     
    vTagsIn(0) = "CYGDEMO.UIS:ENTOPS_SYEDSOPCH"
    vTagsIn(1) = "CYGDEMO.UIS::ENTOPS1.SYEDSOPCH"
    vTagsIn(2) = "CYGDEMO.UIS::ENTOPS_GQDOWNLOAD.SYEDSOPCH"
     
    Dim vTagsOut
    GlobalFunctions.ResolvePointTags vTagsIn, vTagsOut
     
    Dim i, strResp
    For i = 0 To UBound(vTagsOut)
    strResp = strResp + vbCr + vTagsIn(i) + "  " + vTagsOut(i)
    Next
     
    MsgBox strResp
End Sub

ScaleEngToRaw

The ScaleEngToRaw method returns a raw value from an engineering value based on scaling.

Syntax

ScaleEngToRaw(Tag As String, EngValue As Double) As Double

Parameters

Remarks

Return Value: The value of the converted engineering number.

Example

The following example scales a number to a raw value.

1
2
3
4
5
Sub toRaw()
    Dim dRaw
    dRaw = ScaleEngToRaw("CYGDEMO.UIS.00000171", 2.71)
    edtMessageBox.Text = "2.71 scaled to raw is " & dRaw
End Sub

ScaleRawToEng

The ScaleRawToEng method returns an engineering value from a raw value based on scaling.

Syntax

ScaleRawToEng(Tag As String, RawValue As Double) As Double

Parameters

Remarks

Return Value: The value of the converted raw number.

Example

The following example scales a number to an engineering value.

1
2
3
4
5
Sub toEng()
    Dim dEng
    dEng = ScaleRawToEng("CYGDEMO.UIS.00000171", 3.14)
    edtMessageBox.Text = "3.14 scaled to engineering is " & dEng
End Sub

SendUisCommand

The SendUisCommand method sends a command to a UIS or DDS for a specified facility. Also see CxUis.UisClient.SendUisCommand.

Syntax

SendUISCommand(UisOrDdsSiteService As String, FacilityID As String, Command As String, [Parameters As String], [StatusPointID As String])

Parameters

Remarks

The optional UIS command parameters are sent in semicolon delimited format. The status point, if used, is updated automatically. In CygNet Studio, the UIS Command Button object can also be used.

The command priority for a scripted UIS command can be assigned; by setting the UisCmdPriority=<priority> parameter where <priority> is one of the following 'Low', 'Medium', 'High', 'User', or 'Admin'.

See Prioritizing Messages in the Communication Queue for more information.

Example — Open valve when tank level is in high alarm

The following example sends an "OPENVALVE" UIS command to the WELL05 facility on CYGDEMO.UIS when the tank level (as monitored by a separate point) is in high alarm. The status of the command is sent to a separate point.

1
2
3
4
5
6
7
8
9
10
Sub WELL05_TANK_LEVEL_CMD_OnUpdate(EventType) 
    'Get a snapshot of the tank level point
    Set TankState = Points.Point("CYGDEMO.UIS:TANK_LEVEL;STATUS")
      
    'Check for a high alarm
    If (TankState.Status And hpStatusHighAlarm) <> 0 Then
        'Send a Command to the UIS
        SendUISCommand "CYGDEMO.UIS", "WELL05", "OPENVALVE", "", "CYGDEMO.UIS::WELL05_TANK_LEVEL_CMD_STATUS" 
    End If
End Sub

Example — Using DG_F_DEV or DG_T_DEV component types

The following examples show how to send a UIS Command that is not predefined on a device. This example allows you to specify the DG_F_DEV or DG_T_DEV component type, then the data group ordinal (DGORD) and data group type (DGTYPE) that you want to poll.

The same functionality is available with the CxUis method SendUisCommand.

DG_T_DEV

1
2
3
4
Dim GlobalFunctions
Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
Call GlobalFunctions.EnableLiveMode (True)
GlobalFunctions.SendUISCommand "CYGDEMO.UIS", "WELLPILOT_KS_WELL00", "DG_T_DEV", "DGORD=0;DGTYPE=ProVlvOpCl;OpenClose=1", ""

DG_F_DEV

1
2
3
4
Dim GlobalFunctions
Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
Call GlobalFunctions.EnableLiveMode (True)
GlobalFunctions.SendUISCommand "CYGDEMO.UIS", "WELLPILOT_KS_WELL00", "DG_F_DEV", "DGORD=0;DGTYPE=BasicPoll", ""

where

Script Element	Corresponds to	More information
GlobalFunctions.SendUisCommand	Global Send UIS Command
CYGDEMO.UIS	CygNet Site.Service
WELLPILOT_KS_WELL00	Facility
DG_T_DEV (to send a data group to a field device) DG_F_DEV (to get a data group from a field device)	Component type	UISComponentType
DGORD	Ordinal of the data group (for example, 0)	Data Group Ordinals
DGTYPE	Data group type (for example, ProVlvOpCl – is the Production Valve Open and Close data group)
OpenClose	Parameters to send to the device (for example, Open = 1 and Close = 0)	UIS Command Components

ServicePing

The ServicePing method sends a request for data from a specified service.

Syntax

ServicePing(SiteService As String, ByteCount As Integer, Operation As Integer, OperationParam As Integer, PingErrDesc As Variant, PingTime As Variant) As Variant

Parameters

Remarks

The result of the method is returned as a number indicating one of the following error messages.

Example

The following method pings the CYGDEMO.DDS and displays the results in a message box.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Sub PingService ()
    Dim siteService, pingTime, pingError, ret
    siteService = "CYGDEMO.DDS"
     
    'Send ping request
    Ret = ServicePing (siteService, 0, 0, 0, pingError, pingTime)
     
    'Display results based on return value
    If ret <> 0 Then
        MsgBox "ServicePing returned with the following error: " & pingError
    Else
        MsgBox "Ping time for " & strService & " was " & pingTime & " ms."
    End If
End Sub

SetAlarmSuppressionSettings

The SetAlarmSuppressionSettings method sets the provided point’s alarm suppression as specified.

Syntax

SetAlarmSuppressionSettings(PointTag As String, SuppressionEndDate As Date, EndSuppressionOnNormal As Boolean)

Parameters

Example

The following example suppresses an alarm until December 21, 2023 at 3:13 or until it returns to normal state.

1
2
3
4
Sub setAllarmSuppression()
    SetAlarmSuppressionSettings "CYGDEMO.UIS.00000063", "12/21/2023 3:13:00 PM", True
    edtMessageBox.Text = "Alarm suppressed"
End Sub

SetGenserveInfo

The SetGenserveInfo method sets an Info Keyword task. See the SVCINFO Security Event for the applicable CygNet Service in the Security Reference topics for more information about GenServe security management.

Syntax

SetGenserveInfo(SiteService As String, Request As String, SetGenserveInfoResult As Variant)

Parameters

Remarks

If using BACKUP_NOW, the files will be backed up into the directory specified by the BACKUP_PATH keyword in the service configuration file. For more information see on VHS Journal Files and Service Backups on Demand.

Example

The following example backs up CYGDEMO.UIS and alerts the user if it was successful.

1
2
3
4
5
6
7
8
9
Sub setInfoKey()
    Dim arrGsResults
    SetGenserveInfo "CYGDEMO.UIS", "BACKUP_NOW=TRUE", arrGsResults
    If arrGsresults(0, 1) = -1 Then
        msgbox "Backup successful"
    Else
        msgbox "Backup request rejected"
    End If
End Sub

SetPoint

The SetPoint method sets a point to a specified value. For more information about adding a SetPoint button to a CygNet Studio screen, see the SetPoint Button Tool.

Syntax

SetPoint(Tag As String, RawValue As String, [Timestamp As Date], [Status As Integer])

Parameters

Example

This sample HSS point converts the value of a temperature point in Centigrade to another point in Fahrenheit.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Sub TEMP_CONVERT_OnInitialize()
    'Add the Centigrade point
    Points.AddPoint "CYGDEMO.UIS:WELL04_TEMP_C", TEMP_CONVERT
End Sub
 
Sub TEMP_CONVERT_OnUpdate(EventType)
    'Get a Point object from the Points object.
    Set TempC = Points.Point("CYGDEMO.UIS:WELL04_TEMP_C")
     
    'Set the HyperPoint value to the point value converted from Centigrade to Fahrenheit.
    If TempC.Quality = hpQualityGood Then
        TempFVal = (CDbl(TempC.Value) * 9 / 5) + 32
        SetPoint "CYGDEMO.UIS:WELL04_TEMP_F", CStr(TempFVal),TempC.TimeStamp, TempC.Status
    Else
        SetPoint "CYGDEMO.UIS:
End Sub

SetPointEx

The SetPointEx method performs a setpoint operation to a specified tag with the ability to wait for a length of time to verify that the point was set.

For more information about adding a SetPoint button to a CygNet Studio screen, which includes this functionality, see the SetPoint Button Tool.

Syntax

SetPointEx(Tag As String, RawValue as Variant, TimeStamp as Date, Status as Integer, WaitTimeInMs as Integer)

Parameters

Remarks

Any subsequent lines of code will be suspended until the setpoint method returns.

Example

This method serves as a wrapper for the SetPointEx function by accepting a point tag string and value, checking whether setpoints are authorized on the CYGDEMO.UIS service, then sending the setpoint request.

1
2
3
4
5
6
7
8
9
10
11
12
Sub SetPointVal(pointTag, pointVal)
    Dim serviceName
    serviceName = "CYGDEMO.UIS"
     
    'Check that setpoints are authorized
    If Not IsSetPointAuthorized(serviceName) Then
        MsgBox "You are unauthorized to issue a setpoint command" & vbCr & "to the following site service: " &  serviceName
    Else
        'Send the request and wait 10 seconds for verification
        SetPointEx pointTag, pointVal, Now, 0, 10000
    End If
End Sub

SetPointEx2

The SetPointEx2 method performs a setpoint operation to a specified tag with the ability to wait for a length of time to verify that the point was set and change the Base Status and User Status flags.

For more information about adding a SetPoint button to a CygNet Studio screen, which includes this functionality, see the SetPoint Button Tool.

Syntax

SetPointEx2(Tag As String, RawValue As Variant, Timestamp As Date, BaseStatusMask As Integer, BaseStatus As Integer, UserStatusMask As Long, UserStatus As Long, WaitTimeInMs As Integer)

Parameters

Remarks

BaseStatusMask and UserStatusMask are the values (hex or decimal equivalent) representing which flags to change. The mask is the sum of flag's values, (i.e., &h0004 + &h0008 = &h000C;  &h0004 +& h0008 + &h0080 = &h008C). If decimal, use -1, or if hex, use &hFFFF or &hFFFFFFFF to change all the flags.

BaseStatus and UserStatus are the values (hex or decimal equivalent) representing the flag's new statuses. This is obtained by adding together the values of the flags. To have a flag marked, add it to this parameter. To have it cleared, do not add it.

Keep in mind that only the flags referenced in the BaseStatusMask and UserStatusMask parameters will be affected.

Bits that cannot be toggled using this command are:

1. System bits (except the Unreliable bit), and
2. Config bits under control of the UIS (that is, it is being used in an alarm calculation)

If you include values for these bits the system will ignore them. The Base Status and Extended Status values that result per this command include any applicable System and Config bit values. At a minimum, this would include the values of the Initialized and Updated bits in the Base Status and the value of the External Value bit in the Extended Status.

This command requires a value. If you don't want to change the value, first get the existing value and then resend it with this command.

Hex Values

The following tables show the hex values of the individual flags.

Example

There are several examples below that show various ways of using the SetPointEx2 method.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
'This example sets the Unreliable flag (&h0004)

Sub setEx1()
    SetPointEx2 "CYGDEMO.UIS.00000123", 12, Now, &h0004, &h0004, &h00000000, &h00000000, 1000"
    MsgBox "Point set"
End Sub
 
'This example sets the Unreliable flag (&h0004) and clears Out-of-Range (&h0008)

Sub setEx2()
    SetPointEx2 "CYGDEMO.UIS.00000123", 12, Now, &h000C, &h0004, &h00000000, &h00000000, 1000"
    MsgBox "Point set"
End Sub
 
'This example clears all flags for the given point

Sub setEx3()
    SetPointEx2 "CYGDEMO.UIS.00000123", 12, Now, &hFFFF, &h0000, &hFFFFFFFF, &h00000000, 1000"
    MsgBox "Point set"
End Sub
 
'This example sets High Alarm (&h0080), sets UserBit 7 (&h00000040), sets UserBit 15 (&h00004000), and clears UserBit 8 (&h00000080)

Sub setEx4()
    SetPointEx2 "CYGDEMO.UIS.00000123", 12, Now, &h0080, &h0080, &h000040C0, &h00004040, 1000"
    MsgBox "Point set"
End Sub

SetPointVerifiedFlags

The SetPointVerifiedFlags method sets the values for the Verified Flags.

Syntax

SetPointVerifiedFlags(PointTag As String, UpdateFlag1 As Boolean, Flag1 As Boolean, UpdateFlag2 As Boolean, Flag2 As Boolean, UpdateFlag3 As Boolean, Flag3 As Boolean, UpdateFlag4 As Boolean, Flag4 As Boolean)

Parameters

Example

The following example shows all possible ways to update flags.

1
2
3
4
5
6
7
8
9
10
11
12
13
Sub setVerifiedFlags()
    setPointVerifiedFlags "CYGDEMO.UIS.00000195", True, True, 
    
    'Check the first flag
        True, False, 
    'Uncheck the second flag
        False, True, 
    'Leave the third flag as is
        False, False    
    'Leave the fourth flag as is
     
    edtMessageBox.Text = "Flags have been set"
End Sub

ShowDataGroupDialog

The ShowDataGroupDialog method shows the Data Group dialog box. Also see CxDialogs.ShowDataGroupDialog.

Syntax

ShowDataGroupDialog(UisOrDdsSiteService As String, FacilityId As String, DataGroupType As String, Ordinal As Integer)

Parameters

Example

The following example illustrates three ways to call this method. The first two methods display Discrete Output data groups, but the first method shows Ordinal 4 and the second shows Ordinal 5. The third method shows the properties dialog box for TESTMETER because no Data Group Type is specified.

1
2
3
4
5
6
7
8
9
Sub dataGrpDO4()
    'Shows the Discrete Output data group with an ordinal of 4
    ShowDataGroupDialog "CYGDEMO.UIS", "TESTMETER", "DO", 4
End Sub
 
Sub dataGrpDO5()
    'Shows the Discrete Output data group with an ordinal of 5
    ShowDataGroupDialog "CYGDEMO.UIS", "TESTMETER", "DO", 5
End Sub

ShowFacilityRulesDialog

The ShowFacilityRulesDialog method displays the Facility Rules dialog box. Also see CxDialogs.ShowFacilityRulesDialog.

Syntax

ShowFacilityRulesDialog(InRules As String) As String

Parameters

Remarks

This method will return the Facility Rule Filter XML created by the dialog box.

The following is an example of a Facility Rule Filter XML which filters all facilities where facility_category = "GENFAC" AND facility_siteservice = "CYGDEMO.UIS".

1
2
3
4
5
6
7
8
9
10
<ExportedRules exportTime="9/24/2023 07:37:46.621" ruleDataIdentifier="FAC Rules">
    <Rules enabled="true" inverted="false" op="1" name="">
        <Rule enabled="true" name="" referenceAttr="0" compareToType="0" externalData="" value="GENFAC" operator="=" qualifer="Case Insensitive">
            <compareItem attr="facility_category"/>
        </Rule>
        <Rule enabled="true" name="" referenceAttr="0" compareToType="0" externalData="" value="CYGDEMO.UIS" operator="=" qualifer="Case Insensitive">
            <compareItem attr="facility_siteservice"/>
        </Rule>
    </Rules>
</ExportedRules>

Example

The following example launches the Facility Rules dialog box and displays the generated rules in a message box.

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strRules
    strRules = GlobalFunctions.ShowFacilityRulesDialog("")
     
    MsgBox strRules
End Sub

ShowFacilityRulesDialogSimple

The ShowFacilityRulesDialogSimple method displays the Facility Rules dialog box. The optional InRules parameter allows both "simple" human-readable text and XML as the input to initialize the filter. The method will also output only human-readable text. Also see CxDialogs.ShowFacilityRulesDialogSimple.

Syntax

ShowFacilityRulesDialogSimple(InRules As String) As String

Parameters

Remarks

This method will return the human-readable filter text created by the dialog box.

The following is an example of a facility rule filter input in text format which filters all facilities where facility_id = "TANK1" OR facility_id = "TANK2".

Example

The following example launches the Facility Rules dialog box and displays the generated rules in a message box.

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strRules
    strRules = GlobalFunctions.ShowFacilityRulesDialogSimple("")
     
    MsgBox strRules
End Sub

ShowModalView

The ShowModalView method opens a Studio screen as a dialog box.

Syntax

ShowModalView(ViewFileName As String, SiteService As Variant, Facility As Variant, Caption As String, Style As Integer, DefaultButton As Integer, Resizable As Boolean, Left As Variant, Top As Variant, Width As Variant, Height As Variant, DictionaryXml As Variant) As Long

Parameters

Remarks

Return Value: An integer representing which button was selected to close the form. 1 = OK or Done, 2 = Cancel or Close,  3 = Yes,  4 = No.

Example

The following example opens a form. If the user presses OK on the form, some code is performed. If the user presses Cancel or closes the form, some text is put in a text box.

1
2
3
4
5
6
7
8
9
10
11
12
13
Sub showTest()
    Dim iRet
    iRet = ShowModalView("C:\TestScreen.csf", "CYGDEMO.UIS", "CYG_METER", "Test Form", 2, 2, True, 50, 50, 375, 475, objDictionary)
     
    'If the user pressed OK, run some code. 
    'If the user pressed Cancel or closed the form, don’t do anything
    If iRet = 1 Then
        ...
        'Code
    Else
        edtMessageBox.Text = "Action was canceled"
    End If
End Sub

ShowRelativeTimeDialog

The ShowRelativeTimeDialog method displays the Relative Time dialog box. Also see CxDialogs.ShowRelativeTimeDialog.

Syntax

ShowRelativeTimeDialog(InTime As String) As String

Parameters

Remarks

This method will return a string representing the time configured in the dialog box.  This format of this string will vary depending on the type of date time configured in the dialog box.  If "Absolute Date/Time" is selected, the format of the returned string will be "(M)M/(D)D/YYYY (H)H:MM:SS".  If "Relative Date/Time" is selected, the format of the returned string will be "y+/-# m+/-# d+/-# H+/-# M+/-# S+/-#" or "<Current>" if no relative date/time parameters are adjusted.  If "Relative Day" is selected, the format of the returned string will be "T+/-#".

Example

The following example launches the Relative Time dialog box initialized to one year ago from the current time, and displays the result in a message box.

1
2
3
4
5
6
7
8
9
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim strTime
    strTime = GlobalFunctions.ShowRelativeTimeDialog("y-1")
     
    MsgBox strTime
End Sub

ShowRollupConfigDialog

The ShowRollupConfigDialog method displays the History Rollup Configuration dialog box. Also see CxDialogs.ShowRollupConfigDialog.

Syntax

ShowRollupConfigDialog(TimeAdjustment As Variant, RollupType As Variant, RollupPeriod As Variant, Units As Variant, TopOfSubUnit As Variant)

Parameters

Example

The following example launches the History Rollup Configuration dialog box and displays each returned parameter in a message box.

1
2
3
4
5
6
7
8
9
10
11
12
13
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim vTimeAdj, vType, vPeriod, vUnits, vTOS
    GlobalFunctions.ShowRollupConfigDialog vTimeAdj, vType, vPeriod, vUnits, vTOS
     
    MsgBox vTimeAdj
    MsgBox vType
    MsgBox vPeriod
    MsgBox vUnits
    MsgBox vTOS
End Sub

ShowUisCmdAuxDialog

The ShowUisCmdAuxDialog method displays the UIS Command Auxiliary Information dialog box. Also see CxDialogs.ShowUisCmdAuxDialog.

Syntax

ShowUisCmdAuxDialog(UisOrDdsSiteService As String, FacilityId As String, UisCmdName As String) As Boolean

Parameters

Remarks

This method will return false if any of the supplied parameters are invalid.

Example

The following example launches the UIS Command Auxiliary Information dialog box.

1
2
3
4
5
6
7
Sub
    Dim GlobalFunctions
    Set GlobalFunctions = CreateObject("CxScript.GlobalFunctions")
     
    Dim vTimeAdj, vType, vPeriod, vUnits, vTOS
    GlobalFunctions.ShowUisCmdAuxDialog "CYGDEMO.UIS", "FLOWAUTOAP15", "RTUCFGGET"
End Sub

ShowUisCmdStateDialog

The ShowUisCmdStateDialog method shows the UIS Command State dialog box. Also see CxDialogs.ShowUisCmdStateDialog.

Syntax

ShowUisCmdStateDialog(UisOrDdsSiteService As String, FacilityId As String, UisCmdName As String, ShowExecutionPrompt As Boolean) As Boolean

Parameters

Remarks

Return Value: A Boolean indicating whether the operation was successful. If ShowExecutionPrompt is set to False, this method will automatically return True.

Example

The following example shows the dialog box for the POLL command and is used to execute it.

1
2
3
4
5
6
7
8
9
Sub showCmdDialog()
    Dim bRet
    bRet = ShowUisCmdStateDialog ("CYGDEMO.UIS", "CYG_METER", "POLL", True)
    If bRet Then
        edtMessageBox.Text = "Successful execution"
    Else
        edtMessageBox.Text = "Error executing command"
    End If
End Sub

SortArray

The SortArray method sorts an array.

Syntax

SortArray(Array As Variant, Ascending As Boolean)

Parameters

Example

The following example sorts an array alphabetically and displays the new array in a list box.

1
2
3
4
5
6
7
8
9
10
11
Sub sortLetters()
    Dim arrLetters, item
    arrLetters = Array("a", "l", "ab", "z", "aa")
     
    SortArray arrLetters, True
    lstSort.ResetContent
    For Each item In arrLetters
        lstSort.AddString(letter)
    Next
        'Sorted array: a, aa, ab, l, z
End Sub

TogglePointVerifiedFlags

The TogglePointVerifiedFlags method toggles the Verified Flags for a point.

Syntax

TogglePointVerifiedFlags(PointTag As String, ToggleFlag1 As Boolean, ToggleFlag2 As Boolean, ToggleFlag3 As Boolean, ToggleFlag4 As Boolean)

Parameters

Example

The following example toggles the status for flags 1, 3, and 4.

1
2
3
4
Sub toggleFlags()
    TogglePointVerifiedFlags "CYGDEMO.UIS.00000080", True, False, True, True
    MsgBox "Verified Flags 1, 3, and 4 have been toggled"
End Sub