Loading API Index...
Open Automation Software API Documentation
Show / Hide Table of Contents

Trend Tags

GetTrendPointGroupNames

  • The GetTrendPointGroupNames Function returns a list of Groups in the specified ReferenceGroup path that contain Tags that are enabled for trending.
  • Returns Empty String if service is not reachable.
  • Returns a String Array of Groups in the ReferenceGroup that have Tags that are enabled for trending.
  • ReferenceGroup is a string of the Group path to retrieve the Groupss from.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string ErrorString = "";
            string[] GroupNames = null;
            string refgroup = "";
            GroupNames = oasc.GetTrendPointGroupNames(refgroup, networknode, ref ErrorString);
            if (ErrorString == "Success")
            {
                foreach (string GroupName in GroupNames)
                {
                    Console.WriteLine(GroupName);
                }
            }
            else
            {
                Console.WriteLine(ErrorString);
            }
        }
    }
 }
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim networknode As String = ""
            Dim ErrorString As String = ""
            Dim GroupNames As String() = Nothing
            Dim refgroup As String = ""
            GroupNames = oasc.GetTrendPointGroupNames(refgroup, networknode, ErrorString)

            If ErrorString = "Success" Then
                For Each GroupName As String In GroupNames
                    Console.WriteLine(GroupName)
                Next
            Else
                Console.WriteLine(ErrorString)
            End If
        End Sub
    End Class

GetTrendPointTagNames

  • The GetTrendPointTagNames Function returns a list of Tags in the specified ReferenceGroup path that are enabled for trending.
  • Returns Empty String if service is not reachable.
  • Returns a String Array of Tags in the ReferenceGroup that are enabled for trending.
  • ReferenceGroup is a string of the Group path to retrieve the Tags from.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string ErrorString = "";
            string[] TagNames = null;
            string refgroup = "";
            TagNames = oasc.GetTrendPointTagNames(refgroup, networknode, ref ErrorString);
            if (ErrorString == "Success")
            {
                foreach (string TagName in TagNames)
                {
                    Console.WriteLine(TagName);
                }
            }
            else
            {
                Console.WriteLine(ErrorString);
            }
        }
    }
 }
VB
Class Program
    Shared oasc As OASConfig.Config = New OASConfig.Config()

    Public Shared Sub Main(ByVal args As String())
        Dim networknode As String = ""
        Dim ErrorString As String = ""
        Dim TagNames As String() = Nothing
        Dim refgroup As String = ""
        TagNames = oasc.GetTrendPointTagNames(refgroup, networknode, ErrorString)

        If ErrorString = "Success" Then

            For Each TagName As String In TagNames
                Console.WriteLine(TagName)
            Next
        Else
            Console.WriteLine(ErrorString)
        End If
    End Sub
End Class

GetAllTrendPointTagNames

  • The GetAllTrendPointTagNames Function returns a list of all Tags in the specified ReferenceGroup and all sub groups path that are enabled for trending.
  • Returns Empty String if service is not reachable.” + vbCr + “Returns a String Array of Tags in the ReferenceGroup that are enabled for trending.
  • ReferenceGroup is a string of the Group path to retrieve the Tags from.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string ErrorString = "";
            string[] TagNames = null;
            string refgroup = "";
            TagNames = oasc.GetAllTrendPointTagNames(refgroup, networknode, ref ErrorString);
            if (ErrorString == "Success")
            {
                foreach (string TagName in TagNames)
                {
                    Console.WriteLine(TagName);
                }
            }
            else
            {
                Console.WriteLine(ErrorString);
            }
        }
    }
 }
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim networknode As String = ""
            Dim ErrorString As String = ""
            Dim TagNames As String() = Nothing
            Dim refgroup As String = "Tanks"
            TagNames = oasc.GetAllTrendPointTagNames(refgroup, networknode, ErrorString)

            If ErrorString = "Success" Then

                For Each TagName As String In TagNames
                    Console.WriteLine(TagName)
                Next
            Else
                Console.WriteLine(ErrorString)
            End If
        End Sub
    End Class
End Namespace

GetTrendPointParameterNames

  • The GetTrendPointParameterNames Function returns a list of Parameters of a Tag in the specified ReferenceGroup path that is enabled for trending.
  • Returns Empty String if service is not reachable.
  • Returns a String Array of Tags in the ReferenceGroup that are enabled for trending.
  • TagName is a string of the tag name to query.
  • ReferenceGroup is a string of the Group path to retrieve the Tags from.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string[] Parameters = null;
            string tagname = "";
            string refgroup = "";
            Parameters = oasc.GetTrendPointParameterNames(tagname, refgroup, networknode);
                foreach (string Parameter in Parameters)
                {
                    Console.WriteLine(Parameter);
                }
        }
    }
 }
VB
Class Program
    Shared oasc As OASConfig.Config = New OASConfig.Config()

    Public Shared Sub Main(ByVal args As String())
        Dim networknode As String = ""
        Dim Parameters As String() = Nothing
        Dim tagname As String = ""
        Dim refgroup As String = ""
        Parameters = oasc.GetTrendPointParameterNames(tagname, refgroup, networknode)

        For Each Parameter As String In Parameters
            Console.WriteLine(Parameter)
        Next
    End Sub
End Class

GetDataLoggingNames

  • The GetDataLoggingNames Function returns a list of the Data Logging Groups.
  • Returns Empty String Array if service is not reachable.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string[] Groups = null;
            Groups = oasc.GetDataLoggingNames(networknode);
            foreach (string Group in Groups)
            {
                Console.WriteLine(Group);
            }
        }
    }
}
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim networknode As String = ""
            Dim Groups As String() = Nothing
            Groups = oasc.GetDataLoggingNames(networknode)

            For Each Group As String In Groups
                Console.WriteLine(Group)
            Next
        End Sub
    End Class
End Namespace

GetHistoryTagNames

  • The GetHistoryTagNames Function returns a list of Field Names in the Data Logging Group.
  • Returns Empty String if service is not reachable.
  • Returns a String Array of Field Names in the Data Logging Group.
  • Group is a string of the Data Logging Group path to retrieve the Field Names from.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string networknode = "";
            string[] FieldNames = null;
            string ErrorString = "";
            string groupname = "";
            FieldNames = oasc.GetHistoryTagNames(groupname, networknode, ref ErrorString);
            if (ErrorString == "Success")
            {
                foreach (string FieldName in FieldNames)
                {
                    Console.WriteLine(FieldName);
                }
            }
        }
    }
}


VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim networknode As String = ""
            Dim FieldNames As String() = Nothing
            Dim ErrorString As String = ""
            Dim groupname As String = "Boo"
            FieldNames = oasc.GetHistoryTagNames(groupname, networknode, ErrorString)

            If ErrorString = "Success" Then

                For Each FieldName As String In FieldNames
                    Console.WriteLine(FieldName)
                Next
            End If
        End Sub
    End Class
End Namespace

Back to top Copyright (c) Open Automation Software. All rights reserved.