0% found this document useful (0 votes)
147 views

RSCADFX Quick Start Guide

This document provides a quick start guide for using RSCAD FX, highlighting several new features: - The interface is organized into resizable panels including utility tabs for the library, scratchpad, messages, and file manager. - New features include wire mode for drawing wires, auto-naming for automatically naming signals, and a quick access toolbar. - Appendices provide more details on the library, wire mode, auto-naming, converting legacy GSE cases to the new software, and keyboard shortcuts.

Uploaded by

Victor Castro
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
147 views

RSCADFX Quick Start Guide

This document provides a quick start guide for using RSCAD FX, highlighting several new features: - The interface is organized into resizable panels including utility tabs for the library, scratchpad, messages, and file manager. - New features include wire mode for drawing wires, auto-naming for automatically naming signals, and a quick access toolbar. - Appendices provide more details on the library, wire mode, auto-naming, converting legacy GSE cases to the new software, and keyboard shortcuts.

Uploaded by

Victor Castro
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 38

20190211

Quick Start Guide

PAGE 1 OF 38
RSCAD FX Quick Start Guide

TABLE OF CONTENTS
1. Introduction........................................................................................................................................... 4
2. New Layout Overview ........................................................................................................................... 4
3. Utility Tabs............................................................................................................................................. 8
3.1. Library............................................................................................................................................ 8
3.2. Scratchpad ..................................................................................................................................... 8
3.3. Messages and Compile Messages ................................................................................................. 8
3.4. File Manager .................................................................................................................................. 9
4. New Features ........................................................................................................................................ 9
4.1. Wire Mode..................................................................................................................................... 9
4.2. Auto-Naming ................................................................................................................................. 9
4.3. Quick Access Toolbar..................................................................................................................... 9
4.4. Case Comparison Tool ................................................................................................................. 10
4.5. RSCAD FX Conversion Utility ....................................................................................................... 11
4.6. Shortcuts ..................................................................................................................................... 12
5. Toolbars ............................................................................................................................................... 12
6. Consolidated Settings .......................................................................................................................... 12
7. Other Notes ......................................................................................................................................... 13
7.1. Runtime, T-line and Cable Modules ............................................................................................ 13
7.2. SLD View ...................................................................................................................................... 13
7.3. Component Builder (CBuilder) .................................................................................................... 13
7.4. SCD Editor .................................................................................................................................... 14
7.5. GTNET GSE Support ..................................................................................................................... 14
7.6. Compiled Hierarchy Boxes .......................................................................................................... 15
Appendix A: Library Details ............................................................................................................................. 16
1. Introduction......................................................................................................................................... 16
2. Navigation Panel ................................................................................................................................. 17
3. Component Panel ................................................................................................................................ 17
4. Search .................................................................................................................................................. 18
5. Component Filtering............................................................................................................................ 20
6. User Library ......................................................................................................................................... 20
7. Component Category By Colour .......................................................................................................... 21
Appendix B: Wire Mode .................................................................................................................................. 22

2
RSCAD FX Quick Start Guide

1. Initiating Wire Mode ........................................................................................................................... 22


2. Drawing a Wire .................................................................................................................................... 22
3. Exiting wire mode ................................................................................................................................ 23
Appendix C: Auto-Naming ............................................................................................................................... 24
1. Introduction......................................................................................................................................... 24
2. Using the Enumerator Inside a Component ........................................................................................ 25
3. Enumerator Options ............................................................................................................................ 26
3.1. Enabled/Disabled (A) ................................................................................................................... 27
3.2. Enumeration Value (B) ................................................................................................................ 27
3.3. Enumeration Type (C).................................................................................................................. 27
3.4. Reset (D) ...................................................................................................................................... 27
3.5. Enumeration String (E) ................................................................................................................ 28
3.6. Flatten Signal Names (F) .............................................................................................................. 28
3.7. Context Menu.............................................................................................................................. 28
3.8. Reset Auto-Naming from Library ................................................................................................ 29
3.9. Illustrative exercises .................................................................................................................... 30
Appendix D: GSE Converter ............................................................................................................................. 33
1. Introduction......................................................................................................................................... 33
2. The GSE Converter Input and Output Files ......................................................................................... 33
3. Cases with Legacy GTNET-GSE Components to RSCAD FX .................................................................. 34
4. Comparison of Original and Converted Draft Files with GSEv7 .......................................................... 34
4.1. IP Address ........................................................................................................................................ 35
4.2. Quality Variables ............................................................................................................................. 35
4.3. Control XCBR and CSWI Positions ................................................................................................... 35
Appendix E: Shortcuts ..................................................................................................................................... 38

3
RSCAD FX Quick Start Guide

1. INTRODUCTION
This document is intended to give the user an overview of the most significant features of
RSCAD FX. There are a lot of changes made to the RSCAD software suite with the latest
redesign. Detailed information about some of the new features is reserved for the
appendices that follow.

2. NEW LAYOUT OVERVIEW


When opening RSCAD FX for the first time, you will notice that the software is organized into
panels that can be resized and moved. Each panel can contain tabs and each tab can have a
different function. There are two types of tabs -- (1) Case Tabs and (2) Utility Tabs (as
identified in Figure 1). Case tabs contain the circuits that will ultimately be simulated. The
utility tabs offer functionality that allows users to build and analyze their cases. A utility tab
can share a panel with other utility tabs. Similarly, case tabs can share a panel with other
case tabs. Utility tabs and case tabs cannot be mixed in a single panel.
The default layout for RSCAD FX is shown in Figure 1 and has three (3) panels. An ‘Untitled’
case tab is found on the top-right panel; this is where users will build their simulation cases.
On the bottom, the Messages tab and Compile Messages tab are located; this is where
general messages related to building and compiling cases will be output. On the left side,
some other utility tabs, such as the Library and Scratchpad are found.

4
RSCAD FX Quick Start Guide

Figure 1: The layout of RSCAD FX is centered around configurable panels that can contain
several tabs.

Individual tabs or entire panels can be undocked from the main window. A tab can be
undocked by dragging it outside the window or by right-clicking on it and selecting ‘Undock’.
It can be re-docked by dragging the tab back into the main window; the location where the
tab or panel will be placed will be indicated with a light green or a light blue box. Figure 2
shows the above-described indicator.

5
RSCAD FX Quick Start Guide

Figure 2: Colored Indicator showing where a panel or tab will be placed

An entire panel and all the tabs it contains can be undocked by pressing the undock button,
. To re-dock a panel in the main window, it can be dragged back into the blank space
right of the main window as shown in Figure 3. the space to the right of any tabs it contains
can be clicked on and dragged back into the main window. Figure 3 highlights the area that
needs to be clicked on and dragged in order to move an entire panel.
If you want to dock a single tab in an existing panel, drag that tab and drop it on a tab already
in the target panel or in the space to the tabs' right in that panel.

6
RSCAD FX Quick Start Guide

Figure 3: Repositioning an entire panel

Any panel can be minimized to the bottom of the window by pressing the Minimize Panel
button, . Minimizing unused panels results in the other panels taking up its area and can
give more screen space to the tabs that are currently being used. Restoring a minimized tab
can be done simply by clicking on one of the minimized buttons at the bottom of the screen
as shown in Figure 4.

Figure 4: Minimized Tabs are found at the Bottom left of the Main Screen

7
RSCAD FX Quick Start Guide

3. UTILITY TABS
Below is a brief description of the available utility tabs in RSCAD FX. More details can be
found in the appendices.

3.1. LIBRARY
The library in RSCAD FX has a tree to help users navigate through the library. Components
are currently represented by new library icons with a uniform size and appearance.
Components are easily placed in a case by dragging them from the library. Improved search
functionality and a new filtering feature make it easier for users to find the components they
need.
Please refer to Appendix A for additional details.

3.2. SCRATCHPAD
The scratchpad looks and behaves very similar to a Draft canvas. The scratchpad provides an
area for users to quickly place some components if they want to temporarily remove them
from a case. It can also be used as a storage place for groups of components that the user
would like to reuse in the future.
There is a toolbar at the top of the tab, as well as shortcuts that can be used in the
scratchpad. Several scratchpad pages can exist simultaneously, and the user can navigate
between them using a drop down menu. Note: Each page should be saved before switching
to a different page.
A user can import a library file from a previous version of RSCAD into RSCAD FX as a
scratchpad page; the “Import Page” toolbar button is used to do this.

3.3. MESSAGES AND COMPILE MESSAGES


The Messages Tab shows informational messages, warnings, and errors that arise while using
RSCAD FX. Once written to the Messages tab, the information persists until the user clears
it. Each category can be shown or hidden as desired. Clicking on each tab will show/hide the
corresponding messages. The messages can also be sorted based on the column header.
The Compile Messages tab is similar to the Messages tab, except it only gets populated when
a case is compiled. When a case is compiled, the previous compile errors for that case are
erased. The Compile Messages tab will display the messages for the current active case. The
case name will be displayed in the drop down list. The user can look through the different
compile messages by selecting a case in the drop down list.

8
RSCAD FX Quick Start Guide

3.4. FILE MANAGER


The File Manager tab allows the user to browse the case files found in their user directory.
It provides a quick way to open, explore, and otherwise manage these case files. The File
Manager tab is not visible by default, but it can be added by going to View -> Utility Tabs and
checking File Manager.

4. NEW FEATURES
4.1. WIRE MODE
Wire mode allows a user to easily add wires and/or jumpers to a case using only the mouse.
It significantly reduces the amount of time required to connect components together. Please
refer to Appendix B for additional details.

4.2. AUTO-NAMING
A new feature has been introduced in RSCAD FX which helps users automate the process of
naming signals and components. Auto-naming can be enabled from the draft case toolbar
by pressing the button. It can also be enabled/disabled individually for each component
by right clicking on them and selecting from the auto-name menu.

Figure 5: Auto-naming Enable/Disable

This feature has many details but once understood, it can save time and reduce errors
involved in renaming signals. Please refer to Appendix C for additional details.

4.3. QUICK ACCESS TOOLBAR


Commonly used components can be quickly added to a case via the Quick Access Toolbar.
There is a button, , in the case tab’s toolbar that can be used to toggle the Quick Access
Toolbar ON or OFF. When it is ON, it will appear on the right side of the case tabs.
Components can be dragged from the toolbar into a case. A component can be clicked once
to be stuck to the mouse, or twice if the user wishes to place the same component
repeatedly.

9
RSCAD FX Quick Start Guide

4.4. CASE COMPARISON TOOL


There is a Case Comparison Tool that allows users to compare two .dfx files side by side and
makes it easier to identify the differences between files. The tool can be accessed under the
Utilities menu item.

10
RSCAD FX Quick Start Guide

4.5. RSCAD FX CONVERSION UTILITY


Draft files in RSCAD FX have the file extension .dfx instead of .dft, which was used in the
previous generation of RSCAD. When trying to open a .dft file in RSCAD FX, the RSCAD FX
Conversion Utility is automatically launched. Figure 6 displays the RSCAD FX Conversion
Utility.

Figure 6: RSCAD FX conversion program is Launched When Opening a .dft file

As noted below in section 7.2, the wiring of components is a little different than it was in
older versions of RSCAD. The conversion utility generally does a good job of correctly
converting cases, but occasionally, some human intervention will be required. In cases
where the proper node connections cannot be made, the component in Figure 7 will be
placed, and the user will have to use the breakout component to connect a 3-phase bus to
the indicated phase(s). After the proper connections are made, the component shown in
Figure 7 should be deleted.

11
RSCAD FX Quick Start Guide

Figure 7: The nodeError.def component indicates places where user intervention is


required and manually node connections must be made.

4.6. SHORTCUTS
Intuitive, Microsoft Windows based shortcuts are used in RSCAD FX. These shortcuts are
inline with shortcuts used in general windows operations. Details are listed in Appendix E.

5. TOOLBARS
More of RSCAD FX’s functionality is accessible through toolbars and/or menus compared to
previous versions of the software. There is a toolbar for the main RSCAD FX window, and
there are individual toolbars for the different tabs. The toolbars are generally user
configurable by going View -> Toolbar Configuration.

6. CONSOLIDATED SETTINGS
In RSCAD FX many settings have been consolidated so that they are easier to find. There are
two categories of settings, Global Settings, , and Case Settings, . Global Settings can be
found on the main toolbar and main menu, and apply to the whole RSCAD FX application.
Case Settings apply to a specific case and are accessible from a Case tab’s menu and toolbar.

12
RSCAD FX Quick Start Guide

7. OTHER NOTES
7.1. RUNTIME, T-LINE AND CABLE MODULES
The Runtime, T-line, Cable Modules are all launched in separate windows. They look and
function the same way they did in previous generations of RSCAD.

7.2. SLD VIEW


In previous generations of RSCAD, it was possible to switch between a 3-phase view and a
single-line diagram (SLD) view of the Draft circuit. This is no longer possible. There now is
only a single view that can have both 3-phase buses and single-phase components. The
breakout component shown below is now used to connect the two. The 3-phase end of the
component uses a notably thicker wire; this is a common graphical indicator in most power
system models.

7.3. COMPONENT BUILDER (CBUILDER)


The CBuilder module is updated for RSCAD FX. CBuilder can be launched from the “Launch”
menu as shown in

Figure 8: Launching Component Builder

For more details, please go through the CBuilder tutorial.

13
RSCAD FX Quick Start Guide

7.4. SCD EDITOR


The SCD Editor is not available for RSCAD FX. It is being replaced with our new IED
Configuration Tool (RSCAD ICT). Please see the RSCAD ICT manual for more details.

7.5. GTNET GSE SUPPORT


The legacy GSE components (GTNET-GSE-v5 and GTNET-GSE-v6) in RSCAD 5 are obsoleted in
RSCAD FX and replaced with the GTNET-GSE-v7 component (_rtds_GTNET_GSE_v7.def),
which provides backward compatibility. It is important to understand that GSEv7, GSEv6 and
GSEv5 are three independent implementations, which have different hardware and
firmware requirements. Even though all three implementations are supported by the
GTNET-GSE-v7 component in RSCAD FX draft, the applicability of each implementation in
RSCAD FX still depends on available RTDS simulation hardware. In other words, the GTNET-
GSE-v7 component has three operating modes or versions (GSEv) depending on availability
of RTDS simulation hardware and summarized in Table 1.

Table 1: GTNET-GSE-v7 Component GSE Version

GTNET-GSE-v7 Corresponding Legacy Supported


GSE version GTNET-GSE Hardware Description
(GSEv) Component Configurations*
• Operates identical to
GTNET-GSE-v5. Provides backward
GTNET-GSE-v5 Same as
GSEv5 compatibility
(_rtds_GTNET_GSE_v5.def) GTNET-GSE-v5
• Does not support generic GSE
features
• Operates identical to
GTNET-GSE-v6. Provides backward
GTNET-GSE-v6 Same as
GSEv6 compatibility
(_rtds_GTNET_GSE_v6.def) GTNET-GSE-v6
• Does not support generic GSE
features

Only supported on
GSEv7 N/A • Support generic GSE features
NovaCor-GTNETx2

When converting a case that contains one of the obsolete components into RSCAD FX, those
components will automatically get replaced with the GTNET-GSE-v7 component. Please refer
to Appendix D for additional details.

14
RSCAD FX Quick Start Guide

7.6. COMPILED HIERARCHY BOXES


When building a case to distribute to a 3rd party, a user may want to obscure details about
proprietary parts of that case while still allowing the 3 rd party to use the obscured parts as
‘black box’ components. The 3rd party would only deal with the inputs and outputs of the
obscured portions of the circuit, the details within would be unknown to them. The
mechanism for hiding details about all or a portion of the case has been modified in RSCAD
FX compared to previous versions of RSCAD.
Any components that are intended to be hidden/obscured should be placed inside of a
hierarchy box. Beyond doing this, users can build and run their simulation as usual. When
the user is ready to obscure the contents of a hierarchy box, they can right-click on the
hierarchy box and select ‘Pre-compile’ from the context menu that appears. A compiled file
representing the contents of the box is generated in the form of a separate .hbo file.
To use the compiled .hbo file, remove the original hierarchy box and replace it with a
Compiled Hierarchy Box ( _rtds_compiled_hierarchy_box.def), which is shown in Figure 9.

Figure 9: The Compiled Hierarchy Box acts as a shell or interface for .hbo files

The compiled .hbo file can be referenced by appropriately setting the hboFileName
parameter inside the compiled hierarchy box. The whole case can then be compiled as
though the original hierarchy box was still present.

NOTE: Deleting hierarchy boxes in the original case will result in the loss of the details
inside the hierarchy boxes. It is recommended that users make a copy of the original case
before replacing hierarchy boxes with compiled hierarchy boxes.

15
RSCAD FX Quick Start Guide

Appendix A: Library Details


1. INTRODUCTION
The library in RSCAD FX is a utility tab, which means that its placement and size within RSCAD
FX application can be customized. Figure 10 shows the newly reworked library.

Figure 10: Layout of Library tab in RSCAD FX

The library consists of a Navigation Panel on the left side and a Component Panel on the right
side, which displays component categories and components themselves as tiled icons. Each
of the tiled icons has the same size, resulting in a cleaner look that makes it easier for users
to see the available components. Components are easily added to a case by dragging them
from the component panel.

16
RSCAD FX Quick Start Guide

2. NAVIGATION PANEL
Library navigation can be easily done using the navigation panel on the left side of the library
tab. The navigation panel has two trees that show the structure of the Master and User
Libraries, as well as a list showing the past library searches that were made.

Figure 11: Navigation Panel

Components in the Master library have been organized into several categories. These
categories can be expanded or hidden in a tree; clicking on any of the tree items will show
that item's contents in the component panel.
The navigation panel can be minimized if desired to make more room for the library
component panel.
The refresh button located within the library tab refreshes the component definition files.

3. COMPONENT PANEL
The panel on the right shows icons that represent the different component categories and
the components themselves. They are represented with uniformly sized tiles. Each icon is
accompanied by a short description. The size of the icons can be scaled up or down, and they
will automatically be reorganized based on the size of the component panel.
Double clicking on an icon representing a category will show you what is inside that category.
Double clicking on an actual component allows the user to see the parameters of the
component. These parameters cannot be edited from the library.
Hovering over a component displays a more detailed description and a preview of how the
component will look in Draft. Figure 12 shows an arbitrary component’s preview.
Component previews are only visible if enabled in Global Settings->Miscellaneous.

17
RSCAD FX Quick Start Guide

Figure 12: Hovering Over A Component Shows A Preview of The Draft Graphics

The documentation for an individual component can be accessed by right-clicking and


selecting Help or by simply hovering over the component and pressing F1.

4. SEARCH
Components in the library can be searched by using the toolbar at the top of the tab. The
previous searches are stored in a list at the bottom of the navigation panel. If the user wishes
to get more information about a specific search, they can hover the mouse over a previous
search to see a tooltip appear with the search scope.
Components can be searched simply by typing in the keywords in the “search components
box” or to make a detailed search click on the “search” button left of the search components
box.

Figure 13: Search Options

18
RSCAD FX Quick Start Guide

Figure 14: Search Toolbar

19
RSCAD FX Quick Start Guide

5. COMPONENT FILTERING
Component filtering can be used to control which components from the Master library, User
library, or even from past searches are visible in the component panel. In the library toolbar,
there is a filter button that can be toggled on or off.

Figure 15: Available library component filtering options

The available filtering options are accessible using a dropdown beside the filter button.
Figure 15 shows the filtering dropdown. The components can be filtered by Simulation
Environment or by Phasing.
When in Distribution Mode. The filter will automatically be applied only to show the
Distribution simulation environment components.

6. USER LIBRARY
The User Library is characteristically same as master library, with the added option of
customization. Users can create their own libraries containing commonly used components
with customized parameters.
To edit the components in a user library, the library must first be unlocked using the toolbar
button, . When a library is unlocked,
1. New components can be added
2. The components in it can be re-arranged using drag-and-drop,
3. Component captions can be changed
4. Component parameters can be edited.

20
RSCAD FX Quick Start Guide

The library tree for the user library can be modified using options available in the context
menu. This can be done while a library is locked or unlocked.

7. Component Category By Colour


The components in the library have different colours for different categories. Color coding
the category helps them to be differentiated easily.

Colour Category

Black Mainstep

Black Control

Blue Single Phase Power System

Brown Substep

Green GPES

Magenta Small time-step

Orange Distribution Stretchable

Cyan TWRT

21
RSCAD FX Quick Start Guide

Appendix B: Wire Mode


Wire mode is a new feature introduced in RSCAD FX, which should significantly reduce the
amount of time needed to wire components together. Multiple wire segments and jumpers
can be laid down using only the mouse. Wire mode places the same wire and/or jumper
components used in previous versions of RSCAD; it just offers a more efficient way to place
them.

1. INITIATING WIRE MODE


To turn on wire mode, there is a toggle button in the case tab’s toolbar, . The shortcut
ctrl+w can also be used to toggle wire mode on and off.

Figure 16: Wire Mode from Case Toolbar

There are two (2) additional toggle buttons that allow the user to control whether a 1-phase
or a 3-phase wire will be drawn. Once wire mode is initiated, the cursor will change to a
pencil .

2. DRAWING A WIRE
When wire mode is enabled, clicking a point on the draft canvas will start drawing a wire
segment at that point. The wire will draw either vertically or horizontally, depending on the
direction the mouse is moved after the initial click. From here, several actions are possible:
• To complete a wire segment and start with a new segment from that point, click the
left mouse button a second time.
• To complete a wire segment and not draw another segment, double click or press
enter.
• To abort drawing the current wire segment, press the Esc key.
• To add a jumper, press the right mouse button; it will be attached to the cursor. If
drawing a single-phase wire, successive right-clicks will cycle through the several
jumper options. Rotation of the jumper using ctrl+r is available. A left click will place

22
RSCAD FX Quick Start Guide

the jumper attached to the cursor on the draft canvas. Pressing Esc before placing the
jumper will abort the action.
NOTE: When wires/buses overlap or intersect, they are connected electrically. The
user must add a jumper if they want to avoid an electrical connection.

3. EXITING WIRE MODE


If no wire is currently being drawn, pressing the Esc key will end wire mode. Toggling the
toolbar button and pressing the shortcut ctrl+w are two other ways to end wire mode.

23
RSCAD FX Quick Start Guide

Appendix C: Auto-Naming
1. INTRODUCTION
Auto-naming is a feature that helps with creating unique names for components and signals.
It allows users to largely automate the process of creating these names.
In RSCAD FX, every component in a case or library now has an embedded attribute called an
enumerator. That enumerator can be expressed as a number, letter, string, or a combination
of these things. Enumerators can be included as part of any NAME-type parameter in a
component. This includes component names, signal names, and signal outputs.
As stated above, every component has an enumerator, but each parameter within that
component does not necessarily have to use it. Some of a component’s parameters can
include the enumerator, while others do not; it is done on a parameter-by-parameter basis
and is completely customizable by the user. Details of how to add an enumerator to a
parameter are found in the section below titled Using the Enumerator Inside a Component.
The significance of the enumerator is that its value can be automatically increased as
components are copied and pasted, taken from the library or taken from the quick access
toolbar. Any parameter that includes the enumerator can be automatically updated.
In order for a copied component’s enumerator to be incremented during a paste operation
or when taken from the library or quick access toolbar, Auto-Naming Incrementation must
be toggled on. Auto-naming incrementation can be turned on/off using a toggle button on
the draft toolbar. ON: OFF: . When auto-naming incrementation is off, copy and paste
of a component works the same as in older versions of RSCAD. The names and signals of the
pasted components remain unchanged from the originals.
It is essential to emphasize the following because it can easily be a source of confusion.
The auto-naming incrementation toggle button on the toolbar controls whether each
component’s enumerator is incremented during
1. A paste operation
2. When taken from the library
3. When taken from the Quick access toolbar
Regardless of whether auto-naming incrementation is on or off, each component has an
enumerator. Further to this, each component’s enumerator can be enabled or disabled
independently. When enabled, the enumerator is used in resolving signal names; when

24
RSCAD FX Quick Start Guide

disabled, it is not included in resolving signal names. Enabling and Disabling a component’s
enumerator is further explained in section 3.1.
In older versions of RSCAD many master library components had a suffix/sfx parameter to
facilitate quick renaming of all the component’s signal names. In FX, this parameter has been
removed from most components and auto-naming has superseded it as the recommended
means of quickly renaming a component’s signals. Please refer to section 3.5 for additional
details.

2. USING THE ENUMERATOR INSIDE A COMPONENT


As stated above, each component has its own enumerator and users have control about how
and where this enumerator is used. Within a component, the enumerator can be used
optionally on a parameter-by-parameter basis. The best way to understand how to do this
is with a simple illustrative example. Let’s examine the three-phase source's Name
parameter to see how the component’s enumerator can be included in it. Please note that
auto-naming must be enabled for a particular component (not the toolbar option) to resolve
the enumerator in its parameter values.

The Name parameter that does not include the auto-naming enumerator would appear as
shown below when editing the component’s parameters.

Figure 17: Name Parameter without Auto-Naming Enumerator

Including the component’s enumerator in its Name parameter is done simply by typing a ‘#’
in the field. The # symbol is reserved in RSCAD FX and can only be used once within a
particular parameter. Note that the # is highlighted in green to indicate that it is not a usual
character.

Figure 18: Enumerator Included

The # can be placed anywhere in the parameter Name.

25
RSCAD FX Quick Start Guide

Figure 19: Enumerator Symbol Placement

When a particular parameter is not actively being edited and the textbox does not have
focus, the parameter value, including the enumerator, is resolved. This gives the user a
preview of what the resolved parameter value will be. Note that the resolved enumerator
remains green so that it can be easily identified.
The user can delete the enumerator from any parameter that they do not want it in.

3. ENUMERATOR OPTIONS
In the previous section, we demonstrated how to include a component’s enumerator in one
of its parameters. Next, we talk about some of the options available for controlling the exact
‘form’ that the enumerator takes. Each component that has at least one parameter that
supports auto-naming will have a parameter section called ‘AUTO-NAMING SETTINGS’. It will
look like the one shown in Figure 20. The different fields in this figure are described in
Sections 3.1-0. In Section 3.9 there are illustrative examples to help clarify how the different
enumerator options can be used.

Figure 20: Auto-Naming Section in Component Parameters

26
RSCAD FX Quick Start Guide

3.1. ENABLED/DISABLED (A)


When Enabled, the enumerator is included/resolved in any of a component’s string
parameters containing the reserved # symbol.
When Disabled, the enumerator IS NOT included/resolved in any of a component’s string
parameters containing the reserved # symbol. The # is not deleted from the component’s
parameter values, but it will not be included in the evaluated parameter values.

3.2. ENUMERATION VALUE (B)


The user can set the component’s enumerator to a specific value using this field.

3.3. ENUMERATION TYPE (C)


This dropdown allows the user to set the component’s enumerator type. The type can be set
as a decimal number, a hexadecimal number, as lower case letters or as upper case letters.
The examples below show how the enumerator would get incremented depending on the
enumerator type:
Decimal: 1 2 3…
Hexadecimal: 1 2 3 … 9 A B C D E F 10 11 12 …
Uppercase : A B C D …Y Z AA AB AC…
Lowercase : a b c d… y z aa ab ac …

3.4. RESET (D)


Pushing the Reset button sets the component’s enumerator to 0. If the enumerator is 0, it is
not included in the resolved signal name even if the auto-naming is enabled for the
component. In this situation, the preview for parameters containing the enumerator simply
shows a thin green bar in places where the enumerator exists.

Figure 21: Resetting the Enumerator

27
RSCAD FX Quick Start Guide

3.5. ENUMERATION STRING (E)


Instead of simply an incrementable number or letter, the # symbol entered in a parameter
can represent a more complex string that can contain the enumerator. The availability of
this option gives the user some additional flexibility. If the user were to enter abc#def as the
enumeration string, and the enumerator had a value of 3 they could expect to see something
like what is shown Figure 22 .

Figure 22: Use of Auto-Naming Enumerator String

In RSCAD FX, modification of a component’s enumeration string is now the recommended


way of adding suffixes to a component’s signals. The suffix/sfx parameters used in many
master library components in previous versions of RSCAD have been removed. The
enumeration string does not have to contain the enumerator (# symbol).

3.6. FLATTEN SIGNAL NAMES (F)


When a component’s signals are flattened, each of its string parameters is resolved and the
resolved strings are set as the base signal names. The enumerator is re-added to the end of
each ‘flattened’ string and is set to zero. The enumeration string is also reset to the default.

3.7. CONTEXT MENU


A context menu will appear when right-clicking on a component in RSCAD Draft. That context
menu will have the menu item ‘Auto-Naming’, which allows the user to control the
enumerator settings for that component. The context menu is shown below in Figure 23. All
of the features described in Sections 3.1-0 are available via the context menu.
The context menu is especially useful when you want to change the auto-naming settings
for multiple components simultaneously. Simply select the components to be changed and
then right-click on one of the selections.

28
RSCAD FX Quick Start Guide

Figure 23: Auto-Naming Context Menu

3.8. RESET AUTO-NAMING FROM LIBRARY


With auto-naming incrementation turned on (via toolbar button), the first instance of a
component taken from a particular library and placed in a case usually has its enumerator
set to one. Each subsequent component of the same type taken from that library and placed
in the same case has its enumerator incremented by one. The count for each component
starts from zero for each case.
In a particular case, a user may want to reset the enumeration of components taken from
the library and start counting from zero again. This can be done by right-clicking on some
blank space in the case and selecting ‘Reset Auto-Naming From Library’.

The Quick Access toolbar behaves the same way as a Library. Choosing ‘Reset Auto-Naming
From Library’ will also reset it for the Quick Access toolbar.

29
RSCAD FX Quick Start Guide

3.9. ILLUSTRATIVE EXERCISES


The following series of exercises will help clarify how auto-naming works in RSCAD FX.
Step 1:

Turn auto-naming incrementation off ( ), then drag a wire label from the Controls ->
General library into a new draft case. You should see the label ‘A’ on the Draft canvas. Turn
auto-naming incrementation on ( ), copy the label ‘A’, then paste it four times in the case.
Auto-naming should be Enabled for each of the copied components and they should have
the following properties:
Evaluated Name parameter A1 A2 A3 A4
Stored Name parameter A# A# A# A#
Enumerator value 1 2 3 4

Step 2:
Select the four copied labels, right-click on one of the selected labels and select Auto-naming
-> Disable.
Evaluated Name parameter A A A A
Stored Name parameter A# A# A# A#
Enumerator value 1 2 3 4

Step 3:
Select all the labels, right-click on one of the selected labels and select Auto-naming ->
Enable.
Evaluated Name parameter A1 A2 A3 A3
Stored Name parameter A# A# A# A#
Enumerator value 1 2 3 4
Step 4:
Select all the labels, right-click on one of the selected labels and select Auto-naming ->
Enumerator -> Set Enumeration String. In the dialog that appears, set the enumeration string
to ‘_#_ABC’

30
RSCAD FX Quick Start Guide

Evaluated Name parameter A_1_ABC A_2_ABC A_3_ABC A_4_ABC


Stored Name parameter A# A# A# A#
Enumerator value 1 2 3 4
Enumeration String _#_ABC _#_ABC _#_ABC _#_ABC

Step 5:
Select all the labels, right-click on one of the selected labels and select Auto-naming ->
Enumerator -> Set Type. In the dialog that appears, set the enumeration type to Uppercase
letters.
Evaluated Name parameter A_A_ABC A_B_ABC A_C_ABC A_D_ABC
Stored Name parameter A# A# A# A#
Enumerator value 1 2 3 4
Enumeration String _#_ABC _#_ABC _#_ABC _#_ABC

Enumerator type Uppercase Uppercase Uppercase Uppercase


letters letters letters letters
Step 6:
Select all the labels, right-click on one of the selected labels and select Auto-naming ->
Enumerator -> Reset.
Evaluated Name parameter A__ABC A__ABC A__ABC A__ABC
Stored Name parameter A# A# A# A#
Enumerator value 0 0 0 0
Enumeration String _#_ABC _#_ABC _#_ABC _#_ABC

Enumerator type Uppercase Uppercase Uppercase Uppercase


letters letters letters letters
Step 7:
Select all the labels, right-click on one of the selected labels and select Auto-naming ->
Enumerator -> Set. In the dialog that appears, set the enumeration value to 5.
Evaluated Name parameter A_E_ABC A_E_ABC A_E_ABC A_E_ABC
Stored Name parameter A# A# A# A#
Enumerator value 5 5 5 5
Enumeration String _#_ABC _#_ABC _#_ABC _#_ABC

Enumerator type Uppercase Uppercase Uppercase Uppercase


letters letters letters letters
Step 8:
Select all the labels, copy them, and paste them. The pasted components will have the
following properties:

31
RSCAD FX Quick Start Guide

Evaluated Name parameter A_F_ABC A_F_ABC A_F_ABC A_F_ABC


Stored Name parameter A# A# A# A#
Enumerator value 6 6 6 6
Enumeration String _#_ABC _#_ABC _#_ABC _#_ABC

Enumerator type Uppercase Uppercase Uppercase Uppercase


letters letters letters letters
Step 9:
Go back to the output of Step 4 then select all the labels, right-click on one of the selected
labels and select Auto-naming -> Enumerator -> Flatten.
Evaluated Name parameter A_1_ABC A_2_ABC A_3_ABC A_4_ABC
Stored Name parameter A_1_ABC# A_2_ABC# A_3_ABC# A_4_ABC#
Enumerator value 0 0 0 0
Enumeration String # # # #

Enumeration type Decimal Decimal Decimal Decimal

Step 10:
Select all the labels, copy them, and paste them. The pasted components will have the
following properties:
Evaluated Name parameter A_1_ABC1 A_2_ABC1 A_3_ABC1 A_4_ABC1
Stored Name parameter A_1_ABC# A_2_ABC# A_3_ABC# A_4_ABC#
Enumerator value 0 0 0 0
Enumeration String # # # #

Enumeration type Decimal Decimal Decimal Decimal

32
RSCAD FX Quick Start Guide

Appendix D: GSE Converter


1. Introduction
The GSE converter is developed to convert and run RSCAD 5 cases in RSCAD FX by replacing
legacy GTNET-GSE components (GTNET-GSE-v5 and GTNET-GSE-v6) with the GTNET-GSE-v7
component. It also converts System Configuration Description (SCD) files associated with
GTNET-GSE components in previous generations to a new format that can be opened/edited
by the new IED Configuration Tool (RSCAD ICT).
The GSE converter is integrated into the RSCAD FX file conversion utility, where the user
simply has to load the draft case (.dft file) as an input. The GSE converter automatically
upgrades legacy GTNET-GSE components to GTNET-GSE-v7 and creates all necessary case
files for successful compilation in RSCAD FX.

2. The GSE Converter Input and Output Files


The GSE converter takes the following files as inputs –
• Draft file: The .dft file is the main input. The GSE converter reads this file and
identifies legacy GTNET-GSE components and associated SCD files.
• SCD files: The .scd files are associated with GTNET-GSE components. Each GTNET-
GSE component needs an SCD file, which is generated by an editor program that
takes component capability files (.icd files) and merges them into a .scd file.
The GSE converter produces the following files as output –
• Converted CID (.cid) files: These are configured IED descriptions associated with
GTNET-GSE-v7 components. Each GTNET-GSE component needs a CID file, which
describes the configuration of the associated GTNET-GSE-v7 component. Must be
located in the same directory as the .dfx file.
• ICT Project (.ipf) file: This file is the GTNET-ICT project file and can be opened/edited
by the ICT. It contains information about all the GTNET components and external IEDs
in the project.
• ICT Draft (.idf) file: The .idf file is an auxiliary file, which contains component related
information to be used by draft/GTNET-GSE-v7 components. Must be located in the
same directory as the .dfx file.
• Project Auxiliary (.iaf) file: The .iaf file contains similar information as the .idf file.
This file is to be used by the ICT.

33
RSCAD FX Quick Start Guide

3. Cases with Legacy GTNET-GSE Components to RSCAD FX


Table 2 summarizes the replacement of legacy GSE components with GTNET-GSE-v7
component during RSCAD FX conversion process.

Table 2: Replacement of Legacy GSE Components with GTNET-GSE-v7 Component

Legacy GSE GSE Version of GTNET-GSE-v7 Component in RSCAD FX Draft 1


Component Version
Original RSCAD 5 Draft Case Original RSCAD 5 Draft Case
(Component Version
Run on PB5/GPC Simulators Run on NovaCor Simulators
in the Original
RSCAD 5 Draft Case) GTNET GTNETx2 GTNET GTNETx2

GTNET-GSE-v5 GSEv5 2 GSEv5 2 GSEv5 2 GSEv7 4

GTNET-GSE-v6 N/A 3 GSEv6 2 N/A 3 GSEv7 4

1. All legacy GSE components (GTNET-GSE-v5 and GTNET-GSE-v6) are replaced by GTNET-GSE-v7
components in RSCAD FX draft. The operating mode or version (GSEv) of each GTNET-GSE-v7
component depends on RTDS simulation hardware on which the original RSCAD 5 draft case was run
and saved.

2. Operates identical to the corresponding legacy GTNET-GSE-v5 or GTNET-GSE-v6 component, has


identical capabilities and governed by the same set of rules. This component does not support the new
features offered by the generic GSE-v7 implementation.

3. Not applicable as the GTNET-GSE-v6 component is not compatible with GTNET hardware.

4. Operates similar to the corresponding legacy GTNET-GSE-v5 or GTNET-GSE-v6 component with the
differences outlined in a latter section.

4. Comparison of Original and Converted Draft Files with GSEv7


The GSE converter adds new hierarchy boxes for each GTNET-GSE-v7 component where
operation mode or version is GSEv7. These hierarchy boxes are automatically named as –
suffix :: <GTNET-GSE component name>, where suffix = C0, C1, C2, …
For example, if there are two GTNET-GSE components called GTNET1 and GTNET2, the
corresponding hierarchy boxes would be called “C0GTNET1” and “C1GTNET2”, respectively.
Each hierarchy box contains switches to control “Needs commissioning flag” and “Global test
flag” for each enabled GGIO RX/TX and the XCBR/XSWI TX module. In addition, the GSE
conversion manager adds binary switches to control quality outputs and XCBR/CSWI
positions.

34
RSCAD FX Quick Start Guide

4.1. IP Address
Unlike legacy GTNET-GSE components, specifying communication network parameters (IP
address, subnet mask and default gateway) is mandatory for the operation of the GTNET-
GSE-v7 component and must match with the corresponding GTNETx2 modules’ IP
addresses. See the RSCAD ICT help manual for more information.

4.2. Quality Variables


In legacy GTNET-GSE components, quality bitmaps (13 bits) associated with all 32 outputs of
a RX/TX module are mapped to 13 integer words (32-bit) such that each word carries a
certain quality attitude for all 32 outputs (for example, in GTNET-GSE-v6, nIED1Iq0 carries
the validity bit for all 32 GGIO outputs in RX/TX module 1). These 32-bit quality variables are
used to override and control quality outputs in each enabled GGIO RX/TX and the XCBR/XSWI
TX modules. In contrast, the GTNET-GSE-v7 component extracts all 13 quality attributes of a
particular output from a single word (a mask is applied to extract the first 13-bits of the
word). Similarly, the GTNET-GSE-v7 component specifies individual signal names for each
subscribed quality inputs, which are accessible from draft for further processing and in
runtime for monitoring. The GSE converter automatically creates controls (binary switches)
for quality outputs and individual input signal names for all quality subscriptions.
Note: These added controls override the existing controls associated with the legacy GTNET-
GSE quality bitmaps.

4.3. Control XCBR and CSWI Positions


In the GTNET-GSE-v6 component, the circuit breaker position is inputted as a 32‐bit integer,
in which each bit represents the status of one mapped breaker. This variable represents both
XCBR and CSWI positions. However, in the GTNET-GSE-v7 component, XCBR and CSWI
positions are inputted separately and read as double position inputs. The GSE converter
automatically creates double position input for XCBR and CSWI controls.
Note: These added controls override existing controls, and therefore, the user is expected
to modify the draft case accordingly to achieve the switchgear controls offered by the
GTNET-GSE-v7 component.

35
RSCAD FX Quick Start Guide

Table 3 compares variables in legacy GTNET-GSE components and the GTNET-GSE-v7


component.

36
RSCAD FX Quick Start Guide

Table 3: A comparison of controls and signal names associated with legacy GTNET-GSE
components and GTNET-GSE-v7 component

Signal names in
Signal names in legacy
GTNET-GSE-v7 component
GTNET-GSE components
(GSEv7)

Needs commissioning nIEDxInc CnIEDxONC


Example – Example –
nIED1Inc = IED1ONC C0IED1ONC

Global test nIEDxIgt CnIEDxOGT


Example – Example –
nIED1Igt = IED1OGT C0IED1OGT

Quality Control nIEDxOq0 - nIEDxOq12 CnGTmIEDxO1Q – CnGTmIEDxO32Q

(published from Example – Example –


GTNET-GSE) nIED1Oq0 = GT1IED1OQ0 C0GT1IED1O1Q
nIED1Oq1 = GT1IED1OQ1 C0GT1IED1O2Q
: :
nIED1Oq12 = GT1IED1OQ12 C0GT1IED1O32Q

Quality Monitoring nIEDxIq0 - nIEDxIq12 CnGTxIEDyI1Q – CnGTxIEDyI32Q

(subscribed by Example – Example –


GTNET-GSE) nIED1Iq0 = GT1IED1IQ0 C0GT1IED1I1Q
nIED1Iq1 = GT1IED1IQ1 C0GT1IED1I2Q
: :
nIED1Iq12 = GT1IED1IQ12 C0GT1IED1I32Q

XCBR Position nXCBRPosA CnposXCBR


Example – Example –
nXCBRPosA = GT1PosA (represent C0posXCBR1
up to 32 breakers)
C0posXCBR2 (if breakers 17-32 are
enabled)

CSWI Position CnposCSWI


Example –
C0posCSWI1
C0posCSWI2 (if breakers 17-32 are
enabled)

37
RSCAD FX Quick Start Guide

Appendix E: Shortcuts
The shortcuts that are new to RSCAD FX are listed in the following table.
BASIC
Save Ctrl-s
EDIT
Cut Ctrl-x
Copy Ctrl-c
Paste Ctrl-v
Delete Delete
Select All Ctrl-a
Undo Ctrl-z
Redo Ctrl-y
LAYOUT
Group/Ungroup Ctrl-g
Rotate Ctrl-r
Mirror Ctrl-i
ZOOM
Zoom In Ctrl-scroll
Zoom Out Ctrl-scroll
SEARCH
Search Options Ctrl-f
BUILD
Compile Ctrl-b
DRAFT OPTIONS
Wire Mode Ctrl-w
Quick Access Toolbar Ctrl-q
CONTEXT MENU
Move to New Hierarchy box Ctrl-m
Help F1
Print Parameters Ctrl-p
Edit Parameters Ctrl-e

38

You might also like