System
- Overview
- Configuration List
- Data Flag List
- Nova Score List
- Scheduler List
- Serial Port List
- View Log Files
Overview
The System command accesses a menu of subordinate commands that configure various aspects of the NovaStar 5 system, including:
The Configuration List and the Serial Port List allow configuration of serial port assignments that integrate the NovaStar 5 system hardware and software. These commands should be accessed as a final step in the installation of the NovaStar 5 application as described in the Configuration List section and the Serial Port List section. The Data Flag List and the Nova Score List can be used to change NovaStar 5 configuration, but the defaults provided by the system are often used without edits. See the Data Flag List section and the Nova Score List section, respectively. The Scheduler List allows users to set up automatic processes for data reporting as described in the Scheduler List section. The View Log File menu allows viewing the raw point data reports that are stored by NovaStar 5 in log files. These can be useful for investigating system operation. See the View Log Files section.
Configuration List
To reach the Configuration List page, click on the System menu in the registered user Home page. The Configuration List page will appear, which allows enabling and disabling data collection startup and general display formats.
Clicking on any of the column heading buttons will reorder the reports in the Configuration List, numerically or alphabetically, by that detail. The Choose details... button allows specifying what information is displayed by the Configuration List page using the Configuration List Details page, see the Configuration List Details section.
Configuration List (see also the full-size image)
Click the Add button at the upper right-hand corner of the Configuration List table to define a new item using the Configuration Add page. Click on the Edit button on any row in the Configuration List table to view or edit the item on the Configuration Edit page. See the Configuration Edit section.
Configuration List Details
The check boxes on Configuration List Details page control the items, organization, sort order, and limit the records displayed on the associated List page.
Configuration List Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Configuration Edit
Click on the Edit button associated with any item defined in the Configuration List table, or click Apply from the Configuration Add or Configuration Copy pages to create a new configuration item, which displays the Configuration Edit page.
The contents of the Configuration Edit page will changed depending on the contents of the name field. Some names have values that are limited to false or true; others have programmable values. See the Configuration Parameters section for an explanation of the configuration parameters.
Configuration Edit (see also the full-size image)
Identification
| Data Label | Description |
|---|---|
| Name | Configuration parameter name. Max 100 characters. |
| Value | Configuration parameter value. Max 255 characters |
| Options | Configuration parameter options. Max 255 characters. |
Parameters options may be a list of command line options passed to the NovaStar data collection program.
These command arguments may have the format -X Y.
Where X is a upper or lower case letter and Y is a value or string.
For example: -r 30minutes.
Multiple command arguments are separated by spaces.
See the Configuration Parameters section for a description of configuration parameter names, values, and options.
Execute
Configuration list items that control NovaStar data collection, database replication, and data alarm actions can be controlled from this page. Click an action button to control the process. Select single or network command action. Network commands are executed on all NovaStar 5 database replication nodes.
| Button | Action |
|---|---|
| Start | Start the process if not running. |
| Stop | Stop the process if running. |
| Restart | Stop and then restart the process. |
| Status | Display the running status of the process. |
 |
Stop command. |
 |
Clear display window. |
 |
Reset display window size to default. |
 |
Decrease pick list length. |
 |
Increase pick list length. |
 |
Move from pick list to assigned list. |
 |
Move from assigned list to pick list. |
Configuration Parameters
50386 Data Collection
| Data Label | Description |
|---|---|
| Name | 50386_data_collection |
| Enabled | Replication state that enables start. false: Disabled failover: Enabled when replication state is Failover. master: Enabled when replication state is Disabled, Master, Single, or Failover. single: Enabled when replication state is Disabled or Single. slave: Enabled when replication state is Slave. When enabled, 50386 data collection will begin automatically on system boot up or when the data collection is manually started. Data collection can be disabled by setting this parameter to false when suspension would be useful for system maintenance. |
| Options | none. |
In the below example, the 50386 data collection programs defined by 50386_port# records will be started when the NovaStar 5 data collection is started.
| Name | Value | Options |
|---|---|---|
| 50386_data_collection | true |
50386 Data Collection Ports
| Data Label | Description |
|---|---|
| Name | 50386_port#, where # is replaced by the port number: 1, 2, 3, ... |
| Value | Specifies the serial port alias or network port to which the 50386 receiver is connected. Replace # with 1 for the first receiver, 2 for the second, and so on. Incoming 50386 data is read and station polling commands are sent through this port. Serial port aliases are defined in the serial port list and assigned to physical serial ports; for example /dev/rtdd1. Network ports are defined as hostname:port where hostname is a computer name or IP address and port is a port number; for example 10.150.11.23:2101. |
| Options | Command options for the ns50386server program. -a #: Alarm trigger at loss of data. -d #: Set diagnostic level (Default: 1). -f: Do not file data received. -l #: Sets the file for logging: 0=nssyslog, 1=nsrecdata.log 2=nsautointer.log (Default: 2). -m port: Serial port alias connected to the 50386 DCU (Default: /dev/dc1). -n host:port: Remote host name or TCP/IP address and port connected to the 50386 DCU. -P port: Remote connection port number (can be included in host name above). -p port: Port number to listen on for for connections. -q: Do NOT display status messages. -r #[smhd]: Data collection down timeout (Default: none). -S #: Source line number set in the data port flags and written in the data collection log file (Line: #) to indicate which source a data report came from. -T: Files data reports with current time (Default: report time). -t #[smhd]: Limits future report filing by this interval. -W #[smhd]: Wait to connect interval (Default: 10 seconds). -y: Disable CTS wait for RTS/CTS toggle on serial ports. -Z #[smhd]: Wait before reconnect (Default: 5 seconds). |
In the below example, when the 50386 data collection program is started it will connect to IP address 192.168.1.202 on port 2101.
Manual polling will connect to the program on port 8511.
ScadaLynx reports received on this line will be filed in the database with source line number 3.
Diagnostic logging will be in the nsautointer.log file.
After 30 minutes of no data reports received, the data collection alarm trigger 32 will be executed.
| Name | Value | Options |
|---|---|---|
| 50386_port1 | 192.168.1.202:2101 | -p8511 -S3 -l2 -r30m -a32 |
Alarms Enabled
| Data Label | Description |
|---|---|
| Name | alarms_enable |
| Value | When true, alarm actions will be taken when alarm conditions are met. When false, alarm actions are disabled; the date and time alarms are to be re-enabled must be set in the Options column. |
| Options | Date and time that alarms will be re-enabled. |
In the below example, the system alarms are disabled until 02/11/2012 at 08:00:00.
| Name | Value | Options |
|---|---|---|
| alarms_enable | false | 02/11/2012 08:00:00 |
ALERT data collection
| Data Label | Description |
|---|---|
| Name | alert_data_collection |
| Enabled | Replication state that enables start. false: Disabled failover: Enabled when replication state is Failover. master: Enabled when replication state is Disabled, Master, Single, or Failover. single: Enabled when replication state is Disabled or Single. slave: Enabled when replication state is Slave. When enabled, ALERT data collection will begin automatically on system boot up or when the data collection is manually started. Data collection be disabled by setting this parameter to false when suspension would be useful for system maintenance. |
| Options | none. |
In the below example, the ALERT data collection programs defined by alert_port# records will be started when the NovaStar 5 data collection is started.
| Name | Value | Options |
|---|---|---|
| alert_data_collection | true |
ALERT data collection port
| Data Label | Description |
|---|---|
| Name | alert_port# where # is replaced by the port number: 1, 2, 3, ... |
| Value | Specifies the serial port alias or network port to which the ALERT decoder is connected. Replace # with 1 for the first decoder, 2 for the second, and so on. Incoming ALERT data is read from this port. Serial port aliases are defined in the serial port list and assigned to physical serial ports; for example /dev/rtdd1. Network ports are defined as hostname:port where hostname is a computer name or IP address and port is a port number; for example 10.150.11.23:2101. |
| Options | Command options for the nsrecdata program. -a #: Alarm trigger at loss of data. -B: Baudrate sets the data collection port baud rate overriding the baud rate set in the Serial Port List (Default: 300). -b: Use the baud rate set in the Serial Port List. -c [0,1]: Network connect type: 0=listen, 1=connect. -d #: Set diagnostic level (Default: 1). -EGG: Supports EG&G format -ENH: Supports Enhanced format. -EIF: Supports IFLOWS format. -f: Do not file data received -F: filename Filtered ID checking file name. -G #,#,#: Line input field order for date-time(1), point(2), data(3). Use alert2 alone to specify ALERT2 A format. -H string: Heartbeat string used to keep network communication alive. When this string is received the receive data timeout timer is reset. -k: Enable network connection keep alive feature. -P program: Execute this program when data is received. -q: Do NOT display status messages. -R filename: Rule file nane used to verify ID numbers. -r #[smhd]: Data collection down and baud rate reset timeout (Default: 1hour). -S #: Source line number set in the data port flags and written in the data collection log file (Line: #) to indicate which source a data report came from. -s #[smhd]: Round time of reports received (Default: none). -w #[smhd]: Wait after data received before program executed (Default: 1second). -W #[smhd]: Wait to connect (Default: 10seconds). -Z #[smhd]: Wait before reconnect (Default: 5seconds). -z #: Interval in seconds to prevent repeat report filing (Default: Use repeat_report_interval configuration parameter). |
In the below example, when the ALERT data collection program is started it will connect to serial port alias /dev/rtdd1.
ALERT reports received on this line will be filed in the database with source line number 1.
After 5minutes of no data reports received, the data collection alarm trigger 31 will be executed.
| Name | Value | Options |
|---|---|---|
| alert_port1 | /dev/rtdd1 | -S1 -r5minutes -a31 |
Alert talk 3 auto-dialer
| Data Label | Description |
|---|---|
| Name | alerttalk3 |
| Value | When true, the alert_talk3 driver will start automatically on system boot up. The alert talk 3 driver can be disabled by setting this parameter to false when suspension would be useful for system maintenance. |
| Options | Command options for the nsalerttalk3 program. -d #: Set diagnostic level (Default: 1). -n host:port: Host name and port number (Default: localhost:8503). -U #,#,...: Alert talk 3 units managed by this driver (Default: control all). |
In the below example, the alert talk 3 program is started when the NovaStar 5 data collection is started. The program will control alert talk 3 unit number 1 and will listen for control commands on the localhost port 8503.
| Name | Value | Options |
|---|---|---|
| alerttalk3 | true | -n localhost:8503 -U1 |
Automatic interogation
| Data Label | Description |
|---|---|
| Name | automatic_interrogation |
| Enabled | Replication state that enables start. false: Disabled failover: Enabled when replication state is Failover. master: Enabled when replication state is Disabled, Master, Single, or Failover. single: Enabled when replication state is Disabled or Single. slave: Enabled when replication state is Slave. When enabled, remote station polling will begin automatically on system boot up or when the data collection is manually started. Automatic remote station polling can be disabled by setting this parameter to false when suspension would be useful for system maintenance. The parameter boot_data_collection must be true to start automatic remote station polling on booted. |
| Options | Command options for the nsautointer program. -c #: Wait time in minutes between interrogation time checks (Default: 1minute). -d #: Set diagnostic level (Default: 1). -i: Does immediate interrogation on program start. Otherwise wait for next wait time interval. -m: Disable multi-line station polling. -P program: Execute this program after interrogation. -t polltype: Type of polling: 0 = current value 1 = last sample value 2 = last logged value 3 = logged since last poll 4 = logged between times. -w #: Time to wait in minutes after program start before polling starts (Default: 0). |
In the below example, the automatic interrogation is started when the NovaStar 5 data collection is started. When stations are polled, data is retrieved since the last time polled.
| Name | Value | Options |
|---|---|---|
| automatic_interrogation | true | -t 3 |
Boot data collection
| Data Label | Description |
|---|---|
| Name | boot_data_collection |
| Enabled | Replication state that enables start. false: Disabled failover: Enabled when replication state is Failover. master: Enabled when replication state is Disabled, Master, Single, or Failover. single: Enabled when replication state is Disabled or Single. slave: Enabled when replication state is Slave. When enabled, data collection will begin automatically on system boot up. Data collection can be disabled by setting this parameter to false when suspension would be useful for system maintenance. The automatic data collection starts the 50386_data_collection, alert_data_collection, automatic_interrogation, database_replication, map display, smbfs, and alert talk 3 processes if they are enabled. |
| Options | none. |
In the below example, the NovaStar data collection programs are started when the computer is booted.
| Name | Value | Options |
|---|---|---|
| boot_data_collection | true |
Check interval factor
| Data Label | Description |
|---|---|
| Name | check_interval_factor |
| Value | Point no report interval is multiplied by this factor to computed how far back in time to query the database for reports in data analysis. |
| Options | none |
In the below example, the point no report interval is multiplied by a factor of 10 when query the database for data reports before a data analysis interval.
| Name | Value | Options |
|---|---|---|
| check_interval_factor | 10 |
Database Node # Name and State
| Data Label | Description |
|---|---|
| Name | database_node#, where # is 1, 2, ... |
| Value | Replication host name |
| State | Replication state of local node. failed: Replication failed on node. master: Master of database in replication network. slave: Slave in replication network. |
In the below example, the the master node 1 host name is novastar5a, and the slave node 2 is named novastar5b.
| Name | Value | Options |
|---|---|---|
| database_node1 | novastar5a | master |
| database_node2 | novastar5b | slave |
Database update wait
| Data Label | Description |
|---|---|
| Name | database_update_wait |
| Value | Time to wait in seconds for a database update to complete when the OK or Apply button in clicked on an edit page (Default: 15 seconds). Increase this time if the database replication synchronization time delays require it. |
| Options | none |
In the below example, the database update wait time is set to 30 seconds.
| Name | Value | Options |
|---|---|---|
| database_update_wait | 30 seconds |
Database Replication
| Data Label | Description |
|---|---|
| Name | database_replication |
| State | Replication state of local node. failed: No database replication. failover: Backup database detected failure of master and became failover master. master: Master of database in replication network. single: Replication disabled. slave: Slave in replication network. Database replication can be disabled by setting this parameter to false when suspension would be useful for system maintenance. |
| Options | Replication failover checking -a #: Alarm trigger for replication failure. -f state: Replication failure checking enabled when true, disabled when false. Trigger: Select the alarm trigger for replication failure. Click View to display the alarm trigger parameters for the selected trigger. Click List to list alarm triggers. Enable failover: Select true to enable replication failure checking, false to disable. |
In the below example, the NovaStar database for this server is the master in the replication network, replication failure checking is enabled, and failure executes alarm trigger 45.
| Name | Value | Options |
|---|---|---|
| database_replication | master | -a 45 -f true |
Replication
Node 1 Name: Host name of node 1 in the database replication network.
Node 1 State: Replication state of node 1 in the database replication network.
Node 2 Name: Host name of node 2 in the database replication network.
Node 2 State: Replication state of node 2 in the database replication network.
Replication node names and states are stored in a configuration table row with name database_node1 and database_node2.
Execute
Additional execute command buttons are displayed to control the database replication.
| Button | Action |
|---|---|
| Setup | Setup database replication. Use the database node names and states defined above. |
| Drop | Drop the database replication. |
| Switch | Switch the master database replication node, for example from 1 to 2. |
| Failover | Execute replication failover, take over as master. |
Database update wait
| Data Label | Description |
|---|---|
| Name | database_update_wait |
| Value | Time to wait in seconds for a database update to complete when the OK or Apply button in clicked on an edit page (Default: 15 seconds). Increase this time if the database replication synchronization time delays require it. |
| Options | none |
In the below example, the database update wait time is set to 30 seconds.
| Name | Value | Options |
|---|---|---|
| database_update_wait | 30 seconds |
Forecast
| Data Label | Description |
|---|---|
| Name | forecast |
| Value | When true, the forecast update page button is shown in the menu |
| Options | none |
In the below example, the NovaStar forecast update page button is shown in the menu.
| Name | Value | Options |
|---|---|---|
| forecast | true |
Java Heap Size
| Data Label | Description |
|---|---|
| Name | java_heap_size |
| Value | The limit is defines the maximum memory available for Java requests by the NovaStar5 web pages. It has the greatest effect on the plot data display plot point limit (Default: 512MB). |
| Options | none |
In the below example, the Java heap size is increase from 512MB to 1GB.
| Name | Value | Options |
|---|---|---|
| java_heap_size | 1GB |
Last report interval
| Data Label | Description |
|---|---|
| Name | last_report_interval |
| Value | When performing data analysis, this interval is how far back in time this system looks for a report before the data analysis period starts (Default: 1 year). |
| Options | none |
In the below example, the time interval used to find the last report prior to the data analysis period is 1 month.
| Name | Value | Options |
|---|---|---|
| last_report_interval | 1 month |
Local hostname
| Data Label | Description |
|---|---|
| Name | local_hostname |
| Value | Host name of the local host. Used by database replication logic. |
| Options | none |
In the below example, the local host name is novastar5a.
| Name | Value | Options |
|---|---|---|
| local_hostname | novastar5a |
Map display
| Data Label | Description |
|---|---|
| Name | map_display |
| Value | When true, the map display driver will start automatically on system boot up. The map display driver can be disabled by setting this parameter to false when suspension would be useful for system maintenance. |
| Options | Command options for the nsmapdisplay program. -d #: Set diagnostic level (Default: 1). -n host:port: Host name and port number (Default: localhost:8502). -U #,#,...: Map display units managed by this driver (Default: control all). |
In the below example, the map display program is started when the NovaStar 5 data collection is started. The program will control map display unit number 1 and will listen for control commands on the localhost port 8502.
| Name | Value | Options |
|---|---|---|
| map_display | true | -n localhost:8502 -U1 |
Plot Point Limit
| Data Label | Description |
|---|---|
| Name | plot_point_limit |
| Value | Maximum number of plot points allowed per plot panel. This limit is used to prevent Java memory overflow for plot data display requests. When the limit is exceeded by a user request, the user is warned and the plot request is cancelled. The limit is affected by the Java heap size limit which is 512MB by default. (Default: 50000). |
| Options | none |
In the below example, the maximum number of plot points is increased to 100,000. This can be done if the Java heap size is increased from 512MB to 1GB.
| Name | Value | Options |
|---|---|---|
| plot_point_limit | 100000 |
Polling Ports
| Data Label | Description |
|---|---|
| Name | poll_port# where # is replaced by the port number: 1, 2, 3, ... |
| Value | Defines the serial port alias or network port to which a polled station port is connected. Serial port aliases are defined in the serial port list and assigned to physical serial ports; for example /dev/dc1. Network ports are defined as hostname:port where hostname is a computer name or IP address and port is a port number; for example 10.150.11.23:2101. |
| Options | Command options for the NovaStar polling program. -S #: Source line number set in the data port flags and written in the data collection log file (Line: #) to indicate which source a data report came from. |
In the below example, the manual and automatic station polling programs will connect to the service on host novastar5a port number 8511 for station assigned to line number 1. Data reports received by poll stations on this line will be filed in the database with source line number 3.
| Name | Value | Options |
|---|---|---|
| poll_port1 | novastar5a:8511 | -S3 |
Repeat Report Interval
| Data Label | Description |
|---|---|
| Name | repeat_report_interval |
| Value | Data collection programs will not store multiple data reports received within this interval. For example, this prevents an ALERT data report that is received once directly and then 2 seconds later by a repeater from being filed twice (Default: 2 seconds). |
| Options | none |
In the below example, the repeat report interval is set to 5 seconds.
| Name | Value | Options |
|---|---|---|
| repeat_report_interval | 5 seconds |
System Name
| Data Label | Description |
|---|---|
| Name | system_name |
| Value | Name of system to be used in alarms and reports. Use the hostname by default. |
| Options | none |
In the below example, the system name Hydrolynx Systems NovaStar 5A will be used in alarms and reports.
| Name | Value | Options |
|---|---|---|
| system_name | Hydrolynx Systems NovaStar 5A |
System Name
| Data Label | Description |
|---|---|
| Name | system_name |
| Value | Name of system to be used in alarms and reports. Use the hostname by default. |
| Options | none |
In the below example, the system name Hydrolynx Systems NovaStar 5A will be used in alarms and reports.
| Name | Value | Options |
|---|---|---|
| system_name | Hydrolynx Systems NovaStar 5A |
Time Format
| Data Label | Description |
|---|---|
| Name | time_format |
| Value | Specifies the format for displaying time in NovaStar 5 reports. Years can use a two-digit or four-digit formant, and dates can be displayed with the month, day and year in the desired order. Times can be displayed using either a 24-hour clock or a 12-hour clock by setting the hour value using either capital H's or lower case h's, respectively, see the Time Format Parameters table. |
| Options | Time format options. 24:00:00: Show midnight time as 24:00:00 at end of period. |
In the below example, the time format MM/dd/yyyy HH:mm:ss will display January 5, 2012 at 1:35 pm as 01/05/2012 13:35:00.
| Name | Value | Options |
|---|---|---|
| time_format | MM/dd/yyyy HH:mm:ss | 24:00:00 |
Time Format Parameters
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| M | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT -08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
Time Format 24 hour Clock
| Data Label | Description |
|---|---|
| Name | time_list_24_hour_clock |
| Value | Specifies the format for selecting time in the drop-down selection lists that are available in data reporting interfaces throughout NovaStar 5. When true, the 24-hour clock is used. |
| Options | none |
In the below example, the 24 hour clock time display is selected.
| Name | Value | Options |
|---|---|---|
| time_list_24_hour_clock | true |
Time List Increment
| Data Label | Description |
|---|---|
| Name | time_list_increment |
| Value | Specifies the interval, in minutes, between choices of time increments in drop-down selection lists that are available in data reporting interfaces throughout NovaStar 5. For example, when the time_list_increment is set at 30, the time choices in data display lists will be limited to 30-minute intervals. |
| Options | none |
In the below example, the time list will have 15 minute intervals; for example: 00:00, 00:15, 00:30, 00:45, 01:00, ...
| Name | Value | Options |
|---|---|---|
| time_list_increment | 15 |
Water Year Start Month
| Data Label | Description |
|---|---|
| Name | wateryear_startmonth |
| Value | Sets the starting month for the water year (Default: 10). |
| Options | none |
In the below example, starting month for the water year is 7 (July).
| Name | Value | Options |
|---|---|---|
| wateryear_startmonth | 7 |
Start Year
| Data Label | Description |
|---|---|
| Name | year_start |
| Value | Sets the earliest year of data in the database (Default: 1980). |
| Options | none |
In the below example, starting year of the system is 1995.
| Name | Value | Options |
|---|---|---|
| year_start | 1995 |
Configuration Delete
To delete a configuration parameter from the Configuration List, click Edit on that configuration's row in the table and then click Delete from the Configuration Edit screen to view the Configuration Delete page. The Configuration Delete page prompts to click the Delete button again to confirm that the configuration parameter should be deleted.
Data Flag List
Click on the Data Flag List menu to display the Data Flag List page. Each data flag is assigned a number that is used internally by the NovaStar 5 system to interpret the format of incoming data reports. The Data Flag List shows all of the data flags that are predefined for the system by Name and Description, and can show their associated Table row number in the NovaStar 5 data flag database table. The Choose details... button allows specifying what information is displayed by the Data Flag List page using the Data Flag List Details page, see the Data Flag List Details section. Data flags shown on the Data Flag List page can be ordered numerically or alphabetically using the buttons at the top of each column.
Data Flag List (see also the full-size image)
Although the Add button at the upper right-hand corner of the Data Flag List page can be used to access the Data Flag Add page and create new data flags, the present version of the NovaStar 5 system is not configured to utilize data flags beyond those that have been predefined. Because the numerical assignments preloaded into NovaStar 5 cannot be altered by users, editing the Data Flag List is not recommended, except as desired to rename the data flags to either reflect the use of a different language or so that the data flag nomenclature is easy to remember.
The Edit button at the right side of each data flag in the Data Flag List can be used to access the Data Flag Edit page to alter the nomenclature associated with the data flag numbers that are used by the NovaStar 5 system, see the Data Flag Edit section.
Data Flag List Details
The check boxes on Data Flag List Details page control the items, organization, sort order, and limit the records displayed on the associated List page.
Data Flag List Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Data Flag Edit
Click on the Edit button associated with any item defined in the Data Flag List table, or click Apply from the Data Flag Add or Data Flag Copy pages to create a new configuration item, which will display the Data Flag Edit page.
Data Flag Edit (see also the full-size image)
Identification
| Data Label | Description |
|---|---|
| Table index | Field cannot be modified; it is assigned automatically when a record is added. |
| Value | Data flag character. Max 1 character. |
| Description | Data flag description. Max 1000 characters. |
Data Flag Delete
To delete a data flag from the Data Flag List, click the Edit button on that data flag's row in the table to access the Data Flag Edit page. Click on the Delete button. A prompt will be shown to confirm deleting the data flag. Confirm the delete by clicking on the Delete button again. Deleting predefined data flags is not recommended.
Nova Score List
Click on the Nova Score List menu subcommand to display the Nova Score List page. Nova scores help to categorize active alarms based upon the relative severity of the data report values that trigger an alarm. They are a shorthand way to help interpret alarm data and determine appropriate responses. Each Nova Score is assigned a number that is used internally by the NovaStar 5 system to attach Nova Scores to incoming data reports. The Nova Score List shows all of the Nova Scores that are predefined for the system by Name and Description, and can show their associated Table row number in the NovaStar 5 Nova Score database table. The Choose details... button allows specifying what information is displayed by the Nova Score List page using the Nova Score List Details page, see the Nova Score List Details section. Nova Scores shown on the Nova Score List page can be ordered numerically or alphabetically using the buttons at the top of each column.
Nova Score List (see also the full-size image)
Although the Add button at the upper right-hand corner of the Nova Score List page can be used to access the Nova Score Add page and create new Nova Scores, the present version of the NovaStar 5 system is not configured to utilize Nova Scores beyond those that have been predefined. Because the numerical assignments preloaded into NovaStar 5 cannot be altered by users, editing the Nova Score List is not recommended, except as desired to rename the Nova Score descriptions to either reflect the use of a different language or so that the Nova Score nomenclature is easy to remember. The Edit button at the right side of each Nova Score in the Nova Score List can be used to access the Nova Score Edit page to alter the nomenclature associated with the Nova Score numbers that are used by the NovaStar 5 system, see the Nova Score Edit section.
Nova Score List Details
The check boxes on Nova Score List Details page control the items, organization, sort order, and limit the records displayed on the associated List page.
Nova Score List Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Nova Score Pick Details
The check boxes on Nova Score Pick Details page control the items, organization, sort order, and limit the records displayed on the pick list.
Nova Score Pick Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Nova Score Edit
Click on the Edit button associated with any item defined in the Nova Score List table, or click Apply from the Nova Score Add or Nova Score Copy pages to create a new configuration item, which will display the Nova Score Edit page.
Nova Score Edit (see also the full-size image)
Identification
| Data Label | Description |
|---|---|
| Table index | Field cannot be modified; it is assigned automatically when a record is added. |
| Value | Nova score number. Max 1 character. |
| Description | Nova score description. Max 1000 characters. |
Nova Score Delete
To delete a Nova Score from the Nova Score List, click the Edit button on that Nova Score's row in the table to access the Nova Score Edit page. Click on the Delete button. A prompt will be shown to confirm deleting the Nova Score. Confirm the delete by clicking the Delete button again. Deleting predefined Nova Scores is not recommended.
Scheduler List
NovaStar 5 has an scheduled action feature that executes commands at predefined times during the day, day of week and day of month. The commands can generate reports of point data and distribute them. The commands can also perform system maintenance or utility functions. Automatic system activities are created by users using the Scheduler List subcommand. Click on the Scheduler List menu to display the Scheduler List page.
Scheduler List (see also the full-size image)
The Scheduler List shows the Name assigned to each of the scheduled actions that are defined within the system. Clicking on any of the column heading buttons will reorder the scheduled actions in the Scheduler List, numerically or alphabetically, by that detail. The Choose details... button allows specifying what information is displayed by the Scheduler List page using the Scheduler List Details page, see the Scheduler List Details section.
For a new NovaStar 5 system, no scheduled events will appear on the Scheduler List page. Use the Add button at the upper right-hand corner of the Scheduler List table to define a new scheduled event using the Scheduler Add page. Or, use the Copy button to create a new scheduled event from a similar template scheduled event. First, click the Edit button associated with the template scheduled event to view the attributes of that scheduled event on the Scheduler Edit page. From there, the Copy button can be used to access the Scheduler Copy page to create a new scheduled event as described below.
Scheduler List Details
The check boxes on Scheduler List Details page control the items, organization, sort order, and limit the records displayed on the associated List page.
Scheduler List Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Scheduler Add/Copy
The Scheduler Add page and the Scheduler Copy page allow users to create a new scheduled event. They are described together as they function in the same way. The Scheduler Copy page is most convenient when the new scheduled event will share several parameters with the template scheduled event. To access the Scheduler Copy page, click on the Edit button in the template scheduled event's row in the Scheduler List table. This will display the Scheduler Edit page. Click on the Copy button to reach the Scheduler Copy page. The Scheduler Add/Copy page(s) prompts to enter a new scheduled event name in the highlighted field, and provide the opportunity to define other scheduled event parameters as required. See the Scheduler Edit section for complete details on input parameters for scheduled events, including those that are required on the Scheduler Add or the Scheduler Copy pages. The Scheduler Edit page, described next, provides the same input fields as the Scheduler Add and the Scheduler Copy pages.
Scheduler Edit
The Scheduler Edit page allows users to enter scheduled event parameters that Edit an existing scheduled event, or to add a scheduled event with many of the same parameters as the existing scheduled event using the Copy button.
Scheduler Edit (see also the full-size image)
Identification
| Data Label | Description |
|---|---|
| Table index | Field cannot be modified; it is assigned automatically when a record is added. |
| Name | Name must be unique for each scheduled action and should describe the action. The name is used on pick lists. Max: 100 characters. |
| Description | Use this field to describe the action functionality. Max: 1000 characters. |
Schedule
| Data Label | Description |
|---|---|
| Effective time | Enter the time for the next scheduled action. If a past time is entered, the scheduler will adjust the time to the next scheduled time based on the schedule Interval. The default if no value is entered for the Effective time is the current time. Click the button to assign the current time. |
| Interval | Enter how often the scheduled action should be executed. Enter the numeric value for the interval in the input box and the use the drop-down list to select the interval unit (minutes, hours, days, etc.). Click the Interval button to display a list of intervals to pick from. Click the Interval button again to display the interval value and time units. |
| Day of Week | This list allows selecting the days of the week on which the scheduled action should be executed. If the scheduled action should execute only on Fridays, set the schedule Interval to 1 day and select only Friday from the Day of Week list. Multiple days can be selected from the list by depressing the Ctrl button on the keyboard while selecting from the list with the mouse. |
Command
| Data Label | Description |
|---|---|
| Command | Enter the command to be executed at the scheduled time. Commands are custom script files that can be created by users and stored in the folder /usr/ns/cus. Click the View button to display a script command file. Click the Upload button to upload a new command script file to the NovaStar 5 system. Click the Remove button to delete a command script file. |
| Enabled | Select true to execute the command at the scheduled time. Select false to leave the command in the configuration list but do not execute it. |
Scheduler Command Upload
Command script files can be uploaded from the workstation to the NovaStar 5 system.
They are placed in the /local/bin folder of the browser which is linked to the /usr/ns/cus folder for command execution by the scheduler.
The command ownership and execute permissions are set by the upload process. Click the Upload button to start the process.
Scheduler Command Upload Start (see also the full-size image)
Click the Browse button to open the file browser on the workstation.
Scheduler Command Upload File Selection (see also the full-size image)
Select the command script file from the workstation folder and click the Open button.
Scheduler Command Upload Ready (see also the full-size image)
The workstation file name and path will be displayed in the upload window. Click the Upload button to upload this file to the NovaStar 5 system.
Scheduler Command Upload Success (see also the full-size image)
Click the Close button and the Scheduler Edit page will be updated with the new command. Click the Apply button to save the command name in the scheduler record.
Scheduler Command Execution
Click the Run command button to revalidate data values for the selected time period; activity is shown in the display window. Click Close to hide the revalidation tool.
Scheduler Command Execution (see also the full-size image)
| Button | Action |
|---|---|
 |
Run command; display activity in command display window. |
|
Stop command. |
|
Clear display window. |
|
Reset display window size to default. |
|
Decrease display window height. |
|
Increase display window height. |
|
Decrease display window width. |
|
Increase display window width. |
Scheduler Delete
To delete a scheduled event from the Scheduler List, click Edit on that scheduled event's row in the Scheduler List table and then click Delete from the Scheduler Edit screen. The Scheduler Delete page will display a prompt. Click the Delete button again to confirm deleting the scheduled event. Clicking the Delete button a second time will delete the scheduled event from the Scheduler List. Execution of a scheduled event can be suspended without deleting the scheduled event using the Enabled drop down-list on the Scheduler Edit page. See the Scheduler Edit section.
Serial Port List
Click on the Serial Port List menu to display the Serial Port List page. Computer I/O ports used by NovaStar 5 must be named, typed and configured. I/O port configuration includes the baud rate, parity, flow control, modem initialization and other parameters. The Serial Port List shows all of the serial port connections that are configured for the system. Clicking on any of the column heading buttons will reorder the reports in the Serial Port List, numerically or alphabetically, by that detail. The Choose details... button allows specifying what information is displayed by the Serial Port List page using the Serial Port List Details page, see the Serial Port List Details section.
Serial Port List (see also the full-size image)
Click on the Edit button on any row in the Serial Port List table to view or edit the information that has been entered about that serial port on the Serial Port Edit page or to Delete a serial port map from the Serial Port Edit page. To map a new serial port for the Serial Port List table, use the Add button at the upper right-hand corner of the Serial Port List table to access the Serial Port Add page. A new serial port map can be created based on an existing template serial port map using the Serial Port Copy page, as follows. First, click the Edit button associated with the template serial port map to access its Serial Port Edit page. From there, the Copy button can be used to access the Serial Port Copy page and create a new serial port. The Serial Port Add page, the Serial Port Copy page and the Serial Port Edit pages all provide the same input fields.
Serial Port List Details
The check boxes on Serial Port List Details page control the items, organization, sort order, and limit the records displayed on the associated List page.
Serial Port List Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Serial Port Pick Details
The check boxes on Serial Port Pick Details page control the items, organization, sort order, and limit the records displayed on the pick list.
Serial Port Pick Details (see also the full-size image)
Select the details to display
- Check the box to the left of a detail to display. Details are displayed in the order shown.
- Check the Order by box for the detail to sort first. Check Reverse for a descending sort.
- Check the Then by box for the detail to sort second. Check Reverse for a descending sort.
- Check the second Then by box for the detail to sort third. Check Reverse for a descending sort.
| Button | Action |
|---|---|
| Move Up | Move the selected detail up one row. |
| Move Down | Move the selected detail down one row. |
| Select All | Select all details. |
| Reset | Reset to default details. |
| OK | Return to previous page with new details selected. |
| Cancel | Return to previous page with no changes. |
Serial Port Edit
Serial Port Edit (see also the full-size image)
Identification
| Data Label | Description |
|---|---|
| Name | Enter the operating system I/O port name or select from the port list. The name must be unique in the serial port list. The operating system I/O port names start with /dev/tty and end with an alpha descriptor and number that are assigned by the system. Max 100 characters. For example:/dev/ttyS0: First built-in serial port, also known as COM1. /dev/ttyS1: Second built-in serial port, also known as COM2. /dev/ttyUSB0: First USB to serial port. /dev/ttyUSB1: Second USB to serial port. /dev/ttyACM0: First USB to telephone modem./dev/ttyACM1: Second USB to telephone modem. |
| Port list | Select an I/O port name from the pick list. It will be copied into the Name field. |
| Alias | Enter an alias to be used to reference the operating system I/O port name. Alias names are used by NovaStar 5 to find specific I/O ports in the system, and can make it easier to maintain the system after hardware changes. If ever the I/O port must be moved, the program start argument does not need to be changed; just assign the alias to the new I/O port. The name must be unique in the serial port list. Click the button to reset the alias to the serial port name. Max 100 characters. |
| Description | Enter descriptive information about the serial port. Max 1000 characters. |
| Line | Select a reference line number for the serial port. This number can appear in serial port pick lists. |
Connect parameters
| Data Label | Description |
|---|---|
| Baud rate | Select the communication baud rate for the serial port from the pick list: 300, 600, 1200, 2400, 4800, 9600, 9200, 38400, 57600, 115200. |
| Parity | Select the parity from the pick list: None, Odd, Even, Mark or Space. Use parity None by default. |
| Data bits | Select the data bits from the pick list: 5, 6, 7 or 8. Use 8 data bits by default for parity None, Use 7 data bits by default other parity. |
| Stop bits | Select the stop bits from the pick list: 1 or 2. Use 1 stop bit by default. |
| Allow Login | Select true to allow login on this serial port, false to no login. |
| Echo | Select true to echo input characters on this serial port in full duplex mode, false for no echo. |
Flow Control
| Data Label | Description |
|---|---|
| Hardware | Select true to enable RTS/CTS flow control, false to disable. |
| Software | Select true to enable Ctrl-S/Ctrl-Q flow control, false to disable. |
Modem control
Serial Port Modem Edit (see also the full-size image)
| Data Label | Description |
|---|---|
| Modem | Select true if the serial port is to be handled as a dial-in or dial-out modem. |
| Dial init string | Enter the AT command line to initialize the modem. Refer to the modem manual for a description of AT commands. |
| Dial output line | Enter the digits to dial to get an outside line. Enter commas for a two second delays per comma. Leave blank if not needed. |
Serial Port Delete
To delete a serial port from the Serial Port List, click Edit on that serial port's row in the Serial Port List table and then click Delete from the Serial Port Edit screen. A prompt on the Serial Port Delete page will ask to confirm the delete. Click the Delete button again to confirm deleting the serial port. Clicking the Delete button a second time will delete the serial port from the Serial Port List.
View Log Files
The ALERT data collection and remote station polling programs record their activity in log files. The reports in these files can be displayed in a scrollable window. This display is useful in checking the operation of the data collection system. To access these files click on the View Log Files button to access the Log File Request page.
Log File Request
Log File Request (see also the full-size image)
Select Log File
| Data Label | Description |
|---|---|
| Log file | Enter log file name or select from the log file list. Log files are read from the NovaStar 5 log file folder (/usr/ns/log) unless the log file path is provided as part of the log file name. |
| Log file list | Select a log file from the pick list. The selection is copied to the Log file field. Custom: Other data collection log file ALERT receive data: ALERT data collection log Station polling: Station polling log Database replication: Database replication activity log NovaStar 5 start: NovaStar5 data collection start and stop log NovaStar 5 system: NovaStar5 system activity log |
| Match strings | Enter character strings to match for log file lines to display. By default all lines are displayed up to the buffer limit. |
| Buffer lines | Enter the number of lines in the log file display window that will be available to scroll through. |
| Display lines | Enter the total number of lines shown in the display window. |
| Display columns | Enter the total number of columns shown in the display window. |
| Sort direction | Select Ascending to display the oldest log file line first. Select Descending to display the newest log file line first. |
Log File Display ALERT Receive Data
This page displays lines read from the selected log file. The number of lines and columns in the display are set in the Log File Request page. In addition to the lines displayed, additional lines can be buffered for scrolling with the vertical slider bar. The lines are displayed from oldest to newest if the sort direction is ascending or from newest to oldest if descending. If the display contents are scrolled or if the mouse is clicked on the display window, the automatic refreshed is paused. In this case the red stop display update button will be replaced with the green resume display update button. Click on the green resume button to continue updating. Click the Detach button at the top of the page to open the display in a pop-up window.
Log File Display ALERT Receive Data (see also the full-size image)
In the ALERT Receive Data log the received report time, remote ID, data value, and received source line number are displayed.
| Button | Action |
|---|---|
 |
Redisplay in ascending time order. |
 |
Redisplay in descending time order. |
 |
Update display. |
 |
Resume display update. |
|
Stop command. |
|
Clear display window. |
|
Reset display window size to default. |
|
Decrease display window height. |
|
Increase display window height. |
|
Decrease display window width. |
|
Increase display window width. |
Log File Display Station Polling
In the Station polling log display the polling program steps and successful polled remote ID, data value, report time are displayed.
Log File Display Station Polling (see also the full-size image)