User Manual

ASID12000061, Rev. 8.3, May 16

 Chapter 1 - Introduction

The content of this manual has been carefully revised, however, the full compliance of its
content with the technical and functional characteristics of the product it is referred to
cannot be assured, as typing or other errors cannot be completely ruled out. The
information given is regularly reviewed and any necessary correction or additional
explanation will be included in future revisions of this document.
Due to continuous development, the content of this manual can be changed without
notice.
We appreciate any correction or improvement suggestion.

ii - User Manual, N. ASID12000061, Rev. 8.3, May 16

Manual Revisions

Revision Date Changes

2.0 2012-03-20 Vers ion corresponding to Automation Studio 2.6 or l a ter.

2.1 2012-07-02 Incl uded IDE language option description.
Vers ion corresponding to Automation Studio 2.6 Rev.1 or l ater.
2.2 2012-10-02 Incl uded the T4 Scri pting information.
Vers ion corresponding to Automation Studio 2.6 Rev.2 or l ater.
2.3 2012-10-04 Incl uded Device Templates information.
Incl uded i nformation about Event Records.
Vers ion corresponding to Automation Studio 2.6 Rev.2 or l ater.

2.4 2013-01-16 Incl uded Disable Wa rnings i nformation.

Vers ion corresponding to Automation Studio 2.6 Rev.3 or l ater.

2.5 2013-02-12 Incl uded Fault Reports information.

Vers ion corresponding to Automation Studio 2.6 Rev.3 or l ater.

2.6 2013-03-04 Cha nged Event Records information.

Vers ion corresponding to Automation Studio 2.6 Rev.3 or l ater.

2.7 2013-03-20 Revi ewed library references i nformation.

Vers ion corresponding to Automation Studio 2.6 Rev.3 or l ater.
2.8 2013-07-12 Revi ewed Online Mode chapter, a nd i ncluded Diagnostic Protocol i nformation.

3.0 2013-08-29 Vers ion corresponding to Automation Studio 2.6 Rev.4 or l ater.
7.0 2014-07-28 Vers ion corresponding to Automation Studio 3 or l a ter.
7.1 2015-02-26 Added additional information regarding device templates.
Added information regarding device i nteraction restrictions.
8.0 2015-04-10 Added information about the sys tem simulation feature.

8.1 2015-04-20 Added information about the user defined curves i n Operational Settings.
8.2 2015-04-20 Added information regarding revision backup files.
8.3 2015-05-22 Added additional information a bout device templates.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 iii

 Chapter 1 - Introduction

INDEX
1
1 INTRODUCTION ...................................................................................................................................................... 1-1
1.1 I NTRODUCTION .......................................................................................................................................................... 1-3
1.2 FEATURE O VERVIEW ................................................................................................................................................... 1-4
1.3 SCOPE AND AUDIENCE ................................................................................................................................................ 1-5
1.4 REFERENCES ............................................................................................................................................................... 1-6
1.5 SUPPORT CONTACTS................................................................................................................................................... 1-7
2 WINDOWING........................................................................................................................................................... 2-1
2.1 IDE MAIN W INDOW .................................................................................................................................................. 2-3
2.2 CONTENT W INDOWS.................................................................................................................................................. 2-4
2.3 PADS ......................................................................................................................................................................... 2-5
2.4 ARRANGING W INDOWS.............................................................................................................................................. 2-6
2.5 W ORKSPACES............................................................................................................................................................. 2-7
3 ADDIN S ..................................................................................................................................................................... 3-1
3.1 ADDINS...................................................................................................................................................................... 3-3
4 PROJECT SYSTEM.................................................................................................................................................... 4-1
4.1 SOLUTION .................................................................................................................................................................. 4-3
4.2 LIBRARY PROJECTS...................................................................................................................................................... 4-4
4.3 DEVICE PROJECT......................................................................................................................................................... 4-6
4.3.1 Adding New Devices ....................................................................................................................................... 4-6
4.3.2 Adding Existing Devices.................................................................................................................................. 4-7
4.3.3 Importing an Existing Device Configuration................................................................................................. 4-7
4.3.4 Via Copy-Paste ................................................................................................................................................ 4-7
5 GENERIC DEVICE MANAGEMEN T........................................................................................................................ 5-1
5.1 GENERIC DEVICE ........................................................................................................................................................ 5-3
5.2 CONFIGURATION SETTINGS ......................................................................................................................................... 5-4
5.3 O PERATIONAL SETTINGS ............................................................................................................................................. 5-5
5.3.1 Inverse Time Curves Viewer .......................................................................................................................... 5-7
5.3.2 User Defined Curves ....................................................................................................................................... 5-9
5.3.3 Distances Viewer .......................................................................................................................................... 5-11
5.3.4 XRIO Export ................................................................................................................................................... 5-13
5.4 EVENT RECORDS.......................................................................................................................................................5-15
5.5 DISTURBANCE RECORDS ...........................................................................................................................................5-18
5.6 SYSTEM LOG ............................................................................................................................................................5-23
5.7 FAULT REPORTS........................................................................................................................................................5-24
5.8 CONNECTIONS..........................................................................................................................................................5-25
5.9 DEVICE TOOLS ..........................................................................................................................................................5-26
5.10 DEVICE TEMPLATES ................................................................................................................................................5-27
5.10.1 Device Templates Locations ...................................................................................................................... 5-28
5.10.2 Import and Export templates .................................................................................................................... 5-29
5.10.3 Advanced Usage ......................................................................................................................................... 5-29
5.11 DEVICE I NTERACTION RESTRICTIONS .......................................................................................................................5-31
6 BUILD PROCESS....................................................................................................................................................... 6-1
6.1 BUILD PROCESS.......................................................................................................................................................... 6-3
6.2 VALIDATION RULES..................................................................................................................................................... 6-5
6.2.1 Disabling warnings.......................................................................................................................................... 6-5
7 SIMULATION MODE............................................................................................................................................... 7-1
7.1 SIMULATION MODE .................................................................................................................................................... 7-3

iv - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7.2 IDE I NTEGRATION.......................................................................................................................................................7-4
7.2.1 Main Menu ...................................................................................................................................................... 7-4
7.2.2 Simulation Explorer......................................................................................................................................... 7-5
7.2.3 Decluttering Pad.............................................................................................................................................. 7-6
7.2.4 Data List Pads .................................................................................................................................................. 7-7
7.2.5 Advanced Options........................................................................................................................................... 7-7
7.2.6 Events............................................................................................................................................................... 7-9
8 ONLINE MODE ......................................................................................................................................................... 8-1
8.1 O NLINE EXPLORER PAD...............................................................................................................................................8-3
8.2 O BJECTS EXPLORER.....................................................................................................................................................8-4
8.3 EVENTS ......................................................................................................................................................................8-7
8.4 CONNECTING USING IEC 61850 .................................................................................................................................8-8
8.4.1 Objects Explorer View .................................................................................................................................... 8-8
8.4.2 GOOSE and Report subscription..................................................................................................................8-11
8.4.3 Getting Files...................................................................................................................................................8-12
8.4.4 Mimics............................................................................................................................................................8-12
8.5 CONNECTING USING DIAGNOSTIC PROTOCOL ............................................................................................................ 8-13
8.5.1 Objects Explorer View ..................................................................................................................................8-13
8.5.2 Events.............................................................................................................................................................8-13
8.5.3 Automation....................................................................................................................................................8-13
8.5.4 Mimics............................................................................................................................................................8-14
9 SYSTEM MANAGEMEN T........................................................................................................................................ 9-1
9.1 SCAN NETWORK .........................................................................................................................................................9-3
9.2 SYSTEM CONTROL PANEL ............................................................................................................................................9-5
9.3 MULTIPLE DEVICE ACTIONS..........................................................................................................................................9-7
10 DATA RETRIEVAL SERVICE...................................................................................................................................10-1
10.1 DATA R ETRIEVAL SERVICE ...................................................................................................................................... 10-3
10.2 SCHEDULES ........................................................................................................................................................... 10-6
10.2.1 One Time Schedule.....................................................................................................................................10-6
10.2.2 Cyclic Schedule............................................................................................................................................10-6
10.2.3 Daily Schedule.............................................................................................................................................10-7
10.2.4 Weekly Schedule.........................................................................................................................................10-7
10.2.5 Monthly Schedule.......................................................................................................................................10-7
10.3 ACTIONS ............................................................................................................................................................... 10-9
10.3.1 Get Event Records ......................................................................................................................................10-9
10.3.2 Get Disturbance Records ...........................................................................................................................10-9
10.3.3 Get System Log............................................................................................................................................10-9
10.3.4 Get Fault Reports ..................................................................................................................................... 10-10
11 SERVER COMPONEN TS ........................................................................................................................................11-1
11.1 SERVER COMPONENTS ........................................................................................................................................... 11-3
11.2 BASIC SERVER MODULES ....................................................................................................................................... 11-4
11.2.1 RTDB Module ..............................................................................................................................................11-4
11.2.2 Logger Module ............................................................................................................................................11-5
11.2.3 Remoting Module .......................................................................................................................................11-5
11.3 DEVICE I NTERACTION............................................................................................................................................. 11-6
12 TEAM COLLABORATION ......................................................................................................................................12-1
12.1 TEAM COLLABORATION.......................................................................................................................................... 12-3
12.2 I NITIAL CONFIGURATION........................................................................................................................................ 12-4
12.3 SERVER EXPLORER ................................................................................................................................................. 12-5
12.4 PENDING CHANGES ............................................................................................................................................... 12-6
12.5 SOLUTION EXPLORER............................................................................................................................................. 12-7
12.6 REVISION CONTROL W ORKFLOW............................................................................................................................ 12-9
12.7 CONFLICTS .......................................................................................................................................................... 12-10
12.8 USAGE R ESTRICTIONS AND GUIDELINES................................................................................................................ 12-11

- User Manual, N. ASID12000061, Rev. 8.3, May 16 v

 Chapter 1 - Introduction

13 ANNEXES ................................................................................................................................................................ 13-1

13.1 IDE O PTIONS.........................................................................................................................................................13-3
13.2 GUI L ANGUAGE .....................................................................................................................................................13-4
1 13.3 USER SETTINGS ......................................................................................................................................................13-5
13.4 T4 SCRIPTING ........................................................................................................................................................13-6
13.4.1 Derivatives................................................................................................................................................... 13-7
13.4.2 Text Blocks .................................................................................................................................................. 13-7
13.4.3 Control Blocks ............................................................................................................................................. 13-7
13.4.4 Tools............................................................................................................................................................. 13-7
13.4.5 More Information....................................................................................................................................... 13-8
13.5 PATTERNS FOR FILTERING AND SEARCHING..............................................................................................................13-9
13.5.1 Regular Expressions.................................................................................................................................... 13-9
13.5.2 Wildcards...................................................................................................................................................13-10
13.6 FILE TYPES .......................................................................................................................................................... 13-11
13.7 SHORTCUTS ........................................................................................................................................................ 13-14
13.8 BACKUP FILES ..................................................................................................................................................... 13-16

vi - User Manual, N. ASID12000061, Rev. 8.3, May 16

LIST OF FIGURES

Figure 2.1 IDE main window ..........................................................................................................................................2-3

Figure 2.2 Arranging windows helper ..........................................................................................................................2-6
Figure 2.3 Workspace menu ..........................................................................................................................................2-7
Figure 2.4 Edit Workspaces window ............................................................................................................................2-7
Figure 3.1 AddIn Manager window ..............................................................................................................................3-3
Figure 4.1 Supported project types ..............................................................................................................................4-3
Figure 4.2 Library Project Structure..............................................................................................................................4-4
Figure 4.3 Add Library Reference..................................................................................................................................4-4
Figure 4.4 Library References overlay ..........................................................................................................................4-5
Figure 4.5 Library References contex t menu ..............................................................................................................4-5
Figure 4.6 Object Browser ..............................................................................................................................................4-5
Figure 4.7 Device Project Sample. ................................................................................................................................4-6
Figure 4.8 Add new device wizard ................................................................................................................................4-6
Figure 5.1 IED 500 Device Structure Sample...............................................................................................................5-3
Figure 5.2 “Show” menu from Device..........................................................................................................................5-3
Figure 5.3 Operational Settings window .....................................................................................................................5-5
Figure 5.4 Operational Settings window with Tagged Values and Preview ..........................................................5-6
Figure 5.5 The curves viewer from inverse and defined time .................................................................................5-7
Figure 5.6 User Defined Curves Wizard .......................................................................................................................5-9
Figure 5.7 Distances Viewer ........................................................................................................................................ 5-12
Figure 5.8 Export to XRIO context menu .................................................................................................................. 5-14
Figure 5.9 Event Records List View with Data Objects........................................................................................... 5-15
Figure 5.10 Event Records List View with Data Attributes .................................................................................... 5-16
Figure 5.11 Event Records Oscilloscope View ......................................................................................................... 5-17
Figure 5.12 Data Objects Tree filter........................................................................................................................... 5-17
Figure 5.13 Disturbance Records Window ............................................................................................................... 5-18
Figure 5.14 Context menu of the column headings of the calculations ............................................................. 5-21
Figure 5.15 Fault Report Window .............................................................................................................................. 5-24
Figure 5.16 New Device Template Wizard ............................................................................................................... 5-27
Figure 5.17 Team device templates path definition option .................................................................................. 5-28
Figure 5.18 New Device Wizard with System, User and Team templates .......................................................... 5-29
Figure 5.19 Example of template.x ml file................................................................................................................. 5-30
Figure 5.20 Generic device interactions restrictions configuration options ...................................................... 5-31
Figure 6.1 Disabled Warnings example........................................................................................................................6-5
Figure 6.2 Disabled Warnings editor example............................................................................................................6-6
Figure 7.1 System simulation.........................................................................................................................................7-3

- User Manual, N. ASID12000061, Rev. 8.3, May 16 vii

 Chapter 1 - Introduction

Figure 7.2 Typical simulation environment ................................................................................................................ 7-3

Figure 7.3 Simulation mode main menu ..................................................................................................................... 7-4

1 Figure 7.4 Simulation Explorer Pad .............................................................................................................................. 7-5

Figure 7.5 Example of Usage of the Decluttering Pad .............................................................................................. 7-6
Figure 7.6 Simulation Mode Context Menu ................................................................................................................ 7-6
Figure 7.7 Data List Pad .................................................................................................................................................. 7-7
Figure 7.8 Simulation Mode Options ........................................................................................................................... 7-8
Figure 8.1 Online Mode Toolbar ................................................................................................................................... 8-3
Figure 8.2 Context Menu of a logical device (IEC 61850) ......................................................................................... 8-4
Figure 8.3 Content Window of the Objects Explorer ................................................................................................ 8-5
Figure 8.4 Context menu of the column headings of the Variable List.................................................................. 8-6
Figure 8.5 Device Template ........................................................................................................................................... 8-8
Figure 8.6 Simplified Template of the Logical Device ............................................................................................... 8-8
Figure 8.7 Logical Device Template .............................................................................................................................. 8-9
Figure 8.8 Simplified Template of the Logical Node.................................................................................................. 8-9
Figure 8.9 IO Template .................................................................................................................................................8-11
Figure 8.10 IO Template of the Logical Node ...........................................................................................................8-11
Figure 8.11 Function Template ...................................................................................................................................8-11
Figure 8.12 Context menu of a GOOSE Control Block.............................................................................................8-12
Figure 8.13 Context menu of an object when connected using Diagnostic Protocol .......................................8-13
Figure 9.1 System Control Panel ................................................................................................................................... 9-6
Figure 10.1 Configure Data Retrieval Service ...........................................................................................................10-3
Figure 10.2 Install Data Retrieval Service..................................................................................................................10-4
Figure 10.3 Result of a “Get System Log” action of the Data Retrieval Service .................................................10-4
Figure 10.4 Event Viewer .............................................................................................................................................10-4
Figure 10.5 Command to access Data Retrieval Service Log in text log viewer .................................................10-5
Figure 11.1 Default server environment ...................................................................................................................11-3
Figure 11.2 Default server environment ...................................................................................................................11-6
Figure 12.1 Connect to Server .....................................................................................................................................12-4
Figure 12.2 Pending Changed Pad ..............................................................................................................................12-6
Figure 12.3 Solution Explorer Pad with revision control overlays ........................................................................12-8
Figure 12.4 Revision Control Workflow diagram .....................................................................................................12-9
Figure 12.5 Conflicts window ................................................................................................................................... 12-10
Figure 13.1 User settings folder ..................................................................................................................................13-5
Figure 13.2 User settings folder path.........................................................................................................................13-5
Figure 13.3 T4 Editor plugin installation. ..................................................................................................................13-8
Figure 13.4 VS 2012 with the T4 Editor. ....................................................................................................................13-8
13.5 Revision backup file visualizer ......................................................................................................................... 13-16
13.6 Revision backup files maximum number of history items configuration ................................................ 13-16

viii - User Manual, N. ASID12000061, Rev. 8.3, May 16

LIST OF TABLES

Table 5.1 Configuration Settings actions .....................................................................................................................5-4

Table 5.2 Operational Settings actions ........................................................................................................................5-5
Table 5.3 Operational Settings toolbar items .............................................................................................................5-6
Table 5.4 Viewer Options of time curves. ...................................................................................................................5-8
Table 5.5 Tooltip Information regarding the curve. ..................................................................................................5-8
Table 5.6 Types of lines used to represent curves .....................................................................................................5-9
Table 5.7 Options of user defined curve wizard. .................................................................................................... 5-10
Table 5.8 Viewer options of user defined curves.................................................................................................... 5-10
Table 5.9 Tooltip Information regarding the user defined curve. ........................................................................ 5-11
Table 5.10 Distances Options Viewer ........................................................................................................................ 5-12
Table 5.11 Tooltip Information regarding the distance ......................................................................................... 5-13
Table 5.12 Types of lines used to represent curves. .............................................................................................. 5-13
Table 5.13 Event Records actions .............................................................................................................................. 5-15
Table 5.14 Event Records Viewer Columns .............................................................................................................. 5-16
Table 5.15 Disturbance Records device actions ...................................................................................................... 5-18
Table 5.16 Signal representation in the Tree section............................................................................................. 5-19
Table 5.17 Disturbance Records toolbar items ....................................................................................................... 5-21
Table 5.18 Phasor Diagram actions ........................................................................................................................... 5-21
Table 5.19 Fields of the Calculation list .................................................................................................................... 5-22
Table 5.20 Properties of the cursor ........................................................................................................................... 5-22
Table 5.21 Multiple device actions ............................................................................................................................ 5-23
Table 5.22 Fault Reports device actions ................................................................................................................... 5-24
Table 5.23 Fault Reports actions ................................................................................................................................ 5-24
Table 5.24 Multiple device actions ............................................................................................................................ 5-25
Table 5.25 Device Tools commands .......................................................................................................................... 5-26
Table 5.26 Device template keywords validation rules ......................................................................................... 5-28
Table 5.27 Device template master file elements .................................................................................................. 5-30
Table 5.28 Generic device interactions restrictions ............................................................................................... 5-31
Table 6.1 Generic Actions...............................................................................................................................................6-3
Table 6.2 System-Wide validation rules.......................................................................................................................6-5
Table 6.3 Disable Warnings properties definition......................................................................................................6-5
Table 7.1 Simulation mode main menu items description.......................................................................................7-5
Table 7.2 Simulation Explorer Toolbar items descri ption.........................................................................................7-5
Table 7.3 Decluttering pad toolbar items description ..............................................................................................7-6
Table 7.4 Fields of the Data List pad.............................................................................................................................7-7
Table 7.5 Simulation Mode Options Description .......................................................................................................7-9

- User Manual, N. ASID12000061, Rev. 8.3, May 16 ix

 Chapter 1 - Introduction

Table 8.1 Toolbar commands on the Objects Explorer............................................................................................. 8-5

Table 8.2 Simplified representation of the Logical Node .......................................................................................8-10

1 Table 9.1 Fields of the scan network list ..................................................................................................................... 9-3

Table 9.2 Scan Network Ac tions ................................................................................................................................... 9-3
Table 9.3 Device Context Menu .................................................................................................................................... 9-4
Table 9.4 System Control Panel Actions ...................................................................................................................... 9-5
Table 9.5 Fields of the list on System Control Panel ................................................................................................. 9-6
Table 9.6 Icons of the System Control Panel .............................................................................................................. 9-6
Table 9.7 Multiple device actions ................................................................................................................................. 9-7
Table 10.1 One Time Schedule configuration ..........................................................................................................10-6
Table 10.2 Cyclic Schedule configuration..................................................................................................................10-6
Table 10.3 Daily Schedule configuration ...................................................................................................................10-7
Table 10.4 Weekly Schedule configuration...............................................................................................................10-7
Table 10.5 Monthly Schedule configuration.............................................................................................................10-8
Table 10.6 Get Event Records configuration ............................................................................................................10-9
Table 10.7 Get Disturbance Records configuration.................................................................................................10-9
Table 10.8 Get System Log configuration .................................................................................................................10-9
Table 10.9 Get Fault Report configuration ............................................................................................................ 10-10
Table 11.1 Basic Server Modules ................................................................................................................................11-4
Table 12.1 Revision Control menu..............................................................................................................................12-7
Table 13.1 Most used derivatives ...............................................................................................................................13-7
Table 13.2 Supported metacharacters for regular expressions ............................................................................13-9
Table 13.3 Supported metacharacters for wildcards ........................................................................................... 13-10
Table 13.4 Supported file type ................................................................................................................................ 13-13
Table 13.5 Supported shortcuts............................................................................................................................... 13-15

x - User Manual, N. ASID12000061, Rev. 8.3, May 16

 1
Chapter

INTRODUCTION
 Chapter 1 - Introduction

INDEX
1
1.1 I NTRODUCTION .......................................................................................................................................................... 1-3
1.2 FEATURE O VERVIEW ................................................................................................................................................... 1-4
1.3 SCOPE AND AUDIENCE ................................................................................................................................................ 1-5
1.4 REFERENCES ............................................................................................................................................................... 1-6
1.5 SUPPORT CONTACTS................................................................................................................................................... 1-7

Total pages of the chapter 7

1-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 1.1- Introduction

1.1 INTRODUCTION

In this document the most relevant features of the IDE are presented, namely feature overview, windowing,
management of IDE options, project system, device projects and device management. For device-specific
features check the corresponding guide.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 1-3

 Chapter 1 - Introduction

1.2 FEATURE OVERVIEW

1
Automation Studio is a user-interface software tool for configuring and managing protection, automation
and control devices and systems such as substation automation systems (SAS) or similar systems.
This tool features object oriented device configuration and management, relies heavily on an integrated
and configurable windowing environment, featuring systematic use of copy/paste, drag-and-drop and
context menus, allowing intuitive handling of definitions.

1-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 1.3- Scope and Audience

1.3 SCOPE AND AUDIENCE

This document is aimed to all users of Automation Studio version 2.6 or later.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 1-5

 Chapter 1 - Introduction

1.4 REFERENCES
1
[Ref.] Title Date Rev. Source Doc. Number

1. Automation Studio User Manual – IEC 61850

Latest EFACEC
and Third-Party Devices

1-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 1.5- Support Contacts

1.5 SUPPORT CONTACTS

When interacting with Efacec please refer your product serial number .

Contacts
Automation Studio Licensing E-mail: [email protected]
Automation Studio Customer Support E-mail: [email protected]
EFACEC Energia, Máquinas e Equipamentos
Eléctricos, SA.
Rua Engº Frederico Ulrich, Apt. 3078
4471-907, Moreira da Maia
General PORTUGAL
Tel: +351 229 402 000
Fax: +351 229 485 428
Web: www.efacec.com
E-mail: [email protected]

- User Manual, N. ASID12000061, Rev. 8.3, May 16 1-7

 2
Chapter

WINDOWING
 Chapter 2 - Windowing

INDEX
1
2.1 IDE MAIN W INDOW .................................................................................................................................................. 2-3
2.2 CONTENT W INDOWS.................................................................................................................................................. 2-4
2.3 PADS ......................................................................................................................................................................... 2-5
2.4 ARRANGING W INDOWS.............................................................................................................................................. 2-6
2.5 W ORKSPACES............................................................................................................................................................. 2-7

Total pages of the chapter 7

2-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 2.1- IDE Main Window

2.1 IDE MAIN WINDOW

The IDE main window contains a running instance of the whole Automation Studio application. When any
Automation Studio application starts within the Windows operating system, a completely independent
application instance starts running in its own IDE Main Window.
It is possible to have as many instances of the same Automation Studio application running at a given time.
However, some restrictions may apply to specific Automation Studio products, for example, if the user tries
to open and to edit the same Automation Studio proj ect or solution in two or more IDE Main Windows at
the same time.

Figure 2.1 IDE main window

The application menu, toolbar and status bar are mostly static and target the whole IDE, which means that
these offer access to features and feedback that are common to the whole product.
These operate as many other Windows application do, so nothing special here, it is quite intuitive.
What makes each product or plug-in specific and what provides the user with all of the features are the
content windows and pads. Many specific windows exist for specifics purposes but their handling shares
common mechanisms. Other content windows and pads, like the properties pad, output pad, text editor or
task manager, are commonly used for many purposes within most products.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 2-3

 Chapter 2 - Windowing

2.2 CONTENT WINDOWS

1
Content windows are the main views of the IDE, where most user interaction resides. These are most
commonly used to provide complex object/document/file viewers and editors (text editor, disturbance
records analyzer, mimics page editing, IEC 61131-3 programming, etc.).
Content windows can be placed anywhere within the main window surface bellow the IDE toolbar and
above the IDE status bar. Multiple content windows may be opened at the same time and can be arranged
by dragging their title to the desired position. In the screenshot above three content windows are shown,
two are visible and side-by-side (windows may actually be organized in any grid structure) and one is
stacked (hidden) bellow the active window.
The content of a given content window varies depending on its specific purpose but may contain any visual
elements such as trees, lists, grids, menus, status bars, buttons, design surfaces, etc.
If you double-click the tab of a content window, all pads automatically hide. Double click again to resume
previous state.

2-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 2.3- Pads

2.3 PADS

Pads are just small support windows that help the user while he is working on a given content window.
What is available or portrayed in a pad is usually dependent on the active content window and on what the
user is doing at a given moment.
Pads have more placement options:
 Docked: Pads may be docked to the bottom, top, left or right of the main window (content
windows always stay in the middle) and multiple pads may be visible at each of these four window
sides (side-by-side). A docked pad is always visible and occupies screen-space (see the Solution
Explorer pad above).
 Auto-hide: Docked pads may be placed in auto-hide mode. When in this mode the pads are usually
hidden (no space occupied but also not constantly visible) and are slided in by activating the pad
(clicking on its title) or when the application requires that it needs focusing. When the user
activates another window the pad is slided out of view.
 Floating: Pads can also be placed outside the main window (in its own tool window), floating above
the IDE main window.
 Closed: Pads can also be closed if not needed for a given user task.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 2-5

 Chapter 2 - Windowing

2.4 ARRANGING WINDOWS

1
 Moving Pads and Content Windows: To move a docked pad, floating pad or content window the
user just simply has to drag and drop its title area to the desired position. The window manager
will give very intuitive visual cues as to where the window will be placed when dropped

Figure 2.2 Arranging windows helper

 Docked/Floating: To switch docking mode of any pad the user has to double-click its title or simply
move its title to a position where it wil l become docked or floating.
 Resizing: Between the visible docked pads and content windows draggable splitters are placed that
allow relative resizing of window container areas.
 Stacking: To stack a content window or pad the user has to drag its title bar to the title bar of
another content window or pad with which he would like to stack it.
For stacked windows there is a very helpful activation menu (downward pointing arrow-tip shape)
in the title bar.
 Auto-hide: There is an auto-hide (pin-shaped) button on the right of any pad title bar.
 Close: There’s a close (X-shaped) button on any content window or pad title bar.
For windows the user has access to more sophisticated close operations by right-clicking on the
title bar.
 Open: Pads and content windows are opened by accessing specific commands throughout the IDE;
in case of pads the place to try is the View menu.
 View and Window Menus: Many helpful navigation helpers there.

2-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 2.5- Workspaces

2.5 WORKSPACES

Since all pads and windows can be reorganized, these organizations can also be stored for future reuse. This
will allow you to create a full set of workspaces that can easily adapt to your computing environment, role
or current task.

Figure 2.3 Workspace menu

By default a set of workspaces are already provided to you but you can also create as many new
workspaces as required.
To create a new workspace go to Windows > Workspace > Edit… and fill in the new workspace name and
select New.

Figure 2.4 Edit Workspaces window

After creating the workspace, the new workspace will be available to select on the menu shown in Error!
eference source not found.Select it and you can then start modifying the windows and pads layouts.All
modifications will be automatically stored.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 2-7

 3
Chapter

ADDINS
 Chapter 3 - Addins

INDEX
1
3.1 ADDINS...................................................................................................................................................................... 3-3

Total pages of the chapter 3

3-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 3.1- Addins

3.1 ADDINS

All Automation Studio release packages contain all necessary features for a particular application. But this is
an extensible tool and some specific product features may be released as product AddIns. This will add a set
of new features to a product edition such as new devices support or advanced productivity tools.
Note that, some AddIns are targeted to a specific set of editions, for example, device support addins will
only work in Engineer or Designer editions.

To access the AddIn Manager just open any edition of the Automation Studio and go to Tools -> AddIn
Manager in the Main Menu. Now you should be able to see the AddIn Manager window that allows you to
install, uninstall or simply enable or disable the addins.

Figure 3.1 AddIn Manager window

Note that the AddIns are not migrated between versions. If you install a new Automation Studio version you
will have to install all the necessary addins again.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 3-3

 4
Chapter

PROJECT SYSTEM
 Chapter 4 - Project System

INDEX
1
4.1 SOLUTION .................................................................................................................................................................. 4-3
4.2 LIBRARY PROJECTS...................................................................................................................................................... 4-4
4.3 DEVICE PROJECT......................................................................................................................................................... 4-6

Total pages of the chapter 7

4-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 4.1- Solution

4.1 SOLUTION

To start working with the Automation Studio it is necessary to create a solution. In a solution it is possible to
create new projects and/or add an existing project file.

Figure 4.1 Supported project types

Any project inside a solution can be removed or unloaded. The remove option does not delete the project
from the file system, just remove it from the solution.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 4-3

 Chapter 4 - Project System

4.2 LIBRARY PROJECTS

1
A Library project is a project kind where can be defined elements that can be later reused in other libraries
or in Devices added to the Device Project.
In a library it is possible to add
 data types, functions and functions block that later can be reused in the Automation Module of a
1
Device
2
 symbols and other images files that later can be reused in the Mimics Module of a Device
Note that, it is not necessary to define separate Library Projects for algorithms and symbols. The same
Library project can contain both elements and be referenced in different configuration modules.

Figure 4.2 Library Project Structure

Library projects can be validated and built in the Automation Studio. The output of the build action is a
Library file , alib. These library file can be reused in another Library Project or in a Device Project. In the
References folder, the user may add any library file.

Figure 4.3 Add Library Reference

1
See ‘Automation Studio User Manual - IEC 61131-3’ for more information about this.
2
See ‘Automation Studio User Manual - Mimic Editor’ for more information about this.

4-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 4.2- Library Projects

When you open a project if something went wrong with the available references an overlay will appear. The
warning overlay means that exists a version mismatch, in the example bellow, current System library has
version 1.1 but when reference was added to the references list the available version was 1.0.

Figure 4.4 Library References overlay

To update reference to the new version go the reference context menu and select the command ‘Reload
Reference’ or go to the ‘Change Reference Path’ command, by default the open file dialog will be opened in
the reference path. To accept the new reference version just click Ok, to rollback select the older one.

The error overlay appears when the reference path is not correct, the reference file does not exists in the
file system. In this case, to solve it just go to the command ‘Change Reference Path’ and fix the path.

Figure 4.5 Library References context menu

After adding a Reference to project, library file elements can be visualized in the Object Browser.

Figure 4.6 Object Browser

- User Manual, N. ASID12000061, Rev. 8.3, May 16 4-5

 Chapter 4 - Project System

4.3 DEVICE PROJECT

1
The main purpose of the Device project is to create and manage devices; therefore the next
sections will show the different ways to create Devices to a Device Project.

Figure 4.7 Device Project Sample.

4.3.1 ADDING NEW DEVICES

The usual way to add new devices to device projects is to do it based on existing device templates (packed
in the release version by the product team or even user-designed).
After selecting the option “New Device…” a wizard with all supported devic e models and templates will
popup.

Figure 4.8 Add new device wizard

To finalize the add operation, the user may be asked to supply several template or model specific
parameters. After pressing the “Finish” button a new device will appear in the Solution Explorer.

4-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 4.3- Device Project

4.3.2 ADDING EXISTING DEVICES

The user can also add a new device to a project by connecting to an existing online device. In this scenario
the user will have to choose the appropriate driver as well as c onnection-specific parameters, such as
device IP address. The IDE will try to connect to the physical device, and, if successful, a new device with
available/existing configuration parameters will be added to the current project.

4.3.3 IMPORTING AN EXISTING DEVICE CONFIGURATION

The user has the ability to export a device into a compressed package. This package can later be imported
to any Device Project in Automation Studio.
Note that in the Automation Studio IDE “Options…”, on the “Tools” menu, specific settings to configure
compression ratio and export filters are available, you can find this options in the category Device Project.

4.3.4 VIA COPY-PASTE

Devices can be included in the Device Project via copy-paste operation. The copy operation creates an exact
clone of the Device than can be pasted in any other Device Project (in the same or different Automation
Studio application instances).

- User Manual, N. ASID12000061, Rev. 8.3, May 16 4-7

 5
Chapter

GENERIC DEVICE MANAGEMENT

 Chapter 5 - Generic Device Management

INDEX
1
5.1 GENERIC DEVICE ........................................................................................................................................................ 5-3
5.2 CONFIGURATION SETTINGS ......................................................................................................................................... 5-4
5.3 O PERATIONAL SETTINGS ............................................................................................................................................. 5-5
5.4 EVENT RECORDS.......................................................................................................................................................5-15
5.5 DISTURBANCE RECORDS ...........................................................................................................................................5-18
5.6 SYSTEM LOG ............................................................................................................................................................5-23
5.7 FAULT REPORTS........................................................................................................................................................5-24
5.8 CONNECTIONS..........................................................................................................................................................5-25
5.9 DEVICE TOOLS ..........................................................................................................................................................5-26
5.10 DEVICE TEMPLATES ................................................................................................................................................5-27
5.11 DEVICE I NTERACTION RESTRICTIONS .......................................................................................................................5-31

Total pages of the chapter 31

5-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.1- Generic Device

5.1 GENERIC DEVICE

All devices are organized generically using the same structure. This will allow you to easily identify all similar
device configurations or information.

Figure 5.1 IED 500 Device Structure Sample

Depending on the device model type some of the previous elements may not be defined. For instance, an
UC 500 doesn’t support ‘Operational Settings’ section.
On the device context menu it is possible to select which elements from the device structure you want to
visualize in the Solution Explorer tree pad.

Figure 5.2 “Show” menu from Device

Most of the driver actions that will be displayed in the next sections can run simultaneously in the
Automation Studio. The user can follow those actions in the Task Manager pad and check for any errors
that may occur in the Output Window pad.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-3

 Chapter 5 - Generic Device Management

5.2 CONFIGURATION SETTINGS

1
Icon Text Description
Load/Unload Configuration Settings Set (or unset) configuration settings in edit mode.

Driver Actions

Deploy Configuration Settings Sends full or partial built configuration settings to device.

Get Configuration Settings Gets the configuration settings from the device.

Gets all possible settings from device. This is device

model dependant, and may include configuration
Get All
settings, operational settings, event records, disturbance
records, etc.

Deploys all possible settings into the device. This is device

model dependant, and may include configuration
Deploy All
settings, operational settings, event records, disturbance
records, etc.

Table 5.1 Configuration Settings actions

The configuration settings section is device model dependent. Therefore, to understand how to configure it
is necessary to read the device specific Automation Studio Manual.

5-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.3- Operational Settings

5.3 OPERATIONAL SETTINGS

Icon Text Description

Edit Operational Settings Open, if exists, the current operational settings file.

Command action that allows comparing current settings

Compare with...
file with another settings file.

Driver Actions

Deploy Operational Settings Deploys the operational settings to device.

Get Operational Settings Gets the operational settings from the device.

Change Active Group Changes the active groups(s) from the device.

Table 5.2 Operational Settings actions

If the device model that is being configured supports the Operational Settings module, when you build with
success its configuration in the Operational Settings section will be created the curren t settings file. The
Operational Settings viewer looks as follows:

Figure 5.3 Operational Settings window

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-5

 Chapter 5 - Generic Device Management

Icon Text Description

Properties Show Operational Settings database properties.
1 Validate Validate current settings.

Descriptions Show or hidden operational settings descriptions.

Comments Show or hidden operational settings comments.

Groups Show or hide groups from the operational settings.

Import Import settings from another file.

Compare Compare settings with another file.

Curves Show wizard to edit user defined curves.

Driver Actions

Deploy settings Deploy operational settings to the device.

Get Settings Get operational settings from the device.

Active Group Change active group settings from the device.

Table 5.3 Operational Settings toolbar items

Every object in the operational settings model is extensible; this means that the user can have multiple
combinations of key/value pairs. This mechanism can be used to include information that the user finds
important or to trigger a specific behavior in the compilers, for example in the export of the operational
settings to the XRIO format, these values are normally read-only.

Figure 5.4 Operational Settings window with Tagged Values and Preview

From version 2.6 Rev.4 of Automation Studio is possible to graphically visualize the inverse time curves,
time curves defined and distances.
The viewer is available in pad "Preview".

5-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.3- Operational Settings

5.3.1 INVERSE TIME CURVES VIEWER

The curves viewer from inverse and defined time allows estimating the time of action of protective
functions due to the fault current.
Only the following firmware functions will be considered:
 Maximum Current Phase Directional (PhaseOC);
 Maximum Current Directional Earth (EarthOC);
 Maximum Reverse Current Sequence Directional (NegSeqOC);

The curves viewer from inverse and defined time will present itself in the following way:

Figure 5.5 The curves viewer from inverse and defined time

The curves are updated automatically when you change the settings values.
For performance reasons, the resolution of dots is 0.05. If the user wants a lower resolution, you can
change it by choosing “Resolution” in the options window (Tools  Options...  Operational Settings
Resolution). The low resolution can affect the refresh timing whenever the viewer changes a setting value
of an definition.
Curves are always presented with the application of modifiers where they exist. The modifiers available are:
 Time Multiplier;
 Adding time constant;
 Maximum time;
 Minimum time;
 Inrush current;

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-7

 Chapter 5 - Generic Device Management

Icon Text Description

Show Track Info Allows you to activate the cursor to display the
1 coordinates of all points along the curve.

Show Operation Zone Activate the display area of operation for all stages
simultaneously.

Show Original Allows you to turn the curves without the application
of modifiers.

Show Axis X in Logarithmic Allows switching between decimal and logarithmic

scale for the axis X.

Show Axis Y in Logarithmic Allows switching entity and decimal logarithmic scale
for the axis of Y.
Optimize View Optimizes the view of the viewer.

Show current in primary values Allows you to switch the scale of values of current
between primary values and PU.

Show Information Display a tooltip with some information regarding the

curve.
Table 5.4 Viewer Options of time curves.

By default, when the user selects a stage of a particular group, the display shows the curve of the same
stage and group. If the user select a function or a general definition, the viewer shows all the curves of the
active stages (StxOperation = ON) of the selected group.
By clicking on the area of operation of a curve is possible to select the same. If there is a number of
overlapping areas, simply click several times on the same area for that selection go alternating between
curves.
Clicking with the right button on the area of operation is possible to open the tooltip with information
regarding the curve.

Icon Text Description

Operation Indication of the value of the Operation setting.

Device Device name.

Logical Device Logical device name.

Function Function name.

Group Number group.

Stage Number stage.

Color Color line of the curve.

Fill Operation color area.

Allows to pin / unpin the curve in the viewer. The curve

will keep visible in the viewer even when you change
Pin / UnPin the selection to another stage or group. Allows in an
easy way to compare curves of different groups /
stages.
Table 5.5 Tooltip Information regarding the curve.

5-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.3- Operational Settings

The type of line used to define the curves has different meanings, such as:

Line Text Description

Solid Used by curves whose definition StxOperation = ON.

Square Dot Used by curves whose definition StxOperation = OFF.

Dash As used in the curves without the application of the

modifiers.
Table 5.6 Types of lines used to represent curves

5.3.2 USER DEFINED CURVES

Operational Settings support inverse time curves editable by the user. These can be defined point by point
and may be between 6 and 25 points. The curves may be associated with settings (StxCurve) identically to
curves based on known formulas.
The user defined curves are only supported by some devices. To determine if the device supports the user
defined curves should perform update capabilities.
The user defined curves wizard looks as follows:

Figure 5.6 User Defined Curves Wizard

The curves are only available in operational settings after you finish the wizard. If you use the cancel button,
the changes will not take effect on the operational settings. You can use the cancel button to cancel any
changes, including changes in the templates.

The wizard toolbar commands are:

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-9

 Chapter 5 - Generic Device Management

Icon Text Description

Show Curves Values Allows you to show or hide the list of point of the
1 curves.
Show Curves Graph Allows you show or hide the viewer of the curves.

Add Curve Allows you to add a new curve or add a new curve
Add Curve Point point.

Move to top Brings selected curve to highest in the list.

Move up Brings selected curve one position up the list.

Move down Brings selected curve one position down the list.

Move to bottom Brings selected curve to lowest in the list.

Table 5.7 Options of user defined curve wizard.

The User Defined section represents the curves that can be used in operational settings. You can save these
curves as template to reuse in another operational setting. To do this, use the option “Save as template.”
In the Library section, you can find all templates of the curves. You can change the curves and points of the
templates. To restore the template use the option “Set as user defined curves” and the user defined curves
are replaced by the template. If you want restore only one curve of the template, use the copy/paste
operation on the curve.
The affected settings section indicates the settings that are using the selected curve.

The curves viewer, allows visualize the user defined curves.

Icon Text Description

Show Track Info Allows you to activate the cursor to display the
coordinates of all points along the curve.

Show Operation Zone Activate the display area of operation for all stages
simultaneously.
Show Original Allows you to show the defined points.

Show Axis X in Logarithmic Allows switching between decimal and logarithmic

scale for the axis X.

Show Axis Y in Logarithmic Allows switching entity and decimal logarithmic scale
for the axis of Y.
Optimize View Optimizes the view of the viewer.

Show current in primary values Allows you to switch the scale of values of current
between primary values and PU.

Show Information Display a tooltip with some information regarding the

curve.
Table 5.8 Viewer options of user defined curves.

The curves are updated automatically when you change the selection. If you select a curve, only shows the
selected curve. If you select a User Defined node, the viewer shows all the curves.

5-10 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.3- Operational Settings

By clicking on the area of operation of a curve is possible to select the same. If there is a number of
overlapping areas, simply click several times on the same area for that selection go alternating between
curves.
Clicking with the right button on the area of operation is possible to open the tooltip with information
regarding the curve.

Icon Text Description

Name Name of the curve.

Color Color line of the curve.

Fill Operation color area.

Allows to pin / unpin the curve in the viewer. The curve

Pin / UnPin will keep visible in the viewer even when you change
the selection to another curve. Allows in an easy way
to compare different curves.
Table 5.9 Tooltip Information regarding the user defined curve.

The curves are validated according to the following rules :

 The curve must have least 6 points and a maximum of 25 points ;
 The I(u) of points must be greater than 1;
 The t(s) of points must be equals or greater than 0;
 The minimum distance between two consecutive points (x coordinate) is 0.005 ;

5.3.3 DISTANCES VIEWER

The viewer distances only considered the function of firmware (Distance).

The distances viewer will present as below:

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-11

 Chapter 5 - Generic Device Management

Figure 5.7 Distances Viewer

1 Icon Text Description

Show Guide Lines Show the lines of support for the creation of the figure.

Optimize View Optimizes the view of the viewer

Show Information Display a tooltip with some information regarding the

figure.
Allows you to select the area that is selected when the
user clicks on a picture.
 Phase Phase + Phase Earth: Selects the
corresponding figures for Phase Phase and
Select Zone Phase Earth;
 Phase Phase: Just select the corresponding
figure for Phase Phase;
 Phase Earth: Just select the corresponding
figure for Phase Earth;
Table 5.10 Distances Options Viewer

By default, when the user selects an area of a particular group, the display shows the picture of the same
area and group. If the user select a function or a general definition, the viewer shows all the figures of the
active zones (StxOperation = ON) of the selected group.
By clicking on the area of the figure it is possible to select the same. If there is a number of overlapping
areas, simply click several times on the same area for that selection go alternating between the figures. This
selection will take into account the active option "Select Zone".
Clicking with the right mouse button on the area of operation is possible to open the tooltip with
information regarding the Zone / Group.

5-12 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.3- Operational Settings

Icon Text Description

Operation Indication of the value of the Operation setting.

Device Device name

Logical Device Logical device name.

Function Function name.

Group Number group.

Zone Number zone.

Indication of phase (Phase Phase or Phase Earth).
Phase If both phases are active in the "Select Zone", this field
will be hidden and the tooltip will concern both phases.
Color Figure color line

Fill Operation color area

Allow to pin / unpin the figure in the viewer. Figure will

Pin / UnPin keep visible in the viewer even when you change the
selection to another zone or group. Allows for an easy
way to compare different distances zones / groups.
Table 5.11 Tooltip Information regarding the distance

The type of line used to define the figures has different meanings, such as:

Line Text Description

Solid Used by figures whose definition StxOperation = ON.

Square Dot Used by figures whose definition StxOperation = OFF.

Dash Only used for the support lines.

Table 5.12 Types of lines used to represent curves.

5.3.4 XRIO E XPORT

Starting from the version 2.6 Rev.4 the Automation Studio supports the generation of the XRIO (eXtended
Relay Interface OMICRON) format. For the function of the device that supports this funtionality it is possible
to access it in the context menu, or using the main menu (File  Menu  Export  XRIO …) option.
The operational settings cannot contain any errors to use this feature.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-13

 Chapter 5 - Generic Device Management

Figure 5.8 Export to XRIO context menu

In the export is possible to choose the group to export, by default, the selected option is the Active Group
of the operational settings.
Please note that the generation of the XRIO format can depend on the right configuration of the device,
normally semantic extensions are created in the function to be consumed here.

5-14 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.4- Event Records

5.4 EVENT RECORDS

Icon Text Description

Merge all event records file from ‘Event Records’ folder
Merge All Local Event Records
into one file.

Merge into the selected event log another log chosen

Merge With...
by the user.

Merge selected event records in a new one, with a

Merge Selected
name chosen by the user.

Driver Actions

Get Event Records Get event records from device.

Delete Event Records Delete event records from device.

Tools Options

Merge Event Records Merge logs locally when getting event records.

Delete Merged Logs If true, merged logs will be deleted.

Table 5.13 Event Records actions

The event records viewer allows user to simply visualize changes on logged variables .
Events can be analysed in List and in Oscil loscope Views.
In List View is possible to show Data Objects or Data Attributes. This view can be grouped and filtered by
any field.

Figure 5.9 Event Records List View with Data Objects

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-15

 Chapter 5 - Generic Device Management

Figure 5.10 Event Records List View with Data Attributes

In the List View it is possible to sort information by any column and it is also possible to add or remove
columns from the viewer.

Name Description
Device Name of the device where the log entry occurred.

Entry Log entry numeric id.

Entry Time Data time of the log entry.

Reason Reason of the log entry

Name Name of the logged object.

Object Description Description of the Data Object.

Attribute Description Description of the Data Attribute.

Raw Value Value of the logged object.

3
Value Value displayed according to some event log definitions .

Title Title of the logged object.

Quality Quality of logged object.

Source Time Source time of the entry.

Units Units of the logged object.

Table 5.14 Event Records Viewer Columns

3
For instance, a digital entry will appear with value True or False in this column.

5-16 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.4- Event Records

In the Oscilloscope View it is possible to analyse the evolution of each variable in the time with a graphic
representation.

Figure 5.11 Event Records Oscilloscope View

In both views (List and Oscilloscope) is available a Tree that is used has a Data Objects filter for user to
chose what objects wants to analyse.

Figure 5.12 Data Objects Tree filter

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-17

 Chapter 5 - Generic Device Management

5.5 DISTURBANCE RECORDS

1
Icon Text Description
Driver Actions

Get Disturbance Records Get disturbance records from the device.

Delete Disturbance Records Delete disturbance records from device.

Table 5.15 Disturbance Records device actions

The Disturbance Records Analyser offers a high-resolution graphical interface for displaying, analyzing and
manipulating analog and digital channels of an oscillography record.

Tree
Chart
Chart
View
View
Properties

Phasor Diagram

alculations

Figure 5.13 Disturbance Records Window

The main window from a disturbance record analyzer is organized with different sections to easily find and
analyze all the relevant data from the disturbance record file.
In the tree it is possible see all the signals presented in the record file:

5-18 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.5- Disturbance Records

Icon Text Description

Element that represents a record.
You can find on property pad the following fields:
 Device: Identification number or name of the recording
device;
Record
 Line Frequency (Hz): Nominal line frequency in Hz;
 Station: Name of substation location;
 Time Reference: Time of the first data value in data file;
 Trigger: Time of trigger point;
Element that contains all analog signals.
Analog Signals
You can find on property pad the number of the analog signals.
Element that represent analog signal.
You can find on property pad the following fields:
 Name: Signal name;
 Adder: Adder for the signal;
 Multiplier: Multiplier for the signal;
 Circuit Component: Circuit component;
Analog Signal  Maximum: Maximum value;
 Minimum: Minimum value;
 Phase: Signal phase;
 Ratio: Signal ratio;
 Samples: Number of samples;
 Units: Unit of the signal;
 Values: P for Primary and S for Secondary;
Element that contains all digital signals.
Digital Signals
You can find on property pad the number of the digital signals.
Element that represent digital signal.
You can find on property pad the following fields:
 Name: Signal name;
Digital Signal  Circuit Component: Circuit component;
 Normal State: Normal state for the signal;
 Phase: Signal phase;
 Samples: Number of samples;
Table 5.16 Signal representation in the Tree section
The most relevant section is the Chart View. In the chart view are located all the signal charts and the
Phasor Diagram.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-19

 Chapter 5 - Generic Device Management

Icon Text Description

This view will group signal according to signal type and unit. For
1 Group View
example, two analog signals if have the same unit will be presented
in the same charts otherwise, two charts will be created.
All digital charts will be displayed after the analog charts
This view will present a chart for each signal.
Single View
All digital charts will be displayed after the analog charts.
Allows the user to create his own charts.
User View It's allowed to add signals with different units in same chart but it is
not possible to add digital signals on a chart that contains
analog signals and vice versa.
Optimize View Optimize View.

Center at Trigger Centers view at trigger.

RMS Shows signals according to the RMS values.

Primary Values Shows signals according to the primary values.

Secondary Values Shows signals according to the secondary values.

Show Phasor Diagram Show or hide phasors diagram.

Show a Phasor Diagram

for each cursor Show a Phasor Diagram for each cursor.

Show Marks Show or hide marks of the signals.

Snap to Marks Move the cursors by the marks of the signals.

Zoom Activates zoom tool.

Pan Activates pan tool.

Select Activates selection tool.

Calculations Show or hide grid with calculations.

Tree Show or hide tree with all nodes that represents signals.

Header File Show or hide header file.

Signal with changes If checked, shows only signals with changes on values. Otherwise
shows all signals.
4
Move to top Brings selected object (signal or chart) to highest in the list.

Move up Brings selected object (signal or chart) one position up the list.

Move down Brings selected object (signal or chart) one position down the list.

Move to bottom Brings selected object (signal or chart) to lowest in the list.

Create PDF file Creates a PDF file according to the definitions of the current view.

Save as Template Save the current settings as a template. This template will be
used by the Data Retrieval Service to create PDF reports.

4
Only available on user view.

5-20 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.5- Disturbance Records

Table 5.17 Disturbance Records toolbar items

To add a signal to one chart the user just simply has to drag&drop its signal to the desired chart. If the user
view is selected, it is possible to add multiple charts clicking "Create New Chart View" on context menu of
the signal on the tree.

The phasor diagram shows a vector for each visible analogue channel. The diagram is shown to the right of
the analogue chart. The vectors of the phasor diagram are updated when one of the red or blue cursor
moves. To increase the scale of the phasor diagram, move the splitter.

Icon Text Description

Show/Hide phasors of the blue cursor Show/Hide vectors that represents blue cursor.

Show/Hide phasors of the red cursor Show/Hide vectors that represents red cursor.

Reset Phasors Reset size of the vectors.

Increase Phasors Increase size of the vectors.

Decrease Phasors Decrease size of the vectors.

Table 5.18 Phasor Diagram actions

The calculations section contains a table with the values from the calculations of the red and the blue
cursor located in the chart view. The values of this section are updated whenever one of the cursor is
moved.
To change the precision of the calculations, open the Options on “TOOLS->Options” and select the node
“Disturbance Records Analyser” and change the property “Precision”.
It is possible to group and/or sort by any column calculations. To do this, use the context menu that appears
when you press right click on the column headings.

Figure 5.14 Context menu of the column headings of the calculations

Name Description
Cursor Cursor (Cursor 1 – Red; Cursor 2 - Blue)

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-21

 Chapter 5 - Generic Device Management

Name Description
Time (ms) Time in milliseconds relative to the trigger.
1 Signal ID Name of the signal.

Inst. Value Instantaneous value.

RMS RMS value.

Phasor Magnitude Magnitude of the phasor.

Phasor Angle Angle of the phasor.

Table 5.19 Fields of the Calculation list

When select the cursor, you can view the properties on Properties Pad.

Name Description
Cursor Cursor (Cursor 1 – Red; Cursor 2 - Blue)

Difference Cursors (ms) Difference between cursors in milliseconds.

Time (ms) Time in milliseconds relative to the trigger.

Table 5.20 Properties of the cursor

5-22 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.6- System Log

5.6 SYSTEM LOG

Icon Text Description

Driver Actions

Get System Log Gets system log from the device.

Table 5.21 Multiple device actions

The system log files generally are text files therefore can be viewed in the Automation Studio Text Editor.
Otherwisimse, it is possible to edit in an External Tool.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-23

 Chapter 5 - Generic Device Management

5.7 FAULT REPORTS

1
Icon Text Description
Driver Actions

Get Fault Reports Get fault reports from the device.

Delete Fault Reports Delete fault reports from device.

Table 5.22 Fault Reports device actions

The fault reports viewer allows user to simply visualize report of the faults.
The Fault Reports viewer looks as follows:

Figure 5.15 Fault Report Window

The viewer has the following actions :

Icon Text Description

Export to PDF Creates a PDF file according to the definitions of the current
view.
Print Print Fault Report.

Open Oscillographic List of references of Oscillographic Record existing in the fault

Record report.

Show/Hide columns Allows show / hide columns for the title and description.

Table 5.23 Fault Reports actions

5-24 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.8- Connections

5.8 CONNECTIONS

Icon Text Description

New Connection Add a new connection to the device.

Driver Actions

Cold Reset Resets device and restarts with default values.

Warm Reset Resets device and restarts with values (only persistent variables).

Restore Defaults Restores default configuration settings.

Restore Previous Configuration Restores previous configuration settings.

This action will update local configuration to match physical

Update Capabilities
device capabilities.

Update Firmware This action will update device firmware.

Table 5.24 Multiple device actions

It is possible to define multiple device connections in this section. So, it is very important to very before a
driver action takes place, if you have the right connection set as the ‘Default Connection’.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-25

 Chapter 5 - Generic Device Management

5.9 DEVICE TOOLS

1
Name Description
Compare With In this action it is possible to compare current device configuration with
 another device located in the same Solution
 device package
 online device configuration

Create Device Package Create a device package with the current device settings. In the tools
option it is possible to select which sections should be included in the
device package, such as, configuration, connection(s), output files and
others.

Create Device Template It is possible to create a device template based in the current device
configuration. After performing this action in the ‘Add New Device’ tree
will appear a section with User templates.

Update Capabilities It is possible to perform an Update Capabilities Offline by selecting a

Offline device form the empty device templates available.

Table 5.25 Device Tools commands

5-26 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.10- Device Templates

5.10 DEVICE TEMPLATES

Automation Studio includes a set of predefined device templ ates. They represent a base configuration that
can be used as a starting point for a new device configuration. These templates can be extended by the user
and shared with other users.

Figure 5.16 New Device Template Wizard

To create a device template, a device configuration must first be created. An action is available in the main
menu (DEVICE > Tools > Device Templates > Create Device Template…) to start the template creation
process.
A name for the template is automatically suggested and is possible to define a title and a description, in
several languages. A manual in pdf format can also be attached to the template. When creating a device
from a template all extra information about the template wil l appear, as well as an image of the device
model.
It is also possible to create a zip template by using the option "Package", the template is created as a file
with extension .adt, instead of a folder. User can also define the creation path of the template. If the
location is not the default the template is created as a package.
Automation Studio will identify a set of predefined configuration parameters that can be considered as
template configuration values 5. These parameters will be replaced by keywords that will have the current
values as default values. This information will be asked to the user when instantiating a template, allowing
to configure the new device with new parameters. All of these keywords can be associated, or not, with a
Validation Rule that will be used to ensure that a value selected for it will be within its allowed values.

5
Each device model will use create different keyword replacements. Check the corresponding user manual
for additional information.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-27

 Chapter 5 - Generic Device Management

6
Validation Rule Description
1 Device Name ^[A-Za-z0-9][A-Za-z0-9_ -]*$
Parameter must start with a letter or number and contain only letters, number,
underscores or hyphens in the remaining letters. The minimum length is 1
characters and the maximum length is 64 characters.

IEC 61850 Device Name ^[a-zA-Z]{1}[a-zA-Z0-9_]{0,63}$

Parameter must start with a letter and contain only letters, number, or
underscores in the remaining letters. The minimum length is 1 characters and
the maximum length is 64 characters.

File System Name ^[^\"\\/:*?<>|]+$

Parameter must not contain any of the following characters : ^ " . \ / : * ? < > |

GOOSE Application ID ^.{1,65}$

Parameter must have a minimum length of 1 characters and the maximum
length of 65 characters.

Table 5.26 Device template keywords validation rules

5.10.1 DEVICE TEMPLATES LOCATIONS

As stated previously, Automation Studio already includes a set of device templates. These are considered
System templates. There are two additional locations that can be configured with device templates.
Templates included in a specific user documents folder are called User templates and templates included in
an optionally configured folder are called Team templates.
User templates are located in “%USERPROFILE%\Documents\Automation Studio\Templates\Devices”. This
is the default location used to store user created templates. Team templates are located in a user specified
location in the IDE options, as depicted below. This can be a local path or a network share. It must,
however, must be a full path definition.

Figure 5.17 Team device templates path definition option

6
The validation rules are described using Regular Expressions. See 13.5.1 for additional information.

5-28 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.10- Device Templates

The folder structure inside these folders are also relevant. The first folder inside these folders must have a
specific device model name. To ensure that the correct name is used, it is recommended that the user firs t
create a device template using the integrated wizard. Under that folder, any folder names can be used. The
directory structure will be used to create a hierarchical organization on the New Device Wizard. By default,
Automation Studio will create a folder with the device firmware version and inside a folder with the device
name. The user can modify this structure however he sees fit.

Figure 5.18 New Device Wizard with System, User and Team templates

5.10.2 IMPORT AND EXPORT TEMPLATES

Templates packages can be imported and exported to/from Automation Studio. This actions are available in
the main menu (DEVICE > Tools > Device Templates).
Export action will create a file, with extension .adtp, that is a package containing all the device templates
selected by the user (from a list of available User templates).
In import action the user can select a single template (.adtp file) or a package of templates. Templates
selected will be imported to User default location or to Team location (if available) and if a template with
the same name already exists in the selected location new names will be suggested. After the import
process the imported templates will appear in new device creation wizard.

5.10.3 ADVANCED USAGE

Inside the template directory, a “template.xml” file exists. This file is what identifies that the folder
represents a template and it contains some options that can help to control the device template creation
even more. Do note that this is considered an internal file and any manual modifications must ensure the
correct validity of the file. Below you can find information on what can be modified within this file.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-29

 Chapter 5 - Generic Device Management

Figure 5.19 Example of template.xml file

XML Element Description

Filter Allow the user to exclude (or force inclusion) of specific files or folders when
processing the template for keyword replacement.
Allowed attributes:
 Type: Exclude | Include
 FilterExtension: a string that identifies which files should the filter apply
to based on their file extension
 FilterPath: a string that identifier a path that the filter should apply to.

Keyword Allows the user to define replacement values for a specific value. When the
template is being processed, the tool will search for all ${value of Id attribute}$
in all files that match the given filters and replace it be the value that will be
provided by the user.
Allowed attributes:
 Id: identifier of the keyword
 Title: user friendly name to be presented to the user
 Description: small description of the application domain of the keyword
 Type: type that will be used to parse the value
o String
o Bool
o Color
o Int
o Int32
o Double
o Float32
o IP
o DateTime
o Duration
 DefaultValue: default value that the keyword wi ll have
 ValidationRule: Regular expression that will be used to validate the
value

Table 5.27 Device template master file elements

5-30 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 5.11- Device Interaction Restrictions

5.11 DEVICE INTERACTION RESTRICTIONS

Several device interactions are, by default, conditioned to a match between the project information and the
live device information. This is done to ensure that the action is performed in the correct device. However,
in some situations, it may be required to disable these restrictions to allow the i nteraction with the device.
An example of such scenario is when a device configuration is duplicated, which includes all device
information. Additional restrictions are validated depending on the device model. Please check the
appropriate manual for more i nformation.

Restriction Description Applies to

Device Name Validates if the local device name matches the remote Deploy Configuration Settings
device name. If validation is active, it will provide
Get Configuration Settings
options to the user to continue with the action.
To overcome this mismatch, modify the local device
name. When performing the Get Configuration
Settings action with the validation disabled,
Automation Studio will update the local configuration
with the remote value.

Firmware Version Validates if the local firmware version matches the Deploy Configuration Settings
remote device name. If validation is active, it will
Deploy Operational Settings
generate an error, stopping the action. If false, it will
generate only a warning and continue with the action. Get Operational Settings
To overcome this mismatch, an Update Capabilities
must be performed.

Table 5.28 Generic device interactions restrictions

These restrictions can be activated/deactivated in the IDE Options, Device Project item.

Figure 5.20 Generic device interactions restrictions configuration options

- User Manual, N. ASID12000061, Rev. 8.3, May 16 5-31

 6
Chapter

BUILD PROCESS
 Chapter 6 - Build Process

INDEX
1
6.1 BUILD PROCESS.......................................................................................................................................................... 6-3
6.2 VALIDATION RULES..................................................................................................................................................... 6-5

Total pages of the chapter 6

6-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 6.1- Build Process

6.1 BUILD PROCESS

There are several actions that have general behaviour, independently of the type of object the user is
working on. Some of those actions wil l be described in this section.

Name Description
Disk Space Actions
Remove Backup Files The remove backup files action will delete all backup information
presented in the file system of the selected object.
Optimize Disk Space The optimize disk space action will delete all intermediate date presented
in the file system from the selected object, such as, output files, backup
information, build log files, etc.

Build Actions
7
Build The build command generates an output with all the needed files (files
that have no difference are not built). The result of an build action can
later be in other features.
Clean The clean command removes all the output that was generated by the
build command.
7
Rebuild The rebuild command performs a clean operation followed by a build. It
removes all the output and intermediate objects, and builds all the
objects again.
Validate The validate action validates the configuration of the selected object.

Table 6.1 Generic Actions

The result of all these actions will appear in category Output of the output window pad.
The Disk Space Actions run in the Automation Studio environment therefore the IDE will be blocked until
the action finishes. The Build Actions run in an external process called ASBuild and it is not possible to have
more than one external process compiler running at same time.
When one of these actions is performed in a Solution, the same action will be performed in all contained
Projects. Each project is responsible to perform the same action in all contained elements, such as devices.
Each device is responsible to perform the same action in all available modules, such as Automation Module
and Mimics Module. So, wherever the action starts, takes into account the solution explorer hierarchy,
therefore, it is very important to organize the projects and devices according to its in ternal relations and
references.
The Build Actions of Devices can be performed simultaneously, in a processor with multiple cores , an action
can be performed by each core. For example, if you have a processor 'Intel Core 2 Duo’ with two cores , it
will run two build actions simultaneously.
This will imply that the order of the error messages, warnings or information are affected, being included
the identifying "[Device Name]" before each message for disambiguation.
The option to build devices in simultaneously is enabled by default, but you can change it through option
"Build Simultaneously devices ". To access, click 'Tools' in the Automation Studio main toolbar and then click
on 'Options ...', select 'Designer Edition' and change option on 'Projects and Sol utions'.

7
Build action should be used while testing the configuration and the rebuild action should be done to
ensure consistency of data.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 6-3

 Chapter 6 - Build Process

If the previous option is disabled or if you just build one device it can allow to perform actions of build from
Efacec devices simultaneously. For example, you can create settings 61850, FTP, WatchDog, etc,
simultaneously. This option is also enabled by default, but you can change it through option “parallelize
1 building operations." To access, click 'Tools' in the Automation Studio main toolbar and then click on
'Options ...', select 'Efacec IED Series' and change option on 'Build'.
The Build Actions of Projects and Devices can be customized by modifying or creating a build.xml file. All
Devices contains a build.xml file that usually specifies the Build, Validate and Clean actions, but it is possible
to add Pre and Post-Build Steps. In device projects and library projects it is possible to specify Pre and Post-
Build steps too, creating a build.xml file near to the project file.
To see a full example of the build.xml configuration execute ASBuild process with option –h followed a path,
a build.xml file will be written in that path. To run the ASBuild outside of the Automation Studio it is
necessary to open a command prompt window located directory Bin from the installation directory and call
ASBuild.exe followed arguments.

6-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 6.2- Validation Rules

6.2 VALIDATION RULES

The Device project has a property named: ‘Enable System-Wide Validation’. If this property is set to true the
Validate action will perform a system-wide check of all relevant inter-device elements including IEC 61850
communications.

ID Validation Description
Errors
1007 Device Time Zone Device Time Zone does not match with element container.

1009 IP Address Start The start IP address must be less or equal to the end IP
address.
The end IP address must be greater or equal to the start IP
1010 IP Address End
address.
Warnings
1008 Device IP IP address is out of range

Table 6.2 System-Wide validation rules

6.2.1 DISABLING WARNINGS

Automation Studio has the ability to disable the output of warnings during the build and validation
processes, and in order to do this the user can either disable the output of all warnings, or disable only
some of the warnings.
All projects as well as devices have two properties which help accomplish this.

Properties Description

Disable All Warnings Setting this property to True means the output of all warnings will be
disabled.
Disabled Warnings A semi-colon separated list of warning IDs, which will not be output.

Table 6.3 Disable Warnings properties definition

In order to disable certain warnings you can use the editor to add a list of warning IDs or you can type them
by hand.

Figure 6.1 Disabled Warnings example

A warning ID is composed of the compiler ID together with the warning number (compiler ID + warning
number) this is normally a set of alphabetic characters followed by a number, for example, “MV3000”,
“SCLV1001”, etc. The editor allows you to easily add new warning IDs.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 6-5

 Chapter 6 - Build Process

Figure 6.2 Disabled Warnings editor example

Please note that when these warning IDs are applied to a device project all devices that are contained
within the project will also inherit these warning IDs.
This means that - during the build/validation process of each device - Automation Studio will disable the
output of the warning IDs defined in the project.
This saves the user from having to define the same warning IDs on each device.

6-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7
Chapter

SIMULATION MODE
 Chapter 7 - Simulation Mode

INDEX
1
7.1 SIMULATION MODE .................................................................................................................................................... 7-3
7.2 IDE I NTEGRATION ...................................................................................................................................................... 7-4

Total pages of the chapter 9

7-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7.1- Simulation mode

7.1 SIMULATION MODE

With simulation mode the user can test and debug it’s devices without having to deploy a configuration,
and validate that the device will behave has expected.
It is possible to simulate the whole device, or just parts of it like the Mimics and the Automation modules,
or even just parts of a module like for instance a Mimics page.
Starting in the Automation Studio 3.0 Rev. 1 [2015 Q2] it is possible to simulate more than one device at a
given time, for that a device project or a device container (Bay, Voltage Level, System or Folder) should be
selected. If the configuration contains GOOSE mappings between them then this communication will also
be emulated (not that the delay of the communication, or the failure of communica tion is not simulated), if
one end of the communication mapping changes then the other also changes.

Figure 7.1 System simulation

Please note that this feature can be a little slow if the number of devices or the size of the devices
configuration is high.

Figure 7.2 Typical simulation environment

- User Manual, N. ASID12000061, Rev. 8.3, May 16 7-3

 Chapter 7 - Simulation Mode

7.2 IDE INTEGRATION

1
7.2.1 MAIN MENU

Figure 7.3 Simulation mode main menu

In the main Automation Studio toolbar, under ‘Simulation’, the user has access to several options on how to
start, stop and reset the simulation and several pads, such as the decluttering pad, to better help him in the
simulation process.

Icon Text Description

Cold Start Starts the simulation with default values.

Starts the simulation with last execution values that where stored
Warm Start in the previous simulation.

Start Previous Starts the last successful simulation.

Cold Start Without

Same as Cold Start but without the automation module active.
Automation

Warm Start Without

Same as Warm Start but without the automation module active.
Automation

Cold Reset Resets device and restarts with default values.

Resets device and restarts with last execution values (only

Warm Reset persistent variables).

Stop Stops the simulation.

Windows

7-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7.2- IDE Integration

Simulation Explorer Activates the simulation explorer pad.

Data List 1 Activates the Data List 1 pad.

Data List 2 Activates the Data List 2 pad.

Decluttering Activates the Decluttering pad.

8
Administrative Console… Activates the Administrative Console.
Table 7.1 Simulation mode main menu items description

7.2.2 SIMULATION EXPLORER

The simulation explorer pad allows the user to quickly access all elements, such as mimics pages or
automation tasks, in the current simulation environment. It also allows the subscribing, if the module is
active, of record changes, by right clicking on ‘Data Objects’ and ‘Automation’ elements.

Figure 7.4 Simulation Explorer Pad

Icon Text Description

Same as in ‘Simulation mode context menu icons’ table 7.1 For

Stop Simulation
more information see,

For more information see table 7.1.Same as in ‘Simulation mode

Cold Reset
context menu icons’ table.

For more information see table 7.1.Same as in ‘Simulation mode

Warm Reset
context menu icons’ table.

Shows the changes of any subscribed data object and automation

Show Events
task.
Table 7.2 Simulation Explorer Toolbar items description

8
For more information, see Device Interaction (Server components) in this manual.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 7-5

 Chapter 7 - Simulation Mode

7.2.3 DECLUTTERING PAD

With the decluttering pad the users are able to view all of the page’s layers and decluttering animations.
1 This allows the user to debug any decluttering animations and any defined page limits; it also allows turning
on/off decluttering animations and controlling the visibility of page layers.

Figure 7.5 Example of Usage of the Decluttering Pad

Icon Text Description

If active, the layers and objects with decluttering animation in the

Auto mimic page will be or not visible according to the defined values
and the current zoom value.

If active, all layers and objects with decluttering in the mimic page
Show All
will be visible.

If active, all layers and objects with decluttering in the mimic page
Hide All
will not be visible.
Table 7.3 Decluttering pad toolbar items description

Figure 7.6 Simulation Mode Context Menu

7-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7.2- IDE Integration

7.2.4 DATA LIST PADS

Variable information can be listed in Data List 1 and Data List 2 pads.
Lines are colored according with variable quality:
 Invalid: Purple
 Reserved or Questionable: Green
 Variable doesn’t exist: Gray

Figure 7.7 Data List Pad

Name Description
Full Name Full name of the object.

Name Name of the object.

Variable Name Name of the variable.

Value Value of the object.

Quality Quality of the object.

Time Stamp Time Stamp of the object.

Description Description of the object.

Type Type of the object.

Type Code Type code of the object.

Table 7.4 Fields of the Data List pad

New lines can be added by drag and drop variables from the explorer pad or with command Add Line that
creates an empty line.
Fields Full Name, Name, Value and Quality can be changed by the user.

7.2.5 ADVANCED OPTIONS

There are several options that the user can change to better suit its needs.
To access the Simulation Mode options, click ‘Tools’ in the Automation Studio main toolbar and then click
on ‘Options…’, select ‘Simulation Mode’.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 7-7

 Chapter 7 - Simulation Mode

Figure 7.8 Simulation Mode Options

Option Notes
9
Alarms Module

Include Module Activate/ deactivate the alarms module in simulation.

Automation Module

Defines VM debugger level. Level 0 doesn’t display any trace messages.

Debug Level
The higher the level the more trace messages will be displayed.

Determine how the tasks cycle according to task priority: high, above
Task Cycle
normal, normal, below normal, low.

If set to true, when a value attribute is updated by the module, the time
Write Time Stamp
stamp is also updated.

Event Records

Auto Subscribe Changes If set to true, changes to subscribed variables are done automatically.

Include Module If set to true, the event records module is simulated.

Log to DB If set to true, event records are saved in database.

General

Debug Level Defines the server debugger level.

If set to true, will activate the debugger module when simulating the
Debugger Module
automation module.

If set to true, variable values will change automatically using random

Random Module
values.

User Interface

Will set a transparent background of a mimics page or symbol, in

Default Simulation Background
simulation, to a user defined color.

If set to false, the user will be asked to save any modified files before
Remember Save Decision
simulation starts.

9
This module is available only for testing purposes.

7-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 7.2- IDE Integration

Save Decision Last save decision chosen by the user before starting simulation.

If set to true, the time stamp attribute will be update when the user
Write Time Stamp
updates the status attribute.

Table 7.5 Simulation Mode Options Description

7.2.6 EVENTS

In Simulation Mode is possible to record variable changes, if option “Include Module” is enable when
starting simulation.
If option “Auto Subscribe Changes” is disabled, user needs to choose option “Record Events” in Data
Objects that wants to analyze. At any time can also Stop Recording Events.

Figure 7.8 Record Events menu

Events can be analyzed in Events View, already mentioned in chapter 5.4.

By dropping data objects from Solution Explorer to Events View, variable changes are automatically
subscribed. In Oscilloscope View drop also create a graphic.
When actions “Warm Start” and “Warm Reset” are executed, logs from previous simulation are preserved,
only if option “Log to DB” was enable on previous simulation.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 7-9

 8
Chapter

ONLINE MODE

One of the most useful features on Automation Studio is the ability to explore a device in more detail using
the Online Mode. In order to go to Online Mode select the device you wish to explore and press Go Online
button on the Solution Explorer toolbar at the top.
During the Online Mode the user is able to verify current values of data objects / data attributes and
therefore have a better idea of the current state of the device.
There are two protocols which the user can use to connect to a device: IEC 61850 and Diagnostic Protocol.
These protocols are only available on devices which support them.
 Chapter 8 - Online Mode

INDEX
1
8.1 O NLINE EXPLORER PAD .............................................................................................................................................. 8-3
8.2 O BJECTS EXPLORER .................................................................................................................................................... 8-4
8.3 EVENTS ...................................................................................................................................................................... 8-7
8.4 CONNECTING USING IEC 61850................................................................................................................................. 8-8
8.5 CONNECTING USING DIAGNOSTIC PROTOCOL.............................................................................................................8-13

Total pages of the chapter 14

8-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.1- Online Explorer Pad

8.1 ONLINE EXPLORER PAD

The toolbar of the Online Explorer – see figure below for more details - will allow the user to perform
actions like enabling or disabling the connection to a device, opening the Events viewer, showing or hiding
diagnostic objects and data attributes .

The user is also able to refresh all variables at a specified rate, by enabling the Auto refresh of values
feature, or polling.

Figure 8.1 Online Mode Toolbar

One useful feature is the ability to switch views during Online Mode. The user is able to switch from the
default tree-view which is similar to the Solution Explorer tree-view to a flat view, which contains all devices
without any structure under the same node (i.e. without folders, system, bay, etc). The user is also able to
switch to an online view, which contains only devices that are in fact online. This is useful to minimize any
search for the online device(s).
The available toolbar commands are:

Icon Text Description

Folder View Show devices in folder structure (as in Solution Explorer).

Flat View Show devices without folder structure.

Online View Show online devices within Project, System or Substation

structure.
Diagnostic Objects Show or hide diagnostic objects (or entities).

Data Attributes Show or hide data attributes.

Stop Stop Online Mode.

Enable Enables (or starts) a connection to the device.

Disable Disables a connection with the device.

Polling Auto-refresh values.

Events Show Events.

Properties Show properties of currently selected object.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-3

 Chapter 8 - Online Mode

8.2 OBJECTS EXPLORER

1
The Objects Explorer is a graphical representation of the device’s data model – on Efacec IEDs it will show
its’ Modules and Resources, for UC500 devices it will show the various Hierarchy Levels and Entities.
However, if a device is using an IEC 61850 connection, it will be structured according to its’ Logical Devices,
Logical Nodes and Data Objects .
Regardless of how the data model of a physical device is represented, it will always let the user visualize the
device’s status in real-time.
To access the Objects Explorer, right-click anywhere on the device node, a context menu similar to the
image below will show up. Choose "Open Objects Explorer".

Figure 8.2 Context Menu of a logical device (IEC 61850)

The Objects Explorer will open according to the current context. For instance, i f you select a specific
element of the data model – e.g. a Logical Node on IEC 61850 connections – you’ll notice that the Objects
Explorer will open with that element selected. The Tree View, Variable List and the View will have the
current context, saving the user time in navigating to the desired data.
It is also possible to open the Objects Explorer using the command "Open View", but in this case, the
Tree View and Variable List will be hidden by default. Please note, that this View is dependent on the
connection. Please read chapter 8.4.1 for more information on this view when connected using IEC 61850,
and read chapter 8.5.1 for more information on this view when connected using Diagnostic Protocol.

8-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.2- Objects Explorer

Tree
Variable List

View

Figure 8.3 Content Window of the Objects Explorer

The toolbar contains the following commands:

Icon Text Description

Tree View Show or hide tree view.

Diagnostic Objects Show or hide diagnostic objects (or entities).

Data Attributes Show or hide data attributes.

Variable List Show or hide variable list.

Show or hide view – dependent on actual connection (i.e. IEC
View
61850 or Diagnostic Protocol).
If checked, the variable list will change according to tree view
Auto selection. Otherwise, allows user to drag-drop objects from tree
view to variable list.

Pattern Allow to apply filters to the variable list according to the name of
the object.
Clear all objects from variable list.
Clear All
Only available if Auto option is not check.
Table 8.1 Toolbar commands on the Objects Explorer
The tree contains all devices online. When you select an element, the variable list will be filled with all
children elements. If the device is connected using the IEC 61850 protocol, the view will be updated with
the representation of the selected element. If the selected element is a data object, the logical node that
contains that data object will be presented.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-5

 Chapter 8 - Online Mode

In the Variable List the user can order, show or hide any column. In order to do this, use the context menu
when you right-click on the column headings.

Figure 8.4 Context menu of the column headings of the Variable List
The Variable List has the same behaviour as the Data List Pad. It is possible to simply drag and drop rows
from the Variable List into the Data List and vice versa.
The objects on both lists point to the same data source, even though the na me might be slightly different.

8-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.3- Events

8.3 EVENTS

When in Online Mode it is possible to view and record events as they are triggered, and they can be
analysed in Events View, as it is mentioned in chapter 0.
In order to record events, the option “Event Records Module” must be enabled before starting Online
Mode. The option can be found by navigating to the main menu Tools – Options and selecting Online.
If the device is connected using IEC 61850, it is possible to view and record GOOSE messages and Report
events. In order to do this, please read chapter 8.4.2 for more information.
It is also possible to view and record events if the device is connected using Diagnostic Protocol, please read
chapter 8.5 for more information.
When the Online Mode stops, all of the events occurred during an Online session can be saved in a file
location chosen by the user.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-7

 Chapter 8 - Online Mode

8.4 CONNECTING USING IEC 61850

1
For devices which support this protocol, once the connection is established, the IEC 61850 data model will
show under the device node. The IEC 61850 data model will allow you to explore the values of each data
object and help diagnose any issues.
The user will also be able to view any events which arrive by GOOSE or Reporting.

8.4.1 OBJECTS EXPLORER VIEW

The View section has a similar behaviour to a Mimics Simulation Window. Please read the Mimics Editor
manual to learn more about its functionalities, such as shortcuts.
This view will allow you to explore the device by function, help you determine the health and behaviour of
the device as well as each function. There are various views which depend on the type of object selected
(e.g. Device, Logical Device, Function and I/O) that will enable the user to do this .

Device Template
Template used for the representation of a device.

Figure 8.5 Device Template

Click to navigate to Logical Device

Write Value Execute

Control

Figure 8.6 Simplified Template of the Logical Device

Logical Device Template

Template used for the representation of a Logical Device.

8-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.4- Connecting using IEC 61850

Figure 8.7 Logical Device Template

Each Logical Device template is composed of many Logical Nodes and their corresponding templates.

Behaviour Local Operation

Mode Health

Simplified representation of the Logical

Node

Figure 8.8 Simplified Template of the Logical Node

The simplified representation of the Logical Node may be one of the following:

Simplified Template Description

Generic representation.

Alarm Handling (CALH).

Interlocking (CILO).

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-9

 Chapter 8 - Online Mode

Simplified Template Description

Switch Control (CSWI).
1

Circuit Breaker (XCBR).

Circuit Switch (XSWI).

Measurement (MMXU).

Table 8.2 Simplified representation of the Logical Node

IO Template
Template used for the representation of an I/O of the Logical Device.

8-10 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.4- Connecting using IEC 61850

Figure 8.9 IO Template

Behaviour

Mode

Health
Execute Control

Write Value

Figure 8.10 IO Template of the Logical Node

Function Template
Template used for the representation of a Logical Node.

Write Value
Execute Control

Figure 8.11 Function Template

8.4.2 GOOSE AND REPORT SUBSCRIPTION

In order to subscribe to GOOSE messages, you must have a device with at least one GOOSE control block
setup and you must add it to your project using the right connection configuration, i.e. IEC 61850
connection.
If you wish to learn more about GOOSE and Report messaging please refer to [1] manual, which will detail
why these messages are important and how to correctly configure a device for Online Mode.
Once you start Online Mode, you are able to subscribe to individual GOOSE or Report control blocks, or
subscribe to all available control blocks within a device, a Logical Device or a Logical Node.
In order to subscribe to GOOSE messages, simply navigate to where the GOOSE control block is located,
right-click on it and press the Subscribe command. This also applies to Report messaging, you simply find
the Report control block you wish to subscribe, right-click on it – you should see a context menu similar to
figure shown below - and press the Subscribe command.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-11

 Chapter 8 - Online Mode

Figure 8.12 Context menu of a GOOSE Control Block

8.4.3 GETTING FILES

During Online Mode and when connected using IEC 61850 protocol, you are also able to retrieve any files
from the device’s file system. Please note not all devices support this feature.
To make sure you are able to download any files from the device, the user is required to right-click on the
Files node and press Refresh. If any files are available, they will appear under the Files node as
soon as the refresh is complete.
In order to download these files you’ll need to right-click on the desired folder(s) or file(s) and press Get
Folder(s) or Get File(s). You are able to select any number of files or folders for download.
If you download a whole folder, you will download its entire file structure. For instance, if you press Get
Folder(s) on the Files node, you will download the entire file and folder structure visible under the Files
node.

8.4.4 MIMICS

If you go online with an Efacec device and it contains Mimics configuration, then Automation Studio will
automatically open the most appropriate Mimics page - similar to what happens duri ng Simulation mode -
and will update any and all IEC 61850 variables available in that page.

8-12 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 8.5- Connecting using Diagnostic Protocol

8.5 CONNECTING USING DIAGNOSTIC PROTOCOL

Only Efacec IEDs and UC500 devices support this protocol and in order to use this feature, the user must
first set the option “Use Diagnostic Module” which can be found on the main menu Tools – Options –
Online.
On the same location the user can also find some options which deal with how Automation Studio verifies
the connection with the device. If any of these options is set to True and the corresponding local and
remote values do not match, the Diagnostic Protocol connection will stop.
Please note that if the device also supports the IEC 61850 protocol described in chapter 8.4 the Diagnostic
Protocol connection will take precedence over it.

8.5.1 OBJECTS EXPLORER VIEW

The objects explorer View – when using Diagnostic Protocol connection - is only available on devices that
support Automation during Online Mode. This enables the user to open FBD programs and easily analyse
the current program.

8.5.2 EVENTS

In order to record events while using this feature, right-click anywhere on the device’s data model and press
the “Record Events” – a context menu similar to the one shown below should pop-up.

Figure 8.13 Context menu of an object when connected using Diagnostic Protocol
Please note that the “Record Events” command is context-sensitive, which means that if you right-click on
the whole of the data model, any and all objects for which an event is fired will be reported on the Events
view. On the other hand, if you right-click on a single object only events fired for that object will be
reported.

8.5.3 AUTOMATION

One of the advantages of the Diagnostic Protocol is the ability to diagnose the Automation configured by
the user.
In order to take full advantage of this feature, the user must ensure the properties “Online Mode” and
“Generate Symbol Table File” on the Automation module are set to True before building and deploying the
configuration.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 8-13

 Chapter 8 - Online Mode

During Online Mode the user can enable the Automation module and navigate the available tasks. The user
is able to open FBD programs in a separate view - as discussed previously - and check the values of the
current program.
1
8.5.4 MIMICS

Similar with what happens when connecting using IEC 61850 protocol, if you go online with an Efacec
device that has Mimics configuration, Automation Studio will automatically open the most appropriate
Mimics page. Any and all variables referenced on that page are automatically monitored to detect changes.

8-14 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 9
Chapter

SYSTEM MANAGEMENT
 Chapter 9 - System Management

INDEX
1
9.1 SCAN NETWORK ......................................................................................................................................................... 9-3
9.2 SYSTEM CONTROL PANEL ............................................................................................................................................ 9-5
9.3 MULTIPLE DEVICE ACTIONS ......................................................................................................................................... 9-7

Total pages of the chapter 7

9-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 9.1- Scan Network

9.1 SCAN NETWORK

The Scan Network allows the user to scan for available devices on the network. It essentially pings every IP
address in the specified range in search of a device. For each device found, it tries to identify the associated
driver for effective communications.
To access the scan network functionality, go to the main menu and click on “Networking” and then “Scan
Network”. The devices list is composed of the following fields:

Name Description
IP IP address.

Roundtrip Time (ms) Roundtrip Time in milliseconds.

MMS Server Indicates whether the MMS Server is available.

Name Name of the device.

Model Model of the device.

Firmware Version Firmware Version of the device.

Configuration Version Configuration Version of the device.

Manufacturer Manufacturer of the device.

Order Code Order code of the device.

Serial Number Serial Number of the device.

Table 9.1 Fields of the scan network list

On the toolbar, the user can find the following commands:

Icon Text Description

Start IP The start IP address must be less or equal to the end IP

address.

End IP The end IP address must be greater or equal to the start

IP address.
Start Scan Start scanning for available devices in network.

Stop scanning for new devices. However,

the identification of devices already detected will
Stop Scan continue. To stop the identification of these devices one
has to abort the task associated with the identification in
the Task Manager pad.
Clear Removes all devices found from the list.
Adds the selected device to a project.
Add To Project... The user will be asked the location to add devices and will
be asked to give a username and a password to access
the device.
If checked, it will only show devices with name, model,
Known Devices firmware version, configuration version, manufacturer,
order code or serial number.
Table 9.2 Scan Network Actions

- User Manual, N. ASID12000061, Rev. 8.3, May 16 9-3

 Chapter 9 - System Management

Each device on the list has a context menu with the following options:

Icon Text Description

1 Copy Copies device information to clipboard.

Clear All Removes all devices found from the list.

Information Panel Show/hide the information panel.

Adds the selected device to a project.

Add to Project... The user will be asked the location to add devices and will
be asked to give a username and a password to access
the device.

Tries to identify the selected devices with the available

Identify
drivers.

Web View... Opens the device’s web page view using its IP address.

Ping... Pings the device.

Telnet... Uses Telnet to access the device.

FTP... Opens the device using an FTP connection.

Remote Desktop... Uses Remote Desktop to connect to the device.

Table 9.3 Device Context Menu

9-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 9.2- System Control Panel

9.2 SYSTEM CONTROL PANEL

The System Control Panel allows the user to keep track of configuration differences between IEDs and
project.
It provides a quick visualization of the current state of all devices included in a project, indicating if all
devices are alive or if there is any inconsistency present.
There are two System Control Panel pads and to access them go to the main menu and click on
“Online” and then choose System Control Panel 1 or 2 in “Windows” sub-menu.
On the toolbar, the user can find the following commands:

Icon Text Description

Project Select the project which contains the devices to be

monitored.
Refresh Refresh devices for the selected project.

Start Monitoring Start monitoring all devices of the selected project.

Stop Monitoring Stop monitoring.

Status Filter list with the status.

Table 9.4 System Control Panel Actions

The list of the devices has the following fields:

Name Description
Full Name Full name of the device.

Local Name Local name of the device.

Remote Name Remote name of the device.

Local Model Local model of the device.

Remote Model Remote model of the device.

Local Firmware Version Local firmware version of the device.

Remote Firmware Version Remote firmware version of the device.

Local Configuration Version Local configuration version of the device.

Remote Configuration Version Remote configuration version of the device.

Local Manufacturer Local manufacturer of the device.

Remote Manufacturer Remote manufacturer of the device.

Local Order Code Local order code of the device.

Remote Order Code Remote order code of the device.

Alive Indicates if device is alive (True or False).

Status Indicates the state of the device.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 9-5

 Chapter 9 - System Management

Name Description
 Unidentified: If it cannot identify device;
1  Consistent: If local information equals remote information;
 Error: If local and remote information don’t match (i.e.
model, firmware version or order code);
 Warning: If local and remote name, configuration version
or manufacturer are not a match;

Table 9.5 Fields of the list on System Control Panel

For better detection of inconsistencies, the cells have different colours for states Error (red) and Warning
(yellow).
The cells of the fields "Model", "Firmware Version" and "Order Code" will be red and the cells of the fields
“Name”, “Configuration Version” and “Manufacturer” will be yellow if they have inconsistencies.
Similarly, the icon of the device also determines the state.

Icon Description

Indicates that the device is alive.

If the icon is in the upper left corner indicates that there are inconsistencies in the fields
"Model", "Firmware Version" and "Order Code".
If the icon is in the lower left corner indicates that it cannot identify the device.
Indicates that there are inconsistencies in the fields “Name”, “Configuration Version” and
“Manufacturer”.
Table 9.6 Icons of the System Control Panel

Figure 9.1 System Control Panel

9-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 9.3- Multiple device actions

9.3 MULTIPLE DEVICE ACTIONS

This section describes the actions that can be performed on multiple devices. The result of all these actions
will appear on the Driver category of the output window pad.

Icon Text Description

Sends full or partial built configuration settings
Deploy Configuration Settings
(including mimics) to device.

Get Configuration Settings Gets the configuration from the device.

Deploy Operational Settings Deploys the operational settings to device.

Get Operational Settings Gets the operational settings from the device.

Get Event Records Gets event records from device.

Delete Event Records Deletes event records from device.

Get Disturbance Records Gets disturbance records from the device.

Delete Disturbance Records Deletes disturbance records from device.

Cold Reset Resets device and restarts with default values.

Resets device and restarts with last execution val ues

Warm Reset
(only persistent variables).

Restore Defaults Restores default configuration settings.

Restore Previous Configuration Restores previous configuration settings.

Get System Log Gets system log from the device.

Gets all possible settings from device. This is device-

dependant, and on Efacec devices it can include
Get All
configuration settings, operational settings, event
records, disturbance records, etc.

Deploys all possible settings into the device. This is

Deploy All device-dependant, and on Efacec devices it can include
configuration settings and operational settings.

This is device-dependant, and on Efacec devices it can

Update Capabilities update things like schemas, firmware version, manifest
values, etc.

Table 9.7 Multiple device actions

The action is executed only if supported by the device.
These actions run as an external process. The user can follow the process in the Task Manager pad, and
check for any errors that may occur in the Output Window pad.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 9-7

 Chapter

10
DATA RETRIEVAL SERVICE
 Chapter 10 - Data Retrieval Service

INDEX
1
10.1 DATA R ETRIEVAL SERVICE .......................................................................................................................................10-3
10.2 SCHEDULES............................................................................................................................................................10-6
10.3 ACTIONS ................................................................................................................................................................10-9

Total pages of the chapter 10

10-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 10.1- Data Retrieval Service

10.1 DATA RETRIEVAL SERVICE

The Data Retrieval Service enables users to retrieve data from devices according to specific schedules and
actions. To configure this service follow the following steps:
 Start the Automation Studio Designer as Administrator. Some actions, like installing services,
require elevated permissions.
 Open or create, a project that contains all the devices that wish to monitor.
 To configure the service use the "Configure Service" button on the Data Retrieval Service pad.

Figure 10.1 Configure Data Retrieval Service

 On the "Configure Service" window:

o Select the project that contains the devices you wish to monitor
o Select the schedule.
o And select the action(s) you wish to perform
 When you select "Ok" or “Apply” the service will be ready to start with this new configuration.
 Before the first run you will need to install the service. Use the "Install Service" button.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 10-3

 Chapter 10 - Data Retrieval Service

Figure 10.2 Install Data Retrieval Service

This service will run all the selected actions for all the devices in the project using the stored user
passwords, in the schedule defined, storing all files that are retr ieved by each action in the device specific
folders. For example, if you have a UC 500 and configure an action to get the System Logs, it will be stored
in the System Log folder under the device folder.

Figure 10.3 Result of a “Get System Log” action of the Data Retrieval Service
Every time you want to reconfigure the service, should stop it, reconfigure it and start it again.
If you want to monitor the status of the service, you can use the System Event Viewer or the included text
log viewer.

Figure 10.4 Event Viewer

10-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 10.1- Data Retrieval Service

Figure 10.5 Command to access Data Retrieval Service Log in text log viewer
If you want to configure the service in a different or more specific way, you can also generate it's
configuration to a folder and manipulate the configuration by hand. This is a more advanced feature that
will allow personalizing, for example, the refresh cycle for each action independently or the locations were
the files are stored. You can also use this configuration in a specific Automation Studio Server to run these
actions without the Automation Studio Designer Edition installed.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 10-5

 Chapter 10 - Data Retrieval Service

10.2 SCHEDULES
1
The Data Retrieval Service can run multiple schedules simultaneously. To do this you must change the file
“scheduler.config”.

10.2.1 ONE T IME SCHEDULE

This schedule will only execute one time, on the date and time specified.

Property Description
Name Represents a unique scheduler identifier.
StartTime Represents the beginning date and time of the scheduler. If there is no property, will be
automatically started by default.
AttemptsNumber Represents the number of retries on errors.
Active Represents the state of the scheduler (True or False).

Table 10.1 One Time Schedule configuration

Example:
<OneTimeSchedule Name="OneTimeSchedule1" StartTime="27-05-2011 11:40:22" AttemptsNumber="3"
Active="True" />

10.2.2 CYCLIC SCHEDULE

This schedule will perform the configured actions cyclically

Property Description
Name Represents a unique scheduler identifier.
StartTime Represents the beginning date and time of the scheduler. If there is no property, will be
automatically started by default.
AttemptsNumber Represents the number of retries on errors.
Active Represents the state of the scheduler (True or False).
CyclePeriod Represents the period of the cycle:
Example:
1h30 – 1 hour and 30 minutes for cycle;
30m – 30 minutes for cycle;
30s – 30 seconds for cycle.

Table 10.2 Cyclic Schedule configuration

Example:

10-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 10.2- Schedules

<CyclicSchedule Name="CyclicSchedule1" StartTime="27-05-2011 11:40:22" AttemptsNumber="3"

Active="True" CyclePeriod="30m" />

10.2.3 DAILY SCHEDULE

This schedule will work daily.

Property Description
Name Represents a unique scheduler identifier.
StartTime Represents the beginning date and time of the scheduler. If there is no property, will be
automatically started by default.
AttemptsNumber Represents the number of retries on errors.
Active Represents the state of the scheduler (True or False).
RecurEvery Represents the recurrence frequency of days.

Table 10.3 Daily Schedule configuration

Example:
<DailySchedule Name="DailySchedule1" StartTime="27-05-2011 11:40:22" AttemptsNumber="3"
Active="True" RecurEvery="1" />

10.2.4 WEEKLY SCHEDULE

This schedule will work on the specified week days.

Property Description
Name Represents a unique scheduler identifier.
StartTime Represents the beginning date and time of the scheduler. If there is no property, will
be automatically started by default.
AttemptsNumber Represents the number of retries on errors.
Active Represents the state of the scheduler (True or False).
RecurEvery Represents the recurrence frequency of weeks.
WorkingWeekDays Represents the days of week where will work.
Example:
1 – Sunday; 2 – Monday; 3 – Tuesday; 4 – Wednesday; 5 – Thursday; 6 – Friday; 7 –
Saturday;

Table 10.4 Weekly Schedule configuration

Example:
<WeeklySchedule Name="WeeklySchedule1" StartTime="27-05-2011 11:40:22" AttemptsNumber="3"
Active="True" RecurEvery="1" WorkingWeekDays="1, 2, 3, 4, 5, 6, 7" />

10.2.5 MONTHLY SCHEDULE

This schedule will work on the specified days and months.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 10-7

 Chapter 10 - Data Retrieval Service

Property Description

1 Name Represents a unique scheduler identifier.

StartTime Represents the beginning date and time of the scheduler. If there is no property, will
be automatically started by default.
AttemptsNumber Represents the number of retries on errors.
Active Represents the state of the scheduler (True or False).
WorkingMonths Represents the months where will work.
WorkingMonthDays Represents the days of month where will work.

Table 10.5 Monthly Schedule configuration

Example:
<MonthlySchedule Name="MonthlySchedule1" StartTime="27-05-2011 11:40:22" AttemptsNumber="3"
Active="True" WorkingMonths="1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12" WorkingMonthDays="1, 2, 3, 4, 5, 6, 7, 8,
9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31" />

10-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 10.3- Actions

10.3 ACTIONS

Each schedule allows multiple actions. To define actions you must change the file “dataretrieval.config”.

10.3.1 GET E VENT RECORDS

This action gets the event records and stored in the specified destination folder.

Property Description
Path Represents the path of the device.
DestinationPath Represents the destination folder where event records are stored.
ScheduleName Represents the name of the scheduler where this action is executed.

Table 10.6 Get Event Records configuration

Example:
<GetEventRecords Path="UC 500\Device" DestinationPath="UC 500\Device\Events" ScheduleName="
CyclicSchedule1" />

10.3.2 GET DISTURBANCE RECORDS

This action gets the disturbance records and stored in the specified destination folder.

Property Description
Path Represents the path of the device.
DestinationPath Represents the destination folder where disturbance records are stored.
ScheduleName Represents the name of the scheduler where this action is executed.

Table 10.7 Get Disturbance Records configuration

Example:
<GetDisturbanceRecords Path="UC 500\Device" DestinationPath="UC 500\Device\Disturbances"
ScheduleName=" CyclicSchedule1" />

10.3.3 GET S YSTEM LOG

This action gets the system logs and stored in the specified destination folder.

Property Description
Path Represents the path of the device.
DestinationPath Represents the destination folder where system log is stored.
ScheduleName Represents the name of the scheduler where this action is executed.

Table 10.8 Get System Log configuration

- User Manual, N. ASID12000061, Rev. 8.3, May 16 10-9

 Chapter 10 - Data Retrieval Service

Example:

1 <GetSystemLog Path="UC 500\Device" DestinationPath="UC 500\Device\SystemLog" ScheduleName="

CyclicSchedule1" />

10.3.4 GET FAULT REPORTS

This action gets the fault reports and stored in the specified destination folder.

Property Description
Path Represents the path of the device.
DestinationPath Represents the destination folder where fault report is stored.
ScheduleName Represents the name of the scheduler where this action is executed.

Table 10.9 Get Fault Report configuration

Example:
<GetFaultReports Path="TPU 220\Device" DestinationPath="TPU 220\Device\Faults" ScheduleName="
CyclicSchedule1" />

10-10 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 Chapter

SERVER COMPONENTS
11
 Chapter 11 - Server Components

INDEX
1
11.1 SERVER COMPONENTS ...........................................................................................................................................11-3
11.2 BASIC SERVER MODULES ........................................................................................................................................11-4
11.3 DEVICE I NTERACTION .............................................................................................................................................11-6

Total pages of the chapter 6

11-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 11.1- Server Components

11.1 SERVER COMPONENTS

First of all it is possible to use the Automation Studio Server without having to install the Automation
Studio, there’s a specific installer that installs this component.
The Automation Studio Server is an executable file that runs a configuration based in XML files. The default
Server environment looks as follows:

Figure 11.1 Default server environment

The main module of the server configuration is the ‘server.config’ file. This file specifies all modules that are
configured. To configure a module in the this file it is necessary to specify the module Name, Assembly and
Class than, depending on the module type it is possible to specify other things, such as debug level,
configuration file, etc.
Server configuration example:

<Server Name="GEREC" Version="1.0">

<Modules>
<Module Name="RTDB" Assembly="Efacec.Server.RTDB.dll"
Class="Efacec.Server.RTDB.MemoryDatabaseModule" Debug="2" config="rtdb.config" />
<Module Name="Logger" Assembly="Efacec.Server.RTDB.dll"
Class="Efacec.Server.RTDB.Log.LoggerModule" config="log.config" />
<Module Name="Remoting" Assembly="Efacec.Server.RTDB.dll"
Class="Efacec.Server.RTDB.Remoting.RemotingModule" />
</Modules>
</Server>

- User Manual, N. ASID12000061, Rev. 8.3, May 16 11-3

 Chapter 11 - Server Components

11.2 BASIC SERVER MODULES

1
Module Description
RTDB The RTDB module is the module that configures the real time database of the
Server.
Logger The Logger Module is the module that registers the changes of variables state
and value.
Remoting The Remoting module is the module that enables the remote communication
with the Server.

Table 11.1 Basic Server Modules

11.2.1 RTDB MODULE

The RTDB Module definition in the ‘server.config’ file it is possi ble to specify the debug level (Debug=1), the
configuration file (config=”rtdb.config”). It is also possible to define if we want to keep a snapshot file from
the RTDB in Log directory specifying the snapshot file (snapshot=”rtdb.snap”), snapshot cycle in ms,
10 11
snapshot format and mode .
In the RTDB configuration it is possible to define:
 Enumeration Data Types

<EnumDefinition id="Dbpos" description="Double bit position indicator type." typeCode="UInt8">

<EnumLiteral id="0" description="Intermediate" value="0" />
<EnumLiteral id="1" description="Off" value="1" />
<EnumLiteral id="2" description="On" value="2" />
<EnumLiteral id="3" description="Bad" value="3" />
</EnumDefinition>

 Composite Data Types

<CompositeDefinition
 id="DPS" description="Double point status.">
<SimpleElement id="stVal" description="Status value of the data." fc="ST" tc="UInt8" t="Dbpos" />
<SimpleElement id="q" description="Quality of status data." fc="ST" tc="Quality" />
<SimpleElement id="t" description="Timestamp of the status data." fc="ST" tc="DateTime" />
</CompositeDefinition>

 Database

<Database>
<Container id="1" name="CTRL" description="CTRL" fc="C_LD">
<Container id="2" name="AGR" fc="C_FUN">
<CompositeVariable id="3" name="Pos" fc="DO_ST" t="DPS" init="q=Good;stVal=3" />
<CompositeVariable id="4" name="Agr" fc="DO_ST" t="SPS" init="q=Good;" />
</Container>
</Container>
</Database>

10
XML or Binary
11
All or Default, the default mode only snaps persistent variables.

11-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 11.2- Basic Server Modules

11.2.2 LOGGER MODULE

The Logger Module definition in the ‘log.config’ file it is possible to specify ‘OnEvent’, that if true the
variable change is register everytime the event of changing (state or value) is fired. It is also possible to
define “AutoAdd” that if true, variables are subscribed to changes automatically.

<Log Format="Access" Name="EventLog" />

<Log Format="Memory" Name="MemoryLog" />
<Logger Log="EventRecords" OnEvent="true" AutoAdd="true" />

11.2.3 REMOTING MODULE

By default, the remoting module establishes an IPC connection named like the server name (presented in
the ‘server.config’ file), but it is possible to establish other communications channels. Those communication
channels must be defined in the ‘remoting.config’ file.
Remoting configuration sample:

<configuration>
<system.runtime.remoting>
<application>
<channels>
<channel ref="tcp" port="8989" />
<channel ref="http" port="8880" />
</channels>
</application>
</system.runtime.remoting>
</configuration>

- User Manual, N. ASID12000061, Rev. 8.3, May 16 11-5

 Chapter 11 - Server Components

11.3 DEVICE INTERACTION

1
To interact with the Automation Studio Server it was developed an Administrative Console. With this
console it is possible to connect to an existing Automation Studio Server, using one of the configured
communication channels.
After connection establishment it is possible to restart/shutdown the Server, Get/View error log
information, get a list of running modules. Around the server real -time database it is possible to browse
server data model, read and write variables.
With the administrative console it is also possible to upload a new configuration to the running Automation
Studio Server or to restore the default Server configuration.

Figure 11.2 Default server environment

11-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 Chapter

12
12
TEAM COLLABORATION
 Chapter 12 - Team Collaboration

INDEX
1
12.1 TEAM COLLABORATION ..........................................................................................................................................12-3
12.2 I NITIAL CONFIGURATION.........................................................................................................................................12-4
12.3 SERVER EXPLORER..................................................................................................................................................12-5
12.4 PENDING CHANGES................................................................................................................................................12-6
12.5 SOLUTION EXPLORER..............................................................................................................................................12-7
12.6 REVISION CONTROL W ORKFLOW ............................................................................................................................12-9
12.7 CONFLICTS.......................................................................................................................................................... 12-10
12.8 USAGE R ESTRICTIONS AND GUIDELINES................................................................................................................ 12-11

Total pages of the chapter 11

12-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 12.1- Team Collaboration

12.1 TEAM COLLABORATION

Revision Control is a tool to manage files and directories over time. Files are stored in a central repository.
The repository is much like an ordinary file server, except that it remembers every change ever made to
your files and directories. This allows you to recover older versions of your files and examine the history of
how and when your data changed, and who changed it.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 12-3

 Chapter 12 - Team Collaboration

12.2 INITIAL CONFIGURATION

1
To start using Revision Control Automation Studio 2.6 or above is required. This feature is available when
you install Configuration Management AddIn.
To configure it you must first open Server Explorer Pad and connect to a server:

Figure 12.1 Connect to Server

Credentials are needed on the first access. Once you enter a valid user and password the login window will
not appear again. You can always change the User by selecting Change User in Server Explorer pad.
Once the connection to the server is established the server content is listed in a tree.
If you want to work on a content that is already in the server all you have to do is map the trunk or the
branch where that content is to a local workspace. The command Map to Local will get the server version to
your computer and this workspace will become under Revision Control.
If you want to map some content that only exists in your computer you need to copy the content to a
workspace under revision control. If you want to create a new and empty workspace you must first right-
click on the Server and press Add Server Project. Then select the trunk and use the command Map to Local
to create a local workspace.

12-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 12.3- Server Explorer

12.3 SERVER EXPLORER

All Server Projects are organized wi th the following structure:

Trunk: main line of development. You can map to local, get latest version (if the trunk is already
mapped to a local folder), create tag, create branch and download.

Tags: markers to highlight notable revisions in the history of the repository. You cannot modify
tags, only download or create branches.

Branches: a side-line of development created to make larger, experimental or disrupting work

without annoying users of the trunk version. Also, branches can be used to create development
lines for multiple versions of the same product, like having a place to backport bug fixes into a
stable release.
The command Add Server Project is available in the server, and it creates a clean project with the structure
described previously.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 12-5

 Chapter 12 - Team Collaboration

12.4 PENDING CHANGES

1
The Pending Changes pad lists all items that have local changes and those that are Not Versioned are
unchecked by default, all the others are checked.
In this pad you can select items you want to Check In or Undo the pending changes. You must add a
comment if you want to perform a Check In operation.

Figure 12.2 Pending Changed Pad

12-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 12.5- Solution Explorer

12.5 SOLUTION EXPLORER

Solution Explorer pad maintains the same structure, the only difference are additional overlays in items
under Revision Control.

 Without local changes.

 With local changes.

 Added locally and not present in the server.

Each item has a context menu with the following commands in the sub menu Revision Control:

Icon Text Description

Get Latest Revision Update local workspace with the actual server version.

Update local workspace with a specific version that can

Get Specific Revision
be selected by date, author, comment, etc.

Check In Pending Changes Commit local changes to server.

Undo Pending Changes Revert local changes.

After you create files/directories in your workspace

you need to add them to revision control too. Adding a
file/directory does not affect the repository, you must
first commit local changes from your workspace to
make those files/directories available to other
Add developers.
Revision Control can do the add operation
automatically. An Auto Add option is available in “Tools
– Options”. If this option is set to true all new items
created in your workspace are automati cally added.

Show Log Show history of all changes committed into server.

You may have files and folders that should not be

subject to revision control. If you use this option to
exclude those items they will not appear in Pending
Exclude
Changes list. Furthermore, if Auto Add option is set to
true these items will not be added. You can only
exclude unversioned items.

Excluded items can be placed under revision control

Include
using this menu option.

Table 12.1 Revision Control menu

- User Manual, N. ASID12000061, Rev. 8.3, May 16 12-7

 Chapter 12 - Team Collaboration

Figure 12.3 Solution Explorer Pad with revision control overlays

12-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 12.6- Revision Control Workflow

12.6 REVISION CONTROL WORKFLOW

The following diagram describes the Revision Control Workflow, and in general terms once we have a
workspace, the user is able to get the server revision of the project. Afterwards, the user is able to edit files
using Automation Studio or using an external tool. These changes can either be committed to the server or
discarded by the user.

Figure 12.4 Revision Control Workflow diagram

- User Manual, N. ASID12000061, Rev. 8.3, May 16 12-9

 Chapter 12 - Team Collaboration

12.7 CONFLICTS
1
Some conflicts may occur when checking in or getting versions.
In this case a window will appear with a list of the conflicted files. By selecting each file you can see its
history using the button Show Log.
You will then have to choose if you want the server version or the local version. If you choose Server, you
will lose your local changes. If you choose Local, when you check in your changes they will overwrite the
server version.

Figure 12.5 Conflicts window

12-10 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 12.8- Usage Restrictions and Guidelines

12.8 USAGE RESTRICTIONS AND GUIDELINES

To maintain an effective work environment some guidelines and restrictions should always be followed by
Revision Control users.
All operations must be executed using Automation Studio and never in Windows Explorer. Listed below is a
list of operations not recommended in files/folders in Windows Explorer that compromise the effectiveness
of Revision Control.
 Delete
 Rename
 Copy
 Move
 Drag/drop
Automation Studio doesn’t have a merge tool integrated in Revision Control, so, to avoid conflicts
impossible to solve without losing work some rules should be followed.
Different users must work in independent components, such as, Device Configuration, Automation Module
or Mimics Module. Other independent components are Pages and Symbol files, Functions, Function Blocks
and Programs body. In these independent components, check in, get latest, undo, and other operations can
be performed.
When changing device project or library project structure, such as, add, delete, move, rename of any
project element (System and Devices in the Device Project, and Functions and Variables in the Library
Project), the check in and undo operations must be performed in the Project node at the Solution Expl orer
tree or selecting all pending changes in Pending Changes Pad.
Those structure changes must be performed by one user only. The workflow should be:
 All users make check in of all pending changes
 User A, make all the project structure changes
 User A perform check In on the Project node
 All other users get latest revision
 Now, all users can perform changes in independent components.
If you want to copy a folder in Windows Explorer (for instance, if you want to give a zip file to someone else)
it is recommended to use the Export option available in Tortoise. Right-click on the folder and choose
“TortoiseSVN” and then “Export”. Check the option “Export unversioned files too”. This new folder will have
the same content as the original but without Revis ion Control files.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 12-11

 Chapter

ANNEXES 13
 Chapter 13 - Annexes

INDEX
1
13.1 IDE O PTIONS.........................................................................................................................................................13-3
13.2 GUI L ANGUAGE .....................................................................................................................................................13-4
13.3 USER SETTINGS ......................................................................................................................................................13-5
13.4 T4 SCRIPTING ........................................................................................................................................................13-6
13.5 PATTERNS FOR FILTERING AND SEARCHING..............................................................................................................13-9
13.6 FILE TYPES .......................................................................................................................................................... 13-11
13.7 SHORTCUTS ........................................................................................................................................................ 13-14

Total pages of the chapter 16

13-2 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.1- IDE Options

13.1 IDE OPTIONS

Each user has the possibility to customize some IDE options. They are kept between sessions and can be
restored to their default values at any time. Those options can be found on the Tools menu.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-3

 Chapter 13 - Annexes

13.2 GUI LANGUAGE

1
The language used to display all text for default in Automation Studio is English (en-US).
To change the language, click ‘Tools’ in the Automation Studio main toolbar and then click on ‘Options’
menu, select root node and change the option ‘GUI Language’ (only appears the available languages). Click
‘OK’ and restart Automation Studio. The language only change after restart Automation Studio.

13-4 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.3- User Settings

13.3 USER SETTINGS

These are the personal settings that the user has changed on Automation Studio, all is saved inside the
%AppData% of the current user. The user settings currently saved are,
 IDE Options (options.def);
 IDE Layout and Workspaces (Layouts Directory);
 Last solutions and files open (StarterProperties.xml);
 History of navigation in the IDE browser (StarterProperties.xml);
 Installed add-ins (Only valid for versions 2.5 and higher) (AddIns.xml);
o Do not try to migrate this file. AddIns must be reinstalled in every new minor/major
version.
 The variables added to the data list for online or simulation (simulationVarList.def).
 The external tools configuration (AutomationStudio-tools.xml)

Figure 13.1 User settings folder

When the user upgrades the version of Automation Studio it is possible to migrate almost all the personal
settings, by following the next procedure.
Before starting the user must be sure that all instances of Automation Studio are closed.

Figure 13.2 User settings folder path

Next, the user must open an instance of the Windows Explorer, type in the address bar the following
address, replacing the Edition and the Old Version values according to the previous version, then copy the
files in that folder, note that the migration can be made partially (copying only some settings). On Windows
Explorer, typing the same address as above but replacing the version with the new one. Paste the files
previously copied to the new folder and the migration is complete.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-5

 Chapter 13 - Annexes

13.4 T4 SCRIPTING
1
T4 (Text Template Transformation Toolkit) scripting is a mixture of text blocks and control logic that can
generate a target file. The control logic is written as fragments of program code in Visual C# or Visual Basic.
The generated file can be text of any kind, such as a UC500 xml model file, or a mimic page, or a ST program
source code.
This feature will enable the user to create dynamic behaviour in any device templates file, automation
object or automation template.

To define a specific language in each the file should be processed just enter the following line in the first
line of the text file, if none is specified then the file will be processed in C#.

Example:

<#@ template language="C#" #>

Date and time: <#

for(int i = 0; i < 2 ; i++)
{
WriteLine(DateTime.Now.ToString());
}
#>

On VB.NET,

<#@ template language="VB" #>

Date and time:<#

For i As Integer = 1 To 2
WriteLine(DateTime.Now.ToString())
Next
#>

Output:

Date and time:02-10-2012 16:12:55

02-10-2012 16:12:55

13-6 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.4- T4 Scripting

To explicitly define c# use:

<#@ template language="C#" #>

For VB.NET,

<#@ template language="VB" #>

T4 Text Templates consist of three parts , the derivatives, text blocks and controls blocks that are going to be
explained on the following entries.

13.4.1 DERIVATIVES

Directives control how the template is processed. They are represented by the prefix <#@.

Identifier Description Example

import directive enables

assembly <#@ assembly name="System.Core" #>
use of assembly

import using namespace <#@ import namespace="System.Collections.Generic" #>

directive for including

include other files (relative <#@ include file="uc500.tt" #>
path)

Table 13.1 Most used derivatives

13.4.2 TEXT BLOCKS

Text blocks which contain text that i s directly copied to the output, in the example the “Date and time:” is a
text block.

13.4.3 CONTROL BLOCKS

Control blocks – basically program code that controls the flow of the template or generates output text
using variables and function:
 Evaluation Control Blocks <#= myVariable #> which allow you to output variables
 Code Blocks <# var myVariable=”hello”; #> which allow you to write code
 Class Blocks <#+ void x(){} #> which allow you to define functions or inner classes

13.4.4 TOOLS

It is possible to write the T4 scripts on any text editor (Notepad++, WordPad,...), but for more advanced
support it is recommended the use of the Visual Studio 2010 or 2012 product with the T4 Editor extension.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-7

 Chapter 13 - Annexes

Figure 13.3 T4 Editor plugin installation.

Figure 13.4 VS 2012 with the T4 Editor.

13.4.5 MORE INFORMATION

In here the user can find other references that are helpful to understand and learn more advanced parts of
the T4 Text Template Engine.

 http://msdn.microsoft.com/en-us/library/bb126445
 http://www.olegsych.com/2007/12/text-template-transformation-toolkit/

13-8 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.5- Patterns for Filtering and Searching

13.5 PATTERNS FOR FILTERING AND SEARCHING

Patterns can be used in any search/filter box of the IDE, as well as in replacement features.

13.5.1 REGULAR EXPRESSIONS

Metacharacter Description
. Matches any single character except the newline character \n. To match any character
including the \n, use a pattern like [\s\S].
* Matches the previous character or sub-expression zero or more times [Maximal].
+ Matches the previous character or s ub-expression one or more times [Maximal].
@ Matches the previous character or sub-expression zero or more times [Minimal].
# Matches the previous character or sub-expression one or more times [Minimal].
^n Repeat n times.
[] Marks the start and end of a bracket expression.
[^...] Represents any character not in set.
^ Matches the position at the start of the searched string. If the Multiline property is set,
^ also matches the position following \n or \r.
$ Matches the position at the end of the sea rched string. If the Multiline property is set, $
also matches the position before \n or \r.
< Represents beginning of word.
> Represents end of word.
() Marks the start and end of a sub-expression. Sub-expressions can be saved for later use.
| Indicates a choice between two or more items.
\ Marks the next character as a special character, a literal, a back reference, or an octal
escape.
{} Marks the start and end of a quantifier expression.
nth Represents tagged text.
\(w,n) Represents right-justified field.
\(-w,n) Represents left-justified field.
~(X) Prevents match.
:a Represents an alphanumeric character.
:c Represents an alphabetic character.
:d Represents a decimal digit.
:h Represents an hexadecimal digit.
:i Represents an identifier.
:n Represents a rational number.

Table 13.2 Supported metacharacters for regular expressions

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-9

 Chapter 13 - Annexes

13.5.2 WILDCARDS

1 Metacharacter Description
? Represents any single character.
# Represents any single digit.
[!] Represents characters not in set.
* Represents one or more characters.
[] Represents a set of characters in the list. Exactly one character in the list is matched.
Within these brackets, you can use a hyphen (-) to specify a range.

Table 13.3 Supported metacharacters for wildcards

13-10 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.6- File Types

13.6 FILE TYPES

Extension File Type C O R I E Usage

Project Management
asln Automation Studio Solution x x x
Automation Studio Device
adprj x x x
Project
12 Automation Studio Library x x x
alprj Project
2
alib Automation Studio Library x x x Compiled library
addin Automation Studio Add In

Automation Studio Manifest x x x Device manifest, Library

manifest manifest
src General Purpose Source File x x Many

bak General Backup Purpose File x Many

rev.bak Revision Backup File x x
Mimics
2 Automation Studio Mimic x x x Mimics
asb Symbol
2
apg Automation Studio Mimic Page x x x Mimics
13
syn ScateX Synoptic Page x x Mimics (ScateX importer)
2 Scalable Vector Graphics File x x Generated for UC 500 HMI
svg Configuration
2 Compressed Scalable Vector Generated for UC 500 HMI
svgz x x
Graphics File Configuration
Device Management
Automation Studio Device
acn x x x
Connection
Automation Studio Device
adev x x
Package
Automation Studio Event x x
asoe Record
Automation Studio x x x
aosc Oscillographic Record
Automation Studio Load
aload x x
Diagram
Automation Studio Operational x x x
aset Settings
Microsoft Office Access x x x Managed UC 500 Configuration
mdb Database Database

12
Only available in Engineer and Designer Edition.
13
Only available in Designer Edition.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-11

 Chapter 13 - Annexes

Extension File Type C O R I E Usage

pfr UC 500 Print Form x x x UC 500 HMI Configuration

1 IEC 61131-3
Virtual Machine target-specific
bin Binary File x
binary
st IEC 61131-3 Structured Text File x x x Virtual Machine source file
IEC 61131-3 Function Block x x Virtual Machine source file
afb Diagram File
Virtual Machine pre-compiled
obj Object File x object code, compiled library
structure
IEC 61850
System Configuration Language
scl x IEC 61850 Configurator
Document
icd SCL IED Capability Description x IEC 61850 Configurator

cid SCL Configured IED Description x IEC 61850 Configurator

SCL System Configuration x IEC 61850 Configurator
scd Description
SCL System Specification x IEC 61850 Configurator
ssd Description
COMTRADE
zip Compressed Zip Document COMTRADE file import / export

COMTRADE Data File COMTRADE file analysis / import

dat / export

COMTRADE Header File COMTRADE file analysis / import

hdr / export
COMTRADE file analysis / import
cfg COMTRADE Configuration File x x x
/ export
inf COMTRADE Information File COMTRADE file import / export
Other
Virtual machine definition,
General Purpose Definition File x x x mimics application definition,
def disturbance record analyzer
options, SCL import options, …
txt Text Document x x General purpose

XML Document x x Build script, General purpose

xml configuration or data file
bmp
dib
gif
jpg
Image File x x Mimics Configuration
jpeg
tiff
tif
png

Comma Separated Values File x x x General purpose configuration

csv or data file

13-12 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.6- File Types

Extension File Type C O R I E Usage

Excel 97-2003 Workbook General purpose configuration

xls or data file
pdf Portable Document Format File Manuals
14
Table 13.4 Supported file type

14
C – Can be created within the IDE via the New command (or generated by tools or compilers). O – Can be
opened via the Open command (or by other specific means) for use, editing and/or viewing. R – Is
registered as an Automation Studio file and can be opened directly via Windows Explorer. I – Can be
imported. E – Can be exported.

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-13

 Chapter 13 - Annexes

13.7 SHORTCUTS
1
Shortcut Notes
File
CTRL+N New document
CTRL+SHIFT+N New project
CTRL+O Open
CTRL+S Save
CTRL+SHIFT+S Save all
CTRL+W Close
CTRL+P Print
ALT+F4 Exit
Build
CTRL+F6 Build solution
CTRL+F12 Validate solution
F6 Build selected application, folder, document
F12 Validate selected application, folder, document
Find and Replace
CTRL+F Find
F3 Find next
CTRL+F3 Find previous
CTRL+H Replace
View
CTRL+TAB Next window
CTRL+SHIFT+TAB Previous window
CTRL+SHIFT+E Show solution explorer
CTRL+SHIFT+Q Show output window
ALT+SHIFT+ENTER Full screen
F5 Refresh
Edit (General)
CTRL+Z Undo
CTRL+Y Redo
CTRL+C Copy
CTRL+V Paste
CTRL+X Cut
DEL Delete
CTRL+A Select all
CTRL+G Go To
CTRL+SHIFT+A Add
Edit (Text)
CTRL+E Comment selected lines

13-14 - User Manual, N. ASID12000061, Rev. 8.3, May 16

 13.7- Shortcuts

Shortcut Notes
CTRL+SHIFT+E Uncomment selected lines
CTRL+I Increase indent
CTRL+ SHIFT+I Decrease indent
CTRL+D Fill down
CTRL+U Fill up
Edit (Advanced)
CTRL+SHIFT+UP Move To Top
CTRL+UP Move Up
CTRL+DOWN Move Down
CTRL+SHIFT+DOW Move To Bottom
N
Others
CTRL+K Options
CTRL+F1 About
Pads
CTRL+SHIFT+E Solution Explorer
CTRL+SHIFT+P Property Pad
CTRL+SHIFT+Q Output Window
Table 13.5 Supported shortcuts

- User Manual, N. ASID12000061, Rev. 8.3, May 16 13-15

 Chapter 13 - Annexes

13.8 BACKUP FILES

1
Some core files are backed up automatically every time the file is modified. These backup files have the .bak
file extension. Generically, these are compressed files (zip) that can be opened and used to restore the
previous version of the file. Some however are revision backup files, which means that it contains more
than one version of the file. These files are identified by the extension .rev.bak and can be opened in
Automation Studio to allow restoring of a specific version.

13.5 Revision backup file visualizer

Once opened in Automation Studio, it is possible to select a version to restore it by double clicking on the
corresponding history line. To aid in the identification of modifications between versions, a comparison tool
is available. By selecting a single line, Automation Studio will compare the current file version (assuming
that a file with the same name, minus the .rev.bak extension exists in the same directory) with the selected
version. If two lines are selected, a comparison will be done between those versions.
This feature may have an impact on the overall performance of the tool due to the fact that several history
versions are maintained. If you identify that the performance is degrading, it is possible to limit the number
of versions that are kept in a single revision backup file by modifying the Max History Items, available in the
IDE Options.

13.6 Revision backup files maximum number of history items configuration

13-16 - User Manual, N. ASID12000061, Rev. 8.3, May 16