You are on page 1of 21

Expert Tool for

SmartStruxure

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 1 of 21
Contents
Contents .................................................................................................................. 2
Overview................................................................................................................. 3
Installation............................................................................................................... 3
Registration ............................................................................................................. 3
Window Layout ....................................................................................................... 3
Connect to an SBO Server........................................................................................ 4
Server Upload Manager ........................................................................................... 6
Import Data ............................................................................................................. 7
Export Files ......................................................................................................... 7
Backup Files ........................................................................................................ 7
Screen Display......................................................................................................... 8
Selecting Objects ..................................................................................................... 9
Flow Chart Options .............................................................................................. 9
Add Selected Objects ........................................................................................... 9
Drag and Drop ..................................................................................................... 9
Add Linked Objects ............................................................................................. 9
Remove Selected Objects ..................................................................................... 9
Viewing Objects .................................................................................................... 10
Moving Objects ................................................................................................. 10
Zooming ............................................................................................................ 10
Magnifier Viewer............................................................................................... 10
Overview Control .............................................................................................. 10
Zooming onto Selected Area .............................................................................. 10
Highlight an Object ............................................................................................ 10
Zooming and Viewing Objects ........................................................................... 10
Layout Manager .................................................................................................... 11
View Properties ..................................................................................................... 12
Save Data .............................................................................................................. 12
Graphic View ........................................................................................................ 12
Binding Report ...................................................................................................... 13
Object List Report ................................................................................................. 14
Selecting objects ................................................................................................ 14
Selecting type specific columns .......................................................................... 15
Selecting standard columns ................................................................................ 15
Presets ............................................................................................................... 15
Reports .............................................................................................................. 15
Object Data Report ................................................................................................ 16
Selecting objects ................................................................................................ 16
Run time value ................................................................................................... 17
Object Report .................................................................................................... 17
Compare Object Data Reports ................................................................................ 18
Compare Report Content .................................................................................... 18
Compare Different AS or Folder......................................................................... 19
Live Values ........................................................................................................... 20
Settings tab ........................................................................................................ 20
Logon tab (only required for Import files) ........................................................... 20
Containers tab (only required for Import files) .................................................... 20
Live Data tab ..................................................................................................... 21

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 2 of 21
Overview

The Expert Tool can provide a graphical view of objects located in a SBO
Enterprise Server, Automation Server, Project Configuration Server or PCT.
The tool can generate a drawing in a number of different file formats as well
as a binding report. The Expert Tool also includes a report feature which
allows the user to generate a number of object reports. It is also possible to
read live values which can help identify problems when commissioning or fault
finding on site.

The Expert tool can also create the configuration data for Building Analytics. A
licence file is required to enable this option.

The tool is compatible with all SBO releases from 1.5 to 1.9. The tool can
directly connect to an Enterprise server, Automation Server, Project
Configuration Server Project or PCT. The tool can also read export files (type
XML) or backup files (type XBK) from SBO release 1.4 upwards.

Installation

To install the software, click on the file “Setup.exe” and then follow the default
instructions. If a previous version of Expert Tool is already installed, then you
may need to remove this first using the control panel. The tool requires .NET
version 4.5.

The main operational files are installed in the “Program Files” or “Program
Files (x86)” folder while data files are installed in the application folder which
is located in the “Program Data” folder.

Registration
The software requires a one-off registration the first time it is run. The
registration details require user name, company name and contact email
address. The application will generate a warning message if there is a newer
version of software available or the installed release is no longer supported.

Window Layout
It is possible to customise the layout of the screen by dragging and docking
tabs windows and the System Tree to desired position. The layout will be
saved when the application is closed. If you want to return to the default
layout, then select the Restore Default Position menu from the Window
menu.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 3 of 21
Connect to an SBO Server

Click on the Open SBO Server icon on the tool bar or the menu option from
the File menu.

Automation Server
For an Automation Server enter the IP address and the user name and
password. The Automation Server must be connected to the PC network.

Enterprise Server
For an Enterprise server enter the PC name, user name and password. The
Enterprise Server service must be started. Note that if you connect to an
enterprise server then any Automation Servers connected to the Enterprise
Server will also display in the system tree.

Project Configuration Server Project


For a PCS project enter the PC name as the address and the user name and
password and the name of the PCS project. The available projects are listed
in the drop down project list. The Project Configuration Server service must be
running.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 4 of 21
Domain
From SBO 1.7 onwards it is possible to enter a domain.

Automatically Upload AS Servers


This option can make it much faster to upload the required part of a network if
the network contains multiple AS controllers. If the option is enabled the
upload manager will upload all data in the network unless manual stopped. If
the option is disabled, then the upload manager will not upload any data
below an AS server. To upload the required AS select the context menu of the
AS and click the “Upload” menu option. It is also possible to upload the
required AS server(s) via the upload manager as described later.

SBO Certificates
Between SBO 1.6 up to SBO 1.8 a valid and trusted certificate must be
available for each destination except for a PCS project. If a trusted certificate
is not available, then the Expert Tool connection will fail. Create a certificate
via the control panel in the SBO workstation.

Changing Release
The SBO Release radio buttons show the current Expert Tool API release.
The release version can be changed when the Expert tool is started and this
will start a program called the Expert Tool Release Manager. The release
manager will control the version of API libraries in the Expert Tool. The
release manager needs to run with administrator privileges.

Once a connection has been made from the API to a SBO server it is not
possible to change the release until the next time the Expert Tool is started.

Click the OK button to load the system tree of the server. The upload of the
server is controlled by the Server Upload Manager described in the next
section. If you want to update the system tree, then logon to the same server
again. If you want to logon to a different server then enter the new information
in the logon dialog.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 5 of 21
Server Upload Manager

When you connect to an SBO server it can take from a few seconds to many
minutes to load the information to the Expert Tool. The time taken depends on
a number of factors including the network bandwidth, number of automation
servers, number of folders, Lon and BACnet devices, etc.

During the server upload the Server Upload Manager will be visible. The
Server Upload Manager allows the progress of the upload to be monitored. It
also enables the automatic upload to be stopped. When the automatic update
is stopped folders can be selected manually and uploaded. The Refresh
Time is an adjustable value that sets the amount of time that the program will
spend collection information from the server without stopping and updating
the screen. A large number will make loading a device significantly faster but
will mean there will be a delay when clicking the Stop Upload button.

To manually select folders firstly click the Stop Update button. Folders can be
selected from the System Tree by either dragging the folder from the tree to
the folder list or by selecting the required folders in the System Tree before
clicking the Select Highlighted Folders button. Click the Start Upload button
to upload the selected folders. The folder colour indicates the status of the
folder. Red text indicates the folder has not been uploaded. Blue text means a
child folder has not been uploaded. If you close the Server Upload Manager,
then you can open it again from the File menu or by a toolbar button if you
want to upload more folders at a later time.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 6 of 21
Import Data

It is possible to display a flowchart from information contained in SBO Export


files or SBO Backup files.

Export Files
Click on the Open option in the File menu and select the SBO Export Files
menu option or click the icon in the tool bar. The file select form allows multi-
selection of files. To export files from a SmartStruxure server firstly highlight
the folder in the Building Operation Workstation and select the Export option
from the File or Context menu. If you only want to view part of a folder, then
highlight the relevant folder in the folder tree before exporting. For IO objects
in an AS highlight the required IO modules in the IO folder prior to exporting.
The files are exported in XML format. The file names of exported files are not
important. For SBO Release 1.4 or later select the Export Special Reference
Filter. Importing data will create a system tree. Selecting objects to view is the
same as a direct connection to as SBO Server.

Backup Files
Click on the Open option in the File menu and select the SBO Backup Files
menu option or click the icon in the tool bar. A workstation backup is a
complete backup of an AS, ES, or PCS project. To create a backup file from a
server firstly highlight the root folder in the Building Operation Workstation and
select the Backup option from the File or Context menu. It is possible to
import multiple backup files by selecting multiple backups.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 7 of 21
Screen Display

When connecting to an SBO server or Importing data files the flow chart
display will initially be empty and objects can be added as described in the
next section.

Simple objects such as IO objects and values are displayed as blocks whilst
more complex objects like functions, programs and graphics are displayed as
tree view objects containing a number of tree items. It is possible to expand or
collapse individual tree items by clicking on the box to the left of the folder.
Bindings between objects are shown as connecting lines and the direction of
the binding is shown by an arrow. Move the cursor over an object or line to
display a tooltip of the object parameters. Selecting an object will highlight
bindings connected to the object and highlight the object in the system tree.
For a tree view object collapsing a topic will hide the topic bindings.

There are 4 different flow layout formats available that use different methods
for location objects and links. Refer to the layout section for more details.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 8 of 21
Selecting Objects
Objects can be selected or removed from the System Tree to display in the
flow chart window in the following ways. Objects in the System Tree have
black text if they are currently displayed in the flowchart otherwise they have
gray text. To create a new flow chart, click the New menu item or tool bar
button.

Flow Chart Options


A Flow Chart Options window will appear when adding objects to the flow
chart. The flow chart options allow objects types such as alarm objects, trend
objects, graphic objects and shortcuts to be hidden in the flowchart. The
options also allow the option to hide objects that have no links to other
selected objects. The Flow Chart Options form will be displayed when objects
are selected but the form can be hidden by clicking the Do not show this
dialogue box again. The flow chart form can also be accessed from the Flow
Chart menu.

Add Selected Objects


Select any number of folders and/or objects in the System Tree and then
click the Add Selected Objects menu item or tool bar button. This operation
will add all selected objects to the flow chart that are enabled by the Flow
Chart Options.

Drag and Drop


It is possible to drag a folder or object from the System Tree to the flow chart
window. This operation will then add all selected objects that are enabled by
the Flow Chart Options to the flow chart.

Add Linked Objects


Select any number of folders and/or objects in the System Tree and then
click the Add Linked Objects menu item or tool bar button. This operation
will add all selected objects to the flow chart that are enabled by the Flow
Chart Options. The operation will also add any other objects in the System
Tree to the flow chart if they have an input or output binding to the selected
objects and are enabled by the Flow Chart Options. Note that this action
might take a considerable time the first time it is run as the application has to
check the bindings on every object. It will be especially slow if there are a
number of Automations Servers connected to an Enterprise Server.

Remove Selected Objects


Select any number of folders and/or objects in the System Tree and then
click the Remove Selected Objects menu item or tool bar button. This will
remove from the flow chart any objects that are selected. It is also possible to
delete objects by highlighting then in the flow chart window and then clicking
the keyboard Delete button.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 9 of 21
Viewing Objects
Moving Objects
Object(s) can be moved by firstly selecting a part of the display and then
dragging the selected area. Firstly, click on one corner of the required area
with the left mouse button and then keeping the button pressed move to the
opposite corner before releasing the button. All objects within the area will be
selected. Click on one of the selected objects and move to the required
location before releasing the button. All the selected objects in the group will
be moved together. Connecting lines will automatically redraw after moving
objects.

Zooming
The scaling can be adjusted by altering the zoom factor in the toolbar or by
moving the mouse scroll wheel whilst pressing the Ctrl key. It is possible to
scroll up and down by using the vertical scroll bars or the mouse scroll wheel.

Magnifier Viewer
An object can be viewed in more detail by enabling the magnifier viewer. The
magnifier can be removed by clicking the tool bar button again or by right
clicking the flow chart view.

Overview Control
Click the Overview menu option in the View menu to display an overview
window. The overview window allows you to navigate around the flow chart to
view areas that are outside the viewable area of the flow chart.

Zooming onto Selected Area


It is possible to zoom into an area of the flow chart by selecting the area with
the right mouse button. Firstly, click on one corner of the required area with
the right mouse button and then keeping the button pressed move to the
opposite corner before releasing the button. The screen will then zoom to
display the required area.

Highlight an Object
It can be difficult to find a specific object in a flow chart especially if there are
many objects. Clicking on an object in the System Tree view will cause the
object in the flow chart to flash between red and white for a few seconds.

Zooming and Viewing Objects


Double-clicking on an object in the tree view has a different function than the
single click feature that highlights an object. A double click on an object will
highlight the object but also ensure that the object in visible in the viewable
area of the flow chart window by automatically scrolling the display so that the
object is viewable. If the same object is double clicked a number of times,
then each double click after the first will cause the display to zoom in on the
selected object.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 10 of 21
Layout Manager
Select the Layout manager from the View menu. The layout manager allows
adjustment of the main parameters used in the layout algorithm.

There are 4 different layout styles available which use different criteria for
locating objects. The styles have different performance regarding drawing
speed and readability. Some of the styles are better for large or small number
of objects. The drawing styles available are

Circular layout
This layout arranges nodes in a circle around their parent. It has the fastest
drawing speed and is the best layout style for large flow charts.

Flow layout
Nodes are arranged relative to each other in a flow format. The drawing
speed is fairly fast and the style is best suited to small flow charts.

Layered layout
Nodes are arranged in horizontal or vertical layers. The drawing speed is slow
and it is more suitable for small flow charts comprising of a small number of
objects.

Topological layout
Nodes connections are arranged in a column or row. The drawing speed is
medium and it is more suitable for small flow charts.

The other layout settings are enabled when they are relevant to the selected
layout style.
Schneider Electric Expert Tool 23 June 2017
Document Issue 2 Release 1.9 Page 11 of 21
View Properties
Select the View Properties from the View menu. The view properties window
allows changes to the background colour, line, colour, object colours, effects
and scale and magnifier settings.

To change a colour, select the colour mode first (Background, line or object).
To select an object, pick the object type from the list view. Effects such as 2
colour objects, Glass effect and Aero Effect apply to all objects.

Click on the colour box for colour 1 or colour 2 to edit the colour. The changes
can be viewed in the view window. Click on the OK button to save the
changes

Save Data

It is possible to save the flowchart in a number of different formats. Click on


the Save menu option and then select the destination folder, filename and file
type. The supported file types are

Portable Document Format (.PDF)


Scalable Vector Graphics (.SVG)
Portable Network Graphics (.PNG)
Drawing Interchange Format (.DXF)
Shockwave Flash Files (.SWF)
Visio Files (.VDX)
Windows Metafiles (.WMF)

Graphic View

It is possible to display a graphic drawing. Drag a graphic object from the


System Tree to the Graphic View tab.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 12 of 21
Binding Report
To generate a binding view, click on the Binding Report option in the Report
menu and this will show the report in the binding view tab. Also clicking on the
binding view tab will automatically generate a new binding report. The report
will show a list view of the visible objects in the flow view.

Each object is shown with the object name, description, object path and object
type. Each separate binding parameter is shown on a separate line with the
binding category, binding name, binding type, input bindings, output bindings
and binding value. The binding value will either display the historical value if it
is a signal or the live value if the flow chart is currently displaying live values.
The binding report will also show the object status of the object or parameter if
a live value has been read. The object status can be Good, Uncertain,
Forced, Offline or Error. If no live value has been read, then the Status will be
blank.

It is possible to save a binding report by clicking the Save button. The binding
report can be saved as either

CSV Report File (.CSV)


The CSV output is in Excel compatible format and shows the same data as
the list view

Text File (.TXT)


The text file report shows the bindings in a format this is similar to the data
shown in the Edit Binding window in SBO.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 13 of 21
Object List Report
Click on the Object List Report icon in the tool bar or Object List Report in
the Reports menu to enable the report view setup. You can generate an
Excel compatible report or text report of parameters of SmartStruxuture
objects in the System Tree. The report option is only available when direct
connected to an SBO server or with Backup files.

Selecting objects
Selecting objects for the report is a combination of selecting folders or objects
in the System Tree and selecting object types. The System Tree is multi-
select and you can select any number of different folders or objects. Select
the object types that you want in the report which can be either a single object
type or any combination of object types. The objects selected window shows
the number of objects that will be in the report. The object types are in
categories rather than individual types so for example Program objects
include function block and script programs.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 14 of 21
Selecting type specific columns
Each object type (except graphic objects) has a number of selectable
parameters that can be added to the report. Each selectable parameter will be
included in the report if it is checked. The actual sequence of columns in the
report and output files is the order in which they are selected rather than the
order in the list. This allows the sequence to be determined.

Selecting standard columns


There are a number of standard texts that are common to all objects such as
name, type and description. These columns are optional but it would be usual
to include at least the name in the report. The standard columns will appear at
the start of the report but the sequence of the standard parameters is also
determined by the order in which they are selected.

Presets
It is possible to save the configuration settings as a preset. A preset includes
the selected object types, standard parameters, specific parameters and
selection order sequence. This makes it possible to save a scheme that you
might use again. The installation software comes with a number of existing
presets. To save a preset click on the Save Preset button and select a
filename. To open an existing preset click on the Open Preset button and
select the required preset file. Presets have the extension name “preset” and
are normally saved in the Presets folder in the application data folder.

Reports
Click the OK button on the Object List Report form to generate a report in
the Report View tab. You can change the object sequence by clicking on any
of the header columns in the list view.

It is possible to save the reports in two different formats. To save the report
click the Save button on the toolbar when the report view tab is selected or
click the Save Object Report menu option under the File menu. Select the
required option of “CSV Report file” or “Text Report File” from the Save type in
the Save form.

A CSV file saves the report as a comma separated file as shoe in the Report
View tab. A text file creates a report with the objects in a vertical list. Only the
appropriate fields with data are added to the text report.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 15 of 21
Object Data Report
Click on the Object Data Report icon in the tool bar or Object Data Report in
the Reports menu to enable the report setup. You can generate a text report
of the configuration of SmartStruxuture objects in the System Tree. The report
option is only available when directly connected to an SBO server.

Selecting objects
Selecting objects for the report is a combination of selecting folders or objects
in the System Tree and selecting object types in the data options. The System
Tree is multi-select and you can select any number of different folders or
objects. The point select options allow you the option of including Alarm
objects, Trend objects, BACnet objects, Lon objects, Modbus objects and INet
objects.

For Function block, Script objects and Graphic objects it is possible to select if
you just want to include binding information and/or the object data. The object
source data is the AUT, Script program or TGML data. It is possible to select if
the object source data is shown in the report.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 16 of 21
Run time value
It is possible to select if you want to include run time values in the report. The
reason that the run time values are optional is because you may want to
compare data reports at a later stage without the run time values showing
changes.

The run time options are

No run time variables


All parameters that can change at run time are not included in the report
Value objects only (without controlling binding)
This option will include variable objects as long as the value is not set by a
binding parameter.
Value objects only
This option will include the value of variable objects
All run time values
All parameters are included

Object Report
Once the object report parameters have been set click the Create Report
button to start the report. The report may take a while to create on a slow
network and it is possible to cancel if required. The report is saved as an
encrypted file (Type ERF) but will display as text in the Report View tab. It is
possible to save the report as a text file by clicking the Save button or menu
option.

The report will contain all adjustable parameters belonging to an object. In


most cases the object parameter value will be displayed as the raw value. For
example, a binary value will display as true or false. It is possible to set more
descriptive texts by adding output values in the report view configuration file.

It is possible to open a saved report. In this case the file will display all data
including file data.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 17 of 21
Compare Object Data Reports
Click on the Compare Data Report icon in the tool bar or Compare Data
Report in the Reports menu to enable the compare report feature. The data
report feature compares 2 data reports and documents all changes between
the two reports. The compare report feature can compare the data in a
system at different dates to highlight changes or it can be used to identify
differences between 2 servers or 2 folders.

Compare Report Content

The Compare Data Report is saved as a text file and displays in the Report
View tab. The compare report output contains a summary at the top
containing the names of the two data reports and the number of objects in
each report.

The report then lists the changes in 3 sections. An object is considered to be


the same object if the object name, object type and object address match.

Deleted Objects
The list contains objects that are in the first report but not in the second report.

Added Objects
This list contains objects that are not in the first report but are in the second
report.

Modified Objects
The modified object list contains objects that have at least one parameter
change. A modification contains 3 lines which are firstly the name of the
parameter that has changes, then the old value and finally the new value.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 18 of 21
Compare Different AS or Folder
Firstly, you need to create 2 separate reports of the required servers or
folders. Then enter the differences in the relative paths as shown in the
examples. An object is considered the same object in the 2 reports if the path
is the same when name 1 is replaced by name 2. It is possible to ignore the
object modification date as this is likely to be different for all objects in the 2
reports.

Example 1 – comparing 2 paths at the same level in the system tree.

Example 2 – comparing 2 paths in a different part of the system tree.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 19 of 21
Live Values
Click on the Live Data icon to enable the Live Data manager. For the live data
feature to operate the AS or ES must be on-line. There are 2 communication
methods for collecting live data, either through the SBO interface (API) or via
Eco-Struxure Web Services (EWS). If the System Tree is created from Export
files, then the only option available is EWS. If the System Tree is created from
connecting to an SBO server then it is possible to use either API or EWS
communication method. The API communication is faster. It is possible to
read forced status from SBO version 1.8 or by EWS.

Settings tab
Communication Type
Select the communication method (API or EWS)
If EWS is selected, then enter the communication port (for example 80 or 81)

Sample Period
Set the sample period in milliseconds. For slow network network bandwidth
enter a longer time period.

Timeout Period
This is the timeout period before a failure is reported.

Logon tab (only required for Import files)


Enter the IP address of the AS, for example “192.168.1.99” in the IP Address
window. To display live values in an ES enter the address of the ES, for
example “localhost” or the PC name. Enter the user name and password for
the SBO log-on. Click the Get Root Containers button to get the root
containers of the device. Once the root containers are available a second
Container tab will appear.

Containers tab (only required for Import files)


The objective is to locate all the objects. An object is located when the root
folder of the object is displayed in the Containers list. As the root object of an
object might be a sub folder in the AS you may need to search for the
appropriate folders.

To add sub containers, check the relevant folder or container in the


Containers list and then click the Get Sub Containers button. This step can
be repeated as many times as required.

When all the objects in the flow chart are visible the Live Data tab will appear
and live data collection will automatically start. If the number of located
objects is greater than zero but less that the total the Live Data tab will
become visible and it possible to manually start the live data collection.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 20 of 21
The reason for the manual subfolder search is because it might take many
minutes for the program to discover all the sub containers in an AS especially
if there are LON or BACnet containers.

Live Data tab


Click on the Get Live Values button to start collecting live data and click the
Stop Live Values button to stop collecting live values. The speed of the data
collection will depend on the bandwidth and speed of the network. The
number of successful reads will be displayed as well as if an object in the
Forced or Error condition has been encountered.

Schneider Electric Expert Tool 23 June 2017


Document Issue 2 Release 1.9 Page 21 of 21

You might also like