RSCADFX Quick Start Guide
RSCADFX 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
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.
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
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
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.
8
RSCAD FX Quick Start Guide
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.
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.
9
RSCAD FX Quick Start Guide
10
RSCAD FX Quick Start Guide
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
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.
13
RSCAD FX Quick Start Guide
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
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
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.
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
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.
18
RSCAD FX Quick Start Guide
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.
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.
Colour Category
Black Mainstep
Black Control
Brown Substep
Green GPES
Cyan TWRT
21
RSCAD FX Quick Start Guide
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.
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.
The Name parameter that does not include the auto-naming enumerator would appear as
shown below when editing the component’s parameters.
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.
25
RSCAD FX Quick Start Guide
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.
26
RSCAD FX Quick Start Guide
27
RSCAD FX Quick Start Guide
28
RSCAD FX Quick Start Guide
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
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
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
31
RSCAD FX Quick Start Guide
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 # # # #
32
RSCAD FX Quick Start Guide
33
RSCAD FX Quick Start Guide
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.
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.
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.
35
RSCAD FX Quick Start Guide
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)
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