Remote Unit Executive - Configuration

RUEX

Global parameters can be viewed and / or edited by selecting RUEX à Configure à RUEX Global. The last step can be done alternatively by pressing the Configure RUEX button in the main window.

PARAMETER	DESCRIPTION
Manager Status	Enables or disables all RUEX activities. When enabled, any enabled sub processes are allowed to execute. When disabled no automatic activities are allowed to execute.
Export File Directory	Specifies the directory where RUEX reports get deposited. This can be a directory on a local hard disk, or a network drive.
Outgoing Message Sorting	Specifies whether or not outgoing message dispatchers sort messages by remote unit External Client Id. This minimizes excessive channel switching, and can be useful when channel switching is mechanically operated.
Alarms	Can be Enabled or Disabled. When Enabled visual and audio alarms are generated in addition to alarm log entries when error conditions occur. When Disabled, log entries are generated only.
Midnight RU Clock Synchronization	Midnight remote units clock synchronization with master time executes nightly when enabled.
OS Time Monitoring	Operating system time is monitored when enabled. When operating system clock is reset discontinuously, a log entry is generated, and application modules ignore data from the first poll following the detected time shift.
RURDR File Backup Directory	Specifies the directory where RUEX RURDR files get archived. This can be a directory on a local hard disk, or a network drive.
NTMCRDR File Backup Directory	Specifies the directory where RUEX NTMCRDR files get archived. This can be a directory on a local hard disk, or a network drive.
Auto - Archiving (Data and Event Log Files)	Specifies if data recording files and event log file are to be archived automatically, and how often. Possible options are Disabled, Daily, Weekly, and Monthly.

Auto Backup parameters can be viewed and / or edited by selecting RUEX à Configure à Auto Backup:

PARAMETER	DESCRIPTION
Automatic File Backup	Enables or disables nightly automatic file backup activities.
Automatic File Backup Directory	Specifies the directory where RUEX backs up its own files every night. For safety reasons this directory may not be on the same hard disk as RUEX.
Number Of Backup Subdirectories	Specifies the number of most recent backups to be kept in the above directory. Every night a subdirectory named YYYYMMDD is created in the above directory, and all NTMC system files are copied to it. The directory name changes daily, YYYY stands for the current year, MM for the current month, and DD for the current day.

External Commands parameters can be viewed and / or edited by selecting RUEX à Configure à External Commands:

PARAMETER	DESCRIPTION
External Command Processing	Enables or disables processing of command requests generated via the internet.
Max. age of External Command (Minutes)	Specifies maximum age of external commands, in minutes. Command requests older than specified here are not executed.

Polling parameters can be viewed and / or edited by selecting RUEX à Configure à Polling:

PARAMETER	DESCRIPTION
Polling	Enables or disables automatic polling activities. When disabled, manual polling still works.
System Polling Period In Effect	Specifies which polling period is in effect. Two choices are available: primary period, and secondary period.
System Polling Period Control Authority	Specifies who is responsible for selecting which polling period is in effect. When the value is set to RUEX, the latter is responsible for selecting the choice. It is done manually, by the operator, by setting the value of System Polling Period In Effect above. When set to LMEX, the latter manipulates System Polling Period In Effect automatically.
System Primary Polling Period (Seconds)	Specifies primary polling period, in seconds.
System Secondary Polling Period (Seconds)	Specifies secondary polling period, in seconds.
Polling Offset From Midnight (Sec.)	Specifies the offset from midnight, in seconds, used to calculate the next poll.
Double Poll Interval (Sec)	Specifies duration of the delay, in seconds between two successive polls in a double poll.
LMEX Data Input Domain	Specifies the domain relevant to LMEX, the load management application module. Whenever an automatic poll completes, and any of remote units from this domain were polled, LMEX gets notified of the event. This notifies LMEX that new data is available, and that it may have to execute its own activities.
CCEX Data Input Domain	Specifies the domain relevant to CCEX, the capacitor control application module. Whenever an automatic poll completes, and any of remote units from this domain were polled, CCEX gets notified of the event. This notifies CCEX that new data is available, and that it may have to execute its own activities.

Domains

Parameters below are common to all domains. They can be viewed by first opening the relevant domain window, then selecting Domain à Configure. The last step can be done alternatively by pressing the Configure Domain button in the domain window.

PARAMETER	DESCRIPTION
Domain Id	Displays the domain id. This is a read only parameter, it can not be changed. The identifier is selected by the operator at the time of domain creation.
Manager Status	Enables or disables all domain activities. When enabled, any enabled sub processes associated with this domain are allowed to execute. When disabled no automatic activities associated with the domain are allowed to execute.
Polling	Enables or disables domain associated automatic polling activities. When disabled, manual polling still works.
Evaluation Priority (0 = highest)	Specifies evaluation priority of I/O points under this domain during each point evaluation cycle.
Timed Switch Manager	Enables or disables timed switch manager activities.
Timed Switch Manager Period	Specifies how often timed switch manager executes, in seconds.
Timed Switch Update Period Cushion	Specifies the number of seconds to subtract from each timed switch timeout period. This cushioning assures that switches get refreshed on time even when RUEX is very busy and timed switch manager execution is delayed.
Control Point Operation Logging	Specifies which control point operations are recorded in RUEX event log file. The following options are available: All - Every control code is recorded; State Changes Only - Only control codes which cause state change (OnàOff and OffàOn) are recorded; None - recording is disabled. Note that this parameter does not affect NTMCRDR control point activity recording. The latter always records control point state changes only.
Control Point Operation Repeating (times)	Specifies the number of times control code is to be repeated each time control point is controlled by RUEX. The value of 0 means control code is not repeated, i.e. one control code only is sent out.
Evaluator Driven Control Point Operations	Domain control point desired states can be set based on evaluator calculations, and then executed automatically by RUEX when this parameter is Enabled.
Add Control Point Sunday AOT to Total	Control point Sunday Accumulated Off Time (AOT) is added to point's total AOT when this parameter is Enabled.
Failed Poll Repeating (times)	Specifies maximum number of times remote unit poll gets to be repeated when poll fails. The value of 0 means remote unit gets polled once only.
Delay Between Polls (ms)	Specifies amount of time, in milliseconds, between successive polls. The value of this parameter depends on the communications medium used. This same delay is also used by control code dispatcher for pacing of outgoing control codes.
Data Recording Interval (Minutes)	Specifies RURDR interval, in minutes, to be programmed into remote units when data recording is enabled.
RU List Display Method	Specifies remote unit list display method, when domain list view window is displayed. The value RU Data should be used when domain contains RTUs or multiple relay switches. In this case remote unit relevant data gets to be displayed. The value First CTP Data is used when domain contains single relay switches. In this case first (and only) control point relevant information is displayed.
RU Id Displays (On 2D Listings)	Specifies if remote unit identifiers are to be displayed in 2D domain view windows. This may be turned off when domains contain many remote units.
Hidden RUs / Points	When set to Hide, hidden remote units and I/O points are not displayed. When set to Show, all remote units and points are displayed.
RU Comm. Lines Drawing	Specifies if remote unit communications lines get to be shown in 2D domain view windows. This may be turned off when domains contain many remote units.

Remote Units

Remote unit configuration parameters can be viewed by first opening the relevant remote unit window, then selecting RU à Configure. The last step can be done alternatively by pressing the Configure On-line RU button in the remote unit window.

Remote units differ from one manufacturer to another, and from model to model. The first table below lists parameters common to all remote units.

PARAMETER	DESCRIPTION
<Manufacturer><Model / Protocol><Unit Type>	Parameter value is remote unit id. The identifier is selected by the operator at the time of remote unit creation. Parameter name specifies manufacturer name, unit model / communications protocol, and unit type. For example, GE REMS 101/102 Switch.
Manager Status	Enables or disables all remote unit activities. When Enabled, any enabled sub processes associated with this remote unit are allowed to execute. When Disabled no automatic activities associated with this unit are allowed to execute.
Communications Protocol	Specifies which communications protocol RUEX is to use to communicate with remote unit. Not all choices may be available. Possible choices are NONE (no communications), Native (manufacturer's own protocol), <Specific Protocol> (one or more of the standard protocols, such as DNP 3.0, MODBUS, etc).
External Client Id	Specifies communications channel and protocol RUEX must use to communicate with this unit. The allowed choices are presented in a pull-down menu, and come from the choices configured into IOEX by the operator.
Evaluation Priority (0 = highest)	Specifies evaluation priority of I/O points under this remote unit during each point evaluation cycle.
Display Status	Specifies whether this remote unit is to be displayed in domain windows. When Enabled, the unit is always displayed. When Disabled, the unit is hidden when domain parameter Hidden RUs / Points is set to Hide.

The table below lists parameters common to 2-way remote units, i.e. remote units capable of responding back to the master.

PARAMETER	DESCRIPTION
Polling	Specifies whether this unit is to be polled automatically by RUEX. When Enabled RUEX polls this unit automatically. When Disabled, RUEX ignores this unit, but manual polling is still possible.
Polling Period (System Periods)	Parameter specifies how often this unit is to be polled when polled automatically by RUEX. The period is in multiples of currently active RUEX polling period.
Minimum Polling Period (Seconds)	Specifies minimum interval, in seconds, between automatic polls of this unit. This restriction may have to be imposed on slow counting pulse inputs in order to avoid bad calculation results derived from poor statistics. Manual polls are still permitted during blackout period, however numeric data received during that period (analog points and counters) does not get entered into database.
Min Consec. Poll Failures to Alarm	Specifies minimum number of consecutive poll failures for NTMC to post remote unit alarm. When set to 1, every poll failure generates an alarm.

Remote units reachable via DNP 3.0 protocol.

The table below lists parameters common to all remote units reachable via DNP 3.0 protocol.

PARAMETER	DESCRIPTION
Polling Method	Specifies polling method to be used. Possible choices are Standard (standard RUEX polling algorithm which asks for data for defined I/O points only), and By Classes (polling by DNP object classes).
Static Polling Period (0 = Disabled)	Specifies how often RUEX is to poll remote unit for static (DNP class 0) data objects. The value of 0 means never, the value of 1 means every poll, the value of 2 means every other poll, etc. This parameter is ignored when parameter 'Polling Method' is set to Standard.
Class 1 Period (0 = Disabled)	Specifies how often RUEX is to poll remote unit for events (DNP class 1 data objects). The value of 0 means never, the value of 1 means every poll, the value of 2 means every other poll, etc. This parameter is ignored when parameter 'Polling Method' is set to Standard.
Class 2 Period (0 = Disabled)	Specifies how often RUEX is to poll remote unit for events (DNP class 2 data objects). The value of 0 means never, the value of 1 means every poll, the value of 2 means every other poll, etc. This parameter is ignored when parameter 'Polling Method' is set to Standard.
Class 3 Period (0 = Disabled)	Specifies how often RUEX is to poll remote unit for events (DNP class 3 data objects). The value of 0 means never, the value of 1 means every poll, the value of 2 means every other poll, etc. This parameter is ignored when parameter 'Polling Method' is set to Standard.
R.U Programming on R.U. Restart	Specifies if RUEX must upload programming parameters to remote unit when the latter reports it has been restarted. Programming transpires when parameter is set to Enabled.
Unsolicited Report Generation Management	Specifies how RUEX is to manage unsolicited report generation by remote unit. When set to Disable RUEX sends a command to remote unit instructing it to disable unsolicited report generation. When set to Enable RUEX sends a command to remote unit instructing it to enable unsolicited report generation. When set to Do Not Manage, RUEX sends no command to remote unit.
Event Driven Polling	When parameter is set to Enabled RUEX polls the remote unit whenever the latter sends an unsolicited message reporting availability of class 1, 2, or 3 data (events). No such polling of remote unit transpires when this parameter is set to Disabled.
I/O Points Under Local Control Alarms	Remote unit reports whenever one or more of I/O points is under local control. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Off-Line Alarms	Remote unit reports whenever I/O point is put off-line by point's hosting system. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Host Restart Alarms	Remote unit reports whenever the field device that originated the data object has is-started. This device may be the device reporting this data object. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Host Communications Lost Alarms	Remote unit reports whenever the device reporting a data object has lost communication with the originator of that data object. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point State Forced Remotely Alarms	Remote unit reports whenever the state of the binary I/O point has been forced to its current state at the originating device. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point State Forced Locally Alarms	Remote unit reports whenever the state of the binary I/O point has been forced to its current state at the device reporting this data object. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Chatter Filter Alarms	Remote unit reports whenever a binary I/O point has been filtered in order to remove unneeded transitions in the state of the point. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Value Out of Range Alarms	Remote unit reports whenever a digitized signal or calculation has exceeded I/O points maximum positive or negative value The actual I/O point value can be ignored as its value is not defined. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
I/O Point Reference Check Alarms	Remote unit reports whenever the reference signal used to digitize an analog input is not stable and the resulting digitized value may not be correct. RUEX logs that event and generates an alarm when this parameter is set to Enabled. When set to Disabled RUEX only logs the event.
Momentary Control State 0 Function Code	Function code to be sent to momentary a relay when setting it to logical state 0.
Momentary Control State 1 Function Code	Function code to be sent to momentary a relay when setting it to logical state 1. This code is also used for pulsing of single state relays.
Station Address	Specifies remote unit DNP address.
Manual Control Point Operation Mode	Parameter dictates how control points on this remote unit can be operated. Direct Operate means control points can be operated directly, with a single command. Select Then Operate means control points must first be selected, before manual operation command is sent.
Object Prefix Code	Specifies the DNP Object Prefix Code to be used in replies and unsolicited messages. This parameter is used only when RUEX acts as a DNP slave station (server). Parameter is ignored when RUEX acts as a DNP master station (client).
Range Specifier Code	Specifies the DNP Range Specifier Code to be used in replies and unsolicited messages. This parameter is used only when RUEX acts as a DNP slave station (server). Parameter is ignored when RUEX acts as a DNP master station (client).
Undefined I/O Point Data Processing	Specifies how RUEX is to behave when data is received, but is addressed to an undefined I/O point. Possible values are NONE (Ignore), and Log and Alarm. In the latter case RUEX generates an event log entry for every data received for which I/O point was not defined, also recording I/O point's address.
Unsolicited Report Recipient	Specifies if remote unit is recipient of unsolicited reports. If set to yes, RUEX sends unsolicited reports to remote unit when data change. This parameter is used only when RUEX acts as a DNP slave station (server). Parameter is ignored when RUEX acts as a DNP master station (client).

Remote units reachable via MODBUS protocol (RTU, ASCII, or Enron)

The table below lists parameters common to all remote units reachable via MODBUS protocol.

PARAMETER DESCRIPTION

RTU Address Specifies the unit's MODBUS address.

Modbus Register Width (bits) Width of device Modbus register, in bits. Allowed values are 16 (RTU and ASCII) and 32 (Enron). Associated RUEX I/O point Number of Bits parameters must have the same values as this parameter.

The table below lists parameters specific to General Electric 16 bit PLCs.

PARAMETER DESCRIPTION

PLC Address Numerical address identifying the PLC.

Register Address (Status Reads) Numerical address of the PLC register used for reading status bits. NTMC status point addresses are interpreted as bit identifiers in the register specified by this parameter. All other types of I/O points addresses are interpreted as register addresses within the PLC.

The table below lists parameters specific to Baritek MRCC Master Radio Communications Control unit.

PARAMETER	DESCRIPTION
MRCC Address	Specifies the unit's MODBUS RTU address.
Register Address (Status Reads)	Address of a 16 bit register, assigned by Baritek Inc., for up to 16 status inputs. This parameter is not used at this time, and is reserved for future use.
Register Address (Control Writes)	Address of a 16 bit register, assigned by Baritek Inc., for up to 16 control outputs. This parameter is not used at this time, and is reserved for future use.
Push To Talk Delay (ms)	Delay after the transceiver is keyed before sending data. This is to allow the master transceiver to go from transmit to receive mode. The value of this parameter gets uploaded when programming the remote unit. The default is 250 ms.

The table below lists parameters specific to Baritek WSR 4400 RTU.

PARAMETER	DESCRIPTION
Register Address (Control Writes)	Address of a 16 bit register, assigned by Baritek Inc., for up to 16 control outputs.
Push To Talk Delay (ms)	Delay after the transceiver is keyed before sending data. This is to allow the master transceiver to go from transmit to receive mode. The value of this parameter gets uploaded when programming the remote unit. The default is 250 ms.
Counter 0 Pre-scale Value	Pre-scale factor for KYZ pulses on digital inputs 0 and 1. For example, if the value is set to 6, the pulse counter will be slowed down by a factor of 6. The value of this parameter gets uploaded when programming the remote unit. Default value is 1.
Counter 1 Pre-scale Value	Pre-scale factor for KYZ pulses on digital inputs 2 and 3. For example, if the value is set to 6, the pulse counter will be slowed down by a factor of 6. The value of this parameter gets uploaded when programming the remote unit. Default value is 1.

The table below lists parameters specific to General Electric kV2 meters. Please refer also to General Electric's GEH-7282 documentation on kV2 MODBUS board.

PARAMETER	DESCRIPTION
Load Interval Delay (ms)	Delay, in milliseconds, between them time when NTMC loads the data logger interval selector register, and the time when NTMC reads the interval data (time stamps and load profiling channels) from the unit's MODBUS board.
Last Downloaded Interval	Number of last data logger interval (1 - 2880) downloaded from meter's MODBUS board. The number can be set back in case older data needs to be re-downloaded.
Interval Period (Minutes)	Data logger interval period programmed into the meter. The value of this parameter is copied from the meter and set at the time when NTMC RURDR is enabled. NTMC does not enable the data logger, because the MODBUS board does not support that feature. Meter's data logger must be enabled using GE's MeterMate software.

Telescada NeXGen units (DNP 3.0 Protocol)

The table below lists parameters common to Telescada NeXGen remote terminal units.

PARAMETER	DESCRIPTION
Route Id	Specifies Route identifier to be used when direct communication with remote unit is not possible. When the value is set to NONE, RUEX communicates with the remote unit directly.
Max. Readings per Download	Parameter specifies maximum number of RURDR readings downloaded per each master request. The default value is 50.
Data Recording Interval Authority	Specifies who is responsible for maintaining the value of parameter Data Recording Interval (Minutes). If set to Domain, the domain owning this remote unit is allowed to set the interval. This setting is useful when RURDR is enabled in all remote units simultaneously, using the same data recording interval. When set to RU, the domain manager owning this remote unit is not allowed to change the value. This setting is useful when different data recording intervals are desired.
Data Recording Interval (Minutes)	Specifies RURDR data recording interval to be used. The value is specified in minutes. The possible choices are 1, 5, 10, 15, 30, and 60.

Remote units reachable via Telescada ARS protocol.

The table below lists parameters common to Telescada remote terminal units.

PARAMETER	DESCRIPTION
RTU Address	Specifies address used by RUEX to communicate with the RTU.
Group Address Usage	Specifies if parameter RTU Group Address is defined, and is allowed to be used by RUEX for communication with groups of RTUs. Parameter must be Enabled for this to happen.
RTU Group Address	Specifies group address used by RUEX to communicate with the RTU. All RTUs set up with the same group address receive and process messages containing this address. Parameter Group Address Usage must be Enabled for RUEX to use this address.
Route Id	Specifies Route identifier to be used when direct communication with remote unit is not possible. When the value is set to NONE, RUEX communicates with the remote unit directly.
Quiet Time Duration (ms)	Radio communications timing parameter. Specified in milliseconds. Value ignored when communicated via media other than radio.
Mark Tone Duration (ms)	Radio communications timing parameter. Specified in milliseconds. Value ignored when communicated via media other than radio.

The table below lists parameters common to Telescada ARS-2M, ARS-2MA, ARS-2P and ARS-16P remote terminal units.

PARAMETER	DESCRIPTION
Data Recording Interval Authority	Specifies who is responsible for maintaining the value of parameter Data Recording Interval (Minutes). If set to Domain, the domain owning this remote unit is allowed to set the interval. This setting is useful when RURDR is enabled in all remote units simultaneously, using the same data recording interval. When set to RU, the domain manager owning this remote unit is not allowed to change the value. This setting is useful when different data recording intervals are desired.
Data Recording Interval (Minutes)	Specifies RURDR data recording interval to be used. The value is specified in minutes. The possible choices are 1, 5, 15, 30, and 60.
Download Block Size (Bytes)	Specifies block size, in bytes, for RURDR downloads. Although less efficient, smaller block size may be more appropriate on noisy radio channels.
Download Value Undefined	When RTU receives no data during a time interval it records a 'no data' value into its buffer. This parameter specifies that 'no data' value. When contents of the buffer are downloaded, the 'no data' items are ignored, and are not recorded into NTMC data recording files. The parameter value is 0 for ARS-2M RTUs, and 65535 (Hex FFFF) for ARS-2MA, ARS-2P and ARS-16P models.

The table below lists parameters specific to Telescada ARS-16P remote terminal units.

PARAMETER	DESCRIPTION
RTU Address (Board 2P)	ARS-16P RTUs contain two boards: and ARS-16 type board, and an ARS-2P type board. Each board has its own address, and is communicated with individually. This parameter specifies the address used to communicate with the ARS-2P board. Addressing of the ARS-16 board is done via the RTU Address parameter.

The table below lists parameters specific to switches using General Electric REMS 101 / 102 Protocol.

PARAMETER	DESCRIPTION
Switch Address	Numerical address identifying the switch.
State 0 Function Code	Specifies code used to open the switch relay.
State 1 Function Code	Specifies code used to close the switch relay.
RCG Board Remote Unit Domain	Specifies NTMC domain which contains the remote unit acting as a repeater, using a remote code generator board.
RCG Board Remote Unit Id	Identifies the above-mentioned remote unit.

The table below lists parameters specific to switches using Scientific Atlanta REMS 101 / 102 Protocol.

PARAMETER	DESCRIPTION
Switch Address	Numerical address identifying the switch.
State 0 Function Code	Specifies code used to open the switch relay.
State 1 Function Code	Specifies code used to close the switch relay.
RCG Board Remote Unit Domain	Specifies NTMC domain which contains the remote unit acting as a repeater, using a remote code generator board.
RCG Board Remote Unit Id	Identifies the above-mentioned remote unit.

The table below lists parameters specific to Motorola 5-tone pagers.

PARAMETER	DESCRIPTION
Pager Address	Numerical address identifying the pager.
State 0 String	Specifies string used to announce disconnect messages.
State 1 String	Specifies string used to announce reconnect messages.
RCG Board Remote Unit Domain	Specifies NTMC domain which contains the remote unit acting as a repeater, using a remote code generator board.
RCG Board Remote Unit Id	Identifies the above-mentioned remote unit.

The table below lists parameters specific to Motorola digital switches.

PARAMETER	DESCRIPTION
Plug Code 1 (hex)	Specifies first of three components of numerical switch address. The code must be specified in hexadecimal notation.
Plug Code 2 (hex)	Specifies second of three components of numerical switch address. The code must be specified in hexadecimal notation.
Plug Code 3 (hex)	Specifies third of three components of numerical switch address. The code must be specified in hexadecimal notation.
State 0 Function (hex)	Specifies function code used to open the switch relay. Function must be specified in hexadecimal notation.
State 1 Function (hex)	Specifies function code used to close the switch relay. Function must be specified in hexadecimal notation.

The table below lists parameters specific to switches using Scientific Atlanta 206 Protocol.

PARAMETER	DESCRIPTION
Start Bits	Specifies the number of start bits to be used when communicating with the switch.
Utility Address	Specifies utility address of the switch.
Switch Address	Numerical address identifying the switch.
State 0 Function Code	Specifies code used to open the switch relay.
State 1 Function Code	Specifies code used to close the switch relay.

The table below lists parameters specific to Scientific Atlanta Digital switches.

PARAMETER	DESCRIPTION
State 0 Address	Specifies numerical address used to open the switch relay.
State 1 Address	Specifies numerical address used to close the switch relay.

I/O Points

I/O point configuration parameters can be viewed by first opening the relevant remote unit window, right-clicking on the I/O point, and selecting 'Configure...' command from the context menu.

The table below lists I/O point parameters. Columns on the right side specify which types of points parameters apply to.

PARAMETER	DESCRIPTION	STP	CNT	ANP	LCP	MCP	TCP
I/O Point	I/O point id.	+	+	+	+	+	+
Manager Status	Enables or disables all I/O point activities. When Enabled, any enabled sub processes associated with this I/O point are allowed to execute. When Disabled no automatic activities associated with the I/O point are allowed to execute.	+	+	+	+	+	+
Polling	When Enabled, I/O point is to be included in polling when owner remote unit is polled; when Disabled, the point data is not requested during remote unit poll. See notes on Evaluator Name below.	+	+	+
Point Address	I/O Point's address within owner remote unit. Interpreted differently by the various drivers, but the parameter essentially identifies I/O point in messages between owner remote unit and RUEX.	+	+	+	+	+	+
Bit Offset	Bit location within the register specified by Point Address (when applicable). The value of 0 denotes the least significant bit. The value is ignored by status points where Logic Type is set to Multi-State.	+			+	+	+
Number of Readings	Number of readings kept for trending displays.			+
High Region Name	Region above high threshold. When value of I/O point exceeds the high threshold an alarm event is generated, stating that the point value has entered a region named here.			+
Normal Region Name	Region between high threshold and low threshold. When value of I/O point enters this region an alarm event is generated, stating that the point value has entered a region named here.			+
Low Region Name	Region below low threshold. When value of I/O point falls below the low threshold an alarm event is generated, stating that the point value has entered a region named here.			+
Threshold to High Region	High value threshold. See above notes.			+
Threshold to Low Region	Low value threshold. See above notes			+
Thresholds Absolute Values	Specifies if thresholds are absolute values, i.e. whether absolute point value only is to be compared against the thresholds. This is when monitoring power factor, for example, which may jump from +100% to -100%, and one does not want to alarm that transition.
Units of Measure	Units of measure identifier, such as kW, for display purposes. If set to "NONE" no units are displayed.			+
Evaluator Name	Evaluator identifier assigned to this I/O point. When defined, the I/O point polling parameter must be disabled, for the point's value is to be computed. If the point value is not to be computed, this parameter must be set to NONE, and the point polling parameter must be Enabled.	+	+	+	+	+	+
NTMC Resident Data Recording Status	When Enabled, NTMCRDR is in effect for this I/O point. Not so when Disabled.	+	+	+	+	+	+
NTMC Resident Data Recording File Size	Size limit of point's NTMCRDR file. Unlike event log files which are circular, data recording files are not. An alarm is generated every time new data is appended to a data recording file which is larger than allowed by this parameter. No data is lost, however alarms persist. The only way to get rid of alarms is to archive the file.	+	+	+	+	+	+
Data Recording Scale Factor	Numbers stored in data recording files are first rescaled by this factor. The default value is 1.0 (no scaling), however this parameter may be manipulated by application modules.		+	+
Display Window Id	Parameter specifies window in which I/O point is to be displayed.	+	+	+	+	+	+
Display Status	I/O point is visible in windows when this parameter is set to Visible. The point is not visible when this parameter is set to Hidden, and domain parameter Hidden RUs / Points is set to Hide.	+	+	+	+	+	+
Display Order (0 = First)	Parameter specifies the order in which I/O point gets to be displayed in the window specified by parameter Window Id. Point with Display Order set to 0 is displayed first.	+	+	+	+	+	+
Number of Decimal Places	Specifies number of decimal places to show when displaying analog point values.			+
Number of Significant Figures	Specifies number of significant figures to show when displaying analog point values.			+
Max Abs. Value Displayed Non-Scientifically	Specifies max value displayed non-scientifically (i.e. as 123000), as opposed to 1.23E+05.			+
Trending	Specifies whether value trending is enabled or disabled.			+
Evaluation Priority (0 = highest)	Specifies evaluation priority for the point during each point evaluation cycle. Parameters with lower values assign higher priorities.	+	+	+	+	+	+
Display Color Reversal	The various display color schemes (like ON vs. OFF, for example) get reversed when this parameter is Enabled.	+	+	+	+	+	+
Number of Bits	Specifies register size. The value of this parameter tells RUEX how to handle issues like counter roll-over conditions, signed and unsigned integers, dynamic memory allocation, etc. This parameter must have the same value for all I/O points sharing the same point address.	+	+	+	+	+	+
Integer Type	Specifies whether the point manager is to treat the holding register value as holding a signed or unsigned integer.		+
Logic Type	Specifies what kind of logic is associated with a status point. Possible values are Boolean (two states only, e.g. TRUE vs. FALSE, ON vs. OFF, etc.), and Multi-State (up to 16 possible values).	+
Input Register Encoding	Specifies the encoding format of hardware register being read. Possible choices are: Unsigned Integer, Signed Integer, Twos Complement, and IEEE Standard Floating Point.			+
State n Id	Parameter used by points with N possible states. This parameter labels the nth of the available N states. The value, such as OPEN or CLOSED, comes from StatusNames database, populated by the operator using MCED off-line. Index n must satisfy 0 <= n <= N. For control points, N = 1, i.e. only two possible states. For status points N = 1 when Logic Type = Boolean, and N = 15 when Logic Type = Multi-State (see parameter 'Logic Type' above).	+			+	+	+
Operation Mode	When set to Auto, control point is involved in automatic control point operations. It can also be operated manually. When set to Manual, only manual operation is allowed.				+	+	+
Accumulated Off Time Accumulation	When Disabled, control point's AOT is not updated at the time of transition from OFF to ON state. At that same time parameter's value is automatically reset to Enabled.				+	+	+
State 0 Safety Timer (sec, 0 = off)	Control point safety timer, specified in seconds. After the point transitions from state 0 to state 1, it is not allowed to transition back to state 0 for the number of seconds specified by this parameter.				+	+	+
State 1 Safety Timer (sec, 0 = off)	Control point safety timer, specified in seconds. After the point transitions from state 1 to state 0, it is not allowed to transition back to state 1 for the number of seconds specified by this parameter.				+	+	+
Operation to State 1	Timed control point operation to state 1 commands are issued by RUEX when parameter value is Enabled. Timed control point is left to time out when transition to state 1 is desired (parameter value = Disabled).						+
Operation Logic	When set to Reverse, states 0 and 1 are logically reversed. This may be used when relay operated by this point is a driving relay of a secondary relay with opposite states.				+	+	+
Controlled Quantity Value	Value of quantity may be controlled by application modules. Units of measure are arbitrary, and defined by application modules. Value is used in control point NTMCRDR.				+	+	+
Modbus State 1 Register Value	Value uploaded to Modbus register when control point operation to to State 1 is performed. Default value is 0. Parameter is used by remotes units running one of Modbus protocols only.				+	+	+
Modbus State 0 Register Value	Value uploaded to Modbus register when control point operation to to State 0 is performed. Default value is 255. Parameter is used by remotes units running one of Modbus protocols only.				+	+	+
Time-out Period (Seconds)	Switch time-out period, specified in seconds. Parameter tells RUEX timed switch manager how often to send refresh control code to the switch.						+

Routes

Route parameters can be viewed and / or edited by selecting RUEX à Route à Edit, then selecting the route to be edited. After changes are saved routes must be re-programmed. After routes have been re-programmed, route users must also be re-programmed individually, or all at once. The latter option takes longer to execute, but guarantees correct programming of all remote units in the field.

PARAMETER DESCRIPTION

Route Number Numeric route identifier. Used in messages between master and remote units to identify routes.

Domain Id of domain which owns a route link.

Remote Unit Id of remote unit which acts as a route link. Individual address of this remote unit is used in building remote unit resident route tables. RUEX also uses this information when building messages which need to be relayed by this route.

Evaluators

Evaluator can be viewed and / or edited by selecting RUEX à Evaluator à Edit, then selecting the evaluator to be edited. After changes are saved RUEX event log must be checked for possible compiler errors. Once compiled, any possible linker errors may show up after first evaluation cycle. This happens if references to nonexistent database entries are made. BTE recommends that evaluator editing be done by qualified engineers only.

Keywords

Evaluators understand the following keywords:

KEYWORD DESCRIPTION

define Used in definition statements to:

Define a symbol for a variable.

Associate above variable with an I/O point.

this Used in assignment statements to denote the I/O point in the process of being evaluated.

Keywords Table

Statements

Evaluators understand the following statements (see sections following the table for explanation):

STATEMENT FORM

definition define symbol = I/O point

assignment symbol = expression

Statements Table

Definition Statements

In the definition statement (line 1 of the Statements Table), symbol can be any string composed of characters A-Z, a-z, and 0-9. The parser is case sensitive, which means that it treats symbols such as energy and Energy as different symbols. Spaces are allowed in definition statements, but not in symbol names. Purely numerical identifiers (such as 123) are not allowed.

In the definition statement (line 1 of the Statements Table), I/O Point identifies the I/O point the above symbol represents in calculations to follow. The identifier can have one of the following forms:

I/O POINT IDENTIFIER FORM EXPLANATION

PointId PointId identifies I/O point on the remote unit being evaluated. Linking of such variable is done every time I/O point is involved in a calculation. This makes sharing of evaluators possible.

PointId@RemoteUnitId PointId identifies I/O point, and RemoteUnitId specifies the remote unit hosting the I/O Point. This form specifies one, and only one I/O point in the database.

I/O Point Identifier Forms Table

Syntax in line 1 above is useful when one is using one evaluator for many I/O points on similarly configured remote units. Example:

define DP = DemandPulses

Here, DP is the new symbol, and DemandPulses is the identifier of an I/O point. Whenever a point called DemandPulses is involved in a calculation, the linker maps the symbol DP to the point called DemandPulses, on the remote unit being evaluated.

Another Example:

this = DP * 3.14

Here, this translates to I/O point being evaluated. In this case, the value of I/O point calculates to 3.14 times the value of Demand Pulses on the same remote unit.

Syntax in line 2 above is useful when we have a unique I/O point, and want to refer to it specifically. Example:

define DP = DemandPulses@Substation1

Here, DP is the new symbol, and DemandPulses is the identifier of an I/O point on remote unit called Substation1. This reference points to the same point in the database no matter where the evaluator is executed.

Note that, since RUEX can act as a remote unit to another NTMC system, using syntax in line 2 of the above table enables one to map variables not only to I/O points on any remote unit in the system, but also to I/O points on any machine on the network.

All definition statements must be executed before any assignment statements.

Assignment Statements

In the assignment statement (line 2 of the Statements Table), symbol can be any string composed of characters A-Z, a-z, and 0-9. The parser is case sensitive, which means that it treats symbols such as energy and Energy as different symbols. Spaces are allowed in assignment statements, but not in symbol names. Purely numerical identifiers (such as 123) are not allowed.

If the symbol was previously defined in a definition statement, then it refers to some I/O point (see above). If the symbol appears in the evaluator for the first time, it is treated as a temporary variable. Temporary variables hold intermediate calculation values. Purely numeric symbols are not allowed on the left side of assignment statements, i.e. to the left of '='. if the symbol is the keyword this, the result of the statement expression goes directly into the I/O point being evaluated.

In the assignment statement (line 2 of the Statements Table), expression can be any valid mathematical expression consisting of numerical constants, symbols (previously defined, or temporary variables - as described in the last paragraph), unary operators, binary operators, functions, and parentheses. The tables below list operators and functions supported by RUEX.

OP NAME EXAMPLE

** Power 2**3 = 8

* Multiplication 2*3 = 6

/ Division 2/3 = 0.66666...

+ Addition 2+3 = 5

- Subtraction 2-3 = -1

Operators

FUNC NAME EXAMPLE

abs Absolute Value abs(2) = 2, abs (-2) = 2

sgn Sign sgn(2) = 1, sgn(-2) = -1

sqrt Square Root sqrt(2) = 1.41427...

sin Trigonometric Sine sin(2) = 0.90930...

cos Trigonometric Cosine cos(2) = -0.41615...

tan Trigonometric Tangent tan(2) = -2.18504...

asin Trigonometric Arc Sine asin(0.90930...) = 2

acos Trigonometric Arc Cosine acos(-0.41615...) = 2

atan Trigonometric Arc Tangent atan(-2.18504...) = 2

sinh Hyperbolic Sine sinh(2) = 3.62686...

cosh Hyperbolic Cosine cosh(2) = 3.76220...

tanh Hyperbolic Tangent tanh(2) = 0.96403...

log10 Logarithm, base 10 log10(2) = 0.30103...

log Natural Logarithm, i.e. Logarithm base e (e = 2.71828...) log(2) = 0.69315...

exp Exponential function exp(2) = 7.38906...

Standard Functions

FUNC	DEFINITION	EXAMPLES
if	A=if(x), A = 1.0 for x > 0, A = 0.0 otherwise	if (2) = 1, if (0) = 0, if (-1) = 0
ltime	Latest time I/O point was updated	ltime(A) = N, See note below
ptime	Previous time I/O point was updated	ptime(A) = M, See note below
prev	Previous value of I/O point	prev(A) = B

NTMC Specific Functions

Note: In examples above, the returned times (M and N, respectively) are in Microsoft format - number of seconds since January 1, 1970. In other words, just a large integer. This makes time computation easier. For example, elapsed time, in seconds, between the last two updates of I/O point in above table is N - M. All internal time calculations inside NTMC are done this way. This is one reason why NTMC is Y2K compliant (as long as the Microsoft time libraries are compliant): the year 2000 in this format does not stand out in any special way. Time conversions to various string formats (04/26/02, April 26, 2002, etc.) are done for display purposes only.

Panels

Parameters below are common to all panels. They can be viewed by first opening the relevant panel window, then selecting Panel à Configure. The last step can be done alternatively by right-clicking onto the open panel window, and selecting 'Configure...' command.

PARAMETER DESCRIPTION

Panel Id Displays the Panel id. This is a read only parameter, it can not be changed. The identifier is selected by the operator at the time of display panel creation.

Manager Status Enables or disables all panel activities. When enabled, any enabled sub processes associated with this panel are allowed to execute. When disabled no automatic activities associated with the panel are allowed to execute.

Design Window Background Color Parameter specifies background color of panel window in design mode.

Monitor Window Background Color Parameter specifies background color of panel window in monitor mode.

Design Window DE Connector Color Parameter specifies connector color of display elements when panel window is in design mode.

Monitor Window DE Connector Color Parameter specifies connector color of display elements when panel window is in monitor mode.

Design Window DE Body Color Parameter specifies body color of display elements when panel window is in design mode.

Monitor Window DE Body Color Parameter specifies body color of display elements when panel window is in monitor mode.

Monitor Window DE Body Alarm Color Parameter specifies body color of display elements when panel window is in monitor mode, and display element is in alarm state.

Design Window DE Frame Color Parameter specifies frame color of display elements when panel window is in design mode.

Monitor Window DE Frame Color Parameter specifies frame color of display elements when panel window is in monitor mode.

Design Window DE Body Background Color Parameter specifies body background color of display elements when panel window is in design mode.

Monitor Window DE Body Background Color Parameter specifies body background color of display elements when panel window is in monitor mode.

Display Elements

Tables below use terminology defined in the following figure, showing a display element in design mode:

Parameters below are common to all display elements. They can be viewed by first opening the relevant panel window, right-clicking onto the display element of interest, then selecting the 'Configure...' command.

PARAMETER DESCRIPTION

Display Element Id Displays the display element id. This parameter can be edited.

Display Element Type Displays the display element type. This parameter can not be edited.

Manager Status Enables or disables all display element activities. When enabled, any enabled sub processes associated with this display element are allowed to execute. When disabled no automatic activities associated with the display element are allowed to execute.

Object Rotation (Degrees) Parameter specifies whether or not object should be rotated. When Disabled, object is not rotated, otherwise it is rotated by the specified number of degrees. Available options are 90, 180, and 270. This parameter is not available for descriptors.

Color Management Authority Parameter specifies which object is responsible for object colors. When set to Owner Object, the owner panel color settings determine this object colors. When set to This Object, this object is responsible for its own color settings (parameters below).

Design Window Background Color Parameter specifies background color of display element window when owner panel window is in design mode.

Monitor Window Background Color Parameter specifies background color of display element window when owner panel window is in monitor mode.

Design Window Connector Color Parameter specifies connector color of display element window when owner panel window is in design mode.

Monitor Window Connector Color Parameter specifies connector color of display element window when owner panel window is in monitor mode.

In addition to above, the following parameters describe display elements which can be mapped onto panels, I/O points, or remote units.

PARAMETER DESCRIPTION

Mapping Mode When set to NONE, display element is not mapped to any child object. When set to I/O point, display element is mapped to an I/O point. When set to Display Panel, display element is mapped to display panel. When set to Remote Unit, display element is mapped to a remote unit. See parameters below.

Child Panel Id Parameter can be either NONE, or must identify display panel to which this display element is being mapped to. This parameter is ignored unless 'Mapping Mode' parameter above is set to Display Panel.

Domain Id Parameter can be either NONE, or must identify domain to which this display element is being mapped to. This parameter is ignored unless 'Mapping Mode' parameter above is set to I/O point or Remote Unit.

Remote Unit Id Parameter can be either NONE, or must identify remote unit to which this display element is being mapped to. This parameter is ignored unless 'Mapping Mode' parameter above is set to I/O point or Remote Unit, and 'Domain Id ' parameter above is properly defined.

I/O Point Id Parameter can be either NONE, or must identify I/O point to which this display element is being mapped to. This parameter is ignored unless 'Mapping Mode' parameter above is set to I/O point, and 'Domain Id ' and 'Remote Unit Id' parameters above are properly defined.

Mapped Relay State Logic Relay state can be displayed as opposite to that of the child object when this parameter is set to Reverse.

Descriptor Id Parameter can be either NONE, or must identify a descriptor used to describe this display element.

Design Window Body Color Parameter specifies body color of display element window when owner panel window is in design mode.

Monitor Window Body Color Parameter specifies body color of display element window when owner panel window is in monitor mode.

Monitor Window Body Alarm Color Parameter specifies body color of display element window when owner panel window is in monitor mode, and display element is in alarm state.

Design Window Frame Color Parameter specifies frame color of display element window when owner panel window is in design mode.

Monitor Window Frame Color Parameter specifies frame color of display element window when owner panel window is in monitor mode.

Design Window Body Background Color Parameter specifies body background color of display element window when owner panel window is in design mode.

Monitor Window Body Background Color Parameter specifies body background color of display element window when owner panel window is in monitor mode.

Center to 0 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 45 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 90 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 135 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 180 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 225 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 270 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

Center to 315 Degrees Connector When parameter is set to Display, the connector is displayed. When set to Hide, connector is not displayed.

The following parameters describe descriptors.

PARAMETER DESCRIPTION

Frame Type Parameter specifies the type of frame to be drawn around the displayed labels.
When set to Single Rectangle, a single rectangle is drawn around the label(s).

When set to Multiple Rectangles, a separate rectangle is drawn around each of the displayed labels.

When set to Circle, a single circle is drawn around the label(s).

When set to NONE, no frame is drawn.

Labels to Display Parameter specifies the number of labels this descriptor is to display. Available options are 0, 1, 2, 3. The value of 0 effectively turns off this object.

Identifier Label Source Parameter specifies which object provides Identifier string to be displayed.
When set to This Object, descriptor's own Display Element Id parameter is used.

When set to Parent Object, parent display element's Display Element Id parameter is used. That display element must point to this descriptor via the Descriptor Id parameter.

When set to Sibling Object, parent display element must be mapped to an I/O point via the I/O Point Id parameter. At the same time, that display element must point to this descriptor via the Descriptor Id parameter. The above mentioned I/O point is the sibling object whose Id gets to be displayed.

When set to NONE, no identifier is displayed.

Value Label 1 Source Parameter specifies the source of the first label used to display a value.
When set to Value Label 1, the value of descriptor's own 'Value Label 1' parameter (below) is used.

When set to Owner Object Value, parent display element must point to this descriptor via the Descriptor Id parameter. The above mentioned display element is the owner object whose value gets to be displayed.

When set to Sibling Object Value, parent display element must be mapped to an I/O point via the I/O Point Id parameter. At the same time, that display element must point to this descriptor via the Descriptor Id parameter. The above mentioned I/O point is the sibling object whose value gets to be displayed.

When set to Sibling Object Status, parent display element must be mapped to an I/O point via the I/O Point Id parameter. At the same time, that display element must point to this descriptor via the Descriptor Id parameter. The above mentioned I/O point is the sibling object whose status gets to be displayed.

When set to NONE, no value is displayed.

Value Label 1 This parameter value can be displayed by the descriptor when 'Value Label 1 Source' (above) is set to Value Label 1.

Value Label 2 Source Parameter specifies the source of the second label used to display a value.
When set to Value Label 2, the value of descriptor's own 'Value Label 2' parameter (below) is used.

When set to Owner Object Value, parent display element must point to this descriptor via the Descriptor Id parameter. The above mentioned display element is the owner object whose value gets to be displayed.

When set to Sibling Object Value, parent display element must be mapped to an I/O point via the I/O Point Id parameter. At the same time, that display element must point to this descriptor via the Descriptor Id parameter. The above mentioned I/O point is the sibling object whose value gets to be displayed.

When set to Sibling Object Status, parent display element must be mapped to an I/O point via the I/O Point Id parameter. At the same time, that display element must point to this descriptor via the Descriptor Id parameter. The above mentioned I/O point is the sibling object whose status gets to be displayed.

When set to NONE, no value is displayed.

Value Label 2 This parameter value can be displayed by the descriptor when 'Value Label 2 Source' (above) is set to Value Label 2.

Text Justification Parameter specifies how label(s) displayed by this descriptor are justified. The possible choices are Left, Center, and Right.

The following parameters describe display elements of type 'Circle'.

PARAMETER DESCRIPTION

Circle Radius Parameter specifies circle radius. Possible values are 0 - 100.

The following parameters describe display element types 'Relay', 'Fuse', 'CircuitBreaker', and TwoThrowRelay'.

PARAMETER DESCRIPTION

Unmapped Relay State Possible values are Open, and Closed. Parameter determines the state of the relay in display panel when the display element is not mapped to any I/O point. One can thus bring one-line diagrams up to date manually even when NTMC does not control all relays.