ConfigureTag Function

Help Contents

Introduction

Applies new configuration to a Database Tag.

Functions and Function Blocks

The ConfigureTag Function is intended for use in an Operator Action. Operator Actions run in response to user input gestures in the Operator Interface. In an Operator Action, code execution is suspended until the function completes.

If you want to change tag configuration from a Program Tag, running on the SCADA Server, use the ConfigureTag Function Block.

Syntax

Informal Syntax:

ConfigureTag( TagName, NewConfiguration )

Formal Syntax:

ConfigureTag( TagName:=Expression, NewConfiguration:=Expression )

Parameters

ParameterTypeDescription
TagNameANY_STRINGThe full name of the tag.
NewConfigurationANY_STRINGThe new configuration of the tag.

NewConfiguration Parameter

The NewConfiguration input parameter is the configuration change to apply to the tag. This is a STRING value that can set 1 or more configuration properties in one operation. The syntax of the NewConfiguration input parameter is:

config-parameter ::= { property-and-value }

property-and-value ::= property ':=' value

property ::= <The name of the configuration property>

value ::=IEC 61131-3 Literal

The following example shows an appropriate value to configure the URL property of a URL Scanner Tag:

URL:='https://www.example.com/web-server-request'

Return Value

None.

Examples

Changes the values of the HighLimit and HighHighLimit properties of an Analog Level Alarm Tag to new values.

ConfigureTag( "Storage.LevelAlarm", "HighHighLimit:=5.0 HighLimit:=4.0" );

Further Information

Operator Actions

To learn where you can use this function.

Structured Text Function Call

To learn about calling a function from IEC 61131-3 structured text.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

ConfigureTag Function Block

For a function block to provide the equivalent feature in a IEC 61131-3 Program Tag.

Glossary

For the meaning of terms used in Fernhill SCADA.