Define - Substation Details

From the Define - Substation page, click Add or double-click an existing Substation, and then the Substation Details page is displayed.

The following table lists the items that are available on the Substation Details page:

Item Description
Name Type a Substation name.
Description Type a short description of for the Substation.
Substation ID Type the ID of the Substation.
Log and Trace Details Expand this panel to set the log and trace details.

For more information, see Log and Trace Details.

Initialization Expand this panel to set the initialization details.

For more information, see Initialization.

Admin Interface

Type an Admin interface name, or click the icon to select one.

Log and Trace Details

The Log and Trace Details panel is made up of the Log area and the Trace area.

The following table describes the items that are available in the Log and Trace Details region:

Log and Trace Details
Item Description
In the Log area, the following items are available:
Level Enter the level of informational messages recorded to the appropriate file.

The following values are valid for this field:

  • 0 indicates none. Record only the main system startup and shutdown messages.
  • 1 indicates critical. Record only the startup, connection, and shutdown information message.
  • 2 indicates recording the major message level information messages.
  • 3 indicates recording the minor message level information.
  • 4 indicates recording the detailed-level messages.
  • 5 indicates recording the detailed-level messages.
Format Enter the log format indicator.
The following values are valid for this field:
  • 1 indicates short format output.
  • 2 indicates short format output with information on the Substation ES location.
  • 3 indicates detailed format output.
File DDName Type the DDName of the data set which the formatted log information is written to.
File Destination Select the location to which the output for log entries is routed.

The following values are valid for this field:

  • Printer indicates formatted print file, which is similar to SYSPRINT.
  • Disk indicates disk file, which is a VSAM RRDS disk file formatted for Substation ES.
Disk File DDName Type the DDName of the data set for logging Substation ES messages, errors, and general information to disk.
Startup Method Select whether the information written to the log data set is kept across Substation ES instances. An instance ends when Substation ES is shut down or terminated.
  • WARM indicates that when Substation ES is started, the information recorded in the previous executions is retained and the new information is recorded following the most recent entry in the last used file. The information is retained.
  • COLD indicates that all disk files specified are reset to empty and the existing information within these files cannot be accessed again. The information is lost.
Disk File Wrap

If you select this check box, the information written to the log data sets is overridden when the log data sets are full.

If you do not select this check box, when all the log data sets are full, the disk facility is disabled and the information is recorded to SYSOUT.

Debug Level Enter the level of debug information that is generated for the log.
Log to SYSLOG Select the severity of Substation ES log messages that are printed to the z/OS SYSLOG.

This parameter assists automation tools that pick up and react to Substation ES messages.

The following values are available for this field:
  • 0 prints all the log entries.
  • 4 prints all the messages with the severity level of warning or higher.
  • 8 prints all the messages of that severity and higher or those that are suffixed with E, C, or F and written to the Substation ES log.
  • 20 prints nothing in addition to the z/OS SYSLOG.
Console Output Message Select whether operator commands and optional system status messages are echoed to the console or to the log file.
In the Trace area, the following items are available:
Level Enter the level of informational messages recorded to the appropriate file.

The following values are valid for this field:

  • 0 indicates none. Record only the main system startup and shutdown messages.
  • 1 indicates critical. Record only the startup, connection, and shutdown information message.
  • 2 indicates recording the major message level information messages.
  • 3 indicates recording the minor message level information.
  • 4 indicates recording the detailed-level messages.
  • 5 indicates recording the detailed-level messages.
Format Enter the log format indicator.
The following values are valid for this field:
  • 1 indicates short format output.
  • 2 indicates short format output with information on the Substation ES location.
  • 3 indicates detailed format output.
File DDName Type the DDName of the data set which the formatted trace information is written to.
File Destination Select the location to which the output for trace entries is routed.

The following values are valid for this field:

  • Printer indicates formatted print file, which is similar to SYSPRINT.
  • Disk indicates disk file, which is a VSAM RRDS disk file formatted for Substation ES.
Disk File DDName Type the DDName of the data set for tracing Substation ES messages, errors, and general information to disk.
Startup Method Select whether the information written to the trace data set is kept across Substation ES instances. An instance ends when Substation ES is shut down or terminated.
  • WARM indicates that when Substation ES is started, the information recorded in the previous executions is retained and the new information is recorded following the most recent entry in the last used file. The information is retained.
  • COLD indicates that all disk files specified are reset to empty and the existing information within these files cannot be accessed again. The information is lost.
Disk File Wrap

If you select this check box, the information written to the trace data sets is overridden when the trace data sets are full.

If you do not select this check box, when all the trace data sets are full, the disk facility is disabled and the information is recorded to SYSOUT.

Debug Level Enter the level of debug information that is generated for the trace.

Initialization

The following table describes the items that are available in the Initialization panel:

Initialization
Item Description
Maximum Units of Work Enter the maximum number of concurrent messages that can be processed by Substation ES.
Valid values for this field are in the range 200 - 2048.
Note: Do not change this value unless requested by TIBCO Support.
Workers Enter the number of concurrent worker threads that are started to service Substation ES requests.

Valid values for this field are in the range 10 - 40.

For best results, do not simply set it to 40, because such an allocation might slow down your system if you do not have enough processors to satisfy all the requests.

Workers (End of Task) Enter the number of End of Task (EOT) concurrent worker threads that are started to service Substation ES UoW termination requests.

Valid values for this field are in the range 5 - 40.

Snapshot Enter the number of entries of a snapshot.

Valid values for this field are in the range 100 - 10000 per snapshot, where the value is the duration of the measured event in minutes.

Storage Protect If you select this check box, storage address validation occurs when various interfaces and agents within Substation ES communicate with each other.
Storage Free If you select this check box, the internal Unit of Work (UOW) communication storage is released when the value of UOW Stress Restart Level is exceeded. By default, this check box is not selected.

By default, Substation ES releases unused UOW communication storage when the number of the UOWs that are concurrently in use is more than the value of UOW Stress Restart Level.

Changing this value is only beneficial if the stress levels within the Substation ES are consistently being exceeded.

Storage Size Maximum Enter the maximum storage size that Substation ES maintains.

Substation ES frees the storage when it reaches 32K or the STGSIZE-MAX limit.

Valid values for this field are in the range 4000 - 200000.