Schneider Electric - PowerStruxure Diagnostics Tool v2.0.

PowerStruxure Diagnostics Tool

User Guide

v2.2.0

9/29/2010
 2

Contents
Introduction .................................................................................................................................................. 3
Concepts ....................................................................................................................................................... 3
Interface Components .................................................................................................................................. 4
Menu ......................................................................................................................................................... 4
File ......................................................................................................................................................... 4
Tool ....................................................................................................................................................... 4
Help ....................................................................................................................................................... 5
Analysis Configuration .............................................................................................................................. 5
Commands List .......................................................................................................................................... 5
Analysis Output ......................................................................................................................................... 7
Analysis Control Buttons ........................................................................................................................... 7
Running an Analysis ...................................................................................................................................... 8
Output Files ................................................................................................................................................. 10
Configuration .............................................................................................................................................. 11
Email Settings .......................................................................................................................................... 11
Products and Commands ........................................................................................................................ 12
Adding a New Product ........................................................................................................................ 12
Adding a Command ............................................................................................................................. 12
Order of Products and Commands ..................................................................................................... 12
Appendix A – General Commands .............................................................................................................. 13
Appendix B – ION EEM Commands ............................................................................................................. 13
Appendix C – ION Enterprise 6.0 and 6.1 Commands ................................................................................ 14
Appendix D – ION Enterprise 5.6 Commands ............................................................................................. 15
 3

Introduction
The PowerStruXure Diagnostics Tool v2.2.0 is an application built to retrieve useful and specific
information from other systems i.e. ION EEM or ION Enterprise. The Diagnostics Tool queries databases,
files and libraries in search for system information. The information gather by the tool is presented to
you in portable and easy to use files.

With the information gathered using the PowerStruxure Diagnostics Tool, you are able to troubleshoot
software and hardware problems, take snapshots of a system’s status, test commissioning efforts, etc.

Besides being an application, the PowerStruXure Diagnostics Tool v2.2.0 is also a framework that allows
extensibility and evolution. The framework allows the tool to work in many and any systems.

Concepts
Here are the definitions for important terms used throughout the document:

Analysis: Atomic process in which a set of commands are executed against a product and output is
generated.

CAB File: Windows native compressed file format

Command: A task that will retrieve information relevant to a specific area(s) of a product, and save that
information to an output file.

CSV File: Comma Separated Values file is a file that contains rows of data separated by commas. It is
supported by Microsoft Office Excel.

Output, output files: The file(s) generated by the tool after an analysis is finished.

Package: Also known as diagnostic package, it is the folder or cab file with all the output files.

Product: Any application that is supported by the Diagnostics Tool where the tool can execute
commands and retrieve information.

Software Product: See Product.

 4

Interface Components
The PowerStruXure Diagnostics Tool is made up of five main areas:

Menu

The menu located at the top of the tool contains the following items:

File

The File menu item gives you the options to:

- New Analysis: Clears the current selections and settings in the tool in preparation for a new
analysis.
- Load configuration: Loads the configuration settings that we’re found in the tool’s configuration
file.
- Save configuration: Saves all the selected settings (selected product, output package
destination, compressed file or not, emails to send to, selected commands, etc.) to the tool’s
configuration file.
- Exit: Closes the application.

Tool

The Tool menu has the following options:

- Email Settings: Opens the form to enter the SMTP server and other email specific values. See
the Configuration section for more details.
- Log: Opens a popup containing the tool’s log, used to report issues during the execution of the
tool.
 5

Help

As for this version, the Help menu only contains the About item. The About item gives copyright
information and version numbers for the tool.

Analysis Configuration
This section contains the main settings of the analysis, we’ll describe each of them here:

1) List that contains all the products that the tool can run analysis against.
2) The location where the output package will be saved.
3) Check box indicating whether you want the output package to be compressed into a CAB file or
be created as a folder.
4) Check box indicating whether you wish to send the compressed output package to one or
multiple email addresses. This option is only available when you choose to compress the
package.

Commands List
The command list shows all the commands available for a selected product. Commands can be members
of a group or be independent. Selecting a group will select all the commands within the group.

Some commands need parameters for their operation, for example a date range, these commands will
be displayed with the necessary controls to achieve this. If the controls of a command do not have a
default value, you will be required to fill the parameters before proceeding with the analysis.
 6

The following screenshot shows the main parts of this component:

1) The Select All button selects all the commands in the list.
2) The Select None button de-selects all the commands in the list.
3) This is a group heading, selecting this will automatically select all commands within the group.
4) An example of a simple command that requires no parameters from the user.
5) An example of a command that requires the user to select a date range, in this case by default it
selects the range for today.
 7

Analysis Output
This component displays information about the analysis being executed. Information like the command
currently being executed, number of successful or erroneous commands, etc.

Analysis Control Buttons

The tool has three main buttons that control any actions:

The Start Analysis button runs an analysis after checking that all the settings are correct. If there are
incorrect settings the user is notified and the analysis is not run.

The Pause/Resume button pauses or resumes the analysis. When pausing the analysis, the tool will try
to finish the command currently in execution and then pause.

The Cancel button first pauses the analysis, confirms that you want to cancel the analysis and if you
confirm it stops everything.
 8

Running an Analysis
Running an analysis is the main and most important action performed using the Diagnostics Tool. The
following steps describe the actions and considerations needed to perform an analysis:

1) Select a product. After selecting the product you should see the analysis items list get
populated, you’ll select the analysis items in a later step.

2) Choose the location in your computer where to save the output package too.

3) Choose whether you want the output folder compressed to a CAB file or leave it as a regular
folder.

a. If you selected Compress package, you will have the option to send the CAB file to one
or multiple email addresses. In order for the email functionality to work you need to
configure the email settings, see Configuration – Email Settings for more information.
 9

4) Select which groups or commands you want to be included in the analysis. Groups can be
identified as being shaded, selecting a group will cause the automatic selection or de-selection
of the commands within the group. You can also Select All or Select None.

Some commands, like the Windows System Event Log shown in the previous image, need you to
choose some parameters, like a date range. Most commands will have default values, however
remember you can always change them to obtain the right information you’re looking for.

5) Click Start Analysis to run the commands.

a. To pause an analysis simply click the Pause button. When pausing the analysis the tool
will finish the command that is currently running to maintain consistency.
 10

b. To cancel an analysis, click the Cancel button. When trying to cancel the analysis the
tool will display a message confirming that you really wish to cancel it. As with pausing,
the tool will finish the currently running command.

Output Files
Every analysis that is run generates an output package in the form of a folder or CAB file. This output
package is named like this: Diagnostics_SELECTED_PRODUCT_NAME_VERSION_DATE.

Inside the output package you will find HTML files, XML files, text files or CSV files containing the
information that each command extracted from the selected product. To ease in the browsing of this
files an Index.html file is always created.

The Index.html file lists all the files within the output package and its contents. The Index file has the
following format:
 11

Configuration
The Diagnostics Tool has two areas that configure the functionality of the tool itself. One are controls
the sending of emails. The other one controls which products and commands are supported.

Email Settings
In order for the tool to be able to send the output package to an email address, you need to set up the
SMTP server and account. If this settings are incorrect or not present, the tool won’t be able to send
emails. Here are the steps to set the email settings:

1) Open the Email Settings dialog.

2) Enter the SMTP Server and the SMTP Account to use for sending the emails.

3) If the SMTP server requires a password, please provide it too.

4) Provide the text that will make up the Subject line of the email.
5) Click Save.
 12

Products and Commands

One of the advanced features of the Diagnostic Tool, is the ability to add or remove products and
commands with ease. By default, the tool comes with all available products and commands, however,
you may want to remove unnecessary commands or products to prevent selection.

Adding a New Product

To add a new product, you need to have access to the Products.xml file that comes with the Diagnostics
Tool package. Here are the steps:

1) Open the Products.xml file.

2) Inside the <Products> section add the following, where MY PRODUCT is replaced by the product
name:

<Product name="MY PRODUCT" version="1.0">

</Product>

3) The previous step creates a product, but with no commands, it is not useful. To add commands
simply add whatever number of the following lines inside the newly created product tags:

<Command namespace="EEMCommands.HardwareCommand"></Command>
<Command namespace="EEMCommands.OperatingSystemCommand"></Command>

The next time you open the tool, you will find the new product in the products drop down list.

Adding a Command
To add commands simply add whatever number of the following lines inside the a product tag:

<Command namespace="Commands.ExampleCommand"></Command>

Order of Products and Commands

If you want to change the order in which products or commands appear in the UI, simply rearrange
them within the Products.xml file according to the order you want.
 13

Appendix A – General Commands

The commands in this section can be executed in any computer without the need of an specific
application being installed:

- Hardware Command: Retrieves hardware information from the current machine. All values are
specific to the time of generation.
- Operating System and Internet Explorer Command: Gets the Operating system information and
a copy of the main Internet Explorer settings.
- Microsoft .NET Framework: Gets a list of all the .NET versions installed.
- Windows Services Command: Retrieves a list of the Windows Services installed with their status
information.
- Windows System Event Log Command: Retrieves a list of events from the Windows System
Event Log for a user specified time range. Exported in CSV format.
- Windows Application Event Log Command: Retrieves a list of events from the Windows
Application Event Log for a user specified time range. Exported in CSV format.
- Windows Scheduled Tasks Command: Gets details for all the Scheduled Tasks in the system.
- SQL Server Command: Returns the version of SQL Server available for the given system (if any),
databases available with the size, and database file locations and sizes.
- SQL Server Jobs Command: Details on the configured SQL Server Jobs (if there’s a server
available).
- Message Queues Command: Retrieves a list of message queues in the OS (if available).
- Regional Settings Command: Returns the language and date settings.
- Virtual Directories Command: If IIS 6.0 or later is installed, this command retrieves a list of
configured virtual directories.

Appendix B – ION EEM Commands

The following commands will only work in machines with an ION EEM installation:

- Registry Settings and Timezones Command: Retrieves Schneider Electric settings found in the
Windows Registry. Also copies all the Timezones found in the Registry.
- System Configuration Command: Retrieves whether the ION EEM installation is standalone or
distributed.
- Enabled Modules Command: Gets a list of all the enabled ION EEM modules.
- Files Version Command: Returns a list of all the files and versions found in the Bin and web\bin
folders.
- Configuration Table Command: Retrieves the configuration settings found in the CFG_Item and
CFG_ItemValue tables.
 14

- Configuration Files Command: Gets the configuration settings in all the .config files found in the
bin and web/bin folders.
- Sources Command: Gets a list of all the sources in ION EEM with additional information.
- Source ID Mappings Command: Returns the mapping between ION EEM’s source IDs to the
corresponding ION Enterprise source IDs.
- Source Sampling Command: Retrieves the first and last timestamp for each source.
- Virtual Sources Command: Gets a list of all the virtual sources and the constituents for each.
- Node Hierarchies Command: Returns all the hierarchy nodes with their details.
- System Log Command: Retrieves the contents of the ION EEM System Log for a user defined
time range.
- Setup Logs Command: Copies all the available ION EEM Setup Logs.
- Report Packs Command: Returns a list of all the installed report packs.
- Report Subscriptions Command: Gets a table with all the enabled report subscriptions.
- Reporting Services Command: Gets the configuration settings for the Report Server
communication.
- Enabled Timezones Command: Retrieves a list of enabled Timezones in the ION EEM database.
- Time Dimensions Command: Returns a list of all the time dimensions installed in the system.
- Data Management Rules Command: Gets a collection of enabled Data Management rules.
- Installed Schneider Electric Products Command: Retrieves basic information on Schneider
Electric products like ION EEM, ION Enterprise, ETL, Alarming and Rate Engine.

Appendix C – ION Enterprise 6.0 and 6.1

Commands
The following commands will only work in machines with an ION Enterprise 6.0 or 6.1 installation:

- Registry Settings and Timezones Command: Retrieves Schneider Electric settings found in the
Windows Registry. Also copies all the Timezones found in the Registry.
- Product Information Command: Retrieves information on this specific ION Enterprise
installation (version, license, etc.)
- SQL Server Command: Returns the version of SQL Server available for the given system (if any),
databases available with the size, and database file locations and sizes.
- SQL Jobs Command: Details on the configured SQL Server Jobs (if there’s a server available).
- Reports Command: Gets a list of all the installed reports and the reports saved by users.
- Setup Logs Command: Returns a copy of the setup log files.
- VIP Configuration Files Command: Copies the VIP configuration files and the diagrams.
- Log Inserter Configuration Files Command: Copies all the Log Inserter configuration files.
 15

- Translator Files Command: Gets a copy of all the translator files.

- ION Database Revisions Command: Retrieves the Registry table contents for the three ION
databases.
- ION_SystemLog Table Command: Gets records from the ION_SystemLog database based on the
user defined parameters (number of rows, priority and date range).
- ION_SystemLog Exception Events Command: Retrieves events from the ION_SystemLog
database that relate to exceptions.
- ION_Network Configuration Command: Gets all the servers, sites, devices, factory information,
modems and connection schedules.
- Diagnostic Viewer Information Command: Returns important information from the Diagnostic
Viewer.
- Configuration Table Command: Retrieves configuration settings found in the CFG_Item and
CFG_ItemValue tables.
- DeviceType Table Command: Gets all the records in the DeviceType table.

Appendix D – ION Enterprise 5.6

Commands
The following commands are specific to ION Enterprise 5.6 versions:

- Communication Server Events: Retrieves the last 2000 communication server events.