Professional Documents
Culture Documents
Workbench User Manual
Workbench User Manual
User Manual
Version 2.2.0
Workbench User Manual Version 2.2.0
Page 2 of 89
Workbench User Manual Version 2.2.0
1 Contents
1 Contents .................................................................................................... 3
2 Reference Documents.............................................................................. 8
3 Introduction............................................................................................... 9
3.1 Minimum System Requirements ................................................................ 9
3.2 Installing Workbench ................................................................................ 10
3.3 Uninstalling Workbench............................................................................ 14
3.4 Upgrading Workbench .............................................................................. 14
3.5 Starting Workbench................................................................................... 14
3.6 Basic and Advanced Versions ................................................................. 15
3.7 Security....................................................................................................... 15
3.7.1 Access Passwords ................................................................................ 15
3.7.1.1 Group Access Level........................................................................ 16
4 User Interface.......................................................................................... 18
4.1 The Workspace .......................................................................................... 18
4.2 Arranging Windows................................................................................... 19
4.2.1 Docking Tool Windows.......................................................................... 20
4.2.2 Hiding Tool Windows Automatically ...................................................... 21
4.2.2.1 To place a window in auto hide ...................................................... 21
4.2.2.2 To disable Auto Hide ...................................................................... 21
4.3 Menu Bar .................................................................................................... 22
4.3.1 File Menu .............................................................................................. 22
4.3.1.1 File - New........................................................................................ 22
4.3.1.2 File - Open ...................................................................................... 22
4.3.1.3 File - Close...................................................................................... 22
4.3.1.4 File - Save....................................................................................... 22
4.3.1.4.1 Project Information Box.............................................................. 23
4.3.1.5 File – Save As................................................................................. 24
4.3.1.6 File – Print....................................................................................... 24
4.3.1.7 File – Print Preview......................................................................... 24
4.3.1.8 File – Print Setup ............................................................................ 25
4.3.1.9 File – Open Recent Files ................................................................ 25
4.3.1.10 File - Exit ........................................................................................ 25
4.3.2 Edit Menu .............................................................................................. 25
4.3.2.1 Edit - Undo...................................................................................... 25
4.3.2.2 Edit – Redo ..................................................................................... 26
4.3.2.3 Edit - Cut......................................................................................... 26
4.3.2.4 Edit - Copy ...................................................................................... 26
4.3.2.5 Edit - Paste ..................................................................................... 26
4.3.3 View Menu ............................................................................................ 26
4.3.4 Window Menu ....................................................................................... 27
4.3.4.1 Window - Cascade.......................................................................... 27
4.3.4.2 Window – Tile ................................................................................. 27
4.3.4.3 Window- Select Specific Project ..................................................... 28
Page 3 of 89
Workbench User Manual Version 2.2.0
Page 4 of 89
Workbench User Manual Version 2.2.0
Page 5 of 89
Workbench User Manual Version 2.2.0
Page 6 of 89
Workbench User Manual Version 2.2.0
Page 7 of 89
Workbench User Manual Version 2.2.0
2 Reference Documents
Page 8 of 89
Workbench User Manual Version 2.2.0
3 Introduction
The minimum requirement for installing and running Microsol Workbench are
outlined below:
• A 500MHz or better Pentium class PC processor
• 32 Mbytes or more of Random Access Memory (RAM)
• Minimum 40 Mbytes of Hard Disk Space for the program, additional hard disk
space will be required for storing the individual configurations
• A Windows supported graphics adapter supporting 12-bit colours or more and
a 4x CD-ROM drive.
• An RS-232 serial communications port, although this is not necessary to run
the configuration program you will not be able to download the configuration to
the target system or perform any online diagnostics without it.
Page 9 of 89
Workbench User Manual Version 2.2.0
• If, at this point you do not wish to install ‘Workbench’, click ‘Cancel’,
otherwise click ‘Next’ and you will be presented with the Microsol
License Agreement.
Page 10 of 89
Workbench User Manual Version 2.2.0
• If you accept the Agreement click Next and you will be presented with
the Installation Folder Selection dialog
• Although it is recommended that you install the program into the default
folder you can use this dialog to select another location for the
installation. Additionally, Workbench can be installed in a single-user
(Just Me’ radio button) or multi-user (‘Everyone’ radio button) mode. It
is recommended to install the multi-user Everyone’ radio button.
• Although the disk space requirements of the program are modest you
may wish to check that sufficient space is available on your hard disk
using the ‘Disk Cost’ button. This will present you with a list of your hard
drives and the amount of space available for installation and the amount
of space required for installation of the program (currently ~30Mbytes).
Ensure that you install the program on a drive with sufficient space.
• Once you have finished the selections click ‘Next’ and the installer will
ask you to confirm the installation, as shown in Figure 3-4
Page 11 of 89
Workbench User Manual Version 2.2.0
• The final dialog will confirm the installation is complete and the
‘Workbench’ is ready to be used; this is shown in Figure 3-6.
Page 12 of 89
Workbench User Manual Version 2.2.0
• Finally the installer will place the Microsol Workbench icon on your
desktop.
Page 13 of 89
Workbench User Manual Version 2.2.0
If at any time you require to uninstall Workbench you will have to carry out the
following steps:
• Click the Start menu, then Settings and finally Control Panel.
• Double click the Add/Remove Programs icon.
• Find the Microsol Workbench entry in the list displayed and single-click
it.
• Finally click the Remove button. This will remove the Workbench
program from your computer but it will not remove any project
configurations that you have created. These can be removed separately
using Windows Explorer if required.
To upgrade Workbench simply install the new version according to section 3.2
Installing Workbench. The install program does not remove any existing project
configurations so they will still be available in the new installation.
Workbench can be started by double clicking the icon on the desktop (Figure 3-7) or
selecting the program from the Start program menu, then selecting Programs
followed by Microsol Workbench as shown in Figure 3-8. The program will then
present a blank workspace to allow you to begin configuration or diagnostics
Page 14 of 89
Workbench User Manual Version 2.2.0
Workbench is available in two versions; basic and advanced. The basic version has
the ability to configure RTUs and run diagnostics with RTU Live but without
advanced features. The advanced version has the basic functionality plus other
advanced features. These advances features are:
• Print Configuration
• Import eXpert Databases
• OSI SCADA export
• Flash Programmer
• Password Control
• Templates
• Wiring List (XML Spreadsheet)
• Upload Config
• Remote Workbench (Not really used)
• DMF Downloader
To upgrade Workbench to advanced, load the Advanced License File using the
Upgrade… (4.3.5.4) item in the Help menu.
Please consult your Microsol contact for more information on obtaining a Workbench
Advanced License.
3.7 Security
Note: The Workbench Security feature is only available with the advanced version of
Workbench. Please consult your Microsol contact for more information.
Page 15 of 89
Workbench User Manual Version 2.2.0
Prohibited Tasks
When the user attempts to run a prohibited task, a password dialog will appear
displaying its Group and Level, as shown in Figure 3-9. To set the Group Access
Level the user must enter the password for this level. The new access level will
remain valid until workbench is closed.
Password Manager
The user can also set a Group Access level in the Password Manager
(Options->User Access...) by selecting the required level and clicking the ‘Change
Level’ button, as shown in Figure 3-10. As a rule, any Level within a Group has
access to a level with less access. i.e. If the Group Access Level is ‘Full’ the user
has access ‘View’ and ‘Control’. The user may also change the password using the
‘Change Password…’ Button.
Page 16 of 89
Workbench User Manual Version 2.2.0
Page 17 of 89
Workbench User Manual Version 2.2.0
4 User Interface
Menu
Toolbars
Start Panel
(AutoHide)
Record Properties
RTU Live Panel Data Panel
(AutoHide) Window (AutoHide)
Project
Hierarchy
Elements
Project Area
• Start Panel is used for opening or creating a project. It contains the recent
projects list and templates for creating new project.
• Workbench Messages Panel is used to display messages, warnings, and errors
from the deferent workbench modules.
• Elements Panel is used for project configuration. It contains all configuration
components that can be used for creating a new project configuration
• Record Properties Panel is used for viewing the project data in deferent orders.
• RTU Live Panel is used for communicating with the target hardware for on-line
diagnostics or downloading/uploading system configurations
• Database Messages Panel is used to display on-line messages from the target
system
• XCell Flash Programmer Panel is used to program Microsol XCell products that
use flash memory. Currently, this includes CPR-021 fitted with the FXP-010
Memory Expansion Card and the CCM.
The Project area is used to define the configuration for a particular project or
system. The Project area is divided into two, the Project Hierarchy and the Data
Window. Configuration simply involves dragging and dropping configuration
elements from the Elements window to the Project Hierarchy.
The Message window is used to display on-line messages from the target system
Page 18 of 89
Workbench User Manual Version 2.2.0
The individual windows will be described in more detail in later sections of the
manual along with their associated Right-Click menu options
The windows within the workspace can be resized by dragging the edge of the
window to the required size. In addition the Elements, RTU Live and Message
windows may be re-positioned by double clicking on the relevant title bar and
repositioning the window. The window may be restored to its original position by
double clicking on the title bar again. The windows may be removed completely by
double clicking the close icon. Panels that have been removed can be restored using
the relevant checkbox in the View menu. If the width of any window in Workbench
has been reduced to such an extent that all of the tabs cannot be displayed together,
then scroll arrows will be available to scroll through the available tab list. The filled
arrow shows that there are further elements to be displayed while the empty arrow
shows the end of the list of tabs has been reached.
More items to
the Left
More items
to the Right
Close Active
Document
The Microsol Workbench has two types of windows, tool windows and document
windows. You can increase the viewing and editing space for project, depending on
how you arrange the windows in the Microsol Workbench. You have many options
for arranging windows within the Microsol Workbench, including the following:
• Tab-dock several windows.
Page 19 of 89
Workbench User Manual Version 2.2.0
When a tool window is dockable, it floats on top of the other windows or it snaps to a
side of the application window.
To dock “RTU Live” to “Record Properties”, drag “RTU Live” and drop it on
“Record Properties” (Figure 4-3):
Tip To move a dockable window without snapping it into place, press CTRL
while dragging it to the location you desire.
Page 20 of 89
Workbench User Manual Version 2.2.0
Tool windows, all of which appear on the View menu, support a feature called Auto
Hide. Auto Hide allows you to see more of your code at one time by minimizing tool
windows along the edges of the Microsol Workbench.
When auto hidden, the name and icon of a window are visible on a tab at the edge of
the Microsol Workbench. Move your cursor over the tab to access auto hidden
windows. The window slides back into view and is ready for use. When an auto-
hidden window loses focus, it automatically slides back to its tab on the edge of the
Microsol Workbench.
Tip Tool windows in Auto Hide temporarily slide into view when the window
has focus. To hide the window again, select an item outside of the current
window. Once the window loses focus, it slides back out of view.
Page 21 of 89
Workbench User Manual Version 2.2.0
Page 22 of 89
Workbench User Manual Version 2.2.0
Project file
Specific Project directory
Project zip file
Sub-directory for parameters
Project before last
Sub-directory for eXpress Save
… applications
Page 23 of 89
Workbench User Manual Version 2.2.0
To download the configuration over the IEC 60870-5-101 Protocol the Generate IEC
Files flag must be set. Tag names can also be generated automatically by setting
the Automatic Tag Generation flag. If this flag is set, all Tags will be assigned by
workbench and read-only. Note: A prompt will automatically appear to choose
Automatic Tag Generation when the user adds the first element to a new project.
Note: Configuration Print is only available with the advanced version of Workbench.
Please consult your Microsol contact for more information.
Print – This menu option will only become active (not 'greyed out') when a
configuration table has been selected by clicking on any field in the Data Window.
Print will then present the print dialog as shown in Figure 4-9. This option is also
available using Ctrl+P.
Page 24 of 89
Workbench User Manual Version 2.2.0
Page 25 of 89
Workbench User Manual Version 2.2.0
Each of these items can be displayed or hidden by checking their individual boxes in
the drop down menu as shown.
Page 26 of 89
Workbench User Manual Version 2.2.0
Page 27 of 89
Workbench User Manual Version 2.2.0
Page 28 of 89
Workbench User Manual Version 2.2.0
The Toolbar icons as displayed from left to right, represent the following menu items.
The menu items have already been described in the previous sections.
• File – New
• File - Open
• File – Save
• Edit – Cut
• Edit – Copy
• Edit – Past
• File – Print
• Help – About XCell Workbench
Page 29 of 89
Workbench User Manual Version 2.2.0
5 Configuration
5.1 General
To configure a new project activate the Start Panel by selecting its AutoHide Tab;
this is automatically activated when Workbench is run. Select the project you wish to
create. The Start panel lists the type of projects that are available plus the recent
project list. The Elements tab provides the user with access to all configuration
components that can be dragged and dropped onto the Project Hierarchy window,
see diagram below.
File New
Start Panel
(AutoHide)
Project
Hierarchy Data
Window
Project Area
Elements
Page 30 of 89
Workbench User Manual Version 2.2.0
5.2 Profiles
Page 31 of 89
Workbench User Manual Version 2.2.0
FileÆOpen and select the project in the normal manner. A message will appear
requesting you to select a profile for this project – click OK. Select the profile that
you want to use from the Select Profile dialog (Figure 5-2) – Click OK. Note: If the
profile does not match the project you
5.3 Elements
Page 32 of 89
Workbench User Manual Version 2.2.0
the highest level object in a project hierarchy. There can only be one
RTU in each project. It can contain a number of equipment Bays or
Units but may NOT directly contain I/O points, eXpress points or
protocols.
• Bay Is a logical grouping of processing Units. Bay is a second level object
in a project hierarchy. Each RTU can contain a number of Bays and
each Bay can contain a number of Units up to the maximum of 254
Units per RTU.
• Unit Is a central processing unit that can be used for I/O, communications
and express program applications. Unit is the lowest level structural
element in a project hierarchy. Each unit must be assigned a unique
address within the RTU, up to a maximum of 254 and each unit can
contain a maximum of 256 physical I/O channels.
The Status tab contains all the hardware status elements that may be required for
diagnostics or incorporated into user application programs. These include processor
status, module status and serial port status. These status elements must be
associated with the relevant processor unit in the configuration hierarchy.
The Slave Protocols tab contains all the Slave Protocol configuration elements that
can be used in the Project. A Slave Protocol
communicates with an external master station or data
concentrator. The Slave Protocol tab is divided into
sub-tabs for each of the available protocols. Each
protocol may have several configuration elements that
are required for the protocol operation. Click on the
required protocol sub-tab to reveal the various
configuration elements that can be dragged to the
Project Hierarchy.
An example of using the protocol tables will be found in
the Tutorial section and full details of the protocol
configuration can be found in the relevant Protocol
Configuration Guide.
Note: The processing Unit must be factory loaded with
the required protocol firmware for the protocol to operate Figure 5-6 - Slave Protocols
Page 33 of 89
Workbench User Manual Version 2.2.0
The Project configuration is divided into two areas, the Project Hierarchy and the
Data Window. The Project Hierarchy defines all the elements required for the
project. These elements are dragged and dropped from the Elements tab. Once the
project hierarchy has been created, the Data Window is used to define the
parameters for each of the elements.
Project
Hierarchy Data
Window
Elements
Project Area
Page 34 of 89
Workbench User Manual Version 2.2.0
The basic project hierarchy that must be observed when defining a configuration is
outlined in the following diagram.
RTU
Bay
Unit
I/O Modules
Point Components (I/O)
Master Protocol Components
Slave Protocol Components
Express Components
Unit
Point Components (I/O)
Master Protocol Components
Slave Protocol Components
Express Components
The diagram in Figure 5-8 below shows the hierarchy diagram with both Unit nodes
and Bay nodes connected to the primary RTU node. The I/O modules, I/O nodes
(e.g SDI, Single Digital Inputs), and protocol nodes (e.g. IEC, DNP and Master
Modbus) are all attached to Unit nodes. Please refer to “Tutorial – Simple RTU
Configuration” and “Tutorial – IO Modules and Wiring list”.
The Project Hierarchy window in the Figure 5-8 has been resized (i.e. one edge
has been dragged over to resize it) to show some additional parameters in this view.
The only parameter that can be changed is the Unit number of the Unit nodes.
Page 35 of 89
Workbench User Manual Version 2.2.0
As you drag and drop certain elements onto the Project Hierarchy you may be
prompted for the number of data elements associated with the node, e.g. the number
of Single Digital Input points.
Once a data node has been added to the Project Hierarchy, the individual elements
can be edited in the Data Window.
There are several context sensitive menu options available in the Project Hierarchy,
which are activated by right-clicking the mouse. See Figure 5-9 Context Menu.
The Change Log which is a text file change.log located in the project directory on
the PC, also logs this information but has greater capacity. This file will rollover
when the 64k maximum file size is reached. The data is stored in csv (comma
seperated values) format, columns are: Date, Time, Engineers Name, Version and
Change Description.
Page 36 of 89
Workbench User Manual Version 2.2.0
Note: The Wiring List feature is only available with the advanced version of
Workbench. Please consult your Microsol contact for more information.
5.4.1.5 Copy
To Copy items from the Project Hierarchy simply right-click on the item and select
the Copy option. Right-click on the destination and select Paste.
5.4.1.6 Move
To Move items from the Project Hierarchy simply right-click on the item and select
the Cut option. Right-click on the destination and select Paste.
5.4.1.7 Link
To Create a link of an item from the Project Hierarchy simply right-click on the item
and select the Copy option. Right-click on the destination and select Paste
Shortcut..
5.4.1.8 Delete
To remove items from the Project Hierarchy simply right-click on the item and
select the Delete option. Confirmation of the deletion will be required before the
action is performed.
Page 37 of 89
Workbench User Manual Version 2.2.0
Data
Window
selection
Project Data
Hierarchy Window
Elements
Project Area
This section will detail the general data manipulation facilities and menus available in
the Data Window. The detailed description of the various configuration tables is
provided in the Appendices and is not covered in this section.
Note: Any data changes performed in the Data Window can be undone using the
Undo menu option or Ctrl+Z. These operations will only work if the relevant
configuration table is currently being displayed in the Data Window and the cursor is
active on the window. If one operation changes multiple fields, the Undo will undo
them one at a time. If a configuration table entry is deleted and its associated
Reference Tags automatically deleted, the Undo operation must be performed on
both the configuration table and the reference table(s) separately.
For editing data in the Data Window there are different methods of data entry
depending on the field type.
Typed data entry is available by double-clicking on the field to be edited. This will
highlight the current data within the field and allow it to be changed to any valid
value. If the value entered exceeds the maximum permissible value, a message will
be displayed advising the user of the maximum field value.
Page 38 of 89
Workbench User Manual Version 2.2.0
A Drop Down selection box is available on certain data entry fields. Left click on the
field to display a single down arrow beside the field. Click on the arrow to display the
drop-down options available and simply select the required option.
There are several context sensitive menu options available in the Data Window,
which are activated by right-clicking the mouse. The menu options provide facilities
for manipulating the contents of the table entries, and also inserting or removing
table entries. The menu options will vary depending on the area highlighted when the
right-click menu is selected. All options will be detailed here but they are not all
available in any single menu.
Page 39 of 89
Workbench User Manual Version 2.2.0
The Figure 5-13 below shows some of the different menu displays.
Note: Before describing each of the menu options it should be noted that any table
column may be selected by left clicking on the column title. However, no right-click
menu options are available when the mouse is placed over the column title or the
row number.
5.4.2.1 Cut
Cut – Will delete the contents of any highlighted text fields within the Data Window.
Once Cut, the text fields will revert to their default value (generally blank) and the
Cut fields can be Pasted elsewhere. This operation only applies to TEXT fields.
Numeric fields or fields with a drop-down option cannot be Cut.
5.4.2.2 Copy
Copy – Will copy the contents of any highlighted fields to the Windows clipboard.
Any copied fields can be Pasted elsewhere. All fields, including Tags and drop-down
options can be copied.
5.4.2.3 Paste
Paste – Will Paste the contents of the Windows clipboard to the corresponding
number of fields in the Data Window beginning at the top left of the highlighted area.
If only one field is on the clipboard and three fields are highlighted for pasting, only
one field will be pasted. If ten fields are on the clipboard and only three fields are
highlighted, ten fields will be pasted. It is not advisable to paste the contents of fields
into different field types, e.g. pasting text fields into numeric fields etc. If a Tag is
copied and pasted into another entry in the same column it will be appended with the
suffix “_Copyn” where “n” is the number of times the tag has been copied to the
same column. A message is displayed in the Message Window whenever a Tag
substitution is made.
Page 40 of 89
Workbench User Manual Version 2.2.0
DDI_3
DDI_3_COPY1
DDI_3_COPY2
Reported in the
Message Window
5.4.2.4 Find
Find… – Will search for a specified data value in the first column of any highlighted
area. The Find… option will display a simple dialogue for entering the required data
value. This option will search the entire column where the first highlighted field is
located regardless of the size of the highlighted area. If only two fields are
highlighted it will search the entire column on which the first field is located.
5.4.2.5 Replace…
Replace… – Provides standard Find and Replace facility for text fields only. It can
be used to find and replace an entire field contents or any part of a text string.
Page 41 of 89
Workbench User Manual Version 2.2.0
any other configuration table the reference will be removed automatically and the
user will be informed. Details of all deleted references will be provided in the
Message Window as shown below. This option is only available if the highlighted
area is on a single row.
Reported that a
reference to SDI_2
has been removed
from the DNP Map
Messages Window
Workbench
5.4.2.11 Set
Set – Sets all highlighted fields to a user entered
value. The user will be prompted to enter the
required value. If the highlighted area spans more
than one column then the user will be prompted
for a set value for each of the columns in turn.
The Set operation will not allow you to set a value Figure 5-16 – Set value selection
outside the range of the particular field (e.g. a
Page 42 of 89
Workbench User Manual Version 2.2.0
5.4.2.12 Interpolate
Interpolate – This very powerful function is
used to set both numeric and text fields with
incrementing values. This option is only
available if fields in more than one row are
selected. It has two modes of operation.
In its simplest form it allows the user to set a
numeric value and automatically increment it
for each highlighted entry in a particular Figure 5-17 - Interpolate - numeric values
only
column. The user can specify the start value
and the increment to be used for the
subsequent entries in the column. The
dialogue opposite is used to set these values. As an example, this menu option can
be used to set sequential channel numbers for all channels in a configuration Table
for Single Digital Inputs.
The second mode of operation allows it to
be used for non-numerical fields. The user
can combine a text prefix and/or a text suffix
to the numerical value to generate unique
tags or descriptions. The dialogue opposite
is used to set these values.
Note: Interpolate only works on a single
column regardless of the number of columns
selected. It will operate on the column where
the menu option is selected.
Figure 5-18 - Interpolate with Prefix and
Suffix
Page 43 of 89
Workbench User Manual Version 2.2.0
The diagram below shows fields set using the various Interpolate options and the
Set option.
Interpolate
Dialogue
Set using Interpolate Prefix
and numeric increment of 1
5.4.2.13 Definition
Definition – This option is only available on Tag or Reference Tag fields. It displays
the source of the Tag and places where the Tag is referenced. The format of the
information is shown in Figure 5-20 below.
Page 44 of 89
Workbench User Manual Version 2.2.0
Left-clicking on the Definition or the Reference in the “[…]” the relevant data table
will be displayed in the Data Window. In the example above clicking on the
Reference […] will result in the reference data table (DNP3 Map) being displayed in
the Data Window.
5.4.2.14 Properties
Properties – This option displays a separate Properties Window showing all the
properties associated with a single row entry, refer to Figure 5-21 below. This option
is only available when fields in a single row entry are selected. The data can then be
edited either in the Properties Window or the Data Window. The format of the data
display in the Properties Window can be altered using the various options at the top
of the window. The data can be displayed Categorized by data type, Alphabetically
or by Display order.
Properties
Display Options
Page 45 of 89
Workbench User Manual Version 2.2.0
1 2 3 4 5 6 7 8 9 10
Tag This is the TAG of the point if it exists. This is retrieved from
the current open project configuration
Unit This is the XCell unit number where the change message was
generated.
Group This is the data type that changed, e.g. SDI, DOT, AIN, BCD,
RAW_DI, RAW_AI etc
Record This is the channel number or record number of the point that
has changed within the unit.
Field This is the data attribute of the point that has changed. It
usually corresponds to the data size but may specify another
attribute in some circumstances e.g. Suppression field for
SDIs or DDIs.
Message This is the message type. Currently there are four message
Type types that can be reported:
Change Messages
• Single point change
Full Update
• Current value/status report –
Page 46 of 89
Workbench User Manual Version 2.2.0
Multiple configuration projects may be opened or created at any time. Each project
has its own selection tab immediately above the Project Hierarchy and Data Window.
The selection tabs contain the name of the Project file as stored on the hard drive.
The title bar of the Project Hierarchy displays the name and version number provided
when saving the project.
Configuration components can be copied or moved between projects. To achieve
this both projects must be on display simultaneously using the Window+Cascade or
Window+Tile menu options. Once both projects are on display components can be
moved from one project to another by using drag and drop from one project to the
other. Components can be copied by holding the <Ctrl> key while using drag and
drop from one project to the other.
Page 47 of 89
Workbench User Manual Version 2.2.0
Note: The XCell Flash Programmer is only available with the advanced version of
Workbench. Please consult your Microsol contact for more information.
The XCell Flash Programmer Panel is a tool that can be used to download software
applications to a Microsol XCell Processor equipped with Flash Memory. The figure
below displays a sample screen shot of the tool (Figure 6-1).
In order for the XCell Flash Programmer to work, the XCell processor must be set to
debug mode. The following steps in setting the processor to debug mode are:
• Turn OFF the processor
• Press and hold the function button
• Turn ON the processor
• Release the function button
After releasing the function button, only the power LED should be ON.
6.2 Connection Set-up
Only one XCell Processor can be configured at one time using the XCell Flash
Programmer. The figure below illustrates the connection set-up between the PC and
the XCell Processor.
The download cable is identical to that used for configuration download, ie DTE to
DTE. Refer to the XCell user guide for a pin out.
The “Show XCell Flash Information” button ( ) communicates and reads the flash
memory module inside XCell processor. It then displays the applications in
Applications item under XCell Unit tree view item. The XCell Unit tree view item
displays the applications present in the processor. It displays the name of the
Page 48 of 89
Workbench User Manual Version 2.2.0
applications and other relevant details. The Figure 6-2 shows a sample screen shot
of the XCELL APPLICATION.
The software applications that are downloaded to the processor are S-Record files.
The S-Record files that can be downloaded to the XCell Processor are found under
“Files” tree item. The “Load” and “Erase” buttons are used to display and remove S-
Record files from this window. It displays the name of the applications and other
relevant details. Figure 6-3 shows a sample screen shot of the window.
NOTE: Invalid files will not be loaded into the XCell Flash Programmer.
If the memory addresses of the code or data of the NBs overlap each other, the
XCell Flash Programmer will detect it and give out a warning dialog. Applications are
incompatible in this situation, please consult your Microsol contact.
6.6 Erasing an Application
Clicking on the appropriate Chip / Sector displayed under “Flash Devices” item and
clicking on the “Erase” removes the Chip / Sector inside the XCell Processor.
6.8 Calculating Chip CRC
Clicking on the appropriate Chip displayed under “Flash Devices” item and clicking
on the “Calculate CRC” calculates CRC for the Chip inside the XCell Processor.
6.9 Downloading Files
Clicking on the appropriate application displayed under “Files” item and clicking on
the “Download” placing the XCell RTU into download mode, and transfers the
binary data in its memory to the RTU. If the file being downloaded is being
Page 49 of 89
Workbench User Manual Version 2.2.0
downloaded to a region of RAM, then the file is downloaded without erasing the
memory first. If the file being downloaded is being downloaded to a region of FLASH
memory then XCell Flash Programmer will prompt you if you want to erase the
memory first. A dialog box is displayed that shows the download progress and any
errors that occur.
The RESET button resets the processor. If you don't hold in the Function Button on
the front panel of the XCell while the RTU is restarting it will exit BUG mode and it
will no longer be possible to communicate with the XCell using XCell Flash
Programmer.
Page 50 of 89
Workbench User Manual Version 2.2.0
7 Configuration Download
7.1 General
Configuration download is done using the RTU Live window. The RTU Live Window
is generally located on the left hand side of the display and selected by clicking on
the RTU Live tab as shown in Figure 7-1.
Comms Status
Figure 7-1 RTU Live Window
The RTU Live panel must be online and communicating with target XCell hardware
for any of the functions to operate.
To establish communications between Workbench and the XCell target the following
steps need to be carried out.
• Connect a serial cable between the Workbench PC and the diagnostic port on
the XCell unit (usually the top port). In any XCell system there may be many
processing units but it is only necessary to connect to one unit to retrieve data
from all units on the network.
Page 51 of 89
Workbench User Manual Version 2.2.0
Once the protocol has been selected, Workbench will automatically try to establish
communications with the target hardware. If it is successful then the communications
status at the bottom right of the Project work area (Figure 7-1) will indicate Good
Communications as shown in Figure 7-4. The relevant icon (host computer on the
left and RTU on the right) will briefly flash when the relevant unit is transmitting a
message. If it is unable to establish communications then it will indicate
Communications Failed as shown in Figure 7-4.
Page 52 of 89
Workbench User Manual Version 2.2.0
To download configuration data to the target XCell system, simply drag and drop the
required project element from the Project Hierarchy into the RTU Live window. This
action will automatically start the download of the required component(s). You can
drag and drop the entire RTU, a bay, a unit or simply an I/O table from one unit.
Note, The project must be saved before you can download it and the XCell
units MUST be online.
The Workbench Project can then be retrieved from either the Primary or Redundant
unit at any time using the Project-Upload menu option from the appropriate XCell
Unit Node Menu. Refer to section 8.3.3.1 for further details.
Page 53 of 89
Workbench User Manual Version 2.2.0
8 RTU Live
8.1 Introduction
The RTU Live panel provides a range of online diagnostic facilities as well as
configuration download/upload to the target hardware. The diagnostic facilities
include:
• Display Hardware Modules
• Memory Map
• Current I/O Status
• Online XCell units
• Flash File Contents
• Set Time
• Drive Outputs
• Simulate Inputs
• Display archived messages
• Configuration Download
• Configuration Upload
For all these facilities Workbench must be connected and communicating with the
target XCell system. For details on establishing communications with the target XCell
system refer to section 7.2. Once communications is established Workbench
automatically determines the structure of the target system. Once the structure of the
system has been determined a series of menu options are available by right clicking
on the main nodes within the RTU Live window. Many of the options are common to
several menus and will therefore only be detailed in one menu.
Comms Status
Figure 8-1 RTU Live Window
Page 54 of 89
Workbench User Manual Version 2.2.0
8.2.2.1 Upload
Note: Upload is only with the advanced Figure 8-3 –RTU Live - Project Menu
version of Workbench. Please consult your
Microsol contact for more information.
Upload – Displays a list detailing every unit that contains an archival copy of a
project, see Figure 8-4. The selected copy can be uploaded and opened in
Workbench and so viewed and modified if required.
8.2.2.2 Delete
Delete – Displays a list detailing every unit
that contains an archival copy of a project,
see Figure 8-5. The selected copy can be
deleted from the unit.
Page 55 of 89
Workbench User Manual Version 2.2.0
Page 56 of 89
Workbench User Manual Version 2.2.0
UIP - User Interface Protocol is used by the earlier version of XCell and will limit the
diagnostic functionality available.
UIP Version 2 – An upgraded version of the UIP protocol that supports additional
functionality and should be used where possible.
Remote Workbench… -
Note: Remote Workbench is only available
with the advanced version of Workbench.
Please consult your Microsol contact for
more information.
suspended using the Pause button and then a new time can be entered manually.
To set the XCell system time with that displayed, simply click on the Set RTU Time
button.
Page 57 of 89
Workbench User Manual Version 2.2.0
Page 58 of 89
Workbench User Manual Version 2.2.0
% Slidebar – Enter the value in percent (0-100%) or use slide bar to set the value.
Unipolar – Enter a positive value in mA or V. This must be between 0 and
(Maximum + Over Range) as defined below, e.g. 0 - 21 mA.
Bipolar – Enter ether positive or nagative value in mA or V. This must be between
+/- (Maximum + Over Range) as defined below, e.g.-20.5 to +20.5 mA.
Maximum – Nominal maximum value of the point/card in mA or V or etc. (e.g. 20
mA)
Over Range (%) – The over range supported on the card. (e.g. 5% )
The analog drive commands are always single stage commands initiated by the
Single Stage button.
Page 59 of 89
Workbench User Manual Version 2.2.0
8.3.1 Update
Selecting this option will force Workbench to interrogate
the particular Unit and update the RTU Live display. This
may be used if any hardware or software has changed or if Figure 8-18 - Unit-Menu
new configurations have been downloaded. A similar menu
is available from the RTU node that will update all units in the project.
Page 60 of 89
Workbench User Manual Version 2.2.0
8.3.2.3 IO Modules
Selecting IO Modules on the Information menu will result in an IO Modules node
being available under the particular Unit node in the RTU Live display. This shows
the I/O modules installed on the unit, refer to Figure 8-23. If the RTU Live window is
expanded it will show the module types and the hardware channel numbers
associated with each module.
Page 61 of 89
Workbench User Manual Version 2.2.0
8.3.2.4 Memory
Selecting Memory on the
Information menu will result in a
Memory node being available
under the particular Unit –
Hardware node in the RTU Live
display. This shows the memory
allocation on the unit, similar to that
shown in Figure 8-26.
This display shows the Memory
Figure 8-26 Memory Allocation
Type, Start Address, End Address
and Block Size
Page 62 of 89
Workbench User Manual Version 2.2.0
Double-clicking on any
message brings up the
Message Look-up dialog box
similar to that shown in Figure
8-30. This describes the
possible cause of the message
and actions that may be
required.
8.3.3.1 Upload
Note: Upload is only available with the advanced version of Workbench. Please
consult your Microsol contact for more information.
Page 63 of 89
Workbench User Manual Version 2.2.0
8.3.3.2 NB Downloader…
This option allows you to download new software modules (Named Blocks) to the
relevant processor thereby allowing 'on-line' updating of the processor software.
Page 64 of 89
Workbench User Manual Version 2.2.0
8.3.4.3 Debug
This option changes the Front Panel LED Matrix on the particular XCell unit to
display the Debug panel. The LED's reflect internal diagnostics of various processes
currently active in the unit. The interpretation of the LEDs will depend on the
software modules running on the unit.
In addition to viewing the current values of the physical I/O points, Workbench
provides the facility to view all software points or Tagged points within the project.
This includes points derived from the physical I/O such as Single Digital Inputs and
Double Digital Inputs but it also includes IED data points that are retrieved via Master
protocols. In order to show the current values of all the different tagged data in a cell,
the following steps should be taken:
1. Open a Workbench database which includes the required tagged
data;
2. Enable database change messages;
3. Request Full-update.
This will result in the Tagged data points from the current Workbench project being
available for viewing in the RTU Live window under their respective units and data
types as shown below.
Page 65 of 89
Workbench User Manual Version 2.2.0
Page 66 of 89
Workbench User Manual Version 2.2.0
In this section we will create a simple project and download it to a connected XCell
RTU. Although all of the interface functions will not be used for this tutorial many of
the most commonly used functions and point types will be included thereby giving
you a basis for creating more complex configurations when required. The process
that will be followed is:
• For this tutorial it is assumed that the PC and the XCell rack hardware
are already powered and connected together.
Page 67 of 89
Workbench User Manual Version 2.2.0
This section will create a blank new project named 'Workbench 1' based on a sample
profile (“IEC 60870-5-101 (Sample Profile)”), carry out the following steps to create
this blank project. (Please note that the sample profile with your installation of
Workbench may have a different name – see Profiles 5.2 ).
•
Figure 9-1 - Part 1 - 'Workbench 1' Blank Project
9.2 Create an RTU with one bay and one unit in the bay
At this stage we will create the Project Hierarchy before attempting to add any I/O
or protocols.
• Select the Elements tab in Elements/RTU Live and then the Project
tab
• Drag an RTU node into the Project Hierarchy panel and then drag a
Bay node onto the RTU node and a single Unit node onto the Bay node.
Page 68 of 89
Workbench User Manual Version 2.2.0
If you want to change the unit number double click on the value beside
the Unit node and enter the required address.
• In the Elements window select the Point tab and then from the Digital
sub-tab drag an SDI node onto unit 1 in the Project Hierarchy. When
prompted for the number of records to add, enter 8. Again from the
Digital sub-tab drag a DOT node onto unit 1 but this time just add 4
records.
• From the Analog sub-tab drag an AIN node and add 4 records.
• Select the Slave Protocols tab and then from the DNP 3.0 sub-tab drag
a DNP3 Gen node onto unit 1. From the same sub-tab drag a DNP3
Map node to unit 1 and select 6 records to add in the DNP Map. This will
result in a configuration diagram similar to that shown in Figure 9-3.
Figure 9-3 - Workbench 1 project with all I/O and protocol nodes defined
Page 69 of 89
Workbench User Manual Version 2.2.0
Figure 9-6 - Unit 1 SDI TAG and Description fields set using the Interpolate option
We will also assign the channel numbers 0-7 using the Interpolate function on the
Channel column but without the Prefix/Suffix option as shown in Figure 9-7.
Page 70 of 89
Workbench User Manual Version 2.2.0
We will assign all the ON Filter Time (ms) to 100 using the Set menu option as
shown in Figure 9-8 Similarly, we will assign the OFF Filter Time (ms) to 500.
Figure 9-7 - 'Set' options dialog Figure 9-8 - 'Set' value request box
SDI points 6 and 7 will be Inverted and Not Suppressed by clicking the relevant
field and selecting the required value from the associated Drop Down options.
The complete SDI configuration can be seen in Figure 9-9.
Page 71 of 89
Workbench User Manual Version 2.2.0
Page 72 of 89
Workbench User Manual Version 2.2.0
Figure 9-13 - The completed six entries in the DNP3 Map Table
Page 73 of 89
Workbench User Manual Version 2.2.0
Page 74 of 89
Workbench User Manual Version 2.2.0
In this tutorial we will create a simple IED template. The process that will be followed
is:
Page 75 of 89
Workbench User Manual Version 2.2.0
•
10.1 Start a New Project (Database 1)
This section will create a blank new project named ‘Database1', carry out the
following steps to create this blank project.
Page 76 of 89
Workbench User Manual Version 2.2.0
• In the Elements window select the Master Protocls tab and then from
the Modbus sub-tab drag an Modbus DI node onto IED in the Project
Hierarchy. When prompted for the number of records to add, enter 8.
Again from the Modbus sub-tab drag a Modbus DI node onto IED but
this time just add 4 records. And drag an Modbus AI node and add 4
records.
• Drag a Modbus Map node onto IED and select 3 records to add in the
Modbus Map. From the same sub-tab drag a Modbus RTU node to
IED and select 1 record to add. This will result in a configuration diagram
similar to that shown in Figure 10-3.
Page 77 of 89
Workbench User Manual Version 2.2.0
Figure 10-3 - Database 1 project with all I/O and protocol nodes defined
Page 78 of 89
Workbench User Manual Version 2.2.0
In this section we will create a simple project using IO Modules and Create the wiring
list for it. The process that will be followed is:
Bay 1
Cabinet 1 Cabinet 2
Rack 1 Rack 1
Rack 2 Rack 2
Page 79 of 89
Workbench User Manual Version 2.2.0
This section will create a blank new project named 'Workbench 1' based on a sample
profile (“IEC 60870-5-101 (Sample Profile)”), carry out the following steps to create
this blank project. (Please note that the sample profile with your installation of
Workbench may have a different name – see Profiles 5.2 ).
Page 80 of 89
Workbench User Manual Version 2.2.0
Page 81 of 89
Workbench User Manual Version 2.2.0
• Drag another MODULE node onto the Unit 1 and do the following
changes:
• Module - Type: HAO-03X
• Termination Block - Type: TAI-040
• Name – 1st: TAO1
• This should then give you the hierarchy shown in Figure 11-3.
Page 82 of 89
Workbench User Manual Version 2.2.0
• In the Elements window select the Point tab and then from the Digital
sub-tab drag an SDI node onto HDI-05X in the Project Hierarchy. When
prompted for the number of records to add, enter 8. Again from the
Digital sub-tab drag a DOT node onto unit 1 but this time just add 4
records.
• From the Analog sub-tab drag an AIN node onto HAI-03X and add 4
records. Again from the Analog sub-tab drag a AOT node onto HAO-
03X and add 4 records.
• The first channel number of each module is 0. So the first channel
number of SDI, DOT, AIN, AOT should be 0.
• This should then give you the hierarchy shown in Figure 11-4.
Figure 11-4 – Unit 1 with I/O Modules and some IO points defined
Page 83 of 89
Workbench User Manual Version 2.2.0
Page 84 of 89
Workbench User Manual Version 2.2.0
Page 85 of 89
Workbench User Manual Version 2.2.0
12 Glossary
Area This is the area of the screen within 'Workbench' that contains one
of the main operating functions, Elements, RTU Live, Project
Hierarchy, Data Window, Properties and Messages.
Bay This is a second level object in a 'Workbench' project. Each RTU
can contain a number of Bays and each Bay can contain several
Units up to the maximum of 254 Units per RTU.
Change Message A change in status or value that exceeds a reporting threshold and
is notified to all other XCell units.
eXpress Express is a graphical programming tool conforming to IEC61131
for the XCell product. eXpress applications may be run on any XCell
unit fitted with eXpress software.
Front Panel Display The arrangement of 64 green LED's on the front panel of an XCell
unit processor module.
I/O Point A single data point within the XCell RTU. I/O Points can be either
RAW (unprocessed by software, e.g. RAW_DI) or PROCESSED
(filtered by software, e.g. SDI), changes in an I/O point beyond
certain defined limits result in the generation of a Change
Message.
Project A 'Workbench' configuration for a single RTU that can contain up to
254 units.
RTU Remote Telemetry Unit, in the context of 'Workbench' this is the
highest level object in a 'Workbench' project, there can only be one
RTU in each project. It can contain a number of Bays and Units but
may NOT contain individual I/O points groups, protocols or eXpress
points.
Unit This is the lowest level structural element in a 'Workbench' project
and corresponds to an XCell processor module. Each unit has an
individual address.
Workspace This is the working area for the creation of configurations with the
Workbench program and comprises Elements, RTU Live, Project
Hierarchy, Data Window, Properties and Messages areas.
XCell The family of monitoring and control hardware and software
produced by Microsol.
Page 86 of 89
Workbench User Manual Version 2.2.0
In the event that problems with 'Workbench' cannot be solved with reference to this
Users Guide or the on line help; TECHNICAL SUPPORT is available from:
Email: support@microsol.ie
Web: http://www.microsol.com
To ensure that you obtain the best service please ensure that you include explicit
details of the problem. Also include the version of Workbench you are using, the
operating system used on the computer and the hardware and software structure of
the XCell system connected to Workbench.
Failure to include this information in your fault report may increase the time to
correct the problem.
Page 87 of 89
Workbench User Manual Version 2.2.0
TAG Descriptio Channe Mode Stages Pulse Enable Input Output Output Enable
n l Time Field Sense Sense Enable TAG
(mS)
DOT 0 Workbench 1 Steady One Stage Not On Off No
TAG Test DOT 0 0 State 0 Selected
Page 88 of 89
Workbench User Manual Version 2.2.0
TAG Description Channe Delta Filter Polarity Max Min mA High Low Alarm
l % % mA Limit Limit Deadban
mA mA d
DL Timeout APP Confirm App Retry App Umode Umode Class Event Size
Timeout Timeout Retry Assignment
Fragment Baud Rate RTS Key On RTS Key Off Parity DataLength StopBits
Message Time Time
Page 89 of 89