SISCO Log Viewer User's Guide

SISCO Log Viewer
User’s Guide
Revision 4
© SISCO, Inc. 2010

All Rights Reserved by:
Systems Integration Specialists Company, Inc.

6605 19½ Mile Road, Sterling Heights, MI 48314-9921, U.S.A.
Tel: +1-586-254-0020, Fax: +1-586-254-0053
E-Mail: support@sisconet.com, URL: http://www.sisconet.com
Printed in U.S.A.
04/2010
SISCO Log Viewer
User’s Guide
COPYRIGHT NOTICE
© Copyright 2008-2010 Systems Integration Specialists Company Inc.
All Rights Reserved.
This document is provided under license to authorized licensees only. No part of this document
may be copied or distributed, transmitted, transcribed, stored in a retrieval system, or translated
into any human or computer language, in any form or by any means, electronic, mechanical,
magnetic, manual, or otherwise, disclosed to third parties, except as allowed in the license
agreement, without the express written consent of Systems Integration Specialists Company
Incorporated, 6605 19½ Mile Road, Sterling Heights, MI, 48314, U.S.A.
DISCLAIMER
Systems Integration Specialists Company, Inc. makes no representation or warranties with

respect to the contents of this manual and specifically disclaims any implied warranties of
merchantability of fitness for any particular purpose. Further, Systems Integration Specialists
Company, Inc. reserves the right to revise this publication and to make changes in it from time to
time without obligation of Systems Integration Specialists Company, Inc. to notify any person or
organization of such revision or changes.
All warranty and support for this product is provided by SISCO.
Revision 4
04/09/2010
INTRODUCTION............................................................................................................. 1
USING THE LOG VIEWER........................................................................................... 3

File ............................................................................................................................... 4
Edit ............................................................................................................................... 4
Sources ......................................................................................................................... 7
Add ............................................................................................................................... 7
Logging......................................................................................................................... 7
Tools ............................................................................................................................. 8
Help .............................................................................................................................. 8
Icons ............................................................................................................................. 9
USING THE LOG CONFIGURATION EDITOR...................................................... 11
INTRODUCTION ............................................................................................................... 11
Log Configuration File............................................................................................... 12
File ............................................................................................................................. 13
Edit ............................................................................................................................. 13
View............................................................................................................................ 14
Help ............................................................................................................................ 15
LOG CONTROL ................................................................................................................ 16
Log Common .............................................................................................................. 16
Log File Attributes ..................................................................................................... 17
Log IPC Attributes ..................................................................................................... 17
Log Memory Attributes............................................................................................... 20
LOG MASKS .................................................................................................................... 22
Component Format .................................................................................................... 22
Subcomponent Format ............................................................................................... 23
Mask Format .............................................................................................................. 26
MEMORY ALLOCATION DEBUG CONTROL ...................................................................... 27
SAMPLE LOG CONFIGURATION XML FILE ....................................................... 31
PORT ASSIGNMENTS FOR SISCO PRODUCTS.................................................... 35
INDEX.............................................................................................................................. 37
Introduction
Chapter 1
Introduction
The Log Viewer is a SISCO application used to look at logging from multiple applications in one file. It
can also be setup on a remote machine to capture logging from multiple applications. Current log
parameter settings can be modified without bringing applications down. This allows modifying log
parameters while the application is running. Previous SISCO logging implementations did not allow this
functionality.
To capture logging for applications running on the same computer as the Log Viewer, no additional
configuration has to be done. The Log Viewer will automatically detect the applications and start capturing
their logging.
To capture logging for applications running on a different computer, the Log Viewer will have to be
configured to look for the application. The SISCO Log Viewer runs on the Windows platform but can
remotely access logging on non-Windows machines.
SISCO’s products and applications use common XML file format to specify logging options in an
application. This document provides descriptions of a default SISCO Log Configuration Template file
(xxxLogCfg.xml) and how it can be edited with SISCO’s Log Configuration Editor.
For purposes of this documentation, the sample template file, TemplateLogCfg.xml, is used.
To comply with UAC requirements on Windows, SISCO has moved the location of some files. The Log
Viewer binaries have not moved and remain in the C:\Program Files\SISCO\Log Viewer. Configuration
file and data files are now located in the Windows Common Application Data path referred also in this
document as %COMMON_APPDATA%. The path varies on different Windows systems:
Windows XP/2003: \Documents and Settings\All Users\Application Data

Windows Vista /2008/Windows7: \ProgramData
1
Log Viewer User’s Guide
2
Using the Log Viewer
Chapter 2

The Log Viewer should be used to view logging. If the user preference Detect SISCO Sources is
checked, the Log Viewer will automatically show all SISCO applications currently running on the machine
that are configured to connect to the Log Viewer.
To start the Log Viewer run:

Start  Program Files  SISCO  Log Viewer  Log Viewer
3
The following menu options are available:
File
Exit
Closes the Log Viewer.
Edit
Find
To search for a specific item in the Logging Display of the Log Viewer. Logging to the display must
first be disabled using either the Enable/Disable toggle button or the Logging/Disable Display menu
option. The following dialog box is shown:
Down
Searches forward in the displayed logging.
Up
Searches backwards in the displayed logging.
Find Next
Allows searching again for a previously specified item.
4
Preferences
When using the Log Viewer you may wish to modify the user options. Selecting Edit - Preferences
will display the following set of options to modify:
Outgoing Connections
Connect on Startup:
If checked, this instructs the Log Viewer to connect on startup. Not checked, means the Log
Viewer will not connect when starting up.
Automatically Reconnect:
If checked, this allows a connection that is lost to automatically resume if it can be established
again. Not checked means a lost connection cannot automatically be re-established.
Reconnect Delay (ms):
This indicates the time to wait in milliseconds before re-establishing a lost connection. The default
is 5000 milliseconds.
Detect SISCO Sources:

If checked, this allows connections to other SISCO sources configured to display their logging.
5
Logging
Max Display Lines:
This indicates the number of lines of logging that can be displayed on the Log Viewer screen at
one time. Range is 10 to 2147483647 lines. Default is 10000.
File Editor:
This specifies the name of the editor invoked when the user wants to edit a log. The default is
Notepad.
Status
Display Status:
If checked, this enables displaying the Status Pane. Not checked, this disables displaying of the
Status Pane. Default is checked for display.
Max Status Lines:
This indicates the number of lines that can be displayed in the status pane at one time. Range is 10
to 2147483647 lines. Default is 1000.
Incoming Connections
Listen on Startup:
If checked, it allows for a remote user to monitor logging locally.
Listen Port:
This indicates the port number to use if Listen on Startup is selected.
Miscellaneous
Confirm Actions:
If checked, a confirm message will appear on the screen if there is a request to delete or modify a
record. If not checked, you will not be prompted with a confirm when adding or modifying
records.
TimeStamp Type:
Timestamps can be one of three types:
Elapsed A high resolution timestamp will be displayed by the Log Viewer.
Local The time the log message arrives displayed in standard time and date format.
Source Displays the application in which the event that triggered the log message actually
happened. This display uses the standard time and date format. This is the default
6
Hide Sources Columns

# of Ports:
If checked, this enables the display of the number of ports utilized. Not checked, means this
column will not appear on the Log Viewer screen.
Smart:
If checked, this enables the display of Smart Mode status. Not checked means this column will not
appear on the Log Viewer screen.
Sources
Add
Selecting this option causes a new Source entry to be automatically generated in the top Log Viewer
pane. This is the name displayed by the Log Viewer when it connects to a source that is generating
logging.
The auto generated Source name may be replaces with a name more meaningful to the user by clicking
in that field and typing the new name followed by a tab or a return.
The auto generated IP Address may be replaces with a name more meaningful to the user by clicking
in that field and typing the new name followed by a tab or a return. Default IP address is “127.0.0.1”.
Delete All
Selecting this option will remove all source entries from the Log Viewer display.
Enable All
If this option is selected, the Log Viewer will attempt to connect all displayed Sources not currently
disconnected.
Disable All
If this option is selected, the Log Viewer will attempt to disconnect all displayed Sources that are
currently connected.
Stop All
Selecting this option will stop all logging to the Log Viewer display.
Start All
Selecting this option will continue all logging to the Log Viewer display.
Logging
Enable/Disable Display
This option enables or disables logging to the screen.
7
Reset Display
Selecting this option causes the Viewer pane displaying logging to be cleared.
Save Display
This option allows Max Display Lines (found in Edit – Preferences) of the Logging Display to be
saved to a specified file.
Edit Display
This allows editing a previously saved file.
Enable/Disable Logging To File
This option enables or disables logging to a designated file in a specific location.
Clear Log File
When this option is selected, the contents of the current log file existing in
%COMMON_APPDATA%\SISCO\Log Viewer\ LogViewer.log will be emptied. See page 1 for
specific directory information for your OS.
Clone Log File
When this option is selected, a copy of the existing LogViewer.log found in

%COMMON_APPDATA%\SISCO\ Log Viewer will be copied to
%COMMON_APPDATA%\SISCO\ Log Viewer\LogViewer.cln. See page 1 for specific directory
information for your OS.
Edit Log File
This allows the user to edit a file they have saved. This editor is previously selected in Preferences -
Logging - Display File Editor.
Tools
Clear Status
Selecting this option clears the contents of the Status Pane.
Help
About
Selecting this option, displays licensing information on the SISCO Log Viewer.
8
Icons
The following icons are displayed in the tool bar.
Display/Hide Sources
Clicking on this icon toggle will cause the Sources pane of the Log Viewer to be displayed or hidden.
Issue a Connect to a Single Source
Clicking on this icon will cause a text box to be displayed to select a source with which to connect.
Selecting OK will attempt to connect to the specified Source if it is not already connected.
9
Issue a Disconnect to a Single Source
Clicking on this icon will cause a text box to be displayed. Selecting OK will attempt to disconnect the
specified Source if it is not already disconnected.
Enable/Disable Display Logging
This icon allows toggling the user to enable or disable logging to the Logging Display.
Reset Logging Display
This icon allows the Logging Display to be cleared.
Add a User Annotation
This icon allows a user to place an annotation in the log file. This button is only available when
Logging to File is enabled.
10
Using the Log Configuration Editor
Chapter 3
Using the Log

Configuration Editor
Introduction
The SISCO Log Configuration Editor provides a GUI for users to edit XML files containing logging
parameters in SISCO’s Log Configuration file format. TemplateLogCfg.xml is supplied as an example of a
valid log configuration file.
Each SISCO application has a separate log configuration file and associated log file and they are located in
different directories depending upon the SISCO product. Most of the XML files provided in SISCO
products are named AppNameLogCfg.xml.
The Log Configuration Editor should be used to configure these files. From the Log Viewer, right
clicking on the application (Source) and selecting Edit LogCfg File will bring up the Log
Configuration Editor with the log configuration file for the selected application.
You can also start the Log Configuration Editor directly and browse for the appropriate log
configuration file using:
Start  Program Files  SISCO  Log Viewer  Log Configuration Editor
The following prompt will be displayed:
11
Log Configuration File

The user may accept the default path and file name or browse for the log file specific to the application they
wish to edit. When the desired path and log file have been entered the user should continue by selecting
“OK”. The file name is a string of ASCII characters. The size can be from 1 to 256 characters.
The Log Configuration Editor will perform validation on the specified XML file and note discrepancies
between that file and the information in the SISCO Template Log Configuration file. For example, the
following file validation might be displayed:
12
Select OK and the Log Configuration Editor will be displayed:
The following menu options are available:
File
Exit
Closes the Log Configuration Editor.
Edit
Preferences
When using the Log Configuration Editor you may wish to modify user options. The options selected
will be retained and only need to be modified if changes are desired later on. This menu option will display
the set of user options that can be modifed.
13
Miscellaneous
Confirm Actions
If checked, a confirm message will appear on the screen if there is any attempt to change the
configuration. If unchecked, you will not be prompted with a confirm message when changing the
configuration. Default is checked.
Display Status Pane
If checked, status messages appear at the bottom of the screen. If unchecked, no status messages
are displayed. Default is checked.
Double Click
If checked, a double click is required to get a form to show. Unchecked, one click is required to
get a form to show.
View
Restore Default Size
Selecting this option, resets all Log Configuration Editor pane sizes back to the default.
14
Help
About
Selecting this option, displays licensing information on the SISCO Log Configuration Editor.
15
Log Control
If you click on Log Control, the following is displayed:
The following are descriptions of each configurable parameter – the file tags from the XML file are shown
within the brackets <FileTag>:
Log Common
Log Elapsed Time
If checked, it displays logged timestamps with high resolution. Not checked, it displays logged
timestamps with standard format. The default is unchecked (Off). The XML file tag is
<LogElapsedTime>. Valid values are On or Off.
16
Log File Attributes

Enable
If checked, it causes logging to the specified log file. Not checked, means that no log file will be
created. Note that the application itself may suppress output to a log file and use the IPC logging
option to send log messages to the Log Viewer. The default is checked (On). The XML file tag is
<LogFileEnable>. Valid values are On or Off.
Name
This contains a string of ASCII characters specifying the path and name of an application log file. The
size can be from 1 to 256 characters. If the path is omitted, then the log file is expected to be in the
directory where the application executable is located or in a directory specified by an application
during initialization. Due to Windows UAC restrictions creating log files in C:\Program Files
subdirectory may not be allowed. The user should change this to the name of their executable
application name. The default is AppName.log. By default, SISCO applications use predefined names
for log files located in a %COMMON_APPDATA%\SISCO\{Product} directory. See page 1 for
specific directory information for your OS. The XML file tag is <LogFileName>.
Size
This is the maximum size to which the log file can grow. The default is 10,000,000 bytes (10 MB).
The maximum is 2,147,483,647 bytes. The XML file tag is <LogFileSize>.
Destroy Old File
If checked, it causes the previously existing log file to be deleted. Not checked means that the new
logging will be appended to the previously existing log file. The default is unchecked (Off). The XML
file tag is <DestroyOldFile>. Valid values are On or Off.
Hard Flush
If checked, it causes a close and open of the log file each time a message is logged. Not checked means
that the log file is not closed and reopened each time a message is logged. The default is unchecked
(Off). There is overhead associated with closing and opening the log file each time a message is
logged. This feature only becomes useful if the program is crashing and the log file is not capturing the
useful messages due to abnormal termination. The XML file tag is <HardFlush>. Valid values are On
or Off.
Log IPC Attributes

Application ID
This contains a string of ASCII characters that identifies a logging application name to the Log
Viewer. It will appear in the Log Viewer’s Source column and in the log pane. The size of this field
can be from 1 to 256 characters. The default is “AppNameID”. SISCO’s applications are using
predetermined names. The XML file tag is <LogIpcAppId>.
17
For example if the Application ID is “AX-S4 MMS,” then the Log Viewer would display the name as
shown below:
Max Que Count
This is the number of log messages we keep on the queue, in the form of external buffering on a TCP
socket. Default is 10. The XML file tag is <LogIpcMaxQueCount>.
Enable Listen
If checked, it allows a listen to be posted by an application on a listen port. This would allow the Log
Viewer or other application like Telnet to connect to the application and monitor logging. Not checked,
it prohibits TCP connections into application. This is a security risk. Default is unchecked for security
reasons (Off). The XML file tag is <LogIpcListenEnable>. Valid values are On or Off.
Listen Port
The port number that logging may be monitored on. To avoid “port already in use” errors, each
application should have its own listen port number. The default base port is 55147. The XML file tag is
<LogIpcListenPort>.
Note: The RFC4340 Standard reserves many ports from the 0 – 49151 range. To avoid port conflicts
with reserved ports, use 55000 or larger for dynamic or private TCP ports.
18
Num of Listen Ports
This indicates the range of ports to be used for listening. For example: Entering 3 for the Num of
Listen Ports and 55200 entered for Listen Port, would mean that 55200, 55201 and 55202 would
be available as listening ports. However, only one port can be used by an application. This allows for
multiple application instances to share a range of ports and be able to use the first available port
number. Default is 1. The XML file tag is <LogIpcListenPort>.
Max Listen Conns
This is the maximum number of connections allowed per port. For example: Entering 10 means up to
10 Log Viewers and other applications like Telnet can connect into application. For security reasons,
the default is 1. The XML file tag is <LogIpcMaxListenConn>.
Enable Calling
If checked, an application is allowed to establish an incomming connection to the Log Viewer for a
user to monitor an application’s logging. Valid values are On and Off. Default is checked (On) in
SISCO compiled applications or samples. The XML file tag is <LogIpcCallEnable>.
Calling Port
This is the port number to specify for an incomming connection to the Log Viewer. The Log Viewer
will be listening for incoming TCP connections on this port. Default listen port number for the Log
Viewer is 55146. Please refer to Appendix B for a list of the port numbers used by SISCO
applications. The XML file tag is <LogIpcCallingPort>.
Calling IP
This indicates the IP address of the Log Viewer. Default is “127.0.0.1” if the Log Viewer is on a local
machine. The XML file tag is <LogIpcCallingIp>.
Calling Backoff Time
This indicates the time in seconds to wait after a failed connection to the Log Viewer before trying
again. Default is 500 milliseconds. The XML file tag is <LogIpcCallingBackoff>.
Enable Smart Mode
If checked, this enables bi-directional flow or enhanced capabilities if using the Log Viewer. Not
checked, enables a less intelligent mode. For example, Telnet might be used instead of the Log Viewer
to connect to the application’s listen port. Valid values are On or Off. By default the smart mode is
enabled (On). The XML file tag is <LogIpcSmartMode>.
NOTE: SISCO recommends that SMART Mode to be enabled as it allows for flow control and the
capability of editing the log configuration file belonging to a specified Source.
Edit LogCfg File
If checked, it allows bringing up the Log Configuration Editor by right clicking on a Source in the
Log Viewer. The default is checked. The XML file tag is <LogIpcEditLogCfg>.
Seal Mode
If this value is set to 2, it enables authentication of the partner node. This provides a level of security
for the IPC logging connections. Possible values: 0 = seal mode disabled, 2 = seal mode enabled. The
default is enabled (2). The XML file tag is <LogIpcSealMode>.
19
Seal Time Window
This is the maximum allowed clock time differential between the logging source and the Log Viewer.
The default is 10 seconds. The XML file tag is <LogIpcSealTimeWindow>.
To add Log Memory Attributes (or delete Log IPC Attributes) from the right hand pane, the user may right
click on the Log Control branch in the tree in the left pane. Clicking on Add Log Memory Attributes will
result in the section being added to Log Control as shown below:
Log Memory Attributes

Enable
If checked, it enables logging to memory. Not checked will disable any logging to memory. The XML
file tag is <LogMemoryEnable>.
Dump
If checked, it causes what is logged in memory to be dumped to a specified file when the specified
number of Items is reached. Not checked turns off logging to a file. The XML file tag is
<MemoryFileDump>.
20
Name
This specifies the desired memory file name. The default is Memory.dmp. The size can range from 1
to 256 characters. If the path is omitted then the file is expected to be in the directory where the
application executable is located or in a directory specified by an application during initialization. Due
to Windows UAC restrictions, creating log files in C:\Program Files subdirectory may not be
allowed. See page 1 for specific directory information for your OS. The XML file tag is
<MemoryFileName>.
Items
The number of items that can be logged. The default is 1,000. The maximum is 2,147,483,647 bytes.
The XML file tag is <LogMemoryItems>.
To remove Log Memory Attributes once it has been added, right click on Log Control, and click on Delete
Log Memory Attributes.
21
Log Masks
Please see individual product documentation for Log Masks that apply to that application.
There are three log mask formats supported by the SISCO Log Configuration Editor. The three formats
are: Component, Subcomponent and Mask Format.
Note: Only one format may be implemented at a time and the XML contained in the
appNameLogCfg.xml file log mask section must conform to one of the valid formats.
Component Format
This format is currently only used by SISCO UIB applications. In this format, there are additional entries
in the tree under the Log Masks branch. Below is a sample Log Mask XML section if Comp1 and
Comp2 are the only two components.
<LogMasks>

<Comp1>
<MmsLogMasks1>
<MMS_LOG_NERR1>On</MMS_LOG_NERR1>
<MMS_LOG_CLIENT1>Off</MMS_LOG_CLIENT1>
<MMS_LOG_SERVER1>Off</MMS_LOG_SERVER1>
<MMS_LOG_DEC1>Off</MMS_LOG_DEC1>
<MMS_LOG_ENC1>Off</MMS_LOG_ENC1>
</MmsLogMasks1>
<MvlLogMasks1>
<MVLLOG_NERR1>On</MVLLOG_NERR1>
<MVLULOG_FLOW1>Off</MVLULOG_FLOW1>
<MVLLOG_ACSE1>Off</MVLLOG_ACSE1>
<MVLLOG_ACSEDATA1>Off</MVLLOG_ACSEDATA1>
</MvlLogMasks1>
</Comp1>
<Comp2>
<MmsLogMasks2>
<MMS_LOG_NERR2>On</MMS_LOG_NERR2>
<MMS_LOG_CLIENT2>Off</MMS_LOG_CLIENT2>
<MMS_LOG_SERVER2>Off</MMS_LOG_SERVER2>
<MMS_LOG_DEC2>Off</MMS_LOG_DEC2>
<MMS_LOG_ENC2>Off</MMS_LOG_ENC2>
</MmsLogMasks2>
<MvlLogMasks2>
<MVLLOG_NERR2>On</MVLLOG_NERR2>
<MVLULOG_FLOW2>Off</MVLULOG_FLOW2>
<MVLLOG_ACSE2>Off</MVLLOG_ACSE2>
<MVLLOG_ACSEDATA2>Off</MVLLOG_ACSEDATA2>
</MvlLogMasks2>
</Comp2>
</LogMasks>
22
Subcomponent Format
This format is used by most SISCO products. As the most common format, is shown as the example.
The above Subcomponent Format will generate the following XML:
<LogMasks>

<MmsLogMasks>
<MMS_LOG_NERR>On</MMS_LOG_NERR>
<MMS_LOG_CLIENT>Off</MMS_LOG_CLIENT>
<MMS_LOG_SERVER>Off</MMS_LOG_SERVER>
<MMS_LOG_DEC>Off</MMS_LOG_DEC>
<MMS_LOG_ENC>Off</MMS_LOG_ENC>
</MmsLogMasks>
<MvlLogMasks>
<MVLLOG_NERR>On</MVLLOG_NERR>
<MVLULOG_FLOW>Off</MVLULOG_FLOW>
<MVLLOG_ACSE>Off</MVLLOG_ACSE>
<MVLLOG_ACSEDATA>Off</MVLLOG_ACSEDATA>
</MvlLogMasks>
</LogMasks>
Log masks may be enabled by checking the checkbox corresponding to the desired log mask.
23
Adding Elements to a LogCfg XML File

The Log Configuration Editor allows the user to add and delete Components, Subcomponents, and Masks
as appropriate for the format.
For SISCO source code (MMS-Lite and ICCP-Lite) and API products (MMS-EASE/ICCP Toolkit/UIB),
this feature may be useful for adding new logging options. However, code must be added to the application
to make use of these new elements. Obsolete logging options can also be deleted.
For SISCO’s packaged products such as AX-S4 MMS, AX-S4 ICCP, etc., additional components,
subcomponents and masks should only be added when instructed to do so by SISCO Technichal Support.
The subcomponents currently defined are MmsLogMasks and MvlLogMasks. To add additional
subcomponents, the user can select Add Subcomponent and the following form will be displayed:
If the user enters “MyNewSubcomponent” and selects OK, the following is displayed:
24
To add a log mask to any subcomponent, right click on the greyed bar. For example, select
“MyNewSubComponent” and right click.
A prompt to Delete or Add Mask will be displayed. Entering Delete at this point will delete
“MyNewSubComponent”. Selecting Add Mask will display:
Enter a desired new log mask name. For example, enter “Mask1” then select OK. The new mask will be
added with the default state of “ON”.
25
Right clicking on an existing log mask will display the option to delete that log mask. If you select Delete
for “Mask1” the screen will no longer display “Mask1”.
Mask Format
This is the least used and most basic format. The Mask Format generates the following XML:
<LogMasks>



</LogMasks>
26
Memory Allocation Debug Control

To generate the XML code necessary to implement Memory Allocation Debug control logging, right click
on Log Configuration, this displays options for Memory Allocation Debug Control.
For SISCO source code (MMS-Lite and ICCP-Lite) and API products (MMS-EASE/ICCP Toolkit), this
feature may be useful for debugging memory problems. For GUI-based products such as AX-S4 61850 and
AX-S4 ICCP, it is recommended not to turn this on unless instructed to do so by SISCO Technical Support.
Selecting OK will generate the following XML code in the logcfg.xml file:
<MemAllocDbgCtrl>
<MemFillEnable>OFF</MemFillEnable>
<MemCheckList>OFF</MemCheckList>
<MemFindNode>OFF</MemFindNode>
<MemNoReallocSmaller>OFF</MemNoReallocSmaller>
</MemAllocDbgCtrl>
27
Note that now the Log Configuration Editor screen will include a branch labeled Memory Allocation
Debug Control. Selecting Memory Allocation Debug Control displays the following options:
Memory Allocation Debug Control

Memory Fill Enable
This flag is used to enable a feature which will fill up a freed buffer with a fixed value that may cause
the program to crash if memory within the buffer is accessed after it is freed, should reference to
locations within the buffer still be active after the buffer has been freed. The default is Not Checked.
The XML file tag is <MemFillEnable>.
For API and Source Code products, the description of this parameter:
extern ST_BOOLEAN m_fill_en; /* global variable */
If checked, the global variable m_fill_en is set. The value of the m_fill_byte is written to each
byte in a buffer freed by calling chk_free.
Memory Check List
This flag is used to enable list validation and overwrite checking on every alloc and free call. This is
useful when the application experiences random crashes in which case this feature is highly
recommended. The default is Not Checked. The XML file tag is <MemCheckList>.
extern ST_BOOLEAN m_check_list_enable; /* global variable */
28
Memory Find Node

If checked, this enables searching the memory list. The default is Not Checked and disables the search.
This may speed up the application. The default is Not Checked. The XML file tag is
<MemFindNode>.
extern ST_BOOLEAN m_find_node_enable; /* global variable */
This variable is used to enable searching the memory list for the element before accessing the memory
during chk_realloc and chk_free calls. The value of SD_TRUE enables searching the memory
list.
Memory No Reallocation Smaller
If checked, so reallocation occurs when the new size is smaller than the old size. The default is Not
Checked. The XML file tag is <MemNoReallocSmaller>.
extern ST_BOOLEAN m_no_realloc_smaller; /* global variable */
This variable will cause chk_realloc not to realloc when the new size is smaller than the old size.
Not reallocating a buffer to a smaller size is desirable on systems whose memory management
algorithms lead to excessive fragmentation.
To remove Memory Allocation Debug Control once it has been added, right click on Log Control and
click on Delete Memory Allocation Debug Control.
29
30
Appendix A: Sample Log Configuration XML File
Appendix A
Sample Log
Configuration XML File
The Logging Configuration file (appNameLogCfg.xml) specifies logging parameters utilized by the Log
Viewer and SISCO applications. The following example shows a generic configuration supplied with
SISCO products, TemplateLogCfg.xml.
<?xml version="1.0" encoding="UTF-8"?>

<LOG_CFG>

<LogControl>
<LogCommon>
<LogElapsedTime>Off</LogElapsedTime>
</LogCommon>
<LogFileAttributes>
<LogFileEnable>On</LogFileEnable>
<LogFileName>AppName.log</LogFileName>
<LogFileSize>10000000</LogFileSize>
<DestroyOldFile>Off</DestroyOldFile>
<HardFlush>Off</HardFlush>
</LogFileAttributes>
<LogIpcAttributes>
<LogIpcAppId>AppNameID</LogIpcAppId>
<LogIpcMaxQueCount>10</LogIpcMaxQueCount>
<LogIpcListenEnable>Off</LogIpcListenEnable>
<LogIpcListenPort>55147</LogIpcListenPort>
<LogIpcNumListenPorts>1</LogIpcNumListenPorts>
<LogIpcMaxListenConn>1</LogIpcMaxListenConn>
<LogIpcCallEnable>On</LogIpcCallEnable>
<LogIpcCallingPort>55146</LogIpcCallingPort>
<LogIpcCallingIp>127.0.0.1</LogIpcCallingIp>
<LogIpcCallingBackoff>500</LogIpcCallingBackoff>
<LogIpcSmartMode>On</LogIpcSmartMode>
31
<LogIpcEditLogCfg>On</LogIpcEditLogCfg>
<LogIpcSealMode>2</LogIpcSealMode>
<LogIpcSealTimeWindow>10</LogIpcSealTimeWindow>
</LogIpcAttributes>
</LogControl>
<LogMasks>

<MmsLogMasks>
</MmsLogMasks>
<MvlLogMasks>
</MvlLogMasks>
</LogMasks>

</LOG_CFG>
33
34
Appendix B: Port Assignments for SISCO Products
Appendix B
Port Assignments for

SISCO Products
Currently, SISCO’s applications use default ports from the range 55050 to 55500. They are assigned in the
logging definition file (slog.h) as follows:
Default listen port numbers for the Log Viewer 55146
Default listen port base

IPC_LOG_BASE_PORT 55147
Ports below are taken by the following SISCO applications:

AXS4ICCP IPC_LOG_BASE_PORT+1 55148
OSILL2 IPC_LOG_BASE_PORT+2 55149
OSILL2_IPC IPC_LOG_BASE_PORT+3 55150
AXS4MMS IPC_LOG_BASE_PORT+4 55151
AXS4IEC61850 IPC_LOG_BASE_PORT+5 55152
AXS4GOOSE_OLD IPC_LOG_BASE_PORT+6 55153
RFC1006_LISTENER IPC_LOG_BASE_PORT+7 55154
ICCPCFG IPC_LOG_BASE_PORT+8 55155
UIB ports: reserve 10: 55157-55167

UIBBASE IPC_LOG_BASE_PORT+10 55157
NUMPORTS_UIB 10
SNAP IPC_LOG_BASE_PORT+30 55177
SNAP_LITE_DAEMON IPC_LOG_BASE_PORT+33 55180

SNAP_LITE_UTIL IPC_LOG_BASE_PORT+34 55181
MMS-EASE demo programs: reserve 10 55190-55199

MMS_EASE IPC_LOG_BASE_PORT+43 55190
MMS-LITE demo programs: reserve 10 55200-55209

MMS_LITE IPC_LOG_BASE_PORT+53 55200
ICCP-LITE demo programs: reserve 5 55210-55214

MMS_LITE IPC_LOG_BASE_PORT+63 55210
USPS IOS ports: reserve 100 55347-55447

IOS_MPECOM IPC_LOG_BASE_PORT+200 55347
IOS_MPE IPC_LOG_BASE_PORT+201 55348
IOS_GATEWAY IPC_LOG_BASE_PORT+202 55349
UAP related elements

AXS4GOOSE IPC_LOG_BASE_PORT+300 55447
DSPI IPC_LOG_BASE_PORT+301 55448
SCLDEVLOADEX IPC_LOG_BASE_PORT+302 55449
UAPPC IPC_LOG_BASE_PORT+303 55450
GOOSEBLASTER IPC_LOG_BASE_PORT+304 55451
GOOSEBLASTERCONTROL IPC_LOG_BASE_PORT+305 55452
SDE_ATM IPC_LOG_BASE_PORT+306 55453
SDE_MONITOR IPC_LOG_BASE_PORT+307 55454
SDE_DRIVER IPC_LOG_BASE_PORT+308 55455
SDE_OPCUA_SERVER IPC_LOG_BASE_PORT+309 55456
35
PI-AF Adapter
PIAF_MANAGEMENT_TOOLS IPC_LOG_BASE_PORT+340 55487
PIAF_MCM IPC_LOG_BASE_PORT+341 55488
PIAF_USL_EXPLORER IPC_LOG_BASE_PORT+342 55489
COMTRADE Utility
COMTRADE_UTILITY IPC_LOG_BASE_PORT+350 55497
Used when Log Viewer is a log source

LOGVIEWER IPC_LOG_BASE_PORT+351 55498
36
Index
Index
A H
Add a User Annotation.....................................10 Hard Flush ....................................................... 17
Add sources ........................................................7 Help About ...................................................8, 15
Application ID..................................................17 Hide Sources Column........................................ 7
AppName.log ...................................................17
AppNameID ......................................................17 I
appNameLogCfg.xml .................................22, 31
Automatically Reconnect ...................................5 Incoming Connections Preferences ................... 6
Introduction ....................................................... 1
Issue a Connect to a Single Source.................... 9
C
Issue a Disconnect to a Single Source ............. 10
Calling Backoff Time .......................................19
Calling IP..........................................................19 L
Calling Port.......................................................19
Clear Log File.....................................................8 Listen on Startup................................................ 6
Clear Status.........................................................8 Listen Port ....................................................6, 18
Clone Log File....................................................8 Local.................................................................. 6
Component Format...........................................22 Log Common................................................3, 16
Confirm Actions ...........................................6, 14 Log Configuration Editor Preferences............. 13
Connect on Startup .............................................5 Log Configuration File .................................... 12
Log Control ..................................................... 16
Log Elapsed Time............................................ 16
D
Log File Attributes........................................... 17
Default listen port numbers ..............................19 Log File Name ................................................. 17
Destroy Old File ...............................................17 Log File Size.................................................... 17
Detect SISCO Sources....................................3, 5 Log IPC Attributes........................................3, 17
Display File Editor .............................................6 Log Masks ....................................................... 22
Display Status.....................................................6 Log Memory Attributes ................................3, 20
Display Status Pane ..........................................14 Log Memory Items .......................................... 21
Display/Hide Sources .........................................9 Log Viewer Icons .............................................. 9
Double Click.....................................................14 Log Viewer Preferences .................................... 5
Logging ............................................................. 7
E Logging Preferences .......................................... 5
Edit Display Logging .........................................8
M
Edit Log File.......................................................8
Edit LogCfg File...............................................19 m_check_list_enable ....................................... 28
Elapsed ...............................................................6 m_fill_en.......................................................... 28
Enable Calling ..................................................19 m_find_node_enable ....................................... 29
Enable Listen....................................................18 m_no_realloc_smaller ..................................... 29
Enable Log File ................................................17 Mask Format.................................................... 26
Enable Log Memory Attributes........................20 Max Display Lines............................................. 6
Enable Smart Mode ..........................................19 Max Listen Connections.................................. 19
Enable/Disable Display Logging..................7, 10 Max Que Count ............................................... 18
Enable/Disable File Logging ..............................8 Max Status Lines ............................................... 6
Memory Allocation Debug Control................. 27
F Memory Check List ......................................... 28
Memory File Dump ......................................... 20
Finding in the Log Viewer .................................4 Memory Fill Enable......................................... 28
Memory Find Node ......................................... 28
37
Memory Log File Name ...................................21 SISCO Template Log Configuration file......... 12
Memory No Reallocation Smaller ....................29 Smart ................................................................. 7
Miscellaneous Preferences ...........................6, 14 Smart Mode status ............................................. 7
Source................................................................ 6
N Sources .............................................................. 7
Starting the Log Configuration Editor ............. 11
Number of Listen Ports ....................................19 Starting the Log Viewer .................................... 3
Number of Ports .................................................7 Status Preferences.............................................. 6
Subcomponent Format..................................... 23
O
Outgoing Connections ........................................5 T
TemplateLogCfg.xml ...................................1, 31
P Timestamp Type ................................................ 6
Port Assignments for SISCO Products .............35 Tools.................................................................. 8
Preferences ...................................................5, 13
U
R Using the Log Configuration Editor ................ 11
Reconnect Delay (ms) ........................................5 Using the Log Viewer........................................ 3
Reset Display Logging .......................................8
Reset Logging Display .....................................10 V
Restore Default Size .........................................14 validation ......................................................... 12
S X
Sample Log Configuration XML File ..............31 xxxLogCfg.xml ................................................. 1
Save Display Logging ........................................8
Seal Mode.........................................................19
Seal Time Window ...........................................20
38

SISCO Log Viewer User's Guide

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

SISCO Log Viewer User's Guide

Hochgeladen von

Copyright:

Verfügbare Formate

SISCO Log Viewer

© SISCO, Inc. 2010

Systems Integration Specialists Company, Inc.

Systems Integration Specialists Company, Inc. makes no representation or warranties with

USING THE LOG VIEWER........................................................................................... 3

PORT ASSIGNMENTS FOR SISCO PRODUCTS.................................................... 35

Windows XP/2003: \Documents and Settings\All Users\Application Data

Using the Log Viewer

To start the Log Viewer run:

The following menu options are available:

Searches forward in the displayed logging.

Searches backwards in the displayed logging.

Allows searching again for a previously specified item.

Detect SISCO Sources:

Max Status Lines:

If checked, it allows for a remote user to monitor logging locally.

This indicates the port number to use if Listen on Startup is selected.

Timestamps can be one of three types:

Elapsed A high resolution timestamp will be displayed by the Log Viewer.

Hide Sources Columns

This option enables or disables logging to the screen.

This allows editing a previously saved file.

Enable/Disable Logging To File

This option enables or disables logging to a designated file in a specific location.

Clear Log File

Clone Log File

When this option is selected, a copy of the existing LogViewer.log found in

Edit Log File

Issue a Connect to a Single Source

Issue a Disconnect to a Single Source

Enable/Disable Display Logging

Reset Logging Display

This icon allows the Logging Display to be cleared.

Add a User Annotation

Using the Log

Start  Program Files  SISCO  Log Viewer  Log Configuration Editor

The following prompt will be displayed:

Log Configuration File

Select OK and the Log Configuration Editor will be displayed:

The following menu options are available:

Display Status Pane

Log File Attributes

Destroy Old File

Log IPC Attributes

Max Que Count

Num of Listen Ports

Max Listen Conns

Calling Backoff Time

Enable Smart Mode

Edit LogCfg File

Seal Time Window

Log Memory Attributes

The above Subcomponent Format will generate the following XML:

Adding Elements to a LogCfg XML File

Memory Allocation Debug Control

Memory Allocation Debug Control

extern ST_BOOLEAN m_fill_en; /* global variable */

Memory Check List

extern ST_BOOLEAN m_check_list_enable; /* global variable */

Memory Find Node

extern ST_BOOLEAN m_find_node_enable; /* global variable */

Memory No Reallocation Smaller

extern ST_BOOLEAN m_no_realloc_smaller; /* global variable */