Function puts (fnput)

command <cmdstring> [confirmed] [cmdauto]

Performs a control to the specified state (cmdstring).

The cmdauto parameter prevents the system from creating a Command In Progress tag.

• multistate

• status

cmdstring is one of the states listed in the message table.

The confirmed parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

For example:

• fnput status.valve24 "command open"

enable alarms [<blockFieldName>]

Enables alarming for the specified point.

Any table with a flags structure that is capable of alarming.

flag.alminh is set to false.

blockFieldName is "totalBlocks[0]" to "totalBlocks[3]", and only applies to the flowTotalConfig table.

This command will cause the following tables to regenerate alarms:

• analog

• compressor

• connection

• flowTotalConfig

• gasmeter

• modem

• multistate

• rate

• remote

• status

• tank

enable log

Enables logging for the point.

Any table with a flags structure that is capable of logging events.

flag.evtinh set to false

enable rtn log

Enables logging of the return to normal condition for the point.

Any table with a flags structure that is capable of logging return to normal events.

flag.cevinh set to false

enable rtn

OR

enable rtn alarms

Enables alarming on the return to normal condition for the point.

Any table with a flags structure that is capable of having return to normal alarms.

flag.clrinh set to false

fastscan <interval>

Sets the remote to fast scan for the specified number of seconds (for example, fastscan 45).

• remote

inhibit alarms [warning <warningPeriod>]

Inhibits alarming for the specified point during the configured alarm inhibition time. The warningPeriod is a number of seconds before inhibition end.

For example, "inhibit alarms warning 60", generates a system alarm indicating that the alarm inhibit will end one minute before the inhibition end.

Any table with a flags structure that is capable of alarming.

flag.alminh set to true

The following tables may take additional command parameters for warning message and inhibit timeout:

• analog

• connection

• flowTotalConfig

• multistate

• rate

• remote

• rtstring

• status

• tank

inhibit log

Inhibits logging for the point.

Any table with a flags structure that is capable of logging events.

flag.evtinh set to true

inhibit rtn log

Inhibits logging of a return to normal condition for the point.

Any table with a flags structure that is capable of logging RTN events.

flag.cevinh set to true

inhibit rtn

OR

inhibit rtn alarms

Inhibits alarming on a return to normal condition for the point.

Any table with a flags structure that is capable of alarming a return to normal condition.

flag.clrinh set to true

interrogate off

Cancels interrogate mode on the remote.

• remote

interrogate on

Places the remote into interrogate mode.

• remote

invstate [confirmed]

Inverts the current operating state of the device (for example, changes on to off, and off to on).

• status

The confirmed parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

jogdown <%percent_change> | <increment_value_in_EU> [confirmed]

Decreases the current setpoint by a percentage (for example, jogdown %5.2) or by a value in engineering units (for example, jogdown 3).

• analog

The confirmed parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

jogup <%percent_change> | <increment_value_in_EU> [confirmed]

Increases the current setpoint by a percentage (for example, jogup %5.2) or by a value in engineering units (for example, jogup 3).

• analog

The confirmed parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

manual

Sets the point to the manual mode.

• analog

• application

• multistate

• rate

• rtstring

• status

flag.manl set to true

manval.<value>

Puts the point into the manual state and sets its value to <value>.

• rtstring

• tank

The value can be different for the rtstring and tank tables. For example, the tank table can set its value to manval.1200, and the rtstring table can set its value to manval.abc.

manval.<value>@<timestampHigh>:<timestampLow>

Puts the point into the manual state and sets its value to <value> with the provided optional timestamp.

timestampHigh is the number of seconds>, and timestampLow is the number of milliseconds since January 1, 1970.

• analog

• multistate

• rate

• status

The value can be different for the analog, status, rate, and multistate tables. For example, the analog table can set its value to manval.1200, and the status table can set its value to manval.open.

offscan

Sets the point to offscan mode.

• connection

• remote

onscan

Sets the point to onscan mode.

• connection

• remote

realtime

Sets the point to RealTime mode.

• analog

• application

• multistate

• rate

• rtstring

• status

flag.manl set to false

set inhibit config

Sets the current generic inhibitions to the values configured in ADE.

Sets flag.alminh to the value configured in flag.alminhconfig and flag.clrinh to the value configured in flag.clrinhconfig.

• Any table with a flag structure capable of alarming.

setpoint <sptvalue> [confirmed] [cmdauto]

Performs a setpoint to the specified value (sptvalue).

The cmdauto parameter prevents the system from creating a command in progress tag.

• analog

The confirmed parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

tag add [func=[ no commands | no open | no close | no operator cmd | no program cmds | warning]] [oper=<operatorName>] [wo=<workOrder>] [desc=<string to be used in the tag record for the description of the tag>] [time=<DateTimeString>] [exptime=<DateTimeString>] [endtime=<DateTimeString>] [priority=[High | Information | Low | Medium]] [perm=[true | false]] [username=<username>] [location=<location>]

Creates a command inhibit tag in the tag table.

• analog

• multistate

• rate

• rtstring

• status

The "func=xxx" parameter supports output message text. For a status point using a base message set of 3DCompressor, you could add tags with func=no run and func=no stop.

It is imperative that no space is placed between the parameter name and the "=" sign

The command does not apply to flexTag.

If a tag is permanent (perm=true), then it doesn't expire at the expiry time.

Sample command:

fnput status.myStatus "tag add func=no open oper=user@domain wo=1234 desc=test the tag time=07/7/2021 08:29:00 exptime=08/8/2021 00:00:00 endtime=08/8/2021 05:00:00 priority=Information perm=false username=George location=ezXOS1@domain"

tag rem [func=[ no commands | no open | no close | no operator cmd | no program cmds | warning]] [oper=<operatorName>] [wo=<workOrder>] [desc=<string to be used in the tag record for the description of the tag>] [time=<DateTimeString>] [exptime=<DateTimeString>] [endtime=<DateTimeString>] [priority=[High | Information | Low | Medium]] [perm=[true | false]] [username=<username>] [location=<location>]

Removes one or more command inhibit tags.

• analog

• multistate

• rate

• rtstring

• status

You only need to specify the minimum fields that describe the tag(s) to be removed. For instance, to remove all tags created for a work order (wo3254), you would use the tag rem wo=wo3254. To remove all warning tags created by the Controller, you would use the tag remfunc=warning oper=Fred.

The "func=xxx" parameter supports output message text. Thus, you can use func=no <status/multistate command>. For example, for a status point using a base message set of 3DCompressor, you could remove tags with "func=no run" and "func=no stop".

total.<value>

Puts a manual value into the current accumulation (acccur) field, and places the point into manual mode (for example, total.3800).

• rate

setval <stringVal> [CONFIRMED] [CMDAUTO]

OR

setstring <stringVal> [CONFIRMED] [CMDAUTO]

Writes a string value (stringVal). The CMDAUTO parameter prevents the system from creating a Command In Progress tag.

• rtstring

The CONFIRMED parameter overrides a Command in Progress warning tag (if one exists), and allows the command to occur despite the tag.

The parameters CONFIRMED and CMDAUTO are both case-sensitive.