DASBAENFTP62U
DASBAENFTP62U
User’s Guide
Famic Technologies Inc. All rights reserved.©
REPRODUCTION
ii
Table of Contents
6.2 Properties of Library Components ....................................................................... 6-26
6.2.1 “Data” Branch........................................................................................ 6-27
6.2.2 “Accessories” Branch ............................................................................ 6-37
6.2.3 Graphical Data ....................................................................................... 6-37
6.2.4 “Variable Assignment” Branch ............................................................. 6-40
6.3 Sizing Sheet Manager .......................................................................................... 6-46
6.3.1 Working with sizing sheets .................................................................... 6-49
6.3.2 Adding a new sizing sheet ..................................................................... 6-55
6.3.3 Association of Sizing Sheet to component ............................................ 6-70
6.3.4 Additional Information Chart ................................................................ 6-72
6.3.5 Additional Information Table ................................................................ 6-77
6.4 Attributes of Graphic Objects .............................................................................. 6-80
6.4.1 “Data” Branch........................................................................................ 6-81
6.4.2 “Transparency” Branch ......................................................................... 6-81
6.4.3 “Hyperlink” Branch ............................................................................... 6-82
6.5 Accessories Management .................................................................................... 6-90
6.5.1 Creating Accessories ............................................................................. 6-90
6.5.2 Accessory Association ........................................................................... 6-93
6.5.3 Deleting Accessories ............................................................................. 6-95
7 Reports ........................................................................................................................... 7-1
7.1 Managing Reports .................................................................................................. 7-1
7.1.1 Creating ................................................................................................... 7-1
7.1.2 Actions in a Spreadsheet Report ............................................................ 7-21
7.1.3 Actions to the Report Print View ........................................................... 7-28
7.1.4 Export .................................................................................................... 7-28
7.1.5 Update.................................................................................................... 7-29
7.1.6 Print Preview and Print .......................................................................... 7-30
7.1.7 Saving a Report ..................................................................................... 7-30
7.2 Report Properties ................................................................................................. 7-30
7.2.1 “Document Properties” Branch ............................................................. 7-30
“Revisions” Branch ............................................................................................. 7-34
8 Simulation and Analysis ................................................................................................ 8-1
8.1 Description of the Simulation Mode ...................................................................... 8-1
8.1.1 Launching the Simulation ........................................................................ 8-2
8.2 Simulation Paces .................................................................................................... 8-3
8.2.1 10 ms Simulation ..................................................................................... 8-4
8.2.2 0.5, 1 and 2 ms Simulation ...................................................................... 8-5
8.2.3 0.1 ms Simulation .................................................................................... 8-5
iv
Table of Contents
10.4 Custom Component Properties Dialogue ........................................................... 10-31
10.4.1 “Data” Branch...................................................................................... 10-31
10.4.2 “Variable Assignment” Branch ........................................................... 10-33
10.4.3 “Accessories” Branch .......................................................................... 10-34
10.4.4 “Troubleshooting” Branch ................................................................... 10-34
10.5 Custom Component Simulation ......................................................................... 10-34
10.6 Additional application example: Hydraulic pump by block diagram ................ 10-38
11 I/O Interface Card ....................................................................................................... 11-1
11.1 Using the I/O Interface Card ................................................................................ 11-2
11.2 Practical Example Using the I/O Interface Card .................................................. 11-4
11.2.1 Building the Circuit ............................................................................... 11-4
11.2.2 Defining the Sequence ........................................................................... 11-6
11.2.3 Sequence Ladder Logic Diagram .......................................................... 11-7
11.2.4 Assigning I/O Variables to Electrical Circuit Components ................. 11-10
11.3 Simulating the Circuit Connected to a PLC ....................................................... 11-11
A Shortcuts ........................................................................................................................... 1
A.1. Keyboard Shortcuts .................................................................................................. 1
A.2. Navigation Keys ....................................................................................................... 5
A.3. Mouse Shortcuts ....................................................................................................... 6
B Glossary ............................................................................................................................. 1
C Index .................................................................................................................................. 1
Automation Studio™ provides the ability to design and document a complete virtual
machine using the available technologies, and step-by-step follow-up on a project
lifecycle by using a minimum number of source projects. These steps are: design, drafting
and technical documents, validation, commercial documentation and technical reports,
training, troubleshooting and document management of the virtual machine. The
objective is to minimize human error, and avoid the need for document and prototype
duplication.
The software consists of several modules, which are also called workshops, and libraries
that can be added according to each user’s needs and requirements. Each library contains
hundreds of SO, IEC, JIC and NEMA compliant symbols. Users can select the appropriate
components and drag and drop them onto the workspace to quickly create virtually any
type of system. Systems can consist of one single technology such as hydraulics,
pneumatics, electrotechnical, etc., or of a combination of multiple technologies that will
interact with each other during simulation as they would in the real life.
Automation Studio™ includes functions for editing, simulation, printing, file management
and presentation. Access to technical and commercial data is also available.
The needs expressed by users have triggered the development of two products that
enhance the capabilities of Automation Studio™.
1. Automation Studio™ Simulation is a product that is used to simulate projects and
create training material for increasing needs.
2. Automation Studio™ Design is a product that is used to edit projects, meeting the
increasing needs in technical drawing and designing.
The Automation Studio™ user documentation has a modular structure. The current
Automation Studio™ - User’s Guide contains information regarding the main functions of
the Project Explorer, the Library Explorer, the common functionalities for all the Editors in
Edition and Simulation mode. Each workshop has a User’s Guide that provides specific
information.
If a function explained into one of the guides is related to users team work,
standardization of work procedure, rights management and access or integration of
Automation Studio™ with other applications, we will mention it.
1-2
Introduction
Depending on the Automation Studio™ edition, some functions might be either limited
(number of components, documents or projects, thermal simulation etc.) or missing
(Specialized builders or report types etc.).
All physics phenomena calculated by the simulator are available in all editions.
Refer to the Workshops User's Guide for information on the different functions,
components and examples in order to learn and use Automation Studio™ in edition or
simulation mode.
All the instructions required to use workshops shared functions are included in this User’s
Guide. Specifically, this guide includes the Project Explorer, the Library Explorer, and the
Diagram Editor environments, along with their commands and dialogue boxes.
Instructions that are essential to the simulation of the different workshop technologies
are also described. This Guide includes the team work functionalities.
See the Administrator’s Guide for the management of user profiles, access management
as well as transfer and management of enterprise standards.
See the Catalogue Manager Guide to discover how to create, manage and design a
system starting from manufacturer’s pre-configured parts instead of using generic
components from the main Automation Studio™ library.
See the API Guide to integrate Automation Studio™ into a work process, create macro
functions or create didactic material.
Instructions are presented the way the process should be executed. The content is
organized so that each step in each section follows the next step very closely. In fact, the
basic Automation Studio™ system can be learned by reading this guide and following the
sequence of chapters as they are presented. For tasks specific to a workshop, users are
invited to read the User’s Guide supplied with that specific workshop.
Information can also be accessed through the index and the appendices at the end of this
The word “select” is used when identifying an object to be modified or when selecting
an option in a dialogue box.
Example: Select the printer driver from the Printer drop-down list box.
1-4
Introduction
KEY1+KEY2:The plus sign (+) indicates that the first key must be pressed and held down
while pressing the second one. Example: CTRL+A.
KEY1, KEY2:
The comma (,) instructs to press the first key, release, then press the second
one. Example: ALT, F.
There are two terminology conventions used in this document. One is for terms
connected with the use of the mouse, and the second is for icons used in this document.
The current help document uses icons to represent important notes and tips explaining
the commands that can be used.
Icon Definition
Indicates an important notice or concept.
Icon Definition
Indicates a tip or a trick that simplifies the use of commands in
Automation Studio™.
1-6
2 User Interface Description
This section introduces a detailed description of each item that comprises the Automation
Studio™ User Interface. Items in the main window are divided into two categories:
1. The main application window gives access to most available functions in Automation
Studio™. This window is contains all the documents used, and will be referred to
“Diagram Editor” in the following pages of this guide.
2. Management utility windows are floating and can be accessed from the main
application window.
A list of shortcuts for utility windows and functions is available at the end of this
document in the Annex.
It is also the main window that contains the views of an active project (see section
2.2.4.2 Project Explorer Configuration Window).
When working on a diagram, the contextual menu can be used an alternative means to
reach certain commands offered in the ribbon. Right-click on the diagram to make the
contextual menu appear.
The commands available in the contextual menu are determined by the current mode
(simulation or edit mode), as well as the position of the cursor. If the cursor is on a
specific item, the contextual menu may contain commands relevant to that item.
Certain commands offered in the contextual menu are not available in the ribbon bar.
These commands apply specifically to the selected element or to the present context.
Refer to the various guides to know the specific contextual menus, depending on the
component and the technology used.
When starting Automation Studio™, the default title bar of the Diagram Editor is shown
on Figure 2-2: Title Bar of Automation Studio™ upon Opening. When saving for the first
time or when opening an existing project, the title bar displays the name of the software
followed by the name of the project and current diagram.
2-2
User Interface Description
The button located in the upper left corner of the main window provides access to
the Automation Studio™ menu.
In general, the Automation Studio™ menu contains project management functions while
the ribbon (see section 2.1.4 Ribbon) contains all the command tabs dedicated to project
creation (editing and simulation).
Automation Studio™ menu functions are grouped together in categories, which appear on
the left-hand side of the menu (Figure 2-3: Automation Studio™ Menu). As long as no
category is selected, click on one of the projects appearing on the right-hand side of the
menu, to open it.
The menu also displays two buttons in the lower section of the window : “Automation
Studio™ Options” to modify the application’s options, and “Exit Automation Studio™” to
close the application.
Automation Studio™ options are described in section 2.1.3.2 Automation Studio™ Options.
A description of the functions offered in the Automation Studio™ menu is provided below.
2-4
User Interface Description
2-6
User Interface Description
For a new web page, a window opens asking for a name and a URL address for the web
page.
The “Support” menu allows you to register the software, check for updates, download
manufacturers’ catalogues and teachware and helps you find information about your
version of Automation Studio™. It gives you also access to the user’s guides of different
Automation Studio™ modules and online support.
2-8
User Interface Description
2-10
User Interface Description
2-12
User Interface Description
These options are user defined and included in a database named ASSettings.mdb. To
standardize this database for all users, administrators must copy ASSettings.mdb in each
user directory:
● C:\Users\UserName\AppData\Roaming\Famic Technologies\Automation
Studio\6.0 (Win7)
● C:\Documents and Settings\[utilisateur]\Application Data\Famic
Technologies\Automation Studio\6.0 (Windows XP) or equivalent path other OS.
Locations
Name Description
2-14
User Interface Description
Name Description
Software Update This command is used to set the software
update mode to be manual or with automatic
check delays for Automation Studio™ (daily,
weekly, monthly).
Electrotechnical Edition
Wire Edition Rerouting This command is used to activate the
automatic rerouting of wires.
Show Wire Update Warning This command displays a warning message
before a wire update.
Information
Company Name This command is used to input the name of
the company.
OPC Server
OPC Server State This command is used to activate or
deactivate the Automation Studio™ OPC
Server.
UA Services TCP Port This command is used to set the TCP port
address for the UA Services. A UA (OPC
Unified Architecture) client will connect to
this port.
UA Discovery Services TCP Port This command is used to set the TCP port
address for the UA Discovery Services.
If the File Project Backup Copy On Opening” option has been selected in the Automation
Studio™ options, the projects are saved automatically if, for whatever reason, Automation
Studio™ was unexpectedly closed after a certain delay.
By default the delay is set to 15 minutes, but the function can be deactivated by
selecting “Never” or can be increased up to 120 minutes.
The saved file is kept under a temporary file in the folder where the project file has been
previously saved or in the default Automation Studio ™ installation folder if the project has
never been saved. The extension .autosave is added at the end of the project file full
name (e.g. MyProject.prx.autosave).
When reopening Automation Studio™, the user will be asked to select the projects
recovered.
2.1.4 Ribbon
The ribbon replaces the usual menus and toolbars. It cannot be moved or hidden, but can
be minimized.
2-16
User Interface Description
It is composed of:
1. Tabs: of typical usage controls or main scenarios.
2. Groups: within the tabs, assembly of controls of a same function.
3. Commands: within groups, to manage generally unit functions.
4. Help button: to access contextual help of the current window (Project, Library
Explorer, etc.) or of the current element (component, group, CAD, etc.).
Once the Ribbon is minimized, the controls are still accessible: click on the tab for
access. Once the control is selected, the tab is minimized again.
When the ribbon is not minimized, it is possible to move from one tab to another
if by placing the mouse on the “Ribbon” and use the mouse scroll.
When putting the mouse cursor on one command, a tooltip appears. To access a
command, simply click on its icon. Some commands have an arrow on the right of or
below the icon. By clicking on the arrow, a menu appears displaying a group of
distributed controls. By clicking on the main icon, the main function is launched.
Command Description
Command Description
Add to the Quick Access Toolbar This command appears when a command of the
ribbon is right-clicked. It is used to add a command
to the Quick Access Toolbar. (See section 2.1.5 Quick
Access Toolbar
Customize Quick Access Toolbar… This command is used to access the toolbar
customization dialogue box, and configure the
toolbar content. (See section 2.1.5 Quick Access
Toolbar)
Show Quick Access Toolbar This command is used to move the customized
(Above) the Ribbon toolbar above or below the ribbon. (By default it
appears above)
Minimize the Ribbon This command is used to minimize the ribbon.
The following is a description of each Command in each Group of the ribbon bar Tabs.
This tab contains all the necessary commands to create documents, access components
and draft the whole technical diagram of the system.
“New” Group
This command group is used to create a new project or a new document in the active
project.
2-18
User Interface Description
Command Description
Project This command opens the project templates list from which
to create a new project.
“Components” Group
This command group is used to access components from many technologies used in
technical drafting.
“Insert” Group
This command group is used to add text information related to components and
documents.
“Links” Group
This command group is used to create links between components and to apply functions
to the components. The content displayed in this group varies according to the active
document. The figure below details of the “Links” group in an active standard diagram.
For details about one-line or multiline electrotechnical and SFC diagrams, please see their
respective workshop guide.
Convert Link This command converts a deviated Link to a Direct Link and
2-20
User Interface Description
Command Description
vice versa.
Break Link This command divides a link into two or more segments.
“Snap” Group
The snapping of symbols from the library onto the grid via connection ports.
The snapping of CAD elements on the virtual grid. The precision of the grip snap
can be set using the “Drawing Snap Precision” command.
Check the Grid box in the View Tab to see the element behaviour. If this box is
unchecked, these snap options will not be visible.
Command Description
Component This command makes the component symbols to snap on
Snap the grid. Otherwise, the component symbols can be located
to the nearest pixel anywhere in the workspace. This is not
recommended for technical diagrams because this can make
the symbol’s alignment more difficult.
Drawing This command makes the CAD elements (circle, line, square,
Snap etc.) snap onto a virtual grid according to its precision
setting.
2-22
User Interface Description
“Component Tooltip” Group
This command group is used to input information that will be displayed in the component
tooltip (text or hyperlink).
When editing, these commands are used to automatically add a text or a hyperlink to a
picture, audio, video and other type of file in the tooltip of a component. Each property
includes a label and a description. Once created, it will be displayed in the component
tooltip, as long as the option is checked in the “View” tab of the
main ribbon.
It is possible to activate the “User Translated Text Value” option in order to display the
information in other languages.
The user can further edit these property values directly in the component property
dialogue box, under “User-defined” properties in the Data tab. The property label appears
as an alias in this dialogue box.
This command supports most of the technology components and drawing elements, even
if they are part of a group or an assembly. The layer, however, must be active and
visible.
To apply one of these commands, simply click on the selection in the “Home” tab of the
main ribbon in the “Component Tooltip” group. When the mouse cursor passes over the
element with a tooltip, the element is highlighted.
Clicking on the highlighted element opens the corresponding property dialogue boxes:
a. Text to edit the label (name) and text (content).
b. Hyperlink to edit the label and text by clicking on the abc command or on
the magnifier icon to browse the required file.
Step 2 : Move the pointer over the component and click on it.
2-24
User Interface Description
Step 3 :Insert the label and the text, then select the translation option, if applicable.
Step 2: Move the pointer over the component and click on it.
Step 3 : Click on the “Magnifier” and browse to find the file (picture, audio, video or
other). Edit the path using the “abc” icon next to the magnifier icon : .
Generic Viewer
Once inserted, the hyperlink will launch from the Component Tooltip and will open in the
Automation Studio™ Generic Viewer (for compatible files).
By clicking on the hyperlink “Video 1”, the Generic Viewer will open to enable the video
to play.
2-26
User Interface Description
This commands group is used to start the wizard for generating a custom component
(see 10.3 Custom Component Generating Wizard), insert a “Port” component (see
10.2.1.2 Ports and 10.2.2.2 Ports Correspondence) and finally, extract the symbol of a
component, a group or an assembly of drawing objects.
This group is located in the “Home” Tab only if the current document is of the “Standard”
or “Electrotechnical” type.
This tab contains all the necessary commands to manage the format of various objects
inserted on a diagram.
“Clipboard” Group
This group of commands is used to copy and paste objects onto a diagram.
2-28
User Interface Description
“Location” Group
This group of commands is used to modify the format of the selected text information on
a diagram.
Align Text Align the text to the left in the selected text box.
Left
Align Text Align the text in the center of the selected text box.
Center
Align Text Align the text to the right in the selected text box.
Right
Font Colour Change the colour of the selected text.
2-30
User Interface Description
“Line” Group
This group of commands is used to individually modify the format of selected drawn
objects and symbols on a diagram. However, this is not recommended when working
within a company standard.
“Surface” Group
“Layout” Group
The “Layout” Group in the “Edit” Tab contains all the commands related to setting the
orientation and layout of elements in a diagram.
2-32
User Interface Description
Alignment
Icon Command Description
Align Left This command is used to align all the selected
components to the left edge of the master.
Align Center This command is used to align all the selected
components to the center of the master.
Align Right This command is used to align all the selected
components to the right edge of the master.
Align Top This command is used to align all the selected
components to the top edge of the page.
Align Middle This command is used to align all the selected
components to the middle of the master.
Align Bottom This command is used to align all the selected
components to the bottom edge of the master.
True/False Align Relative to the This option and the following are mutually
First Shape Selected exclusive. When this option is selected, the
alignment is based on the first selected item
(master), which has blue grips, compared to the
others which have white grips.
True/False Align to Page The alignment is done relative to the page print
boundaries (left, right, top and bottom
boundaries).
Distribute
Icon Command Description
Distribute Horizontally Place evenly all vertical centre axes of each
selected component.
Distribute Vertically Place evenly all horizontal center axes of each
selected component.
True/False Distribute Relative to This option and the following are mutually
Extent of Selection exclusive. When this option is selected, the
distribution is based on the selected items.
Any selected item inserted onto a diagram is surrounded by a rectangle and handles that
are either blue or white. The coordinates of the selection box (the rectangle), upper left
corner, can be located with the X and Y values that are measured relative to the upper
left corner of the document.
The “Coordinates and Orientation” window is accessible from the “Edit” tab “Layout”
group of the ribbon . It is used to display and modify the positioning parameters of
the selected element.
This window is also used to apply mirror operations with the “Vertical Flip” and
“Horizontal Flip” checkboxes.
2-34
User Interface Description
Symbols are inserted on stacked layers on the design. The first layer is superposed over
the others; while the last layer is below all the others.
Sizing
Icon Command Description
Width Resizes all selected items horizontally.
2-36
User Interface Description
“Editing” Group
This command group is used to create and assign layers to components. This command
can also be used to find and select components.
The “View” tab contains the commands related to the display and the modification of
project properties, active document, or components. It is also used to modify the
displayed information on the diagram, the zooms and the windows.
This command group provides access to the project, active document or component
properties.
“Show” Group
2-38
User Interface Description
Once the display options are selected in the “Show” group (see Figure 2-41: “Show”
Group) different kinds of texts displayed on the diagram can be customized according to
user’s needs. The groups “Text”, “Line” and “Surface” located in the “Edit” tab allow the
user to modify characters’ fonts, colour or size or backgrounds and patterns.
References, Drawing Tools or Labels’ typography can also be modified via the project
properties under the category “Appearance”.
The user can also access directly the font window by double-clicking on the group’s name
after an assembly.
2-40
User Interface Description
There are two types of connections: Connection Ports and Contact Points. Connection
ports link two components and allow fluid transmission (air or oil) or electric current
transmission. Contact points put a sensor and a receiver in contact to allow a component
to influence the behaviour of another component.
Connection ports are represented by a circle which appears to the point of connection.
The colour of the circle indicates the state of the connection (connected or not).
Mechanical contacts are represented by a rhombus which appears at the contact point.
Contrary to the connection ports, the colour of rhombuses is not influenced by the state
of the connection.
Figure 2-45: Two Connection Types: Connection Ports (1) and Mechanical Contacts (2)
When two connections are stacked, they change colour to indicate that the link is
established, to quickly identify free connections.
To show or hide the connections: check or uncheck “Connection Ports” and “Contact
Points” in this group.
The display of the port names is a useful function when making a real assembly from a
diagram. In this example, this information is exact and immediate shows which are the
connections to be made.
To show or hide the connection ports names: check or uncheck the “Connection Port
Names” command in this group.
“Component” Group
2-42
User Interface Description
“Navigation” Group
This command group is used to navigate between hyperlinks inside the same or different
documents.
“Zoom” Group
This command group is used to modify the view size of the document page on the
screen.
“Window” Group
This command group is used to manage all open document windows in the project
explorer.
Window Organisation: In Automation Studio™, users can organize the display of projects
and their diagrams in various windows, optimizing the display of these windows while
designing and simulating projects.
2-44
User Interface Description
This feature is useful when working on complex circuits contained on large-size diagrams
or during the simulation of a project containing many diagrams. The following figure is an
example of a multi-window display of two different windows at the same time.
The “Window” group contains the commands related to the organization of the layout
and duplication of certain windows.
Icon Command Description
New View This command is used to create a different view on the
same document with its own zoom scale.
Close all This command is used to close all the windows of the
Window(s) current project.
Horizontal This command is used to display the various projects’
Tile opened windows horizontally, whether or not they are
active.
Vertical Tile This command is used to display the various projects’
opened windows vertically, whether or not they are active.
This tab contains the commands related to the simulation of a project or a diagram.
The simulation of a project or diagram launches the simulation engine that computes and
solves the selected portion of the drawn circuit, and responds to the behaviour and
animation of symbols.
2-46
User Interface Description
“Control” Group
This command group manages the activation of the simulation, from starting, pausing or
stopping, to the speed at which it is run.
“Mode” Group
“Conditions” Group
2-48
User Interface Description
“Measuring” Group
This command group is used to access to the dynamic measuring instruments and the
plotters.
these technologies.
“Troubleshooting” Group
This command group is used for simulation and circuit troubleshooting with realistic
measuring instruments.
This tab appears under the condition of the active document type. In the case of a
2-50
User Interface Description
standard document type, the tab is dedicated to specific fluid technology functions.
Please refer to the Hydraulics & Pneumatics Workshops guide for details on these specific
functions.
“Diagnostics” Group
This command group is used to identify the different error types or causes.
“Builders” Group
This command group creates a database containing hydraulic fluids, line type and
materials.
“Mechanics” Group
This group is used for mechanical simulations functionalities linked with fluid
components.
“Tools” Group
This command group is used to access specific tools according to the technology of the
active document.
“Standards” Group
2-52
User Interface Description
“Management” Group
This command group is used to manage projects, variables and messages generated by
Automation Studio™ while editing or simulating.
“Viewer” Group
This command group is used to create MP4 files during project editing or simulation. This
tool is useful to create didactic materials on Automation Studio ™ or explanations on a
system done in Automation Studio™.
2-54
User Interface Description
“Administration” Group
This command group is used to manage the application and projects rights, definition of
work standards and sharing.
“Update” Group
Update Components
When a new fix or a new Version of Automation Studio™ is released, if any modifications
have been made to a component simulation model, the component version number is
edited by Famic.
When a project opens or the update component tool is launched manually, a comparison
is made between the component version number in the Automation Studio™ database
and the same component version number in the Project. If it is a different version, a
dialogue box will appear with a list of all components for which an update is available,
and the option to update.
2-56
User Interface Description
It is recommended to keep the component library updated with the latest changes to
ensure project and simulation integrity.
Zone Description
7 Description Information (in English only) about the component updates
content.
8 Original Identifies the original component version prior to the update.
Version
9 Current Version Identifies the component version after the update.
10 Disable If checked, the system bypasses the automatic update when a
Component project opens.
Update
This toolbar is located at the top of the application window next to the Automation
Studio™ button. It is configurable to conveniently display commonly used commands.
2-58
User Interface Description
The arrow in the extreme-right of the bar drops down a menu of the following functions:
Command Description
Each of the commands in the customized toolbar appears with a checkbox to
temporarily remove the command from the bar. To remove permanently a command,
access the toolbar customization dialogue box.
More Commands… This command displays the toolbar customization
dialogue box, which is used to modify the contents
of the bar.
Show Below the Ribbon This command switches the customized toolbar
above or below the ribbon.
Minimize the Ribbon This command minimizes the ribbon.
Select the category, then the command in the appropriate lists; the “Current Keys” field
shows all the keyboard shortcuts currently associated with commands.
In the “Press new shortcut key” field, select the new shortcut to associate with the
command.
The key combinations are translated into character strings. For example, CTRL+F9
it will appear as Ctrl+F9.
The field under the “Press new shortcut key” is the combination of keys already
assigned to a command or not. In this last case, the “Assign” command must be
activated in order to assign the combination to the command. The new
combination will then appear in the “Current Keys” field.
The “Reset All” command is used to reset the shortcuts to the default commands
in Automation Studio™.
2-60
User Interface Description
The Diagram Editor’s contextual menus have been created in order to facilitate access to
commands within tabs. With the exception of a few commands created for specific cases,
all commands found in the contextual menus are in the tabs.
A contextual menu appears upon the right-click of the mouse when the arrow is over an
element on the diagram. The contextual menu displays a list of available commands.
Some commands are only available through contextual menus. They are neither accessed
in the tab, nor on the ribbon bar. These commands apply specifically to the selected item
or to the current context. Refer to the Guides to learn about specific contextual menus of
components according to technology.
Examples:
Function Description
Animated symbol
Animation This command applies to the components in the Diagram Editor
while in Simulation mode. It is used to open the window in order
to see the synchronized cross-section view of the component.
Setting Clicking on some components during simulation adjusts the
functional setting applied to components, such the pressure of a
valve opening. The component position or state can also be
modified. For example, making it a distributor, or shutting it off.
Symbol Area in the Library Explorer
Small/Medium/large This command applies to components in the Library Explorer. It
Icons modifies of the display size of the components within the
symbols library window.
Function Description
Rename This command applies to new components, libraries and
categories in the Library Explorer, and to projects and diagrams
in the Project Explorer. It is used to change the name of selected
elements. Therefore, it is possible to rename documents and
work tools according to specific needs.
The status bar shows descriptions of the selected menus and commands for all the
utilities. It contains information cells which indicate the Simulation or Edit application
modes, and the status of particular keys such as CAP, NUM, and SCRL. It also indicates the
position of the cursor on the diagram.
2-62
User Interface Description
Right-click on the status bar to display the contextual menu with the option to add
and remove sections of the status bar.
To optimize the workspace, floating windows can automatically roll up (minimize): when
the mouse cursor is not on the window, the floating point is minimized to its title bar. To
unroll (maximize), hover the mouse cursor over the window’s title bar.
This function is activated and deactivated by clicking on the pin in the title bar of the
floating window.
Pin Description
Does not allow the utility window to roll. The window is always
completely open.
Pin Description
Allows the utility window to automatically roll. When mouse cursor moves
away, only the title bar remains visible.
Window Docking
When repositioning a floating utility window in Automation Studio ™, a ghost window and
positioning arrows appear. When the window hovers over one of the arrows, the ghost
window displays the positions where the window would anchor to the screen, if the
mouse click were released at that moment.
Note that the pins remain operational even if a utility window is docked.
To undock a floating window, drag and drop it out of its docked position.
2-64
User Interface Description
The first four Properties windows can be opened using the “View” “Properties” group
commands of the ribbon. The properties window can be opened from the Project Explorer
Window.
The Document, Component, or Report Properties window can also be opened from
the contextual menu when the mouse cursor is on the appropriate element.
These windows are composed of a tree view on the left and of a “Data” zone on the
right.
or
2 Tree View The tree view is used to navigate through the different groups
of properties.
3 Data The content of the Data zone is determined by the selected
group of properties in the tree view.
The categories consist of component properties. Click on “Show Details” to view the
details of the component properties, which appear in the lowest part of the “Data” zone.
The default name of the property can be changed in the Alias field, according to specific
needs.
Display the property name (or alias) and its value directly on the diagram by checking
one of the first two checkboxes, or in a tooltip by checking the third box.
2-66
User Interface Description
The Library Explorer contains the main Automation Studio™ libraries and allows the
management of custom libraires. The main library contains all the generic component
symbols for hydraulics, pneumatics, electrical controls, etc. These components are
organised by workshop. All of these generic components have default values, unlike the
catalogue components contained in the manufacturers catalogues. The user must modify
the library component parameters in order to model a system.
The Library Explorer can be opened with the following command: “Home”
“Components” “Library Explorer”, or by the F9 function key.
The library is arranged in a tree view, through which the user can navigate by opening
and by selecting branches. The available component symbols in the currently selected
branch appear below the tree view. The standards available for the selected component
are shown below the symbols. A component can be inserted into a compatible document
by simply dragging it onto the page. The following diagram shows the general outline of
the main library.
2-68
User Interface Description
Area Description
3 Library Tools specific to the currently open library, namely the search
Functions filter and standards and display configuration.
4 Library Tree- Used for navigating across different specialised workshops such
view as hydraulic, pneumatic etc. by expanding branches and sub-
branches. Each type of library contains the components
associated with that type.
5 Location Indicates the current level in the tree structure, making it easier
to navigate: clicking on the previous level goes up to that level,
and clicking on the arrow between two levels gives access to
other locations at the same level.
6 Sizing of Opens a slider which can be used to change the size of the
symbols symbol previews in the library.
7 Components Used to display and select the desired component.
area
8 Standards Displays all the available standards for the symbol currently
area selected in the symbols area. The button “Hide Standards” can be
used to hide this area in order to simplify the interface, as shown
in the image on the right of figure Figure 2-79: Areas of the
Library Explorer.
Within each workshop of the main library, the symbols are grouped by category and sub-
category. Two types of display are possible (see section 2.2.3.3 Library Functions for
more details).
2-70
User Interface Description
Standards
Many of the components in the library are available under different standards. For each
group, the first components shown are those available in the standard selected for the
workshop, followed by the symbols from other standards. If a symbol is from another
standard, this is indicated below the symbol.
Figure 2-80 Grouping which contains one Symbol from the default standard for the Workshop
and one Component from another standard
Figure 2-81: Electrotechnical Workshop using the IEC Standard with the Standards Area
Hidden
Inserting Components
Components can be inserted from the components area using the default standard for
the workshop (see Configuration section for more information on standards), or from the
standards area to select the same component but with a representation (or symbol) from
a different standard.
2-72
User Interface Description
Figure 2-82 Inserting a Component from the Components Area or from the Standards Area
It is possible to select multiple components within a library folder using the CTRL and
SHIFT keys and to insert all of the selected symbols in one operation. The components
must be selected in the components area, so the symbols will all be from the default
standard for the workshop.
Figure 2-83: Selecting Multiple Components and Inserting them into the Diagram
Function Description
Search filter Used to filter the library tree-view. The
wildcards (*) and (?) can be used.
Configuration Used to configure the standards for the
display of the components in the
different workshops.
Search Filter
This field can be used to filter the library using the entered text so as to find the desired
component more easily.
The asterisk (*) and question mark (?) wildcards are supported by the filter.
As soon as text is entered into the filter, the tree view will show all of the branches
which contain symbols which satisfy the search criterion. The symbols contained in each
branch are also filtered.
2-74
User Interface Description
The filter is available for the default library containing the generic components as well as
for custom libraries, created with this version of Automation Studio ™, which have the
extension PRLX.
Note that when opening a PRL library (older library format), Automation Studio™
will ask to convert to the PRLX format, which will make the search function
available.
Configuration
The “Configuration” dialogue is unique to the main library and allows the control of the
structure and display of the different symbol standards available.
Function Description
1 Can be used to hide or display completely a library workshop
2 Used to hide or show the name or the reference to a standard beside
the name of the workshop.
Examples
In the following figure, the standard ISO 1219-1:2012 is selected as the default for the
Hydraulic workshop, as shown by the name of the workshop. The symbol shown in the
components area is therefore the symbol which respects this standard and the standards
area shows all of the standards which are available. Additionally, the symbols from each
standard use the colours chosen in the configuration.
2-76
User Interface Description
Figure 2-87: Symbol Shown with the Available Standards using Different Colours for Each
Standard
When a component is not available in the default standard, it is in a grey square in the
components area and the available standards are still displayed in the standards area. For
these components, the name of the standard is displayed.
Figure 2-88: Components not Available in the Selected Standard for the Workshop
It is also possible to hide or show all of the components of a given standard within a
workshop. This has the effect of filtering the library components and branches. In the
following figure, the standard ISO 1219-1:1991 is hidden in the Hydraulic workshop:
2-78
User Interface Description
When the “Display of similar components in the components area” is activated, the
groups are displayed as folders in the components area and one symbol is shown as a
representative for the folder. When deactivated, similar components are grouped as sub-
branches in the tree-view.
Figure 2-91: Display showing the Grouping of Similar Components with a representative
Component in the Components Area
2-80
User Interface Description
When the “Display of similar components in the components area” is activated, a radio
button is available to select which symbol will be the representative.
Additionally, with this display mode, the representative of a folder can be directly
inserted into a drawing by dragging it either from the folder in the components area or
from the standards area.
Merging Workshops
The following figure shows the Electrotechnical workshop shown as three workshops,
one workshop per standard, followed by an image of the same workshop with the
components grouped.
2-82
User Interface Description
a) b)
Figure 2-95: Electrotechnical Workshop Divided in 2 Equivalent Workshops (a) and Merged
(b)
When the workshop is merged, its contents are available through the different standards
in the standards area and the options such as choice of default standard colour for each
standard are available. When the workshops are not merged the equivalent symbols are
nonetheless available in the standards area.
Colours
Non-Standard Symbols
As well as the standard symbols which are available in the different workshops, there are
also some library symbols which are not standardized. In some cases, the appearance of
the symbol is taken from a reference publication which is not standardized or is based on
the commonly used manufacturer symbols. These types of symbol are classified as
“No Standard”. For example, the following figure shows a symbol respecting the
standard ISO 1219-1:2012 as well as another non-standard commonly used symbol.
2-84
User Interface Description
Some other symbols have a single representation which doesn’t belong to any standard.
These are symbols which by their nature must appear regardless of the standards filter
configured for the workshop.
If you click on the icon to open a new library, the browser opens a window where
you can select a custom library from amongst the Automation Studio existing libraries.
For a new installation of Automation Studio ™ (6.3 for instance), the standard path is:
C:\ProgramData\Famic Technologies\Automation Studio P6.3\Libraries. For an upgrade
from Automation Studio™ 6.1 to 6.3, the path from 6.1 will be kept:
C:\ProgramData\Famic Technologies\Automation Studio P6.1\Catalogues and Libraries.
Here we find components with older configurations and curves (these libraries contain
the expression “Previous Modeling”) and also some more recent components (these
2-86
User Interface Description
libraries begin with the word “Manufacturer”). See the figure below:
The user can also add components to a custom library by dragging and dropping a
symbol from a schematic to the components area of the library window.
In the main library, the contextual menu for the tree-view gives the following options:
For custom libraries, the context menu in the tree view of the library explorer provides
the same functions as the toolbar
This contextual menu is available in the component area of the Library Explorer.
3 Shows the help window at the section concerning the Library Explorer
In the case of a custom library, the component’s contextual menu gives the option to
rename or to delete the component.
2-88
User Interface Description
The Project Explorer controls all functions related to the management of opened projects
and their documents. The toolbar and contextual menus make it easy to create, view,
save, send, simulate and print a document.
In multi-user mode, the Project Explorer provides information on the status and uses of
opened projects and documents by the other users. Herein, the term “Team Work” is
used to identify the functions of the multi-users mode. Disregard these functions if only
using the single-user mode.
Zone Description
two view modes: simple and detailed (see below). On the
right of the status bar, the and icons are used to
open and close the tree view detail.
The Toolbar Commands section below describes the
available commands.
2 Tree View The tree view is used to see the hierarchic structure of the
projects, documents, views, etc. For each of these
elements, the tree view also provides useful information in
the form of icons. (See section Tree View Icons below.)
Right-click on the entity to open a contextual menu that
differs according to the type of the entity. For more
information on the contextual menu, refer to Contextual
menu Commands.
Double-click on the entity to (according to its type):
● Open and close projects, files or documents to
several views.
● Load the selected document.
● Start the simulation with data (see section 8.4.1
Snapshot of a Circuit State).
● Open the plotter with data (See section 8.4.2.4
Measurement Data Management).
The tree view offers two view modes:
● Simple Mode: Only the “Name” column is
displayed.
● Detailed Mode: The columns are displayed. See
section Tree View Columns below.
3 Status Bar The Project Explorer status bar displays certain information
according to the selected entity:
2-90
User Interface Description
Zone Description
● Connected user’s name.
● Settings’ information for the selected entity. This
information can be selected by user from the
configuration window. (See section 2.2.4.2 Project
Explorer Configuration Window).
All the entities can be moved or copied in a same project or in a different project
by a Select-Drag-Drop. The copy is done by a Select-Drag-Drop with the CTRL key
pushed.
Toolbar Commands
A right-click on the toolbar displays a contextual menu with the option to change the
commands displayed in the bar. The “Configure” command in the contextual menu opens
the configuration window (See section 2.2.4.2 Project Explorer Configuration Window).
It is also possible to select the commands to be displayed in the toolbar using this
configuration window.
A tooltip associated with the toolbar’s icons offers details about the command.
Command Description
Close Project Closes the selected project.
Close All Projects Close all selected projects and ask to save all them
or not.
New Standard Diagram Opens the dialogue box to start a new diagram
model.
New One-Line Diagram Opens the dialogue box to start a new one-line
electrotechnical diagram model, if applicable.
New Connection Diagram Opens the dialogue box to start a new connection
diagram model.
New Sequential Function Opens the dialogue box to start a new SFC model, if
Chart (SFC) applicable.
New Web Page Opens the dialogue box to set parameters for a new
Web Page.
New link to External Opens the dialogue box with options to set the link
Documents to the external document.
2-92
User Interface Description
Command Description
Update Documents Opens the dialogue box to select documents in the
(Team Work) current project to update that have been modified
outside of Automation Studio™.
Save Documents Open the dialogue box to select and save
documents in the current project.
Project Print Preview Opens the dialogue box to select and preview
documents in the current project.
Each item has three icons that display the following information:
1. First Icon
● Authorization to simulate the document
● Selection of objects for simulation
2. Second Icon
● Reading/writing authorization
3. Third Icon
● Type of object
● Status of object: open /closed
● Synchronized state in Client mode: up-to-date /not up-to-date
1st Status (Team Work)
Icon
Project/Folder (all documents are selected and authorized for simulation)
Or selected document authorized for the simulation.
Project/Folder (at least one document not selected and all documents
authorized for the simulation)
Or Document not selected and authorized for the simulation.
Project/Folder (at least one document not authorized for the simulation)
Or
Document not authorized for the simulation.
2-94
User Interface Description
Folder
Document View
Standard Diagram
Process Diagram
3D Mechanical Diagram
SFC
Web Page
Mechanism
The commands in the contextual menu correspond to the selection. Most of these
commands can also be accessed from the toolbar.
The “Send To” command opens an email containing the selected project as an attached
document. Email software must be correctly installed and configured.
2-96
User Interface Description
The “Add Document View” command creates a new view of the document.
This menu offers the possibility to close a document view. In this example, the view will
continue to exist but it is closed. A document view can also be deleted.
The command “Add a Viewer for this Mechanism” is available only for the contextual
menu of a Mechanism and is used to open a window to view the selected mechanism.
In detailed mode, the tree view can display different columns, customized by the user:
Right-click on a column header to display the contextual menu and switch to the simple
display (one column only). The “Options” command in the contextual menu opens the
configuration window (see section 2.2.4.2 Project Explorer Configuration Window).
The rest of the available columns correspond to the properties of the project, the
document, the view, etc.
If the columns “Write”, “Read”, “Simulation” are selected by the user, they will
only be displayed if Automation Studio is in Client/Server mode. If Automation
Studio™ is in Single Station mode, these columns will not be displayed.
2-98
User Interface Description
Using the Configuration Window
Use the and arrows to move the selected element(s) from the “Available”
to the “Selected” zone, and vice versa.
Use the and double-arrows to move all elements from the “Available” to
the “Selected” zone, and vice versa.
The and arrows are used to move a selected element in the “Selected”
zone in the upper or lower position respectively.
Once the configuration is done, activate the command to save and exit the
configurator. Use the command to cancel all modifications.
A document with a standard diagram type can have many views. Views are used to
display different areas of a single diagram without the need to zoom, pan or resize the
window. While the diagram is being drafted, it might be useful to have a unique view,
but when the system is done, the views are the best way to get the global picture of the
system in a snap.
For example, if a system has a hydraulic circuit, electrical command circuit, a control
panel and many animations, create a view for each of the following: the hydraulic circuit
split into functions, the electrical circuit, the control panel and every animation. It is
easier to navigate through these views instead of moving into a single window. The
management of views greatly facilitates the communication and team work among the
project’s contributors.
View Creation
When a document with a standard diagram type is created, a document icon with its
name and a sub-document “View1” appears automatically in the Project Explorer tree
view.
Create as many views as needed. To create a view, select “Add View” from the
contextual menu of the document, then a second view with the default name “View2”
will appear.
2-100
User Interface Description
View Properties
A view is characterized by the properties that control the appearance of the view (See
section 2.2.2 Properties Window).
Many of these attributes can be modified using a script that displays a control
2-102
User Interface Description
panel when needed. This makes it possible to use a single project to create
multiple scenarios for training purposes.
Refer to the Catalogue Manager Guide. Famic Technologies Inc. offers its customers to
download manufacturer’s catalogues through its client portal (Technical Support section
of the Automation Studio™ website). These catalogues are accessed from the Catalogue
Manager. Open the Catalogue Manager by the “Home” “Components” group in the
ribbon.
The Catalogue Manager is a separate and external module of Automation Studio ™, but
can only be launched within this software. For further information on catalogues, refer to
the Catalogue Manager Guide.
The Variable Manager is the utility tool that monitors all status communication between
variables and components, regardless of whether they are within Automation Studio™ or
external communication through OPC.
To open the “Variable Manager”: Select “Tools” Tab “Management” Group “Variable
Manager” or press the F12 function key.
2-104
User Interface Description
Zone Description
4 OPC Server The OPC Server management tree corresponds to user’s
Management Tree rights. Refer to OPC Module User’s Guide.
Zone
5 Page Tabs The following tabs are available:
“Variables” tab: to display the variables.
“Custom Filters” tab: to manage the custom filters
displayed in the variables management tree zone.
“Custom Selections” tab: to manage the custom
selections displayed in the variables management tree
zone.
“Custom Types” tab: to manage the custom types
displayed in the variables management tree zone.
“OPC Client” tab: refer to OPC Module User’s Guide.
“OPC Server” tab: refer to OPC Module User’s Guide.
6 Selected Page According to the selected tab.
7 Status Bar Shows the number of found variables, followed by the
number of shown variables.
Toolbar Commands
Right-click on the toolbar to display a contextual menu that can switch the command in
the bar. The “Configure” command in the contextual menu opens the configuration
window (See section 2.2.6.2 Variable Manager Configuration Window).
A tooltip associated with the toolbar icon provides more details on the command.
The button provides access to commands that are not displayed in the toolbar.
2-106
User Interface Description
“Variables” Tab
The Variables tab has 3 zones:
Zone Description
3 Details Zone
Display the details of the selected variable.
The choice of columns in the Variable List is customizable: right-click on a column header
to access the contextual menu option to switch the display of a column. The “Configure”
command in the contextual menu opens the configuration window. (See section 2.2.6.2
Variable Manager Configuration Window).
The selection of displayed columns can also be done in the configuration window.
Double-click on the vertical separation of the column to adjust the width of the
column.
2-108
User Interface Description
Name Description
Internal Link to an internal variable (Assignment between variables that are
Variable Link internal to the project).
Location Location of the variable. It can belong to the project, one of its
document or one of its inserted components.
Measure Measurement of the variable.
Name Name of the variable. It cannot be changed.
The “Name” column displays a tree view of the variables in relation
with the selected filters: custom filters and tool filters. Filters only
apply at the first level.
The name of a type of listed variable is preceded by the icon. The
name of a structured variable or of an array is preceded by the
icon or icon and is displayed in a tree view (there can be several
levels).
Plottable Checkbox to verify whether the variable can be plotted.
Precision Number of decimals to display in the value of the variable.
Style Display format (Decimal, Binary, Hexadecimal, …), for DINT type
variables only.
Type Type of variable (conform to the IEC 1131 norm).
Unit Unit of the given variable.
Value Value of the given variable.
User Translated If this attribute and the customized translation option are selected,
Text Value the variable’s value will be translated according to the existing value
displayed in the table of the translation manager.
Select multiple variables simultaneously by using the CTRL key to select non-
consecutive items or SHIFT to select consecutive items.
To add a variable: Click on the icon of the toolbar and complete the fields of the
“Add variable” dialogue box.
Once the variable is added, set other parameters in the variable details.
2-110
User Interface Description
A new variable is automatically filtered by the active “Custom Filters” and by the
active “Custom Selections” and also by the local filter.
To delete a variable: Select the variable in the “Variables” tab and click .
To modify a variable: Select the variable in the list to access the details of the variable
in Details Zone at the bottom of the window.
Custom filters are used to filter the variables displayed in the “Variables” tab. Once
created, the filter is displayed in the Variables Management Tree View zone and can be
applied.
The filter is created and can be renamed via the contextual menu.
The checkbox preceding the custom filter indicates whether the filter is activated or not.
To modify a filter, select it in the Variables management tree view, and go to the
Custom Filters tab.
Click on the button to add a condition to the filter, and modify the filter’s conditions
by the three drop-down menus at the bottom of the screen.
When adding a new condition, the filter applies the conjunction (“AND”) by default
with the previous conditions. Click on the “AND” to choose another logical
operation.
The Custom Selections are used to filter the variables displayed in the “Variables” tab.
Once created, the selections are listed in the “Variable Tree View” zone and can be
2-112
User Interface Description
applied.
The principle of the Custom Selections is to modify the “Variables” tab to show the
variables of the project that are specific to the needs of the user.
Right-click on the “Custom Selections” in the variables management tree view, and
choose “New Selections”, etc.
The “Custom Selections” tab displays all the variables: simply make the
appropriate selections. For multi-selection, use SHIFT and CTRL.
To modify custom selections, select the options in the variables management tree
view, and go the “Custom Selections” tab. Modify the selection of variables.
Create custom types of variables: Enumerations, Structures and Arrays. Once created, the
custom type can be used with a variable.
This tab is used to edit the custom type. There is one control per custom variable type.
To create a custom type, right-click on one of the three types under “Custom Types” in
the Variables management tree view, and choose “New T type…” (T is the type name
that is chosen).
Finally, activate the command to accept and validate the new type. This entry will
appear under the appropriate type in the variables management tree view. It can be
renamed via the contextual menu.
2-114
User Interface Description
The configuration window sets the parameters of the Variable Manager. The elements
that can be set are:
● The commands to display in the toolbar.
● The columns to display in the variables list of the “Variables” tab.
● The displayed information in the tooltip appearing when the mouse is on a
variable in the “Variables” tab.
● The displayed attributes in the toolbar.
The icon is used to access the configuration window, if it is displayed in the Variable
Manager toolbar. Otherwise, right-click in the toolbar to choose the “Configure”
command in the contextual menu.
The use of the configuration window is already described in section Using the
Configuration Window.
In the configuration window, you can for instance add the commands required to
connect to an OPC server.
It is possible to find that a circuit is not behaving as intended. Assuming simulation has
not solved the problem, use the Variable Manager for updates on the state or value of
variables. It will help to identify the components and variables that are not behaving
properly.
Importing Variable(s):
:
Figure 2-121: Variable Importation Dialogue Box
3. Choose the file that contains the variables for importing from the file selection
dialogue box that appears.
Exporting Variable(s):
1. Click on the (“Export variable(s)”) icon, if it is displayed in the Variable Manager
toolbar; otherwise select it from the contextual menu of the toolbar.
2. Follow the steps of the windows that open.
If the icon is grey (by default) , it means that the variables you want to export are not
checked in the list under the column “Exported” . This is mandatory to display the
export tool in blue. The tool is compatible with many extensions for the export.
The Accessory Manager is used to create, and manage accessories for standard,
electrotechnical and one-line circuits in every project that is open.
2-116
User Interface Description
components”.
The accessories list presented in the window can be updated using the button that is
accessible through the dialogue toolbar.
This tab lists all the components labelled “Accessories” of a project in table form. Each
line is a unique item of the project.
In the toolbar, the delete button ( ) cancels “Accessory” labelling for a component. To
filter the variables, select the column to filter in the drop-down menu, enter a value in
the adjacent field, and then choose one of the two options: “Filter” or “Mark”.
The functions that add, move and create links with the parent components are described
further in section 6.5 Accessories Management.
2-118
User Interface Description
“Accessories without Symbol” Tab
This tab is used to create and list templates of an accessory without a symbol that can be
used to create copies (instances) that will be linked to components of the project or
linked globally to the project. An accessory model without a symbol will contain basic
properties and may contain customized properties. These properties can be edited at the
bottom of the tab similarly to data of any component.
Toolbar:
Icon Name Description
Add an Accessory model Adds a new template in the list of accessories
without Symbol without symbol.
Delete an Accessory Deletes an item from the list of templates of
without Symbol accessories without symbol.
“Associations” Tab
This tab comprises a list the associations between the accessories and components of a
project. These are the accessories associated with a parent component (a product or part)
or with an open and active project.
2-120
User Interface Description
Column Description
located.
Parent Identifier Value of the identifier of parent component linked to the
accessory.
Quantity Total number accessories. For accessories with symbol,
this field cannot be edited. For accessories without
symbols, this field can be edited.
Unit Price Cost price of one unit of the accessory. For accessories
with symbol, this field cannot be edited. For accessories
without symbols, this field can be edited.
Discount (%) Percentage value of the rebate offered on the accessory.
For accessories with symbol, this field cannot be edited.
For accessories without symbols, this field can be edited.
The Layers Manager is used to create various layers in standard and electrotechnical
diagrams (not available for SFC).
Access the Layers Manager via Ribbon: “Edit” “Editing” “Layer Properties” in the
ribbon or press F5.
The creation of layers can be very useful when inserting many elements into a diagram.
It allows the user to define layers according to the different elements’ types. Being able
to activate or deactivate certain layers for simulation provides another tool for validating
system function behaviour.
Each layer is independent. Selecting one makes it the active layer. Any inserted
component automatically goes onto the active layer.
The Figure 2-126: “Layers” Manager Window shows an example of layers definition. It
shows hydraulic components, drawing objects and text zone layers. It is possible to hide
some layers or even block them for editing considerations, or to facilitate visualization
and manipulation of specific objects.
Here, the “Hydraulics” layer is selected, so it is visible, unlocked and active. It means that
the inserted objects are assigned to this layer. The “Drawings” layer is visible but
protected whereas the “Texts” layer is hidden.
By default, the maximum number of layers for each diagram is eight. This number
can be modified in “Project Properties” “General Standards” “Layers”.
2-122
User Interface Description
Zone Description
Locked Indicates whether the layer is locked or not.
Command Description
Add a new layer.
The user can filter according to the layer’s name, order or description.
Only layers that matches the filter are displayed in the list for the user to quickly visualize
it.
Clicking on any of the column headers (Name, Order, Description) sorts the layers by that
column. Furthermore, if the layers are sorted by a column and an attribute is modified in
this column, the list is automatically reordered.
Selecting the option “Preserve links and Detect Connectors” allows the user to connect in
editing mode components located on unlocked layers with components located on locked
layers.
This option is also used to keep the connection between components. If it is not selected,
connected components located on locked and unlocked layers will be disconnected when
displaced.
This option is deactivated by default. Please make sure to select it in the project
properties if needed (General Standards → Layers → Edition)
2-124
User Interface Description
When placing an element, either from the library or from another diagram, make sure
the desired layer is activated and unlocked before placing the element onto the diagram.
If the element is already on the diagram and you want to place it onto another layer, you
can simply select it and drag-and-drop it directly onto the layer manager on the desired
layer.
To move elements from one layer to another, there are three methods:
● Using Drag-and-Drag as shown above. The layer must not be locked or invisible.
● Using Cut-Paste: Cut the component (CTRL + X), select the desired layer in the
layer manager, click on an empty zone in the diagram and paste the component.
The layer must not be locked or invisible.
● Open the “Component Properties” dialogue box of a component or group, and go
to “Displayed Information”. The layers can be selected and modified in the drop-
down menu.
If components that belong to different layers are grouped, the group and all its
components then belong to the active layer. If they are ungrouped, each
component returns to its initial layer. The satellites, which are the displayable
properties of a component, belong to the same layer as its corresponding
component.
Layers Simulation
Any layers for which the “Simulation” attribute is not selected will be hidden during
simulation and the simulator will not consider the components on these layers. When the
simulation has terminated, the visibility will revert to its previous state.
Selecting the option “Allow Setting of Components in Simulation” makes available the
setting of component properties in simulation, even though this component is on a
locked layer. The cursor placed over the component takes the form of a hand.
This option can be activated and deactivated in the project properties → General
Standards → Layers → Simulation.
2-126
User Interface Description
Layers Variables
Each layer, when created, generates a visible Boolean variable (“Hidden Layer1”, “Hidden
Layer2”, …) in the variable manager. These variables are “True” when the corresponding
layers are visible. They are compatible with all Boolean variables and can therefore be
used in simulation: for example, objects can be placed on a layer which can be visible or
invisible according to specific events.
The Translation Manager handles all user displayable texts in a project (tooltips
and properties).
The texts management and their display language can be defined via the “Translation
Manager” located in the “Tools” Tab → “Management” Group.
The Translation Manager is used to manage the translations of texts displayed in multiple
languages and save them to a local dictionary within a project. The texts can be also
First Steps
In order to be able to translate the desired texts in other languages, the best practice is
to follow these few steps:
1. Make sure that the checkbox in the Translation Manager is active;
2-128
User Interface Description
Figure 2-134 : Example of User Translated Text and Alias Option in Component Properties
4. Click on the text value, and then click out of the box. This manipulation will add the
term to the translation table and see suggestions of existing translated texts;
This way it is possible to create a project’s dictionary and, if needed, import its content to
other dictionaries or to the global User Translation Database.
To use the Translation Manager, texts should have already been entered by the
user.
The User Translation Database is a global dictionary in which the translations from
different projects’ dictionaries can be integrated. The opposite is also possible: the user
can transfer translations from the global database to a specific project, reusing this way
the previous translations and not having to redo the work each time.
These commands are used to save, synchronize and transfer translations from a database
to another.
Symbols Name Description
Save database This button allows saving the User Translation
Database. Once the latest changes have been
saved, the icon turns grey: .
Synchronize database In the case that the Global Translation Database is
located on a network drive or it is remote. This
button allows synchronizing the User Translation
Database with the local project database.
Transfer Dictionaries This button allows transferring a database. It
opens the window Figure 2-137: Database
Transfer Window where the user can choose
which database is the source and which is the
target one.
Import Dictionary This button allows importing a database from a
.csv file.
2-130
User Interface Description
When importing or exporting a .csv file is needed, in order to preserve the special
characters the .csv file needs to be coded in Unicode format.
When saving a file as .csv in Microsoft Excel a Unicode format file is not created by
default. The user has to save the file as “Unicode Text”, and then modify manually
the .txt extension to .csv.
In this window, the source and target database are defined to transfer the selected
terms. The following combinations are:
● Transfer from a local project database to the global User Translation Database;
● Transfer from the global User Translation Database to a local project;
● Transfer between two project databases.
Once the source and target databases are defined, the translation processing transfer
table opens.
Note that the pink colour indicates a difference between the source and target
dictionary terms. In the example above, all terms are highlighted in pink because
they do not exist in the destination dictionary.
Zone Name Description
1 Search and filter Allows to search and filter in the language
selected via the button.
The drop-down menu
determines the comparison language. Depending
on the selected language, the diagnostic will
return different results.
2-132
User Interface Description
● No operation .
6 Operation on one cell The following actions can be performed on one
specific cell:
● Update target text from source text;
● Keep target text.
The user can decide if the target text has to be
replaced by the source one or will be kept as it is.
7 Legend The mark on a cell means it is the first
inserted text or the one used as reference for
other translations (see “Reference language” in
the “Translations” Tab section).
Pink colour indicates a difference between
the source and target dictionary terms.
Green colour indicates that the action has
been modified by the user.
8 Apply The button apply approves the transfer
process and run the term transfer to the
destination dictionary.
“Languages” Tab
In the translation manager “languages” tab, the user can enable or disable different
translation languages and choose which are the input language and the display language
depending on the case.
2-134
User Interface Description
The input language is the language under which all new terms will be placed and is
automatically defined as reference language for them. The tool uses this language while
the user is typing to search if the new text already exists in the user translation database
or in the local dictionary. If any correspondence is found, the input control will suggest it
to the user in order to minimize the work needed for translation.
Figure 2-140 : Input Language and Similar Terms while Creating a New Term
The display language is the language in which texts will appear on the diagram. It gives
the user the possibility to change the project visualisation language. To display the same
project in a different language select the corresponding mark under the “Display
language” column.
“Translations” Tab
Once the languages are defined, the translation table under the “Translations” tab shows
2-136
User Interface Description
a column for each language. In this table, translations can be inserted and modified. The
mark appears on the term called “reference language”. The right pannel allows to
identify where in the project a term is used: it has to be resyncronized to find all the
present associations.
The reference language is by default the input language when the text was first
entered into a dictionary. It is meant to represent the best text to use as reference for
translations.
Supported Texts
Use the following procedure to use the translation manager in the title block:
2-138
User Interface Description
standards database.
Managing links and communication protocols is possible from the ribbon bar “Tools” tab,
“Management” group and by clicking on “Communication Manager”.
The communication manager allows the user to configure functions related to the
communication protocol to create interactions between external devices and application
TM
functions of Automation Studio .
Step by Step
4. The “OPC Client” Tab allows to access to the configuration functions of an OPC
Client;
2-140
User Interface Description
5. Click on “OPC Server” tab to access the OPC Server configuration functions;
7. Click on the arrow next to “CAN J1939” branch to open the communication tree;
8. Click on the arrow next to “OPC Client” in the upper left corner of the window to
reduce the communication tree;
9. Click on the upper left corner arrow to hide all communications tree;
2-142
User Interface Description
10. Click again on the upper left corner arrow to expand all communications tree
again;
11. Move the central slider to enlarge or reduce the size of the communications tree
in the window;
12. Move the horizontal sliders to resize the sections of communications tree.
There are pictures for various hydraulic, pneumatic and electrotechnical components in
the main library. The image window displays these images both in edit and simulation
mode. Open the window via “Tools” “Viewer” “Photo” , or use the F4 key.
2-144
User Interface Description
Display Image zone. If an image does not exist, this window does
not appear.
This window gives a list of events for the user to gain information about the totality of
errors occurred.
If the Message Explorer is not open in Automation Studio ™ and an error occurs during
Simulation, a red flag blinks in the ribbon. A dynamic windows pops up also
automatically when the software finds some errors.
These errors may appear as warnings (alerts). For example, if components are not
connected when the simulation is launched, the message window will show the numbers
of the free ports causing the error in the simulator. A list of all the components
concerned appears in the message window.
The message window displays the diagnostics results launched from the tab of each
technology. Refer to each specialized workshop guide.
Double-click on the appropriate row to launch the display of the component in the
diagram.
2-146
User Interface Description
The message window is simple to use. Advanced functions are available when working
in Team Work mode.
Toolbar Commands
command in the toolbar. The “Configure” command in the contextual menu opens the
configuration window. (See section 2.2.12.2 Message Explorer Configuration Window).
Select the commands to appear in the toolbar via this configuration window.
A tooltip associated with the toolbar icons gives more details on the command.
The button is a drop-down menu of the commands that are not displayed in the
toolbar.
List of Messages
The header of the list of messages window can be used to filter the messages: choose
the column to filter in the drop-down menu, enter a value in the adjacent field, and then
select one of the two options:
● “Filter”: to filter the list.
● “Mark”: to highlight the messages satisfying the entered criteria.
Choose the columns that will appear in the toolbar via this configuration window.
2-148
User Interface Description
Status Bar
Attribute Description
Nb events Displays the total number of events in the list.
Nb Filtered Events Displays the number of filtered events in the list.
The Configuration Window is used to set the parameters of the message window. The
elements to configure are:
● The columns of the list of messages.
● The commands displayed in the toolbar.
● The items displayed in the status bar.
To access the configuration window, click on the icon, if it is visible in the messages
window toolbar. Otherwise, choose the “Configure” command (available when right-
clicking on the toolbar).
The use of the configuration window is described in the section Using the Configuration
Window.
When the design and drafting of a circuit is done and the system is put into work, it can
be useful to evaluate consequences of some failures on selected components. In fact, it
is possible to create failures and analyse the effects on the system with the available
failure builder module in Automation Studio™.
2-150
User Interface Description
When failures are declared in a component, there are three ways to activate them during
simulation:
Manually, by defining and activating the failure from the component properties dialogue
box.
By setting the variable to TRUE in a SFC diagram, control panel or any command
workshop. This is used to create failure activation scenarios for specific systems.
Automatically, when a limit value is reached – knowing that a failure usually occurs
when a parameter limit is exceeded (e.g. If a maximum pressure (P max) is reached on a
component connection port 1, then an external leak is triggered on port 1). For this
automatic failure trigger, the global automatic failure (project) or local automatic failure
trigger (component) option needs to be activated.
The automatic failure trigger does not require the “Failure activated” option to be
set to TRUE.
In the main library, most of the fluid power and electrotechnical components have a
Troubleshooting branch that can be accessed from the component properties dialogue
box. Specific failures are already defined, but generic failures must be manually added.
This dialogue box is used to create, declare and set failures for a component.
2-152
User Interface Description
Zone Description
5 Automatic The list of properties in this zone is used to trigger the working
Failure Trigger limits of the component at different levels. Selecting one or
many of these properties for the failure will automatically
trigger the failure if the limits are exceeded.
“Failure local activation” is used to automatically trigger the
failure for this component. This checkbox must be selected in
order to locally implement the automatic failure trigger.
The local checkbox can be overridden by the “Global automatic
failure” option, which will activate all the automatic failure
triggers if at least one item in the automatic failure trigger
parameter is checked and the failure is defined.
The “Global automatic failure” trigger option can be activated from the Automation
TM
Studio menu “Project” “Project Properties” and go to the section “Project”
“Properties” “Simulation” section “Automatic Failure”.
A diagnostic utility tool has been created to easily find which components have defined
failures while editing. This tool provides a list of the components with one or more
failures defined. For each component, each defined failure is shown in the list indicating
if the failure is going to be activated at simulation start. The components listed are
shown in colour with a hyperlink (the Message window provides access).
When creating a generic failure using the command, a configuration dialogue box
opens. There are between 1 and 4 types of failures to choose from, depending on the
selected component. For fluid power components, these types are: internal leak, external
leak, restrictive port, blocked port. For electrotechnical components these types are:
internal electrical leak, external electrical leak, restricted connection, severed connection.
The type “internal leak” is only possible when the passage is supposed to be
blocked.
The type “external leak” is only possible when there is normally no leak out of the
component under normal operating conditions.
The working standards are used to modify some options of a project. By sharing
2-154
User Interface Description
standards within the company, there is a common ground and standard operation
concerning drawing rules, components and document naming, etc.
The “Standards Transfer” dialogue box is used to transfer standards from one project to
another or, from a project to the Enterprise Standard Data Base.
To access this dialogue box, activate the following command: “Tools” “Administration”
“Standards Transfer”:
To be able to proceed to the transfer, the source and destination projects must be
opened in Automation Studio™. To transfer a standard towards the Standard
Enterprise Data Base, only the source project must be opened.
1. In the left part of the dialogue box, explore the tree view to identify and select the
standard to transfer (only the standards included by the license are displayed).
2. In the “Source” drop-down menu, choose the project containing the standard.
3. In the “Destination” drop-down menu, choose the project towards which to transfer
the standard. Choose “Enterprise Options” to transfer the standard towards the
Standard Enterprise Data Base.
4. The list appearing in the “Source” drop-down menu displays the names of the
different standards that can be transferred. Select those to transfer, then activate the
“Copy the selection” command.
A project can contain different standards with the same name. However, if the
destination project already contains a standard with the same version number, a
dialogue box will open asking to confirm the replacement of the destination standardTo
delete a standard from a project, proceed as follows:
1. Select the standard to delete in the tree view of the dialogue box.
2. In the “Destination” drop-down menu, choose the project from which to delete the
standard. Choose “Enterprise Options” to transfer the standard towards the Standard
Enterprise Data Base.
3. The list appearing under the “Destination” drop-down menu displays the names of
the different standards that can be deleted. Select the one to delete, then activate
the “Delete” command.
The deletion of a standard is not possible if this standard is already in use in the
destination project.
2-156
3 Common Commands of the Dialogues
This chapter presents the common commands which are located in the different
dialogues and wizards and are used to create or configure specific functions. They can
also be found in some of the Pop-up Windows.
Note that this chapter does not present the common commands of components,
documents, reports, views, projects or application properties dialogues. For more
details on the properties dialogues, please refer to chapter 2.2.2 Properties
Window.
Some dialogues containing tree-like structured information may have commands for
controlling the dialogue’s information display.
3-2
Common Commands of the Dialogues
For the versions preceding Automation Studio ™ 5.6, the file extension of the
project files is .pr5 or .pr4.
To create a new project, choose the menu “New Project”, choose the desired
template or choose “None” if none of the available templates correspond.
A new project identical to the selected template is created, and opens on the screen as
well as in the Project Explorer. By default, a name is assigned to the project; this name
may be modified by those who have these rights. In addition, the software includes a
blank diagram within the new project.
Documents can be now added to the new project. For more details on how to
manage diagrams, refer to section 6 Elements within a Diagram.
4.1.2 Opening
It is possible to open other file types as can be done with an Automation Studio™
project file. In the menu “File type”, there is a list of all the supported file types.
Extension Description
.pr4, .pr5 and .prx Original format of the different Automation Studio ™ versions:
.pr4 for versions 4, .pr5 for versions 5 and from the 6.0
version: .prx.
.backup, .autosave Backup: extension of the file created when openning a
project if the option has been activated.
Autosave: extension of the file created when auto-saving a
project if the option has been activated.
.pj Extension of the file corresponding to the project’s template.
.pkx Extension of files exported by Moduflex valve builders
(Parker).
.dxf Drawing file in .dxf format.
.hfx Extension of files exported by I-Design valve builders
(Hydraforce).
.hix Extension of files exported by Easy Valve valve builders
(Comatrol).
.cdsx Extension of files exported by CDS Studio Project (Eaton).
.chx Extension of files exported by Oil Control Choose Projects
(Bosh Rexroth).
4-2
Creation and Management of a Project
When a project is created, it is given a default name (according to the current standard),
but it is not yet saved in any specific directory. When at least one component is added to
the new project diagram, then this project can be saved for the first time.
An existing project can be saved with a new name and put into another directory.
OR
1. Select “Save Project As” to modify the name or the project location.
The same saving commands are offered in the following menu: “Project”.
To save a project generated by Automation Studio ™ and use it with Automation Studio™
Simulation, choose the .asr file extension. This file can only be opened with an
Automation Studio™ SIMULATION version with the same version (or previous version) as
the one in which the project has been created.
The files generated by Automation Studio™ and Automation Studio™ Design are
compatible.
The following figure summarizes saved file compatibility between derived Automation
Studio™ files.
Many project and diagram templates are offered by default with Automation Studio™.
However, if you frequently use the same project structures, diagram elements or
information in the reports, it is possible to build customized document and project
templates based on individual needs.
In order to ensure that all templates remain accessible, it is important to save them in
the …\Template directory of Automation Studio ™. The default path for this directory can
To open a template: open a file with the extension .pj from “Open Project…”
1. Activate the command: “Project” “Save Template As”, and then enter a
name for the template.
2. Click on the “Save” button to validate.
3. A project template with the former name is created with the .pj extension.
4-4
Creation and Management of a Project
To print the entire project, check the project box. The document checkboxes are
automatically selected.
2. Click on “Ok”.
3. Define printing options.
The same print command is offered in the project’s contextual menu, in the Project
Explorer.
1. Choose menu “Print” “Print Preview…” and check the box of the
documents to preview.
2. Click on “Ok”.
Figure 4-5: “Item for Print Preview and Print” Dialogue Box
To preview the complete project, check the project box. The documents checkboxes are
automatically selected.
4-6
Creation and Management of a Project
The same print preview command is offered in the project’s contextual menu, in the
project explorer.
The print preview page is now open. The pages of the selected document(s) are
displayed.
In the ribbon, you find the usual options to modify the display and navigate across the
document’s pages. Choose the page you wish to print and click on “Print”.
To exit the “Print Preview” window, click on the button or use the ESC key.
TM
To send the current project: Click on Automation Studio menu “Send To” and
fill in the information to send along with the project.
The same “Send to” command is offered in the project’s contextual menu, in the Project
Explorer.
TM
To close a project: Click on Automation Studio menu “Project”“Close
Project”.
If no modification has been made since the project was last saved, the software just
closes the current project. Otherwise, a message appears asking to save the
modifications.
Selecting “No”, closes the project. The most recent modifications are lost.
The same closing command is offered in the project’s contextual menu, in the Project
Explorer.
TM
To close all projects : Click on Automation Studio menu “Project”“Close all
Projects”.
If no modification were made since the last save for all opened projects, then the
software closes all projects. If any of the project contains modifications, a message is
displayed asking to save the projects or not.
4-8
Creation and Management of a Project
If no modifications have been made since the project was last saved, the software closes
and terminates the exit procedure. Otherwise, the system prompts to save modifications
for every concerned project that is opened.
Selecting “No” closes the software without saving the last modifications and ends the
exit procedure.
If the project has previously been saved, selecting “Yes”, replaces by the modified
version. The software closes and ends the exit procedure. If the project has never been
saved, the “Save As” dialogue box automatically opens. (See section 4.1.3 Save).
A project can contain many technologies. In the “Properties” dialogue box, the properties
and standards are regrouped for each technology. A property can be modified by the user
while the standard is predefined and therefore cannot be modified.
4-10
Creation and Management of a Project
The « Project » branch is the first one in the tree of “Project Properties”.
When new projects and documents are created, they are automatically given a default
name.
The “Naming Rules” branch is used to modify the rules by which to form default names.
The toolbar also contains controls to filter or mark certain rules: first choose a column (as
criteria) in the drop-down menu, enter a string in the adjacent field, and select between
the two options:
● “Filter”: to filter the list.
● “Mark”: to highlight the rules satisfying the entered criteria.
When defining a new naming rule, give it a name (in the “Name” field). There is also the
option to add a description of the rule (in the “Comment” field). A default version
4-12
Creation and Management of a Project
number is automatically assigned to the rule. This number is incremented after each
modification.
Every naming rule is a combination of variables (in green) selected from a drop-down list
and user added texts (in orange).
Select a variable from the “Variable:” drop-down list and click on to add it to the
name. There is also the option to add to the name in the “Literal” field. The formula that
defines the naming rule is automatically inserted into the dedicated area.
Each item can be dragged and dropped in this area in order to modify the formula. You
can also click on the item and then on to delete it.
The available variables for building naming rules of projects and documents are derived
from:
● Project (Document) information accessible in the Project (Document) Properties.
For example: project approver, project or document category, different dates and
items relative to the document or project itself, and the project (document)
numbers with the amount of significant numbers desired.
● Project (Document) History information accessible in the Project (Document)
Properties. For example: name of different stakeholders, date of their
intervention and revision number with the amount of significant numbers
desired.
In Figure 4-8: “Project” “Naming Rules”, the selected naming rule is from one project
and combines the 4 elements:
● Project category (there is only one category).
● Project number.
● Character string: “-“.
● Current revision number of the project.
4.2.1.2 “Standards”
As shown in the tabs in the figure below, a project standard is composed of editing
parameters and of simulation parameters.
When creating a new standard, it must be given a name (in the “Name” field). It can also
be given a description (in the “Comment” field). A version number is automatically
assigned to the rule. This number is incremented after each modification.
The modifications made within a project or document can be taken into account different
ways, as indicated by the icon on the right side of the option.
4-14
Creation and Management of a Project
“Edition” Tab
Hide or display the content of every category by clicking on the and icons
respectively.
Name Description
Update Type Manual or automatic update.
Project File Naming Rule To define the default project naming format for
new projects.
Documents Naming Rule To define the default document naming format
for each of the following document types:
Standard document, Electrotechnical Multi-line,
One-line, Panel Layout, Connections Diagram,
Harness, Report and SFC.
Units To set the default components units (Metric or
Name Description
Imperial) monetary units, or units used in sizing
sheets.
Hyperlinks To define the display format of variable’s
hyperlinks.
Components Numbering To define the default naming rules for each of the
virtual electrotechnical components and
electrotechnical wire components.
“Simulation” Tab
4-16
Creation and Management of a Project
Name Description
as maintenance or test ports.
The Manometer and Thermometer
troubleshooting tools are compatible with the
pneumatic module.
4.2.1.3 “Properties”
In the “Project Properties”, the user can specify the simulation options and general
properties affecting the application’s behaviour in Editing and Simulation modes.
4-18
Creation and Management of a Project
4-20
Creation and Management of a Project
Simulation Pace
In Project Properties > Project > Properties > Simulation Tab > Simulation Pace, multiple
values are available for the Simulation Time Step Value. This option corresponds to the
“Pace” at which the calculations for the selected technology are performed during
simulation. The simulation time paces for the different technologies are independent.
Pace
● Standard: 10 ms (milliseconds) ;
● Quick: 2 1 and 0.5 ms;
● Advanced: 0.1 ms.
For the moment, this option is only used by the following Workshops: Hydraulics,
Pneumatics, Electrotechnical, One-Line and SFC.
In the Electrotechnical Workshop, some Motors have a behaviour that adapts to the
selected Pace: Asynchronous Motor, Squirrel Cage, Three-Phase AC, Asynchronous Motor,
Squirrel Cage, Three-Phase, AC with 6 Connectors, Asynchronous Motor, Squirrel Cage,
Three-Phase, AC with NO Brake, Asynchronous Motor, Squirrel Cage, Three-Phase, AC with
NC Brake and Three-Phase Permanent Magnet Synchronous Machine.
Note that for Components not dynamically computed (mostly pressure valves), the
Commutation Time value cannot be smaller than the Simulator Pace. If this is the case,
however, the Simulator will take the Pace as its default value. Generally, these Valves
will also have a proportionally shorter Transitory Delay to the Simulation Time Step, with
the fast and advanced Paces.
By selecting the Pace option in the Project Properties, all of the Diagrams of the Project
will be simulated at the selected pace.
“Information”
The “Information” category contains the information and identifiers in the active project.
Display the details of a selected item in the dialogue box with the command “Show
Details” directly below.
These fields can be used to create title blocks when inserting fields from the “Home” tab
“Drawing” group “Field” command.
Customize fields using the command. For more details on the toolbar, see section
4.2.1.4 “History” Branch.
The “History” branch is used to enter comments and information at different phases of
the project’s progress. The user may assign sequential revision numbers to identify the
project phases. The first comment is automatically saved as are any subsequent revision
numbers, revision dates, comments, the author, and the company’s name.
All the fields in the “History” dialogue box are available to create title blocks when
4-22
Creation and Management of a Project
inserting fields from the “Home” tab “Drawing” group “Field” command.
These revisions are displayed in the list with revision numbers, comments and creation
dates.
Modify Revision
Select the revision in the list to modify it. Details relative to it are displayed in the section
underneath. See Figure 4-14: Revision Modification.
Search Revision
A filer can be used to search a revision from the date, revision number or comment.
Duplicate Revision
The command is used to create a new revision by duplicating the revision currently
selected.
In the project’s properties under the “Global Variables” sub-branch of the “Project”
branch, you can access to the dialogue box in which you can manage user-defined
variables created for all components. These variables are called “global” because they
affect all components.
4-24
Creation and Management of a Project
Global variables are saved in the project and project’s templates. They will be also
available for the components inserted into a catalogue.
To create a global variable, click on the command . You can either create a “User-
Defined” global variable or a variable “From Template”. If you select the “User-Defined”
option, you will be asked to select the variable type and give it a name and an alias.
Once the fields are filled with the desired information, click on to create the variable.
If you select the “From Template” option, another display with all the Automation
Studio™ variables allow you to choose the template you wish to use to create the global
variable.
Once the global variable has been created, it will be added to the existing components in
the project and to all the components newly inserted into a project or copied and pasted
from another project.
Components affected by the global variables are all the simple components of the main
library, components belonging to a group, assemblies and their subcomponents, custom
components and black boxes. However, there are exceptions: CAD objects (rectangles,
ellipses etc.) and builders’ sub-components will not be affected by these variables.
Global variables and variables created locally will all be listed in the “User-Defined”
category of the component’s properties. Two different icons indicate whether the
variable is global or local .
Icon Description
Global variable
Local variable
The global variables created from template will be added to the component’s
4-26
Creation and Management of a Project
If you want to modify subsequently some attributes of a global variable within a project,
this modification will affect only the new components that have been inserted into this
project.
If you delete a global variable from a project, this variable will be removed from all
project’s components, except for the components whose same variable has been created
locally.
The global variables of 5.7 projects will be imported and categorized as explained
above.
4
In the filter’s field, you can create a filter or a mark
for variables.
5
This area displays the main properties of the global
variables within the project.
The other attributes of the global variables are similar to the one locally created by user
on the level of the project, document or component. For more information, please see
section Properties Attributes.
These branches are used to define a set of standards relative to the page setup of the
document. These standards are generic and related to project documents and application
tools.
The toolbar also contains controls to filter or mark certain standards: choose a column as
4-28
Creation and Management of a Project
a criterion in the drop-down menu, enter a character string in the adjacent field, and then
select one of the two options:
● “Filter”: to filter the list.
● “Mark”: to highlight the standards satisfying the entered criteria.
Page setup standards of the project can be defined in this branch. Several considerations
are associated with the work page, such as setting the orientation, and adding a frame, a
title block, a report, revisions history, and/or a map locator, for example.
The work sheet (white) corresponds to the print area of the diagram.
A new page setup standard must be assigned a name (in the “Name” field). A
description of the standard can also be added (in the “Comment” field). A version
number is automatically given to the standard. This number is incremented after each
modification.
The “Page Setup” branch of the “Project Properties” command is used to define all the
page setup standards that can be used in the project. However, to modify one of the
parameters while working from the actual standard, the standard number will change to
reflect that the standard has evolved.
4-30
Creation and Management of a Project
Category Description
Document Size To define the paper format. The selected format corresponds to
the size of the work sheet.
Document To choose the orientation of the worksheet, either Portrait
Orientation (vertical) or Landscape (horizontal).
Printer Margins To define the worksheet margins: left, right, top, and bottom.
Additional Report These four margins define the area in which the report will be
Margins displayed on every page. This area is also defined by the other
margins relative to the page setup.
Title Block To define the title block: no title block, default or create a
customized title block with the command.
Miscellaneous To define the maximum number of layers in the same diagram,
the colour of the document’s grid, the document background
colour and shadow colour.
The “Title Block visible in simulation” checkbox is used to have the Title Block displayed
during simulation as a background, as in the following figure:
While defining the page setup standard, also define a customized title block. To create a
custom title block, select “Customized” and click on the command.
Automation Studio™ will open an internal document in which the user can create a new
title block. This document contains the same tools as the ones already described in
section 2.1.4 Ribbon.
At any time, cancel the title block edition by clicking on the “Cancel Edition” command in
the floating dialogue box. After the title block completion, save it to return to the normal
mode.
Figure 4-22: Floating Dialogue Box while Configuring the Title Block
The “Map Locator Standards” branch defines different standards, including the
measurement units for the map ruler, the location of components, and the link’s display
format for the current diagram.
4-32
Creation and Management of a Project
Figure 4-24: Horizontal Map Locators (numbered 01, 02…) and Vertical (numbered A, B…).
The grid is also visible
A component’s reference on the diagrams is used to locate the principle circuit elements
from optional components. All of them are displayed on the diagram.
4-34
Creation and Management of a Project
The reference default options can be defined for the application, current project
and current document.
Please refer to the Electrotechnical Workshop Guide for these standards used to configure
default connection ports.
4-36
Creation and Management of a Project
The “Plotter, Curve Editor, Oscilloscope and Sizing Sheets” branch is used to define the
appearance of the plotters, the curves and the sizing sheets editor as well as, the
oscilloscope.
Figure 4-28: “General Standards” “Plotter, Curve Editor, Oscilloscope and Sizing
Sheets” Branch
4-38
Creation and Management of a Project
“Plotter” Tab
Category Item Description
Plotter The “Plotter” category contains all the
options regarding the appearance of the
standard plotter.
Background Colour To set the background colour of the plotter.
Grid Colour To set the grid colour of the plotter.
Values Colour Personalize the colour of the displayed
values.
Cursors Colour Personalize the colour of the displayed
cursors.
Annotations Colour Personalize the colours of annotations placed
on the plot area.
Markers Colour Personalize the colour of displayed markers.
Vertical Axes Layout Layout of the vertical axes and the associated
curves: with the option “Layered”, the curves
for each variable overlap on one plot area.
The option “Stacked” shows each curve
separately as a series of graphs stacked one
on top to the other.
Grid Strips Layout Configure the display of strips on the
background of the plot area: None, Vertical,
Horizontal, Both.
Horizontal Axis The time axis can be placed at the bottom or
Placement at the top of the graph.
Vertical Axes The vertical axes can be placed All left, All
Placement right, alternating Left then right, or Right
then left.
“Curves” tab
Category Item Description
Curve Editor The “Curve Editor” category contains all the
options regarding the appearance of the
curves displayed in the properties of certain
components.
Background Colour To set the background colour of the curve
drawing zone.
Grid Colour To set the grid colour of the curve drawing
zone.
Selection Colour To set the colour of the selected curve(s).
4-40
Creation and Management of a Project
“Oscilloscope” Tab
Category Item Description
Oscilloscope Similar to the plotter and the curve editor,
the “Oscilloscope” category contains all the
options regarding the appearance of the
oscilloscope.
General Vertical/horizontal The default value of the vertical (voltage)
Parameters Scale and the horizontal (time) scale for all
channels.
Show Grid Allows you to display or hide the grid on the
oscilloscope’s screen.
Show Axes Allows you to display or hide the axes on the
oscilloscope screen. These axes are
horizontally and vertically centered on the
oscilloscope’s screen.
Background Colour Allows you to select the colour of the
oscilloscope’s screen.
Grid Colour Allows you to select the colour of the grid
when it is displayed.
Axes Colour Allows you to select the colour of the axes
when they are displayed.
Lineweight Allows you to select the thickness of the plot
lines. It applies to all channels.
4-42
Creation and Management of a Project
This section of the document will explain the “Label Standards” main window, label types
and their configuration.
This window is used to define and configure label standards that will be used in the
Project.
Number/Step Description
1 Create a new label standard. Note that other buttons are
available (delete, copy, paste).
2 Assign a relevant name to the label standard.
4-44
Creation and Management of a Project
Number/Step Description
3 The preview zone is updated according to the label type or its
properties defined in the following steps.
4 Selection of the label type (letter, note or show card). The
selection should be same type in the section below. As in the
example in Figure 4-29, the Label Type is “Show Card” and the
section configuration below corresponds accordingly.
5 Text, line or colour properties according to the label type
selected (properties vary depending on the label type selected
at step 4).
6 Save changes.
Label Types
For a One-Line document: the detailed label configuration is presented in the One-Line
User Guide. For One-Line documents only, the label configuration is based on the
component type and a component could be associated with many labels (of different
types).
For all other document types, the “Label Standards” configuration is first defined in the
Project Properties (as shown above) and a Label Standard should then be selected in the
Document Properties (see next figure).
When a standard is selected for a specific document, all components will use the same
label type: the default label type of the label standard. For instance, if the default label
type is a “Note”, then all the component labels of the document will appear as a “Note”
label type.
To add a label to a component (in editing or simulation mode), use the component
contextual menu (right-click). A label can also be deleted using the right-click on the
component or with the “Delete” key on the keyboard.
4-46
Creation and Management of a Project
The label text can be edited two ways: a) select the label and press F2, or b) select the
label and left-click.
The “3D Diagrams” branch is used to define the different options involving the
appearance of 3D Diagrams.
« Edition » Tab
4-48
Creation and Management of a Project
« Simulation » Tab
For all the details of this dialogue box, refer to the Hydraulics and Pneumatics Workshops
User’s Guide.
The electrical system contains the following workshops: One-Line, Multi-Line, Electrical
Command and Digital.
For electrotechnical One-Line and Multi-Line workshops, please refer to the One-Line and
Electrotechnical Workshop User’s Guide.
The electrical circuit should be drawn in the standard editor, as their standards are
described there. This workshop is a simulation with simplified binary control and few
symbols, while standards are kept to a minimum.
4-50
Creation and Management of a Project
The digital electronic circuits should be drawn in the standard editor, as their standards
are described below. This workshop is a simulation with simplified binary control and few
symbols, while standards are kept to a minimum.
Automation systems represent logical and command languages. They include the SFC and
the Ladder Logic diagrams.
This toolbar offers the same controls as in section 4.2.2 “General Standards” Branch.
For SFC standards please refer to the SFC User’s Guide which is an independent editor of
the standard editor.
The ladder logic diagrams should be done using the standard editor. These standards are
used to define the appearance of components in both editing and simulation modes.
“Edition” Tab
Category Item Description
Components Component Satellite To set the typography used for the display of
Typography texts in the ladder diagram components.
Ladder Logic To set the appearance of AB ladder diagram
AB Appearance in edit mode.
4-52
Creation and Management of a Project
Ladder Logic
IEC Appearance To set the appearance of IEC ladder diagram
in edit mode.
“Simulation” Tab
Category Item Description
4-54
Creation and Management of a Project
The reports are not graphical documents, but they are automatically generated according
to filters and user’s criteria. Therefore, only the document names can be modified.
The only aspect of the reports from the project properties in the “Report” “Naming
Rules (Report Properties)” branch that can be configured concerns the rules of reports
naming. This window is identical to the one described in section 4.2.1.1 .
Document Description
Electrotechnical A document that integrates one-line electrotechnical
One-Line workshop components.
Electrotechnical A document that contains cable descriptions as they
Connection are defined in an electrotechnical document.
Electrotechnical A document that contains the panel layout diagram.
Panel Layout
5.1.1 Creation
To create a new diagram, go to “Home” tab Documents group and select the
document type from the drop-down list.
The new document is opened and inserted in the Project Explorer in the current project.
Create a new diagram that is compliant with the user’s needs and standards, and
save it as a template. See section 4.1.3.3 Saving a Template for the procedure.
The creation of another type of Automation Studio™ Document is similar to the creation
of a standard diagram. To get more information on how to create and manage other
typical Automation Studio™ documents, refer to various guides listed in the following
table.
Document Reference
Electrotechnical Diagram Electrotechnical Workshop User’s Guide
One-Line Diagram One-Line Workshop User’s Guide
Connection Diagram Electrotechnical Workshop User’s Guide
5-2
Document
Document Reference
Panel Layout Electrotechnical Workshop User’s Guide
Electrotechnical Report Electrotechnical Workshop User’s Guide
SFC SFC Workshop User’s Guide
Report Chapter 7 Reports of this guide.
To insert a Web page: click on “New” “Web Page” and type the name and
URL of the Web page in the appropriate fields.
The Web page opens and is inserted into the Project Explorer at the desired location.
5.1.2 Import
SFCs generated by the Graphite software as well as GIE format files can be imported.
The specific document template saving is used to save general standards for page setup
parameters and document properties. Therefore, it is possible to create documents from
a template respecting the same standards as the original. The templates that can be
saved are:
5-4
Document
● Diagram (.sc)
● Electrotechnical Diagram (.se)
● Electrotechnical Panel Layout (.sie)
● Electrotechnical One-line Diagram (.seu)
● Electrotechnical Report (.re)
● SFC (.sf)
● Report (standard) (.re)
A diagram template with the assigned name is created in the directory specified in the
Automation Studio™ options (refer to section 2.1.3.2 Automation Studio™ Options) with
the appropriate extension.
5.1.4 Export
To export documents:
1. Click on “Export”, choose the desired format, and then activate the “Next”
command.
2. A dialogue box opens with the selection of compatible documents to export.
For the SVG export, the Crisp-Edges selection box can improve the depiction of the
image in the “Internet Explorer” browser.
For the PDF export, the user can select the option “Formatting of Each Page”
allowing him to select a format for each page. If this option is unchecked, the
same format will be applied to the whole document.
The user can also choose between two options relating to the lineweight: “Equivalent
Lineweight” or “Precise Lineweight”.
Equivalent Lineweight
The option “Equivalent Lineweight” allows the correspondence between the Automation
5-6
Document
Studio™ lineweights and the standard DXF lineweights. In the DXF generated with this
option, the lineweights will be different than the one in Automation Studio ™ but the
proportions will be kept.
This option is recommended in the cases the DXF size must be minimized, the
lineweights are not relevant for the printing and a rounded effect at the end of the
lines is intended.
Here is the cross reference table used to convert the Automation Studio™ values in
standard DXF values (in mm):
AutoCAD 0.05 0.09 0.13 0.15 0.18 0.2 0.25 0.35 0.4 0.5 0.53 0.6 0.7 0.8 0.9 1 1.06 1.2 1.4 1.58 2 2.11 2.11 2.11 2.11
AS 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 2 2.1 2.2 2.3 2.4 2.5
Figure 5-5 Cross Reference Table between Automation Studio™ and DXF Values (in mm)
Precise Lineweight
The option “Precise Lineweight” generates a DXF with exactly the same lineweights than
the one in Automation Studio™.
This option is recommended when the lineweight is essential for both display and
printing and the file size is not important.
Line Breakdown
The option “Line Breakdown” transforms the lines in dotted segments in order to
reproduce the same appearance than the original document. This generates a very
precise DXF with precise lines. The file size will be big.
● The components’ blocks shouldn’t be broken down from the target CAD in order
to modify their style or colour.
Exporting SFC:
to get access to this option (otherwise greyed out), you must have at least one
SFC document opened.
If you export a SFC to a GIE format or to a “Siemens Step S7-Graph” format, a wizard will
guide you through dialogue boxes to edit export parameters.Detailed information on SFC
export is available in the online Help accessible by pressing F1 when your mouse cursor
is positioned in the ribbon, exactly below the “Sequential Function Chart” tab. (If you do
not see this tab in the ribbon, it means that no SFC is currently opened). See chapter 8 of
the user’s guide Sequential Function Chart (SFC), click on “Support” User’s Guide
“SFC”.
When exporting to XML format, the following dialogue box opens to set export options:
5-8
Document
Document properties contain the standards applied to the document as well as the
values of the different editor attributes on this document.
5-10
Document
For every standard, choose from the drop-down list, one of the standards defined in the
project. The displayed buttons at the right of the drop-down menus are used for the
following actions:
Command Description
Open and Modify This button opens the project properties dialogue and
displays the concerned standard.
This command always appears with the following
one.
Import a Copy and This button imports a copy of the selected standard:
Modify the imported standard is therefore placed in the
document properties tree, under “Document
Properties”.
The imported standard is local to the document.
Modify it by selecting it in the tree.
When this command is activated, the corresponding
drop-down list is deactivated, and the “Open and
Modify” and “Import a Copy and Modify” buttons are
replaced by the following one.
List of Used This button is used to delete the local copy of the
Standards imported standard, and to choose one of the
standards defined in the project from the drop-down
list.
When this command is activated, the corresponding
drop-down list is activated, and the button is replaced
by the “Open and Modify” and “Import a Copy and
Modify” buttons.
For more details on standards listed below, please refer to the section 4.2 Project
Properties and search for the relevant standards.
Name Description
Page Setup Standard Displays the page setup standard of the active
document
Map Location Standard Displays the map locator standard of the active
Name Description
document
Fluid Standard Displays the fluid standard of the active document
Hydraulic Standard Displays the hydraulic standard of the active document
Pneumatic Standard Displays the pneumatic standard of the active
document
Electrical Standard Displays the electrical standard of the active document
Digital Electronic Standard Displays the digital electronic standard of the active
document
Ladder Standard Displays the ladder standard of the active document
References Standard Displays the references standard of the active
document
Drawing Tools Standard Displays the drawing tools standard for the active
document
Label Standard Displays the label standard that defines the type and
appearance of one label type that will be used
throughout the document. All labels associated to any
component in that document will use that default label
type (except in a One-Line document in which label
association depends on the component type instead of
the document label standard).
All of the properties described below can also be modified for the current document and
all of its views under the “View” tab “Show” group and in the Home tab Snap
group. These functions are used to set the document’s visual aspect and their goal is to
5-12
Document
Name Description
or as normal text.
Display References This command is used to display component
references.
5.2.1.4 Information
Display the details of a selection in the dialogue box using the “Show Details” command
at the bottom of the box.
These fields can be used in the automatic fields: “Home” “Drawing” “Field”.
Add custom fields by the command. For more information on the toolbar, refer to
section 6.2.1.1 Toolbar.
The “History” branch of a document works the same way as that of the project: refer to
section 4.2.1.4 “History” Branch.
5-14
6 Elements within a Diagram
6.1 Elements Management
6.1.1 Inserting/Creating
The component properties are used to define the component’s behaviour parameters
during simulation. Properties may relate to the components in and out sizes, to its
internal behaviour, or its dimensions.
The parameters of all components in the Hydraulics and Pneumatics workshop are
preconfigured so as to feature a realistic simulation with few user interventions.
Communication variables from the Control workshop are the only exception to this rule.
Automatic sheet displacement occurs when there is an action that extends beyond
the visible zone of the screen (component insertion, power line layouts, object
drawing, object expansion using its selection handles, etc.)
If needed, define the parameters in the component’s properties dialogue box (see
section 6.2 Properties of Library Components).
When a component that possesses an “Emitter” variable is inserted on the diagram, the
“Modify Variable” dialogue box (see figure below) opens automatically. An “Emitter” is a
variable where the value is assigned to a “Receiver” variable of another component. The
“Modify Variable” dialogue box is used to give an alias, a default value, and a description
of the component “Emitter” variable. This data makes it easier to locate the variable
during the variable assignment.
6.1.1.2 Links
Like electrical wires or circuit lines, links are used to connect components. The following
method is valid for all the editors. However, refer to the electrotechnical guide to
discover how to simultaneously edit multiple wires.
To set up a link:
1. Click on one of the symbol’s connection ports.
6-2
Elements within a Diagram
3. Click again at the second connection port. The cursor takes this shape again.
4. The connection is established between the two components.
Double-click on an empty space: the created link will have one open end.
This procedure is easier if the connection ports are visible. Make sure the following
command is checked: “View” “Show” “Connection Ports”.
Modify the shape of a link once it’s inserted using the mouse.
To modify a link:
Occasionally the layout of elements on the diagram requires moving a link to avoid
overlapping.
Moving any type of links or wires where they intersect is possible without having
to redesign all the links.
The link appears in coloured dash line with grips and two types of handle are visible:
To change a link into a direct link, select the link to modify and select the “Direct
Link” option in its contextual menu using the right-click.
To move a link:
To avoid the creation of links at the ends, maintain the SHIFT key during the
procedure.
6-4
Elements within a Diagram
All lines connecting and crossing in the corresponding document are modified.
Locally modify the line’s jump layout by the contextual menu of a jump.
No Jump
To insert a bifurcation:
To avoid connecting the other end of the link, click anywhere in the diagram. If the other
end of the link is to be connected to a connection port, click once on the connector to
terminate the link.
To divide a link:
A link may be cut so as to obtain two distinct links. Two criss-crossing links can also be
cut into four distinct links. Dividing links are used to cut a link at a specific location.
1. Click on the “Break Link” command under the “Home” tab “Links” group.
If the connection ports display is activated, then a new port is displayed between
the two new links.
6-6
Elements within a Diagram
Each link property (pressure line, pilot line, electrical wire, etc.) that is available in the
software can be modified. Refer to the fluid standards of the project properties. When
connected to hydraulic, pneumatic, electric, numeric, or ladder diagram components,
these links adopt that technology’s properties.
Choose the “Component Properties…” command in the contextual menu that appears
when right-clicking on the link; or double-click on the link, or select the link and activate
the “Component Properties” command in the “View” group “Properties” of the ribbon.
The “Component Properties” dialogue box opens and the link’s properties can be
modified.
Refer to the contextual help of the link for further information on its properties.
Using the commands from the “Line” group to modify the thickness and colour of
a link will locally override the display standard for this link.
Case #1: Inserting a component directly from the library, from a different diagram, or by
copying one of the diagram’s components.
Simply select the component and insert it on the link making sure that the connector(s)
is (are) placed precisely on the link when releasing the mouse button.
Case #2: Moving a component on a link when both items are on the same diagram.
Simply move the component to the link while ensuring that the connector(s) remains on
the link, and that the SHIFT key is pressed down when releasing the component.
Many diagnostic tools are available for every editor, so as to verify connection errors on
diagrams. These tools are launched by activating the “Diagnostic Tools” in the
“Diagnostic” group of the dedicated tab of each editor (Electrotechnical, SFC, One-Line,
and Fluid). Please refer to the relative user’s guide for detailed explanations on these
tools. The results of these diagnostics are displayed as text in the message window and
the faulty components will be in different colours highlighted.
Insertion procedures are similar: lines, rectangles, and ellipses are inserted in the same
manner; however the insertion procedures for text boxes, pictures, and fields slightly
6-8
Elements within a Diagram
differ in the last few steps. Link, arc, and polygon insertions are based on a distinct
procedure.
Contrary to technology related links, a line does not transmit signals during
simulation. Hence, it cannot be used to join elements.
For the ellipse and the rectangle, use the CTRL key for a circle or a square,
respectively.
To insert a picture:
1. Select the “Picture” tool and repeat steps 1 to 3 of the previous procedure.
The “Insert Picture” dialogue box opens.
An image can be copied from software and pasted directly on the diagram.
To insert an arc:
1. Select the “Arc” tool and repeat steps 1 to 3 of the previous procedure.
The initial shape of the arc corresponds to ¾ of a circle. To create an arc:
2. Click on one of the handles which are located on the left and top (9 and 12 o’clock),
and holding the mouse button, drag the cursor to either lengthen or shorten the arc
as needed.
3. To stop inserting graphic objects, simply right-click on the mouse.
The cursor reverts to its original shape.
To modify an arc, select the object then click on the corresponding button in
“Home” “Drawing”: the control handles appear on the arc to move it.
To insert a polygon:
1. Select the “Polygon” tool and repeat steps 1 to 3 of the previous procedure.
As soon as the mouse button is released, the second anchor point is created.
2. Change direction and click to fasten the third anchor point of the polygon in the
diagram.
3. Repeat the previous step as often as necessary.
4. To finish drawing the polygon, right-click anywhere.
The polygon closes.
By double-clicking, a final point is inserted; and the polygon does not close (poly-
line).
To update the layout of polygons and arcs, select them on the diagram and click
on the corresponding button “Home” “Drawing”. The handles appear on this
element which can then be manipulated as needed.
6-10
Elements within a Diagram
To insert a polypolygon:
To insert a spline:
Repeat the steps of an opened polygon, but select the “Spline” tool.
To insert a reference:
1. Click on “Home” Tab “Documentation” Group “Reference”.
To update the layout of a reference, select it on the document and move its
handles.
Fill in the active project and/or diagram properties in order to display a value for
the selected fields to create title blocks in templates.
The Bill of Materials (B.O.M.) is displayed, in a tabular form, the list of components
present in a diagram/project. Different filters can be applied.
6-12
Elements within a Diagram
The revision history is displayed in same way, listing relevant information in the stages
of revision of a diagram.
It is possible to add fields to the Bill of Materials in order to access more relevant
information and display additional data (see Reports chapter). It is now possible to insert
several BOMs on the same diagram.
For the “Filter” branch (“Filters”, Fields” and “Options” tabs), refer to section 0 .
For the “Layout” branch, refer to section Error! Reference source not found.
Error! Reference source not found..
As with all components in Automation Studio™, the BOM and revision history have data
that can be classified by category or in an alphanumeric order. The data of the
“Appearance” category can be used to modify the colour and the thickness of lines and
the text typography, just as the “Identification” category can be used to modify the
identification attributes.
To search components:
1. Choose “Edit” Tab “Editing” Group “Find” (CTRL + F); and select installations or
subdivisions to search for components.
2. The “Component Search” appears dialogue box opens: select the pair(s) of circuit /
installation.
6-14
Elements within a Diagram
diagram.
To Search Text :
1. Choose “Find & Replace Text” command from “Editing” group of the “Edit” tab or hit
directly CTRL +F ;
And finally :
During a search, results are updated continuasly and are displayed in the bottom area of
the dialog window.
You can stop the search process at any time by clicking on “Stop” command.
You can continue working in your project while the search process is on going.
Texte : display the complete text, where the string was found;
Type: it gives the type of item where the string was found;
Location: it gives the component location of where the text was found as a hyperlink;
6-16
Elements within a Diagram
Be aware that no restriction or validation exists for text replacement in a SFC step
or transition and for the expression editor.
To select an element:
The “Select” command of the “Edition” group can also be used to select different
elements on the active diagram: refer to section “Editing” Group.
If you do your selection from the bottom right corner to the top left corner, all
components are selected even if they are partially included inside the rectangle.
This procedure applies to the relocation of all elements: a component, a link, or an object.
To relocate an element:
1. Select the element to be relocated.
2. Click on the element, and without releasing the mouse button, slide the cursor to the
new location of the element.
The element follows the mouse cursor.
If a linked component is relocated, the links remain active. To disconnect the links,
press the SHIFT button when sliding the cursor.
6-18
Elements within a Diagram
The “Duplicate” command does not use Windows Clipboard function. It is used to
duplicate elements while leaving the contents of the Clipboard intact.
To duplicate an element:
1. Select the element to duplicate, choose “Edit” “Clipboard” “Duplicate” (CTRL +
D).
2. Move the cursor to the location where the duplicated item is to appear and click.
A copy of the selection is inserted onto the diagram.
Duplicate elements simply by selecting the element to copy, holding the CTRL key
down, and dragging the copy anywhere on the diagram. The copied element
follows the cursor to the new location or until the mouse button is released.
When creating a diagram, modify the orientation of elements in order to organize the
graphic representation of the circuit.
Select the object to be reoriented and choose the appropriate command in the “Edit”
menu “Layout” group “Position” that corresponds best (see “Layout” Group).
Just like actual sheets of paper, the objects drawn first are obviously placed underneath
the more recently drawn ones. It is, however, possible to modify the display order.
Select the object to modify and choose the appropriate command in the “Edit” menu
“Layout” group: “Bring to Front”, “Send to back”, “Bring Forward”, and “Send Backward”,
to modify the display order as needed.
To group elements:
Select the elements to group and choose “Layout” “Group” (CTRL + G).
To modify the properties of a component in a group: select the group and double-click on
the desired component.
For example, to create the following circuit, group it and duplicate it, the assignment of
the variables is still defined in each group.
6-20
Elements within a Diagram
To ungroup elements
Select the group and choose “Layout” “Ungroup” (CTRL + U by default) in the “Edit”
menu.
Modify a group
A contextual tab appears on the ribbon bar when a group is selected. This tab is
named « Group » or « Assembly » according to the nature of the element
selected.
Figure 6-13 : Contextual « Edit » tab for group edition (or assembly)
Begin Group Edition Switch to edition mode for the selected CTRL + K
/ Begin Sub-group group or sub-group.
Edition
Go Up One Level Allows to go up of one level in embedded CTRL +
groups. SHIFT + K
14. Click on « Begin Group Edition » from « Manager » group of the contextual tab.
You can also use CTRL+K as a shortcut to go in group edition mode or by right-
clicking on the group and choose the command “Begin Group Edition”.
In group or assembly edition mode, components from the group are represented in their
original color as when other components are grayed out. Only components from the
group are editable in this mode.
A coordinate system is displayed for each element selected to indicate if the layout of
6-22
Elements within a Diagram
Figure 6-15 : Appearance of coordinates system of a component not modified and modified
15. While editing the group diagram, you can add, move or delete components like
you would do it with a circuit of independent components (not grouped).
Some functionalities are not available while editing a group. However, you can access
those functions after leaving the group edition mode (ENTER).
In this case, we name this an embedding level. To navigate through the different levels
or to go back to the diagram editor, you can use the functions “Go Up One Level” or “End
Group Edition”.
Select a sub-component in a group by a left click on the desired component and use
SHIFT key for a multiple selection.
Both multiple selection types CTRL + A and the selection rectangle are not
available.
Drag and drop a component or copy and paste a component to insert it in the group in
editing mode.
The following functions are not supported during group edition mode :
● Dynamic Measuring Instruments
● Select All
● Component Search
● Select by component type
● Open/Close Embedded Component
● Create a Custom Component
● Create a Concept Diagram
● Generate a Cross Section View
● Pump Conversion
● Create a Black box
● Generate a Spool Position
● Extract Symbol
Other Limitations
It is not possible to insert in a manipulated group a component that cannot receive the
same manipulation.
The clipboard is a function of Windows used for the temporary storage of data for an
information transfer.
This function can be used to transfer or copy elements from one diagram to another.
6-24
Elements within a Diagram
The transfer procedure for a diagram is identical to the transfer of elements; please refer
to the previous section. Simply choose the Select All command (CTRL + A) to execute the
selection before transferring or copying the elements to another diagram.
The Jump-to-Label is used to create a link between distant components connection ports
or when the components are drawn on separate pages. Two possible methods can be
used to create jump-to-label connections:
1. Create a usual line between components and then right-click to access the contextual
menu into which the function “Convert Link to Jump” can be used to automatically
convert the existing line into two separated jumps. In this case, the association
between the “Input” Jump to Label and the “Output” Jump to Label is automatically
created with the default name “R#”.
2. Manually take an “Input” Jump to Label from the library and under the “Association”
branch, type the desired name for that jump. Then, take an “Output” Jump to Label
and open it under the “Association” branch where the given name to the “Input”
Jump to Label must be selected in order to create the link between the two jumps.
Make sure to use only one “Input” for each “Output”, regardless of the flow
direction.
Choose the “Component Properties” command in the “View” menu “Properties” group,
or, use the ALT+ENTER shortcut (by default), or choose the “Component Properties…”
command in the contextual menu when right-clicking on a component.
The component properties window was introduced in section 2.2.2 Properties Window.
These are the “Data”, “Accessories”, “Curves”, and “Variable Assignment” branches.
The “Sizing” branch is treated in details in section 6.3 Sizing Sheet Manager. The
“Troubleshooting” branch is explained in section 2.2.14 Failure Builder. The other
branches are local to each component.
For more details on the properties of a specific component, see the help
associated with this component (accessible from the contextual menu of the
component, or by the F1 function key by default). Also, refer to the guide of the
concerned workshop for specific information on every component.
When several components are selected, the common properties will be displayed in the
properties window, and can be modified. A value will not be displayed for a property,
unless this value is common to all the selected components.
For the Boolean attributes of multiple selection properties, if all the components display
the property, the box will be checked; if none of the components display the property,
the box will be unchecked. If some components display the property and some don’t, the
check mark will be grey.
In a multiple selection, if one of the fields to modify is not available, it is probably about
a field which is not editable or that this last one is not common to all the selected
elements.
The custom properties creation function is available for a single selected component as
6-26
Elements within a Diagram
well as for a multi-selection of components. Specific properties can be added to all the
components of a diagram or a project.
The custom properties created this way remain properties that are local to
components, as opposed to global properties (See section 4.2.1.5 Components’
Global Properties).
Each symbol in the main library represents a component. Each of these components is
defined by its numerical or text properties. Some of these components have specific data
settings. These specific properties are explained in the component’s contextual help and
inside the User’s Guide of its respective technology. The following section describes the
“Data” Branch in the dialogue box which contains the list of alphanumeric properties.
Zone Description
1 Toolbar For easy access to the frequently used commands. The
content of the toolbar is customizable.
Section 6.2.1.1 Toolbar below describes the available
commands.
2 Component Image This zone can contain an image to better understand the
meaning of certain data relative to the component.
If several images are available, use left and right arrows to
move from an image to the other one.
This zone can be displayed or hidden by activating the
or button, respectively.
3 List of Properties This zone displays the list of properties. The properties are
the main functions that make Automation Studio™ an
efficient product:
● They enable system simulation.
● They feed reports and bill of materials.
● They contain information about the components’
symbols on the diagrams.
● They identify the components and their
connectivity.
● They provide information on the use in the editor:
layer, taken into consideration in reports or
excluded.
4 Details When a property is selected, this zone contains all the
details or attributes of the property. These details can be
modified.
This zone can be displayed or hidden by activating the
or button, respectively.
6.2.1.1 Toolbar
6-28
Elements within a Diagram
It is also possible to choose the commands to be displayed in the toolbar via this
configuration window.
A tooltip associated with every toolbar icon provides more details on the
command.
The button is used to access the commands that are not displayed in the
toolbar.
Lock / Unlock the component To lock or unlock the editing capabilities of the
component properties.
Command Description
Component sizing from the Open the sizing sheet manager to the
sizing sheet manager appropriate page for sizing the component.
From this function, some component properties
are linked to the sizing sheet and can be
modified from the sizing sheet manager.
Options Opens the displayed data configuration
dialogue box (see section Configuration
Window below).
Configuration Window
To access the configuration window, click on the icon, if it is visible in the toolbar.
Otherwise, choose the “Configure” command available in the contextual menu that
appears when right-clicking on the toolbar, or anywhere in the list of properties.
The use of the configuration window is identical to that described in section Using the
Configuration Window.
The list of properties displays the component properties: it is possible to modify certain
attributes of these properties, and create own custom properties.
Properties Attributes
The choice of columns in the list of properties is customizable via the Configuration
Window. Every column corresponds to an attribute of the properties. The available
attributes are:
Attribute Description
6-30
Elements within a Diagram
Attribute Description
Name Name of the property. This name cannot be modified.
Alias The user-defined name of the property assigned by the user.
Display Value To display or hide the variable value on the diagram.
(Boolean)
Display Alias To display or hide the alias of the property on the diagram.
(Boolean)
Display in Tooltip To display or hide the property name and its value in the
(Boolean) component tooltip.
Value The value of the property.
Unit The unit of a measurable property can be modified.
Variable State Visual indication of whether the property value comes from a
catalogue, has been modified, or is locked with the toolbar
command.
Refer to the state attribute tooltip if the icon representing the
state does not seem familiar.
Description Description of the variable.
Location The diagram name, component identifier, and variable name.
Measure The type of measure for the property.
Precision The specified number of significant decimals in the variable
value, if it is numerical.
Type The type of the property. Reserved to internal use and for the
Control workshop users, this attribute gives an indication on
the type of variable: integer, real, text, hyperlink.
User translated If this property is checked, the name and the value (if it is a
text(Boolean) text) will be entered in the custom translation table of the
project. Refer to section 2.2.9 Translation Manager.
The used units are those of the configured system during the installation of the
software. They can be converted automatically to the proposed unit type in the
drop-down list and with the desired display precision.
When the list of properties is displayed in the Category mode, properties are grouped by
categories:
Category Description
Technical - Physical parameters used in the model of analogic or graphic
Characteristic behaviour of the component. The values of these properties
are estimated and injected in the calculation of the system
resolution constituted by the diagrams to be simulated. In a
general way, it is data found easily in the manufacturers’
specifications. The properties of “Enumerate” type have the
icon at the first column from the left in the list of
properties.
Some of these properties can be edited, while others cannot.
The properties that cannot be modified are calculated
automatically from other properties, and have the icon in
the first column from the left in the list of properties. For
example, if the diameter of a section is modified, the surface
can be automatically calculated.
Technical – External These properties are external to the component. They are
Data used to model certain physical parameters influencing their
behaviour. They are present, generally, for actuators and
power elements. They can represent for example the efforts
which will apply to actuators during the simulation.
Technical – These properties are necessary for the Automation Studio™
Automation Studio simulator in order to better represent the component’s
behaviour.
Technical - Plotter The values of these properties are calculated in simulation.
Some of these variables can be plotted in the plotter, while
others cannot. The variables that can be plotted have the
icon in the first column from the left in the list of properties;
on the other hand, the variables that cannot be plotted have
the icon.
6-32
Elements within a Diagram
Category Description
Operating Condition Most of these properties define the limits of use of the real
component (maximal pressure, maximum flow, etc.). They
are generally extracted from the industrial catalogues. When
the “Display Faulty Components” or “Automatic Failures”
options are activated, it is these properties which activate
their effects.
These properties can also define the extreme values of the
physical parameters supported by the component and are
suggested to limit the values of the user in agreement with
the underlying mathematical modeling.
Description These properties provide additional information on the
function of the component within the system.
Identification These properties identify:
● Component’s functional location (installation, circuit).
● Component’s ports.
● Commercial or production origin, useful for the
reports (see section 6.1.1.4 Bill of Materials and
Revisions History and chapter 7 Reports).
Commercial These properties are associated with a symbol and are used
to generate various types of reports: BOM, commercial and
technical reports, etc.
Miscellaneous These are properties that cannot be classified according to
previous categories. They are related to editing
functionalities, such as the component layer, for example.
User Defined This category is visible only for the first user-defined
(custom) property. The variables of “Table” type have the
icon in the first column from the left in the list of properties;
and the variables of “Structure “ type have the icon.
The alias of the properties used by the simulator is displayed in blue in the
component properties dialogue box. The simulator can use them to evaluate the
component’s behaviour, to detect a maximum value reached, or to scale certain
sensors (cylinders, motors, etc.).
All the symbols used in a circuit do not necessarily correspond to a unique component:
for example, an assembly of symbols often represents a single product. Therefore, every
component of the library contains the property “Disregarded in B.O.M.” (In the
“Miscellaneous” category) for the option to exclude the component from reports and
lists. To exclude a symbol from the bill of materials, check this property for this symbol.
Properties Edition
It is also possible to edit the attributes of the current selected property in the “Details”
zone, when the latter is visible. For example, if the name by default of a property can be
associated with an alias.
To add a custom property, first make sure the component is not locked. Then, activate
the command (“Add Variable”) in the toolbar, and fill the required fields in the “Add
Variable” window.
6-34
Elements within a Diagram
Field Description
Variable Type Drop-down list to choose the variable type.
Measure Type Drop-down list to select the variable measure.
Variable Name Field to enter the variable name.
The following table lists the different types of variables in Automation Studio ™ (IEC
61131-3 or IEC 60559\IEEE_754):
AS VARIABLES TYPE Description Min / Max
BOOL Boolean False = 0 or True = 1
SINT Short Integer -128 to 127
INT Standard Integer -32 768 to 32 767
DINT Double Integer -2 147 483 648 to 2 147 483 647
LINT Long integer -9 223 372 036 854 775 808 to
9 223 372 036 854 775 807
USINT Unsigned Short 0 to 255
Integer
UINT Unsigned Standard 0 to 65 535
Integer
UDINT Unsigned Double 0 to 4 294 967 295
Integer
ULINT Unsigned Long 0 to 18 446 744 073 709 551 615
integer
REAL Real Number 3.4 E+/-38 (7 digits)
LREAL Long Real 1.7 E+/-308 (15 digits)
TIME Time N/A
DATE Date only N/A
TIME_OF_DAY Time of the day N/A
only
DATE_AND_TIME Date and time of N/A
By order: 16 bits reserved, 8 bits for the scale (exponent 10, from 0 to 28), 8 bits for the
sign (+ or -), 64 for the value.
Once added and edited, these hyperlinks are found at the bottom of the component’s
contextual menu (Figure 6-18: Contextual menu “External File”) or its tooltip, and are
accessible by simply clicking on the desired file. There are endless possibilities to work
with. Point to a manufacturer’s PDF file, play a video on the behaviour of a machine or
anything else using a hyperlink.
6-36
Elements within a Diagram
When working with hyperlinks, it is very important to remember that the link
between the source and the destination can be broken. It can be a permanent
break, if the file has been moved or deleted, or it can be a temporary break if the
Internet site or area network that hosts the file is down.
For more information on this branch, refer to section 6.5 Accessories Management.
Certain branches in the component properties window contain graphical data: for
example the Fixed Displacement Pump has the “Characteristic Curves” branch (Figure
6-19: “Component Properties” Dialogue Box, “Characteristic Curves”), and the Double
Acting Cylinder has the “Driving Force Curve” and “Resistive Force Curve” branches.
Characteristic curves are used during simulation for components with templates that are
defined by graphic modelling. Usually, a curve is defined for a specific value of a
parameter, which is based on one entry from the “Basic Technical Data”.
Refer to the Hydraulics and Pneumatics Workshops User’s Guide for the explanations of
pump behaviour curves, pressure drop in the pressure valves curves, actuator force
curves, ambient temperature generator curves, set point device curves, etc.
6-38
Elements within a Diagram
Area Description
column).
8 To access specific tabs (which number vary according to the
component) containing curve parameters. Help is available
under the button at the right top of the window called
“General Settings”.
Most hydraulic and pneumatic components behave in a way that can be graphically
portrayed. Each component in Automation Studio™ includes a set of standard curves
reflecting the manufacturers’ measures. For a specific component, each curve is
associated with a specific parameter with a differing value depending on the selected
curve. This parameter can be edited in its corresponding field. This parameter is also
visible in the component basic technical data. The value of the parameter visible in the
Technical Data can be modified, although it does not imply that a curve will be defined
for that specific value. However, the simulator automatically creates a curve based on the
component parameter using the in-between method. This curve is constructed
dynamically by the simulator and is not visible.
To edit a curve:
1. Select the curve to be modified.
The selected curve appears in a different colour.
2. Modify the value of the curve’s parameter if needed.
Look at the value of the component’s parameter in the “Technical Data”, and then
associate the value with the curve. Therefore, the edited curve is used by the
simulator instead of the in-between method.
3. Modify the values of the points’ coordinates that are displayed in the chart.
Or
4. Drag the curves’ points directly in the chart area.
During modification, points that do not comply with the constraints appear in a
different colour. These points should be changed prior to applying the changes.
While validating, constraints are applied in relation to the curve’s growth rate.
The simulator considers that a pressure curve based on flow is strictly increasing or
decreasing if the variation rate in absolute value is higher than 1 bar for 1000 LPM,
either dp/dq > 0.1 bar/LPM or dp/dq > 5.5 psi/GPM.
Some component properties can be dynamically modified during simulation; this is the
reason they are called “variables”. Automation Studio™ uses these component variables
and internal variables which are not linked to components to allow communication
between components. This communication link is called “Variable Assignment” which
doesn’t have any visual representation on the diagram. The Variable Manager is used to
visualize the variable’s assignment state (see section 2.2.6 Variable Manager).
It is essential to know the unit of both the output variable of the transmiter and the input
variable of the receiver. The following tables list the unit associated to each type of
variable according to their measurement type.
For example: from the following table, if you assign the “Output Signal Position” of a
cylinder to a controller, the controller read the value as meters even if the value is
displayed in a different unit on the editor.
6-40
Elements within a Diagram
Length m
3
Volume m
Angle rad
Linear Speed m/s
Angular Speed rpm
2
Acceleration m/s
2
Angular Acceleration rad/s
Time m:s.ms
Output Signal Without unit
3
Hydraulic Flow m /s
3
Pneumatic Flow m /s (Atm)
Pressure kPa
Temperature °C
Torque N.m
3
Displacement cm /rev
Fluid height m
Current A
Voltage V
Resistance Ohm
Frequency Hz
Energy J
Power W
An input variable is in reading mode. The input variable reads the value of an output
variable. For example : if the input variable is the resistive force of a cylinder, the
associated output variable will be read as kN.
Measurement Output Variable Unit
Force kN
Torque kN.m
External Load kg
Angular Speed tr/min
Dissipation Power kW
Power W
Inclination rad
Resistance Ohm
Inductance H
Capacitance F
Active Power W
Apparent Power VA
Reactive Power VAR
2
Inertia Drive kg.m
6-42
Elements within a Diagram
Component variables are automatically created when inserted onto diagrams. Logical
internal variables must be created by the user in the dialogue boxes of components’
properties or in the “Variable Manager”.
Some components act as transmitters in that they are transmitting their status or value
to other components or variables. For example, a relay coil transmits its status to
contacts that refer to it.
Other components act as receivers in that they receive their status or value from a
transmitting component or internal variable. For example, a relay contact receives its
status from the coil to which it refers.
Some components have several variables, some of which act as transmitters and others
as receivers.
The assignment of variables allows the creation of a Read or Write link from a specific
variable to a compatible variable or to an external variable, such as an element from an
OPC server. These links are used by the simulator to evaluate components’ status as well
as those of internal and external variables during simulation.
The options in the “Variable Assignment” branch differ depending on whether the
component is a transmitter or a receiver.
Figure 6-20: “Component Properties” Dialogue Box, “Variable Assignment” Branch for
Transmitter and Receiver Components
The following is a description of the fields that make up this dialogue box:
Zone Description
1 Toolbar This toolbar contains commands to:
● Add a variable to the component.
● Modify the dialogue appearance.
● Configure the displayed attributes and the variables
in the columns.
A right-click on the toolbar displays a contextual menu to
switch the display of a command in the toolbar. The
“Configure” command in the contextual menu opens also the
configuration window.
2 Table of the The component variables listed here are variables that can
component be linked (read or write) with other variables.
variables The displayed columns in this table can be chosen in the
properties configuration dialogue.
6-44
Elements within a Diagram
Zone Description
4 Associations This list presents the associations that have been created.
List
5 To create a link between the component variable and its
compatible variable.
6 To delete all the links of the selected variable.
5. Click on the “Delete All” Links to remove all internal and external links of the
selected variable.
The “Read Link” or “Write Link” column is updated.
The sizing sheets are located in the « Tool » tab, in the « Management » group.
The “Sizing Sheet Manager” window contains all the Automation Studio ™ technology
sheets. The available technologies and component groups are listed on the dialogue’s left
side. On the right side, the user can create different sizing scenarios, save and associate
them to the project’s component.
6-46
Elements within a Diagram
The sizing sheets are used to perform the calculations that are required to select and size
a component within a circuit. The sizing sheets calculate component requirements in
terms of capability, and apply certain properties to the components found in some
Automation Studio™ projects.
The sizing sheets use a computing engine to calculate unknown values with the available
values. They use theoretical equations to calculate some parameters and function
according to an equation resolution system used to vary some parameters and observe
their effects on other parameters. The following figure shows the tool’s interface.
6-48
Elements within a Diagram
To launch a calculation, the user needs to select the right technology and component’s
category. Then, he can access the sizing sheets on the tool’s right side. This tab contains
the default calculation sheets whose scope is Automation Studio ™ and the custom ones
whose scope is the project. The sizing sheets that are delivered with the application
cannot be modified (“Unlock Sizing Sheet” is disabled).
When a sizing sheet is selected, some values already appear in the “Calculations” fields
“Output” parameters: those parameters are taken from equations and stand for
researched (calculated) values.
“Input” parameters: those parameters are also taken from the equations but their value
has to be entered by user.
The parameters in bold (ex. Piston Diameter (D)) are the parameters whose values can
be exchanged with technical data of the component of the diagram associated to the
sizing sheet.
Making Calculations
To make calculations, the user has to select the sizing sheet corresponding to its search.
In the “Calculations” tab, “Input” parameters values can be modified with your project
Data. “Output” parameters values will then appear and be automatically calculated
(disabled fields).
6-50
Elements within a Diagram
The default units are those selected in the project properties (branch
“Project”“Standards” tab “edition”). They can be converted into any other unit
automatically with the drop list. If the default unit system is modified the new
sizing sheets created from that moment on will use the new units.
Let’s use the sizing sheet for the hydraulic double-acting cylinder in order to calculate the
piston and rod diameters of a specific cylinder in a system.
To visualize equations
To visualize equations, select the “Equations” Tab and scroll the whole equations that
have been used. The “Print Preview” and “Print” buttons allow you to print
this page content.
The equations cannot be modified and are meant for calculating units in International
System (IS). Some constants have possibly been added to equations for conversion
purposes.
6-52
Elements within a Diagram
Figure 6-28 Equations List Example for an Hydraulic Cylinder Sizing Sheet
Let’s use the sizing sheet for the 3-Phase AC Motor to compute the required voltage for it
to work.
The sizing sheets offer some additional information on certain parameters that are more
difficult to obtain. This information is for your reference only. It can vary according to
using conditions of components. It is important to be able to interpret these data and
understand what they represent before using them.
6-54
Elements within a Diagram
You can configure your own sizing sheets after the current list of a component category.
For example, you would like to know the displacement and inlet flow required by your
application for a hydraulic motor.
To accept the values entered in the editable fields click elsewhere on the sizing sheet.
Adding “Method 2” only helps to distinguish between this new sizing sheet with the
4. Select “Calculations” tab and, on the left, in the “Output” column, select the
“Displacement” variable to give it as an output parameter.
For each sizing sheet, certain parameters must be known in advance. The
checkboxes allow you to set known and unknown values.
Once they are selected, the icon indicates that calculations cannot be completed
with current data, appears on the left of the “input” and “output” checkboxes columns
and on the right of the variables in the “Calculations” tab. Then, you have to decide
which variables will be given as “known” by selecting the mathematical relative
equation. A click on the icon on the right of the variables unities displays an equation
selection dialogue in order to set the calculations source. In this dialogue, additional
equations are specified together with their variables and their current status in the sheet.
6-56
Elements within a Diagram
To know the meaning of an icon, place mouse cursor on it to display its tooltip.
5. Click on the icon on the right of the “Displacement” variable unities and select
the equation of the torque at the motor shaft.
The “Differential Pressure”, “External Torque” and “Mechanical Efficiency” variables are
added to the “Required Unknown” category and appear in gold.
6. In the “Input” checkboxes column, select the 3 variables with the icon .
In case the icon would appear in front of a parameter, this would indicate an
incompatibility between some “input” and “output” parameters. In that case, you
have to unselect the variables and review the sizing sheet.
When the cursor is moving above the parameters, an image of the component’s
symbol and calculation variables appear.
8. In the “input” parameters, modify the default values to compute a new
displacement:
● System Maximum External Torque: 100 daN.m.
● Differential Pressure : 350 bar.
● Mechanical Efficiency: 80%.
3
We get a displacement of 224.3995 cm /rev.
9. To know the motor’s flow, select “Input Flow” as “output” parameter.
Figure 6-35 Adding the Flow to Sizing Sheet of the Hydraulic Motor’s Displacement
10. Repeat step 5 to 7 as for the “Displacement” parameter by selecting the equation of
the rotation speed at the motor shaft.
6-58
Elements within a Diagram
Figure 6-36 Locked Sizing Sheet for Displacement and Flow of an Hydraulic Motor
With a nominal speed of 800 RPM and a volumetric efficiency of 85%, the sizing sheet
shows that the motor will require an input flow of 211.1995 L/min.
An input parameter value can be determine by different way from the following list:
● Manual entry
● Associated to the result of an other sizing sheet
● An utilisation profil
● Manual selection from a standard chart
● Manual selection in a table of standard data.
In case the sizing sheets already exist in the category of the selected component, you
can add some more and use the results of other sizing sheets as « input » values. In that
case, if the sizing sheet is linked to other sizing sheets, the icon used to reload
values of other sheets will be activated.
If we take the previous sizing sheet as an example, the input flow value could be
calculated in a new sheet. To link sizing sheets with each other, follow these steps:
1. Add a new sizing sheet and inform the “Identification” tab like the following
figure.
The icon appears in the list, on the left of “Displacement”. This shows that this
variable is not used at this point in the calculations.
4. In the “Calculations” tab, click on the icon, on the right of the “Input Flow”
variable. Specify the nominal speed equation as calculation source.
5. Select “Nominal Speed” and “Volumetric Efficiency (%)” as input parameters.
6-60
Elements within a Diagram
Like represented in the following dialogue, the icon indicates that the parameter
value should be entered manually.
At this step, it is possible to select the bottom checkbox indicating that the value can be
taken from another sizing sheet already present in this component category.
7. Click on this field then on the button which appears next to the parameter
“Displacement” to specify the sizing sheet that will give the displacement value.
8. The icon on the right changed into to show that this information can be read
from a linked sheet. Moreover, under the “Calculations” tab in the tools bar the icon
, which allows to update the values from linked sizing sheets, is now active.
Like shown in the following figure, a sizing sheet selection dialogue appears for you to
select the source that will give the value to the “Displacement” parameter.
Figure 6-40 Locked Sizing Sheet for a Motor’s Displacement and Flow
9. Select the “Displacement” unknown in the “Displacement (Method 2)” sizing sheet
previously created from the “Bidirectional Motor” category. Then, click on the
button to close window.
The icon on the right of displacement becomes which indicates that this data can be
taken from another sheet linked to this sheet. Furthermore, in the toolbar “Calculation”
tab, the icon used to reload values of other sheets is now active.
10. Click on the icon to reload the displacement value of the linked sheet.
3
The value 224.3995 cm /rev is applied to the “Displacement” parameter of the current
sheet and the “Input Flow” gives as result: 211.1995 L/min for a nominal speed of 800
RPM and a volumetric efficiency of 85%.
11. Lock the sizing sheet in order not to lose its configuration.
6-62
Elements within a Diagram
Input variable defined by a profile curve (time dependent curve) and energetic
evaluations
Some input variables can be defined by a profile curve, i.e. by a curve function of the
time with a specified “cycle duration”. These variables can be useful for an energetic
evaluation of the components.
Let’s take as an example a hydraulic orifice to calculate the lost energy over a cycle of
the passing flow. The following steps show how to use variables with a profile curve to
obtain an energetic evaluation.
1. In the “Sizing sheet manager” select the “Orifice” under “Hydraulic / Valves” in the
tree.
2. Add a new sizing sheet and edit its name and description under the
“Identification” tab (e.g. “Lost energy” as name and “Flow cycle” as description).
3. Select the tab “Calculations”, on the left under the “Outputs” column select the
“Dissipated hydraulic energy”. This will be the result of the calculation.
4. Click on the icon on the right of the variable units of the “Dissipated hydraulic
energy” and select the proposed equation.
5. The energy is calculated as the integral of the power over the cycle piriod. The
parameters “Cycle duration” and “Dissipated hydraulic power” are shown as
“Required unknowns”. Select the “Dissipated hydraulic power” as an output and the
“Cycle duration” as an input.
6. Click on the icon on the right of the “Dissipated hydraulic power” units and
select the given equation (product of flow and differential pressure across the
orifice).
7. Select in the output column the “Differential pressure” and under the input the
“flow”. Change the flow unit for l/min.
8. Click on the icon on the right of the “Differential pressure” and select the
equation “Head loss”.
9. Select all new requested unknown in the input column. Set an opening area greater
than zero.
Figure 6-42 Sizing sheet to evaluate the lost energy across an orifice
Most input variables are a constant numerical value over time, but some when used as
an input can be defined by a profile curve. This applies, for instance, to the “Flow”. In the
following steps we will define the flow as a time dependant curve with specific cycle
duration and will observe the result on other parameters.
6-64
Elements within a Diagram
10. Click on the icon on the right of the “Flow” variable units and select the option
“Profile curve”.
11. The icon on the right of “Flow” has been replaced by to represent that this
variable is defined by a time based curve. The button has also appeared, click on
it.
As shown in the following figure, a dialog window opens allowing the definition of the
profile curve:
Description
1 Toolbar
Description
2 “Plotter” panel. This panel gives access to the appearance configuration of the
plotter. Different options are configured in the project properties under the
“General standards” branch in “Plotter, Curve editor and Oscilloscope” (see
4.2.2.6 “Plotter, Curve Editor,Oscilloscope and Sizing Sheets” Branch). The
following properties are specific to the single curve:
● Curve axis upper value
● Curve axis lower value
● Time axis upper value
● Time axis lower value
The panel visibility can be modified using the show/hide button on the
upper left corner.
4 “Curve” panel. The upper part of this panel shows the axis name with their
units. In the lower part the curve coordinates are listed.
The panel visibility can be modified using the show/hide button on the
upper right corner.
Automatic scale to Resize the plot area to visualize the data points of the y
y axis curve.
Automatic scale to Resize the plot area to visualize the data points of the x
x axis curve.
Automatic scale to Resize the plot area to visualize the data points of all the
all axes curves.
6-66
Elements within a Diagram
The axes units refer to the chosen units of the variables in the sizing sheet.
12. Add points to the curve by double clicking on the graph area. The point coordinates
are automatically added to the points list. For the example use the following points:
Time (s) Flow (L/min)
0 6
10 10
30 10
40 1
50 2
60 6
When the data points are visible (“Show data points” option active) it is possible
to modify the point position by drag and drop.
To add a point it is also possible to use the contextual menu on the point list and
select insert.
Another option is to paste the values from a table. The points beyond the cycle
duration period will not be considered in the sizing sheet calculations. The copy
from the points list to another software is also allowed.
All outputs depending on the flow, which is defined as a function of the cycle
6-68
Elements within a Diagram
duration, become as well variable on the cycle time. A button appers on the
right next to their value allowing the visualisation of their evolution over the cylce.
The visualisation dialog has the same layout as the one for the definition of the
profile curve, but it is not allowed to edit the curve points. Once the input variable
profile curve defined, it is sampled, with a period short enough to have a precise
measure but not to overload the calculation, and then the outputs are evaluated.
If the profile is variable over the cycle duration, in the sizing sheet the parameter’s
field will be “Variable value”. If, instead, the profile is constant over the cycle
duration the parameter’s field in the sizing sheet will display the constant value.
The only exception applies to the energy as it will always display the value at the
end of the cycle even though it varies over time.
In a single sizing sheet many profile curves can be used for different variables, if
they allow this type of definition.
Figure 6-47: Sizing sheet to evaluate the lost energy across an orifice
Figure 6-48: Hydraulic dissipated energy profile through the orifice over a cycle
14. The dissipated hydraulic energy for this example over cycle duration of 60 seconds is
0.028 kWh.
15. Lock the sizing sheet to prevent accidental modifications.
The sizing sheet print tool includes the curve of each variable with the information
about its maximum, minimum and mean value over the cycle duration.
To create an association between a component and a sizing sheet, you just have to drag
and drop the compatible component from the diagram to the “Sizing Sheet Manager”
6-70
Elements within a Diagram
window. The component category and the present sizing sheets will be automatically
associated to the component.
Once the component is associated, the reloading icon and the transfer icon for
parameters values are activated. On the right of the toolbar, the component ID and its
name are disabled.
The same association can be done via the project’s component properties window:
1. Select the component to be sized and double-click on it to open its properties
window.
2. In the toolbar, click on the icon to resize component.
The “Sizing Sheet Manager” is open and the hydraulic motor is associated to the right
sizing sheet category.
If the calculated values do not follow the technical data’s constraints, those cannot be
transferred. For example, the last computing imposes on you a motor displacement of
3
224.4 cm /rev. Now with the hydraulic motor component, if you fix the maximum
3
displacement to 100 cm /rev, the calculated value cannot be transferred because of the
constraint. A message tells you that the sizing sheet cannot transmit this value or any
other value to the technical data of the associated component.
If the component properties are locked, a message will ask you to unlock those in order
to execute data transfer.
Finally, since calculation can be made only when software is in editing mode and not in
simulating mode, the dynamical values calculated by simulation engine (pressure, flow
etc.) are not transferred to the sizing sheets. Only constant values of compatible
parameters found in the technical data of component can be transferred to the sizing
sheet.
6-72
Elements within a Diagram
curves. If the coefficient is not linked to one of the axis, its different values are displayed
in the plotter legend.
For example, on the following image, the unknow parameter is the density (Y axis)
which is a function of temperature (X axis) and is different according to the type of oil
(Legend).
Interface
The plotter window can contain many curves per chart located in different tabs (1).
To select data, simply click on a curve, or between two curves of the chart (2), at the
desired point based on the others parameters. The unknow parameter value will be
displayed in the result area (3). To transfer this value to the sizing sheet, click on
.
For more details about the plotter interface, refer to section 9 Plotters.
If you move your mouse pointer on the chart, the coordinates are displayed next
to it.
If you click between two curves, some chart returns a value of an interpolation
between the curves, other charts will return you the value of the closest curve.
Some variables are associated to an additional information curve. For these variables it is
possible to set a determination mode to “value issued from an additional information
chart”.
In this example, we will create a sizing sheet to determine pressure drops in a hydraulic
line. To do so, in the sizing sheet manager:
1. Click on the command “Add a new sizing sheet” at the top of the window
and give it the desired name in “Identification” tab;
2. From the variable list, check the right box next to “Laminar Flow Pressure Loss” to
set it as output variable;
“Laminar Flow Pressure Loss” variable now appears under “Calculations” tab in
“Outputs” category.
3. Click on command on the right side of the parameter to display the list of
equations and click on the first one;
All the variables required by the equation are now displayed under “Required
Unknown”.
6-74
Elements within a Diagram
5. In the list of variables, check the left box of each variable appearing under
“Required Unknowns” as illustrated below to define them as “Input”;
All Unknown variables now appears under “Inputs” on the right section of the
window.
7. Click on command now available at the right of “Density” to open the chart;
8. Select the desired value from the chart to become the default value of the sizing
sheet and apply changes .
The sizing sheet has been created and is now ready to be use.
6-76
Elements within a Diagram
Interface
The additional information table window can contain many tables located in separate
tabs (1). Each column of a table (3) represent a parameter or property, when a line
represented a configuration. When a line is selected, the unknown parameter value is
displayed in the result area (4). Click on apply (5) to upload the new value to the sizing
sheet.
Some variables are associated to an additional information table. For these variables it is
possible to set a determination mode to “value issued from an additional information
table”.
In this example, we will create a sizing sheet to determine pressure drops in a hydraulic
fitting. To do so, in the sizing sheet manager:
1. Click on the command “Add a new sizing sheet” at the top of the window
and give it the desired name in « Identification » tab;
2. From the variable list, check the right box next to “Pressure Loss” to set it as
output variable;
3. Click on command on the right side of the parameter to display the list of
equations and click on the first one;
All the variables required by the equation are now displayed under “Required
Unknown”.
4. In the list of variables, check the left box of each variable appearing under
“Required Unknowns” as illustrated below to define them as “Input”;
6-78
Elements within a Diagram
All Unknown variables now appears under “Inputs” on the right section of the
window.
6. Click on command now available at the right of “Loss Coefficient” to open the
table;
7. Select the desired value from the table to become the default value of the sizing
sheet and apply changes.
For the animation Properties: Refer to the HMI and Control Panels Workshop User’s
6-80
Elements within a Diagram
The zones described here are the same as in section 6.2.1 “Data” Branch. The available
properties are the following:
Field Description
Internal ID Unique ID of the component.
Layer Layer on which the drawing will be displayed.
This branch is available for images only. To make a specific colour transparent, simply
check the “Transparency” option and, with the tool, and select which colour to make
transparent.
Every CAD object (ellipse, rectangle, arc, polygon, …) possesses the “Hyperlink” branch
called. This feature is used to create links that can open an external PRX file generated by
Automation Studio™, or by another correctly installed application on a computer. These
hyperlinks do not work when Automation Studio ™ is in simulation mode.
Hyperlinks are particularly useful in the design of didactic projects: a directory of PRX
projects in a design can be linked together with hyperlinks. This allows knowledge
transfer, demonstrations or any other educational project implying complex systems.
6-82
Elements within a Diagram
To create a hyperlink:
1. Select a CAD object (text, image, line, rectangle, ellipse, polygon or circle) of the
diagram, open its “Component Properties” dialogue box and choose “Hyperlink”
branch.
2. Type the access path in the “Destination” field, (see the following sections for
hyperlink syntax).
3. Or, choose the cursor form when it is on the object, in the “Cursor Type” drop-down
list.
To launch a hyperlink
1. Place the cursor on the drawing object that contains the hyperlink.
A tooltip appears as a reminder of the launching key combination.
2. Hold the CTRL key and click on the left button.
To navigate forward and backward between documents previously reached, use “Back”
and “Forward” in the “View” tab.
Hyperlink Syntax
The hyperlink syntax related to objects created in Automation Studio™ respects the
following structure containing 4 fields separated by the “:” character.
If the hyperlink source leads to a target located within the same project, it is useless to
set the project path. However, the “:” and “:”separators must remain.
6-84
Elements within a Diagram
Example : http://www.automationstudio.com/
● FILE: This protocol is used to display a file in the associated application window.
● SCRIPT: Refer to the APIs User’s Guide to launch scripts through hyperlinks.
nd
Field 2: Project path: The 2 field defines the project path.
ASREFISO:[Project1]:[Component1].[View1]
ASREF:[Project1]:[Document3]:[Component4].[View2]
Object Identifier
The object identification can be done in many ways. Each document type is free to set its
suitable format. In the following examples, SFC components are identified by their ID X#
(step) and Y# (transition).
Some components cannot be referenced by a text hyperlink. The syntax has not yet been
extended to deal with these cases and browsing options were developed instead. If
needed, the syntax should be extended.
● Some parts of an electrotechnical device (because they all have the same ISO
code).
● The terminals of a terminal strip.
● A cross-reference satellite (because the ISO code is unknown).
Examples
In the following examples each case will be illustrated. For convenience, we show the
project manager with all the documents to be used.
6-86
Elements within a Diagram
For relative path case, as stated above, this implies that Famic_Excavator.prx and
Famic_Excavator_Driving_System.prx projects are in the same Dir1 directory.
The syntax defining the absolute project path is used. Note that for the component, no
path is specified as the internal identifier or ISO code is enough to identify the
component in the project:
The syntax defining the relative project path is used. To make this link works, it is
necessary that the original project, which contains the hyperlink, is in the same directory
as the target project:
If the Famic_Excavator.prx file was in a subdirectory Srep2 then the syntax would be:
6-88
Elements within a Diagram
Other Examples
Hyperlink Syntax Target
ASREFISO::1-1P1 Pump with internal identifier 1-1P1 in the active
project.
ASREFISO:Project1:1-1P1 Pump with internal identifier 1-1P1 in the active
project (without < and >).
ASREFISO:<C:\Project1.prx>:1-1P1 Pump with internal identifier 1-1P1 in another
project (with < and >), written in absolute syntax.
ASREFISO:<Project1.prx>:1-1P1 Pump with internal identifier 1-1P1 in another
project (with < and >), written in relative syntax.
ASREFISO::1-1V1.SOL1 SOL1 distributor command of the 1-1V1 valve in
the current project.
ASREF::X1 A SFC component with relative document.
The first way to transform the component is to drag and drop it to the “Accessory
Manager”.
To do this,
1. Open the “Accessory Manager” window by clicking on tab “Tools” “Management”
“Accessory Manager” (see section 2.2.7 Accessory Manager).
2. Select the component.
3. Drag and drop it in the “Accessory Manager”.
4. A dialogue box opens to confirm configuration of the symbol as an accessory. Click
on “Yes”.
5. A line corresponding to the symbol is added to the Accessory Manager, under the
“Accessories with Symbol” tab.
6-90
Elements within a Diagram
The second way is to transform the component by clicking on the checkbox “Is
Accessory” in the branch “Accessories” of the “Components Properties” (see section
6.2.2 “Accessories” Branch).
Open the Accessory Manager in the “Accessories with Symbol”, to find a new line
corresponding to the symbol has been added.
6-92
Elements within a Diagram
this:
1. Make sure the accessory is unlocked.
The properties will be added to the accessory model without a symbol in the “User
Defined” category in the bottom area of the “Accessories without Symbol” tab.
Once the accessories are defined in the “Accessory Manager”, it is possible to associate
them to a component or to a project for the accessories without a symbol.
The “Associations” tab shows the association between accessories and parent
components. The accessories of a component are also presented in the “Accessories”
branch of the component properties window (see section 6.2.2 “Accessories” Branch).
In the following example shown in the following figure, the dialogue box shows that the
accessory A321 has a symbol that can be simulated (Automation Studio ™ icon) and that
is associated to the parent P1 (“Parent Identifier” column).
6-94
Elements within a Diagram
The following figure shows that an instance of the Accessory without Symbol A321 is
associated to the “Project1”, and that it is not associated to any component.
To delete an association:
1. Open the “Associations” tab in the Accessory Manager.
2. Select the accessory to delete.
To delete an accessory:
6-96
7 Reports
Reports are information documents that are generated using the data from technology
components of the current project or of its documents. All single or assembled
components from libraries and catalogues are considered when creating a report.
Reports are managed the same way as any document type in a project and are
accessible from the project explorer once created.
Automation Studio™ can produce reports based on the project created. Some report
templates are provided with the regular version of the software, but you can create your
own personalized template.
If the report’s characteristics are to be modified, right-click the report in the Project
Explorer and choose “Properties”.
7.1.1 Creating
To create a new report, first create a project containing diagrams. Once this is complete,
When created, new reports have a default name given by the report naming rule
standard accessible from the project properties (see section 4.2.1.2 “Standards”).
Reports can be renamed through the contextual menu of the report in the “Project
Explorer”, or in the Report Properties under the “Document Properties” Branch
“Information” category.
At this point, the report appears in the project’s tree of the “Project Explorer”. Notice that
another view appears under the report.
While a report itself is shown in a spreadsheet form (Figure 7-1: Report Example), the
Report View corresponds to the print view (Figure 7-3: Report Print View), and matches
the report’s Page Setup Standard (page orientation and format, title block…).
7-2
Reports
Figure 7-3: Report Print View
The report’s Page Setup Standard can be accessed via the report’s properties,
under “Document Properties” branch, “Standards” category.
While displaying a report’s view, you can navigate through pages with “Next” and
“Previous” commands.
To create a template:
Notice that many parameters of the report (data, fields, …) are compatible with
user translations. However, to ensure a proper formatting, make sure to select the
same language to display than for edition. Refer to section 2.2.9 Translation
Manager for more details.
The data selection is done through the “Data” branch of the report’s document properties
window.
The sources of the report’s entries can include the types of elements:
● Technology Components
● Accessory Components
● Component Failures
● Virtual components such as cables, PLC, …
7-4
Reports
● Project documents
Filtering rules are defined by sets of rules. For each set, in the dropdown list, there are
three possibilities of treatment:
Create a Rule
To create a filtering rule, select “Add a new rule” command by clicking on button.
Select the set of rules scope and configure the desired values in section (1) of the figure
below.
A filter’s scope for a selected source is applicable exclusively to the following items:
7-6
Reports
The figure below shows an example of a set of rules allowing to filter all hydraulic
components on a visible layer with a manufacturer other than Famic.
All single or assembled components from the library or a catalogue are considered
in a report.
Types of Properties
This dialog appears frequently during the report configuration, it allows the user to
choose a type of property.
7-8
Reports
The property identification is a combination of the name (not alias), its value and
unit.
« Manually Configured Property » Type
For a custom property, the characteristics have to be entered manually. However, the
property needs to exist to receive a value from the source.
« Property » Type
Only properties from the current project, its documents and components appears in the
dialog.
Fields
Column’s field configuration is done from the “Field” branch of the report properties
dialog.
7-10
Reports
Area Description
1 Add or delete a field.
2 Modify a field position:
Move to the top
Move up of one position
Move down of one position
Move to the end.
3 The filters toolbar allows you to filter, or mark fields in a filter applied to
the selected columns of the dropdown list.
Area Description
4 Selected fields and main characteristics:
“Order” of fields in the report
“Is Displayed” or not in the report
“Locked” (not editable) or not. This characteristic can be editable or
not by the user for some fields
Automatic “update” or not of a field for related items.
Add Field
7-12
Reports
Zone Description
1 Selection of a type of field.
2 Characteristics of the selected field.
Types of Fields
The field configuration and characteristics changes according to the type of field selected.
Property Field
Add different types of property field, refer to section “Types of properties” for more
details.
In this section, you can add the required component properties for a bill of
In most cases, you can edit property values in the report and they will be
transferred to its associated component.
Grouped Field
A grouped field allows to group values of properties from different source type.
This field is useful if you desire to have a column with a list of all manual
configurations of components in the circuit.
Select a group property from the list (1), then add a property (2) and choose the
7-14
Reports
Properties displayed in area (3) have to be added previously to the fields list (1).
Those properties don’t need to have the attribute “Is displayed” set to true.
Quantity Field
This expression is a combination of operators, functions and existing fields from the list.
First, select “Calculated Field” (1) and then click on the “ ” button (2).
7-16
Reports
The “Expression Editor” opens up, to edit the field’s expression (2). Use “Functions”,
“Operators”, “Fields” or “Constants” in zone (4) and choose an option located in zone (5)
to create your expression.
The property list that appears in zone (5) is the list of fields added to the report.
The value of “Is Displayed” characteristic, does not need to be TRUE in the report.
Report field
A “Report Field” is a custom field applied to a specific report. This field will be
automatically added as a property to all components linked to this report.
For a custom report field, a value must be added to the “Editable Description” as the
“Name” will be automatically added. The goal is to make the “Name” unique as it will be
sent through the report’s items list.
This field is useful to assign properties to specific components in the project, but
not all of them, like a global variable would do (go see chapter 4.2.1.5
Components’ Global Properties).
When a report’s data and fields are configured, the grouping function can help to make
the report lighter to read and easier to find information.
Access the “Grouping” branch in the report’s document properties to configure grouping
options. This dialog contains two sections: the “Grouping Properties” (1) and the
“Property Concatenation” (2).
Area Description
1 Field selection for the group.
2 Field selection to concatenate values of grouped rows.
7-18
Reports
report.
After adding the “Manufacturer” property for the group with the fields “Part Number”
and “Component Names” as “Property Concatenation”, this is how the data are displayed
in the report:
Figure 7-20: Report after grouping and conatenating component name and part number
Once the configuration of your report is completed, you can create a Report Template.
TM
With the report opened, go to Automation Studio Menu “Document” “Save
Report Template”. The User-defined Report Templates dialogue box opens to name the
new template and enter the directory in which the template will be saved.
The report template has the *.re file extension. It is recommended to save all templates
in the suggested directory. All templates in this location are automatically loaded when
starting Automation Studio™.
7-20
Reports
TM TM
To modify this option, go to Automation Studio Menu Automation Studio
Options and modify “Templates Location”
Some actions can be performed on a spreadsheet report when it is active on the screen.
In the spreadsheet, you can edit an unlocked cell by double clicking on it.
When you modify the value of a cell, this value will be automatically updated in its
source component.
Some actions can be done on a row from the contextual menu in the report editor.
Hyperlink Function
When the mouse cursor is placed on a report row and open the contextual menu with a
right-click, then the command ”Follow the Link” (Ctrl-Click shortcut). When executing this
command, a document view is activated on the highlighted component.
Resize a column by clicking the vertical line that separates headers, and by dragging it to
the left or right. Also see section Error! Reference source not found. Error! Reference
source not found..
A great number of actions can be applied on the report’s columns, these actions are
explained below.
You can open the contextual menu with a right click to access the following functions:
7-22
Reports
Best Fit (all Minimize all column sizes keeping all fields visible.
columns)
Filter Editor This command opens the filter editor dialog. This dialog
allows you to create filters for the selected column from
the different values of the associated field.
Display a Column
Hide a column by dragging its header out of the spreadsheet. To display it again, go to
the “Fields” branch of the Report’s document properties and check the box of the “Is
Displayed” property.
You can move a column’s position in the spreadsheet by dragging its header at the
desired position.
To add a filter to a column, access the filter editor from the contextual menu. From the
“Filter Editor” dialog, a first group must be selected from its dropdown menu. You can
also add a condition, add a group or clear it all from the same contextual menu.
Once the filtering group is set, choose the condition type from its contextual menu by
right-clicking on it and enter a value.
7-24
Reports
There are three types of summary panels available for a report : Report Summary Panel,
Column Summary Panel and Group Summary Panel.
Summary panels are used to display information about the column, group or report. The
available summary values are: “Sum”, “Min”, ”Max”, ”Count” or “Average”. Summary
values can be added to a panel directly from its contextual menu or by the option
“Customize...” of the contextual menu.
All types of summary panels can be displayed or hidden from the ribbon’s bar “View”
tab, “Display” group.
To customize a summary panel, first, select desired summary items (2) for each field (1).
All selected items will be displayed in the summary panel.
Then, go to “Order” tab and modify the layout (1 and 2) or prefix and suffix text of an
item (3) and validate (4).
7-26
Reports
There are two types of group summaries, the group summary panel and summary in the
group header. To edit and customize a summary in the group header, right click it and
access the contextual menu of a grouped column header. Then, from the contextual
menu click on “Group Summary Editor...” to open the “Group Summaries” dialog. From
this widow, it is possible to customize the summary of a group header in the same way
as done for a group summary panel.
Selection :
To select cells in a report, click on a first cell and drag the pointer towards a second one.
The contextual menu offers the possibility of executing the “Copy the selection”
command.
The contextual menu also offers the possibility to navigate through the report.
7.1.4 Export
A report can be exported to many file formats. To export a report click on “Export...”
command located in the “Report” tab of the ribbon’s bar, as shown below.
7-28
Reports
7.1.5 Update
Updating the report is necessary after some changes that will impact the report’s content
or appearance.
If the report or its print view is active, use the command “Update Information” in the
“Tools” group under the “Report” tab of the ribbon bar.
The “Export” command in the figure above export the report’s content to a text file.
Reports can be included when printing a project: refer to section 4.1.4 Print and Print
Preview for more details.
A report is saved with the project. When the project is re-opened, the report contains the
same information as when the project was closed.
Under the “Document Properties” branch can be found the standards used for the report,
as well as a number of parameters and properties.
7.2.1.1 “Standards”
In the “Standards” category, choose and modify the standards used for the report. The
“Page Setup Standard” contains such information as page orientation and format, and the
title block. The other standards are used here to set the naming rules for the components
in the report. Refer to section 4.2 Project Properties for more information on the
standards.
● Page Setup Standard
● Map Locator Standard
● One-Line Standard
● Electrotechnical Standard
7-30
Reports
● Fluid Standard
● Electrical Standard
● Digital Electronic Standard
● Ladder Standard
Fields
Grid
Row Headers
Groups
Group Headers
7-32
Reports
Name Description
Group Header Text Typography Set the font used in the report’s group
headers.
Group Summaries
Grid Summaries
Value Presentation
Search
Name Description
Search Mode Set the report’s search mode to “Filter”
or “Marker”.
7.2.1.3 “Information”
Similar to the project and document properties, the information branch of a report
contains “information” about the document along the different steps of its creation and
the identification of its contributors.
View the details of the selected information in the “Show Details” part at the bottom of
the dialogue.
This data is available in the automatic fields, which can be accessed from the “Home” tab
“Drawing” group “Field” command.
“Revisions” Branch
This option is available only for reports created before Automation Studio
TM
version
6. 3.
The “Revision” branch is used to follow the evolution of a report. Create many revisions
for a given report and display earlier revisions of the report, or compare two different
revisions.
7-34
Reports
Before creating a first revision, the button “Last Revision” is the only one active. The last
revision refers to the current version of the report.
To create a new revision, enter a name for the revision in the field “Revision Name” and
press the “Create Revision” button. The new revision is a snapshot of the current report
at the time it was created.
To view an earlier revision of the report, check the “Revision” radio button and choose
the revision in the drop-down list. When the report is updated, it will show the notice
“Displaying Revision X” at the bottom, where “X” is the revision’s name.
To compare two revisions, check the button “Comparison” and choose the revisions to
compare in the two drop-down lists. The checkboxes below provide extra options to
choose what to display in the comparison. When the report is updated, it will show a
notice at the bottom.
7-36
8 Simulation and Analysis
Upon completion of a diagram or project, a simulation is used to test, verify, analyse,
diagnose, troubleshoot, and eventually validate the design’s integrity.
This section of the User’s Guide gives an overview of simulations. In the User’s Guides of
the various workshops, there are examples of simulations related to the workshop’s
technology.
In the Simulation mode, none of the Edit commands can be used, and modifications
cannot be made to the project or diagram. As a result, deactivated commands are grayed
out. However, it is possible to browse through and display projects and diagrams while in
Simulation mode.
The status bar shows the time elapsed during simulation (see section 2.1.7 Status Bar).
The Mouse Cursor: The hand represents the possibility of intervening during
simulation. Based on the workshop and components inserted in the diagram, make
various modifications such as adjusting the orifice size of the throttle in the Pneumatic
workshop, or activating the push-button of an on-off switch in the Electric workshop.
Window Layout: When a project contains a circuit which spans several diagrams, it is
helpful to place windows so as to have an overall view of the diagram:
1. Open all windows to display.
2. Choose “View” “Window” “Vertical Tile” or “Horizontal Tile”.
3. Select a diagram by clicking on its window.
4. Click on “View” “Zoom” “Zoom All Components” to view the entire diagram in
the window.
5. Repeat previous step for each opened window.
When a project is saved after choosing this layout, the layout will remain the next
time the project is opened.
To simulate the current project: Choose the “Project Simulation” command in the
“Simulation” tab “Mode” group, and then activate one of the simulation commands in
the “Simulation” tab “Control” group (see section “Control” Group“Control” ). The
“Simulation” mode is launched. Elements from the current project’s circuits appear in the
colours related to the Simulation mode. For further information on simulation colours,
refer to standards of the related workshop.
In Simulation mode, it is possible open different diagrams with the “Open” command or
creates a new view with the “New View” command from the document contextual menu
in the “Project Explorer”.
At any time during simulation, switch to another simulation speed just by clicking
on the desired mode command in the “Simulation” tab “Control” group.
8-2
Simulation and Analysis
To launch the Simulation of the Diagram: Open the diagram to simulate. Choose
“Simulation” tab Mode group “Document Simulation”; then choose a simulation
command from the “Control” group. The Simulation is launched and applies only to the
selected diagram.
The simulation pace determines the general parameters of the simulation: simulation
time step, frequency division factor for electrotechnical simulation and animation refresh
rate.
8.2.1 10 ms Simulation
The 10 ms simulation pace is active by default and is the most commonly used. Its
purpose is to allow quick simulation of large circuits and instant interaction with them.
When simulating using this pace, the simulation step time is 10 milliseconds. Because
this step time is not fine enough to sample signal frequencies of 50 or 60 Hz, a frequency
division factor is introduced which divides all electrotechnical source frequencies by 20.
When simulating using the 10 ms pace, components are simulated in steady state;
transient responses are approximated.
If a behaviour seems to be unstable with a certain simulation pace, reduce it for the
simulator to resolve the calculation in a finer way.
8-4
Simulation and Analysis
In this case, the simulation step time is 500 microseconds. This step time is fine enough
to accurately sample frequencies of up to around 100 Hz. It can sample frequencies
above that, but the reduced number of samples per period may result in less than ideal
signal representation. The highest limit above which signal sampling becomes impossible
is 500 Hz for the 0.5 ms simulation pace.
When simulating using this pace, large circuits may simulate slower than real-
time. This simulation pace is ideal for medium to small sized circuits.
In this case, certain components will show a more accurate transient response.
In this case, the simulation step time is 100 microseconds. This step time is good enough
to accurately sample frequencies of up to 500 Hz. It is able to sample frequencies above
that, but the reduced number of samples per period may result in less than ideal signal
representation. The highest limit above which signal sampling becomes impossible is 2.5
kHz.
When simulating using the 0.1 ms pace, medium to large circuits may simulate
slower than real-time. This simulation pace is ideal for small sized circuits focusing
on a few components.
The fluid simulation cannot work properly if a connection is missing. Hence, an error
message appears.
In simulation mode, if the option to display server messages is selected in the “Add
Server” dialogue box, the messages will be displayed during simulation.
In edit mode, the OPC server state is indicated in the dialogue boxes of creating links
between OPC items.
The snapshot saves the values of the simulator in an internal file. This file can be used to
reinitialize the simulation. For example, if an accumulator takes 2 minutes to fill, it can be
useful to capture this circuit state when it is full and to study only the unloading phase,
8-6
Simulation and Analysis
The added value of this feature is two-fold because of the considerable time gain when
studying the different work stages of a machine on one hand. Furthermore, it allows the
analysis of the behaviour differences of the circuit as a result of component modifications
and technical data changes.
The data acquisition is created. Click on the desired simulation speed command to
continue the simulation.
This activation mode is available only for Hydraulics and Pneumatics Workshops. Refer to
the user’s guide of these workshops for details on Steady State configuration.
1. Open the “Project Properties” dialogue “Project” “Properties” branch
“Simulation” category.
8-8
Simulation and Analysis
You can access this function in the ribbon via the “Simulation Options” command
located in the “Control” group of the “Simulation” tab.
8-10
Simulation and Analysis
Every simulated document and component receives a unique ID (ISO code) inside a
project. When a snapshot is triggered, each simulator returns the information on every
simulated document and component, as well as general information on the simulator.
The contextual menu of a data snapshot in the project explorer offers the following
commands:
Command Description
Simulate With This Data To launch a simulation with the values saved in the
snapshot document.
See below for more details.
Export… To export the contents of the snapshot document to
a tabulated .txt file.
More information below.
Cut Standard operations.
Command Description
Copy
Delete
Snapshot can be used to define new initial conditions of a simulation. The simulation can
restart with the same setting as the saved conditions. The relative simulated time starts
at 0. The absolute simulated time is equal to the saved time of the snapshot.
Select a snapshot document in the “Project Explorer”, open its contextual menu and
activate the “Simulate with this Data” command.
or
Activate the “Simulate with Snapshot” command in the “Simulation” Tab “Control”
Group.
The following dialogue box is displayed to choose the desired snapshot document.
8-12
Simulation and Analysis
This function can be used only if the measuring instruments have been inserted with the
option “Record” activated. Refer to section 8.4.2 Dynamic Measuring Instruments for
details.
1. Select a snapshot document in the “Project Explorer”.
2. Open its contextual menu and activate the “Export” command.
The “Filter Configuration” dialogue box appears. It contains two lists for multiple
object selection.
It is possible to open this report with Excel or other similar software. The following
figure shows an example of a snapshot document report transfer to spreadsheet
software.
8-14
Simulation and Analysis
Attribute Description
Simulation Information on the simulation that produced this data
Information snapshot (cannot be edited):
● Type of stop condition: manual, with delay, or steady
state condition.
● In case of steady state, the condition.
● The absolute simulated time.
● The list of simulated diagrams.
● The project’s options.
Renaming or deleting the file necessary for the snapshot, renders it invalid
anymore. Also pay attention to the diagram modifications. If a component is
deleted, its data is not used. If a component is added, the simulation starts in its
default state. If a component is modified, the snapshot data is reinserted if the
simulation is possible with this new data.
Dynamic measuring instruments are specialized components satellites that obtain useful
information on the variables used in a simulation. In order to avoid inserting unnecessary
components in real schematics, these instruments, accessible in the “Simulation” tab
“Measuring” group, can be inserted in a circuit during simulation.
The main purpose of these dynamic measuring instruments is to display and record a
given property. It is then possible to plot evolution curves of variables and to build a
complete analysis report of the simulation. Unit and refreshment period can be specified.
Figure 8-12: “Simulation” tab “Measuring” Group for Fluid, Electrotechnical and One-
Line Editors
One-Line
Electrotechnical
8-16
Simulation and Analysis
Figure 8-13 Activating Power Dynamic Instrument then Setting the Flow
2. Click once the line to set the flow. It will be highlighted in blue. Release. Select a first
junction and, holding down the left button of the mouse, drag and drop it to any part
of the editor.
8-18
Simulation and Analysis
There are two different ways to open the “Measuring Instrument Properties” dialogue
box.
● When creating a new measuring instrument.
● When opening the component properties (“View” Tab “Properties” group
“Component Properties” command, contextual menu, double-click, or ALT-ENTER,
etc.).
8-20
Simulation and Analysis
Reinserts the registered values in the plotter in order to read again the curves.
Exports the registered values by the measuring instruments to a .txt file that can
be used for analysis or reuse by the simulator.
The contextual menu of a dynamic measuring document in the project explorer offers the
following commands:
Command Description
2. Open its contextual menu and activate the “View” command or drag and drop it
directly onto the plotter.
The plotter appears if it is not already opened and the recorded measures are
displayed.
8-22
Simulation and Analysis
To export measures:
Activate the “Export…” command in the measures document contextual menu. If the
values registered in the document are displayed in the plotter, activate the “Export”
command in the plotter.
Set the export file name and the folder in saving dialogue box, then click on “Save”. The
obtained file can be imported into other software (Excel for example).
.
Figure 8-21: Snapshot “Document Properties” Dialogue Box
Attribute Description
Saved The document last save date and time (cannot be edited).
Type of document.
All the video commands are grouped together in the “Tools” tab “Video Recording”
group.
8-24
Simulation and Analysis
The following figure shows all options that can be configured for the recording properties
of Automation Studio™ (accessible from the “Recording Options” command of the “Video
Recording” group).
Zone Description
Video Quality To set recorded file compression. The higher the quality, the
larger the associated file size.
Zone Description
recording.
Marker Options If the cursor is displayed, you may display the mouse
movement, the mouse click or both. For each one, you can
select the colour (“Click colour”).
Audio Parameters From this section you can activate and deactive the audio
recording. If the audio recording is activated, you can select a
recording device.
Audio Recording Display a list of available recording device, you must select
Device one of the choices for recording. This option is only available
if the Audio Recording is activated.
The last two options are deactivated when no recording device is connected.
In synchronous recording mode, if the simulation I sno close from real time, then the
autio quality will not be good. It is recommended to record audio in asynchronous mode.
8-26
Simulation and Analysis
2. Choose the location to save the recording in the “Save In:” zone, and name it in the
“File Name” zone with the .mp4 extension.
Recording begins.
To only record a specific part of the simulation, start the simulation normally and
choose “Asynchronous Recording” or “Synchronous Recording” when the
simulation is already started.
1. Choose “Tools” Tab “Video Recording” Group “Stop” or stop the simulation by
choosing “Simulation” “Pause”.
2. Choose the location to save the recording in the “Save In:” zone and name it in the
“File Name” zone with the .mp4 extension.
The user can drag and drop components, variables or dynamic measuring instruments
onto the plotting area.
The y(t) plotter graphs variables as a function of time, y(x) graphs as a function of
another variable while the z(x,y) plotter provides a graph in three dimensions.
These plotters can be used with all of the technologies available in Automation
Studio™.
The number of plotters that can be created for any project is unlimited, except
when using the Educational Edition.
The plotters are available in the “Measuring” group of the “Simulation” tab in the ribbon.
Once they have been created, plotters are shown and can be accessed from the project
explorer. Each new plotter will be added to a folder named “Plotters” in the Project
Explorer.
Figure 9-2 Plotters shown in the “Plotters” Folder in the Project Explorer
9-2
Plotters
The graph display can be panned by moving the mouse pointer over the display
while the left mouse button is pressed.
The displayed values are the defaults used by the software. Some of them can be edited
whereas others are fixed.
Each project can contain an unlimited number of plotters (except for the Educational
Edition). As an example, here are the three plotters on the same project. For each plotter,
it is possible to edit the scale used on the graph (see section 9.2.3.1 Scale).
9-4
Plotters
The default display settings for the plotter are set in the “Plotter, Curve Editor and
Oscilloscope” section in the project properties.
The y(t) plotter can be used to plot variables as a function of time and to display the
variations. The y(x) plotter is used to plot variables as a function of another variable.
Figure 9-7 Example of three Variables plotted as a function of Time with the y(t) Plotter
Figure 9-8 Example of two Variables plotted as a function of another Variable with the y(x)
Plotter
9-6
Plotters
The properties of the curves and of the plotter are defined in the configuration
panel attached to the plotter and shown to the right of the graph area.
The settings can be modified at two levels: for each variable and its corresponding graph
(“Curve” tab) and globally for the plotter (“Plotter” tab).
The upper part of the “Curve” tab shows the list of variables that are taken into account
by the plotter during the simulation.
Figure 9-10 List of Variables from the "Curves" tab of the y(t) and y(x) Plotters respectively
It is possible to perform a search for specific variables using a filter based either on the
name of the “Variable” or its “Location” using a drop-down menu.
The lower part of the configuration panel can be used to configure the curves and the
scale of the x and y axes of the selected variable.
To select the variable to modify, click on the variable’s row. Its details are
displayed in the lower part.
In the configuration panel of the y(x) plotter, the radio buttons to the left of the
variable names, in the column “X”, are used to choose which variable will be
displayed on the x axis.
Name Description
Curve Colour Modify the colour of the curve selected in the variable
list.
Scale Select the line scale : linear, natural logarithm (ln[e]),
decimal logarithm (lg[10]), binary logarithm (lb[2]).
9-8
Plotters
Name Description
Lineweight Specify the width of the line. 25 different lineweights
are available.
Line Pattern Define the line pattern : Solid, Dash, Dash Dot, Dot,
Small Dot.
Axis Initial Minimum Set the reference axis minimum value.
Value
This is the value that the plotter will set when the
Axis Minimum Value Delimit the plot area by setting the axis minimum value
Axis Maximum Delimit the plot area by setting the axis maximum value
Value
Curve Visibility It is possible to hide a variable curve and to show only
the curves which are of interest.
The “Plotter” tab contains the display options for the plotter and apply to all of the curves
on this plotter.
Name Description
Annotations Colour Change the background colour of the annotation
bubbles.
Background Colour Set the background colour of the plot area.
Background Image The background of the plot area can be personalised by
applying an image.
Cursors Appearance The measurement cursors on the plot area can be
shown as either a vertical bar or as a crosshair. The
« Crosshair » option makes it easier to follow the curves.
Cursors Colour Set the colour of the cursors displayed on the plot area.
9-10
Plotters
Name Description
Grid Colour Set the colour of the grid.
Grid Strips Layout Configure the display of strips on the background of the
plot area: None, Vertical, Horizontal, Both.
Horizontal Axis The horizontal axis can be placed at the bottom or at the
Placement top of the graph.
Initial Time Interval
This option is only available for the y(t) plotter.
Markers Colour Set the colour of markers displayed on the plot area.
Maximum Number Limit of the number of points per plot.
of Measurements by
Plot A tooltip is displayed which shows the simulation
time for the specified limit.
It is also possible to configure the plotters at project level. Go to the Project Properties →
“General Standards” → “Plotter, Curve Editor and Oscilloscope”.
These parameters will be the default parameters for all plotters in the project
unless one of these options is modified in the configuration panel of a given
plotter.
9-12
Plotters
Name Description
Background Colour Personalize the background colour of the plot area.
Grid Colour Personalize the grid colour.
Values Colour Personalize the colour of the displayed values.
Cursors Colour Personalize the colour of the displayed cursors.
Annotations Colour Personalize the colour of annotations placed on the plot
area.
Markers Colour Personalize the colour of displayed markers.
Vertical Axes Layout Layout of the vertical axes and the associated curves:
with the option “Layered”, the curves for each variable
overlap on one plot area. The option “Stacked” shows
each curve separately as a series of graphs stacked one
on top to the other.
Grid Strips Layout Configure the display of strips on the background of the
plot area: None, Vertical, Horizontal, Both.
Horizontal Axis The time axis can be placed at the bottom or at the top
Placement of the graph.
Vertical Axes The vertical axes can be placed All left, All right,
Placement alternating Left then right, or Right then left.
Cursors Appearance The measurement cursors on the plot area can be
shown as either a vertical bar or as a crosshair. The
« Crosshair » option, with a horizontal and vertical line,
makes it easier to follow the curves.
Background Image The background of the plot area can by personalised by
applying an image.
Initial Time Interval
This option is only available for the y(t) plotter.
Show Legend Show the legend on the plot area. The legend also
allows the activation or deactivation of any of the
variables on the plotter.
Name Description
Maximum Number Limit of the number of points per plot.
of Measurements by
Plot A tooltip is displayed which shows the simulation
time for the specified limit.
Precision of The number of decimal places can be specified for
Exported measurement data exported from the plotter.
Measurements
The plotter document properties can be accessed from the contextual menu in the Project
Explorer.
Figure 9-14 Plotter Properties in the Contextual Menu in the Project Explorer
9-14
Plotters
The plotters have a number of tools available. Some of these tools are common to all
plotters, others depend on the type of plotter.
9.2.3.1 Scale
The following tables give a brief description of the toolbar buttons that are common to all
plotters.
The scale can also be changed scrolling the wheel of the mouse.
9-16
Plotters
Remove all cursors Remove all the cursors inserted on the plot area.
Remove all Remove all the markers and their measurements from
markers the plot area.
Cursors
The user can display one or several cursors on the plot area. They can display several
measurements taken at a certain point of the time.
They can be shown as either a vertical bar or as a crosshair. The crosshair allows it to be
able to better follow the curves and the measurement points.
They can be moved within the plot area in order to display other measurements.
The vertical cursor is inserted with the corresponding tool from the toolbar or from
the contextual menu (See section 9.2.4 Plotters Contextual Menu).
The cursor is inserted at the place pointed by the mouse if done from the contextual
menu, and by default at the plot area’s centre if done from the toolbar.
The cursors can be moved by the mouse at any place on the plot area, without them to
necessarily coincide with measurement points.
They can be deleted from the contextual menu or with the corresponding tool from the
toollbar .
With the crosshair, the horizontal bar follows automatically the curve. The time is
indicated under the cursor and the measured value is displayed at each intersection. In
case there are two cursors, the difference between two values is displayed next to the
second one with its unit. The time difference is also indicated under brackets.
The cursor appearance (vertical bar or crosshair, colour etc.) is defined in the
configuration panel. See “Plotter” Tab from the Configuration .
9-18
Plotters
Markers
Markers are inserted from the toolbar or from the contextual menu. The marker is
always inserted at the current point in the simulation.
Measurement values are written under the markers. These values remain the same even
if the scale is modified.
These markers cannot be moved but the user can place an unlimited number of markers
on the curves.
They can be removed from the plotter’s contextual menu (See section 9.2.4 Plotters
Contextual Menu), with the corresponding tool from the toolbar or while simulating
The marker’s colour can be modified with the parameter “Markers Colour” which can be
accessed from the plot area.
These markers and their values are considered for the printing and appear on the
printed document.
Annotations
The user can add annotations according to his needs which allow him to personalize the
plotter adding complementary information.
Annotations are inserted onto the plot area with the corresponding tool from the toolbar
The annotation is inserted at the place pointed by the mouse if done from the contextual
menu and by default at the plot area’s centre, if done from the toolbar.
Select the annotation and click on the Del. key to delete it. The annotation is also deleted
The annotation’s colour can be modified with the parameter « Annotations Colour » in the
configuration panel.
The annotations are considered for the printing and will appear on the printed
document.
9.2.3.3 Display
9-20
Plotters
Figure 9-19 Display Toolbar for the y(t) and y(x) Plotter
Show all plots Show in one click all the plots, even those that were
previously invisible.
Show Legend The legend can be shown on the plot area to visualize the
variables being plotted and deactivate some of them, if
needed.
Unlock/Lock Lock and unlock the acquired measurements.
Acquired
Measurements The user has the possibility to freeze the plotter: it
won’t be restarted at the next simulation which
mean that its plot will be saved.
Print Print plot’s image.
The option “Display Legend” allows the user to visualize the selected and plotted
variables.
Hover the variables’ name with the mouse. The curve of the corresponding
variable is highlighted in the plot area.
The commands from the contextual menu allow the user to navigate through the
annotations and markers, add new one or delete them.
9-22
Plotters
Command Description
Insert Cursor Insert a cursor onto the plot area.
Command Description
9-24
Plotters
Plot Area Background
The plot area’s background can be personalized according to the users’ needs, who can
display curves on a blank background or vertical or horizontal lines (Option “Display Grid
Strips” in the “Plotter” Tab in the configuration panel) or modify its colour (Option “Colour
Background”).
The user can also insert a personalized image in the background of the plot area (Option
“Background Image”).
Curves Colour
The curves colour is defined in the “Curves” Tab from the variables and curves
configurator. The user can choose contrasted colours for a better plots’ visualization. To
do so, select the variable in the variables list, then, in the lower part, select the “Curve
Colour”.
It is also possible to vary the curve colour as a function of the variable measurements.
9-26
Plotters
1. Create a plotter;
2. Select a component in the diagram and drag-and-drop it onto the plot area ;
The dialogue box “Plot Selection” in which the user can select the variables to be plotted
automatically pops up:
If the component has no variable to plot, you will get the message “No available
plots for this component”. Click on OK to close it.
The selected variables are displayed in the configuration area in the “Curves” tab. They
appear in the order defined in the “Variables Selection” dialogue box.
Each variable has its corresponding curve except if the option “Curve Visibility” is
deactivated in the list .
Unlimited number of plotters can be created within a same project which allows
the user to get an unlimited number of plots out of one simulation.
Variables are simultaneously plotted and simulated at each simulator cycle. Simulation
and plotting occur simultaneously. If the simulation’s duration exceeds the visible plotter
frame, the plotting surface scrolls to display the new time frame, and a scroll bar
becomes active at the bottom of the window. This scroll bar is used to review the entire
curve once the simulation is stopped
To change the colour associated with a variable: Go to the Curve tab in the
configuration area, select a variable by double-clicking on its name in the “Variable”
column and modify the “Curve Colour” option.
To modify the plot scale of a variable: Click on the corresponding value in the Plotter
Variables’ Properties Window and modify the value. Make sure that the scale’s minimum
value is smaller than the scale’s maximum value.
You can also launch the automatic scale function by selecting a curve and clicking
Once the simulation is stopped, the graphic data remains on the plotter screen.
9-28
Plotters
Selecting Curves
To select curves:
Select multiple variables in the plotter properties window by holding the CTRL key, or by
clicking directly on the curves in the plot area.
When one or more curves are available without a selected variable, the default scale
displayed is the scale of the first variable in the property window. When a variable is
selected in the property window, its scale automatically appears in the plot area with the
corresponding colour and unit.
When a curve on the graph is selected, it will select the associated line in the properties
table and vice versa.
Taking Measurements
To take a measurement:
1. Start simulation;
The user can also insert a cursor as a vertical bar or crosshair allowing him to display
measurements. This function is only available for the y(t) plotter. Contrary to inserting
markers, this can be done in editing mode.
To cancel a measurement:
Click on or fom the toolbar: The calculated information is removed from the
plot.
After variables have been plotted, it is possible to export the plot data as a .txt file. To do
so, click on the “Export” button from the plotter’s toolbar when the data are plotted.
It is possible to select more than one variable at the same time to export the data
of multiple curves. To do so, hold the CTRL key and select all of the desired
variables. This way, it is possible to compare multiple curves when the data is
exported.
The “Save File” dialog box appears and opens in the root directory of the project if the
data has already been saved. If the data has never been saved, the data is stored in the
9-30
Plotters
Automation Studio™ folder. The formatted data can be imported into any spreadsheet
application.
The number of decimal places can be determined with the option “Precision of
Exported Measurements” located in the “Plotter” tab from the configuration panel.
Click on the variable or one of its values to select it (hold the CTRL key and select all the
desired variables) and click on the “Delete” button .
Drag and drop the same component onto the “Plotter” surface and uncheck the
corresponding variable.
When a component is deleted from a diagram, the associated curves in the plotter
are automatically deleted as well.
The z(x,y) Plotter is used to plot a variable set on the z axis as a function of variables set
on the x and y axes and create a 3D representation.
Figure 9-28 Example of three Variables plotted with the z(x,y) Plotter
The properties of the curves and of the plotter are defined in the configuration panel
attached to the plotter and shown to the right of the graph area.
The settings can therefore be modified at two levels: for each variable in its
corresponding graph (“Curve” tab) and globally for the plotter (“Plotter” tab).
The upper part of the “Curve” tab shows the list of variables that are taken into account
by the plotter during the simulation.
9-32
Plotters
It is possible to perform a search for specific variables using a filter based either on the
name of the “Variable” or its “Location” using a drop-down menu.
The lower part of the configuration area can be used to configure the curves and the
scale of the z, x and y axes of the selected variable.
To select the variable to modify, click on the variable’s row. It will be highlighted.
In the configuration area of the z(y,x) plotter, the radio buttons to the left of the
variable names, in the column “X”, are used to choose which variable will be
displayed on the x axis.
Nom Description
Curve Colour Modify the colour of the curve selected in the variable
list.
Scale Select the line scale : linear, natural logarithm (ln[e]),
decimal logarithm (lg[10]), binary logarithm (lb[2]).
Nom Description
Lineweight Specify the width of the line. 25 different linewidths are
available.
Line Pattern Define the line pattern: Solid, Dash, Dash Dot, Dot, Small
Dot.
Axis Minimum Value Delimit the plot area by setting the axis minimum value.
Axis Initial Minimum Set the reference axis minimum value.
Value
This is the value that the plotter will set when the
Axis Maximum Delimit the plot area by setting the axis maximum
Value value.
Axis Initial Set the reference axis maximum value.
Maximum Value
This is the value that the plotter will set when the
The “Plotter” tab contains the display options for the plotter and apply therefore to all of
the curves on this plotter.
9-34
Plotters
Name Description
Show Legend Show the legend on the plot area. The legend also
allows the activation or deactivation of any of the
variables on the plotter.
Grid Display Set the colour of the grid.
Annotations Colour Modify the background colour of the annotation bubbles.
Values Colour Set the colour of values displayed on the plot area.
Background Colour The background of the plot area can be personalized by
applying an image.
Maximum Number Limit of the number of points per plot.
of Measurements by
Plot A tooltip is displayed which shows the simulation
time for the specified limit.
It is also possible to configure the plotters at project level. Go to the Project Properties →
“General Standards” → “Plotter, Curve Editor and Oscilloscope”.
These parameters will be the default parameters for all plotters in the project
unless one of these options is modified in the configuration panel of a given
plotter.
9-36
Plotters
The plotter document properties can be accessed from the contextual menu in the Project
Explorer.
The plotters have a number of tools available. Some of these tools are common to all
plotters, others depend on the type of plotter.
9.3.2.1 Scale
The following tables give a brief description of the toolbar buttons that are common to all
plotters.
The scale can also be used using the scroll wheel of the mouse.
9-38
Plotters
Annotations
The user can add annotations according to his needs which allow him to personalize the
plotter adding complementary information.
Annotations are inserted onto the plot area with the corresponding tool from the toolbar
The annotation is inserted at the place pointed by the mouse if done from the contextual
menu and by default at the plot area’s centre, if done from the toolbar.
Select the annotation and click on the Suppr. key to delete it. The annotation is also
The annotation’s colour can be modified with the parameter « Annotations Colour » in the
configuration panel.
The annotations are considered for the printing and will appear on the printed
document.
9.3.2.3 Display
Display
Show all plots Show all the plots, even those that were previously
invisible.
Display legend The legend can be shown on the plot area to visualize
the variables being plotted and deactivate some of
them, if needed.
3D Display
3D diplay tools are available for the z(x,y) plotter. They are used to modify the
representation perspective of the curves.
Icon Commands
Display Top View
Click and hold the left button of the mouse to manually modify the 3D curve
perspectives.
9-40
Plotters
The scroll wheel of the mouse allows the user to minimize and maximize the
zoom on the 3D object and its curves.
The commands from the contextual menu allow the user to navigate through the
annotations and markers, add new one or delete them.
Command Description
Add Annotation Add annotation onto the plot area.
Command Description
Export Export measurements to a .txt file.
Measurements
Only available in Editing mode.
The curves colour is defined in the “Curves” Tab from the variables and curves
configurator. The user can choose contrasted colours for a better plots’ visualization. To
do so, select the variable in the variables list, then, in the lower part, select the “Curve
Colour”.
9-42
Plotters
It is also possible to vary the curve colour as a function of the variable measurements.
1. Create a plotter;
2. Select a component in the diagram and drag-and-drop it onto the plot area ;
The dialogue box “Plot Selection” in which the user can select the variables to be plotted
automatically pops up:
If the component has no variable to plot, you will get the message “No available
plots for this component”. Click on OK to close it.
The selected variables are displayed in the configuration area in the “Curves” tab. They
appear in the order defined in the “Variables Selection” dialogue box.
Each variable has its corresponding curve except if the option “Curve Visibility” is
deactivated in the list .
Unlimited number of plots can plot at the same time which allows the user to get
an unlimited number of plots out of one simulation.
Variables are simultaneously plotted and simulated at each simulator cycle. Simulation
and plotting occur simultaneously.
9-44
Plotters
To change the colour associated with a variable: Go to the “Curve” tab in the
configuration panel, select a variable by double-clicking on its name in the “Variable”
column and modify the “Curve Colour” option.
To modify the plot scale of a variable: Click on the corresponding value in the Plotter
Variables’ Properties Window and modify the value. Make sure that the scale’s minimum
value is smaller than the scale’s maximum value.
You can also launch the automatic scale function by selecting a curve and clicking
Once the simulation is stopped, the graphic data remains on the plotter screen.
To select curves:
Select multiple variables in the plotter properties window by holding the CTRL key, or by
clicking directly on the curves in the plot area.
When one or more curves are available without a selected variable, the default scale
displayed is the scale of the first variable in the property window. When a variable is
selected in the property window, its scale automatically appears in the plot area with the
corresponding colour and unit.
When a curve on the graph is selected, it will select the associated line in the
properties table and vice versa.
After variables have been plotted, it is possible to export the plot data as a .txt file. To
do so, click on the “Export” button from the plotter’s toolbar when the data are
plotted.
It is possible to select more than one variable at the same time to export the data
of multiple curves. To do so, hold the CTRL key and select all of the desired
variables. This way, it is possible to compare multiple curves when the data is
exported.
The “Save File” dialog box appears and opens in the root directory of the project if the
data has already been saved. If the data has never been saved, the data is stored in the
Automation Studio™ folder. The formatted data can be imported into any spreadsheet
application.
The decimal number can be determined with the option “Precision of Exported
Measurements” located in the “Plotter” tab from the configuration panel.
Click on the variable or one of its values to select it (hold the CTRL key and select all the
desired variables) and click on the “Delete” button
Drag and drop the same component onto the “Plotter” surface and uncheck the
corresponding variable.
When a component is deleted from a diagram, the associated curves in the plotter
are automatically deleted as well.
9-46
10 Custom Component
The custom component is a tool that complements Automation StudioTM main library by
allowing the creation of components with complex behaviours and specific operation
logic that are represented by simple or specific symbols.
All the above topics will be detailed and illustrated with an example for a better
understanding.
This example consists of a voltage reducing transducer that receives as input an analog
voltage signal and produces as output another voltage signal reduced by a certain ratio
(gain) that depends on the internal circuit and an adjustable parameter in simulation. The
“Input – Output” ratio, also called “Gain”, can be shown or hidden via a switch.
10.2.1 Symbol
It can use different layers of the same document but cannot use several
documents.
The custom component’s symbol drawing can contain drawing objects (“Home” ribbon
“Drawing” Group), and technological and HMI components. It can also contain groups and
assemblies. It can only be drawn on only one “standard” or “electrotechnical” document
but can be represented on several layers of this document.
It is possible to extract symbol from an existing component. For that, the user may
use the “Extract Symbol” command in the “Custom Component” group. For the
command to be active, only one component, one group or one assembly should
be selected on a standard or electrotechnical diagram. Once the command is
applied on the selection, a drawing assembly of this selection is created and
automatically saved in a custom library called “Symbols”. To be able to use this
assembly, the user can simply drag & drop it from the “Symbols” library onto his
10-2
Custom Component
diagram.
You can make the symbol visible or invisible on the diagram by a simple click on
the “eye” icon.
3. Use the drawing tools (“Home” ribbon “Drawing” group) to produce the following
figure:
10-4
Custom Component
5. Insert a MMI Numeric Display Box without frame (“HMI and Control Panels”
“Measuring Instruments” “MMI Numeric Display Box”) into the diagram like the
following figure:
10.2.1.2 Ports
With the Custom Component tool, the user can insert ports into the custom component
symbol when creating it. These ports are considered to be potential connection ports for
the custom component to be generated. They do not have any connection capability until
they are converted to ports of the final custom component.
With the “Port” command (“Custom Component” group of the “Home” ribbon), the user
can insert a “Port” component into a standard or electrotechnical diagram.
The “Port” components must be located on one (or several) layer(s) used for the
custom component’s symbol. Otherwise they will not be considered in the custom
component.
Once a “Port” component is inserted into the diagram, it is given a default name made of
a number which increments with every new “Port”.
The name of the “Port” component will be given to the corresponding future
custom component connection port when the user will link it to a free port of the
behaviour’s circuit, see 10.2.2.2 Ports Correspondence.
It is possible to modify the name of the “Port” component in the “Data” branch of
the component’s Properties dialogue “Identification” group “Component
Name” property.
10-6
Custom Component
10.2.2 Behaviour
Once the custom component is generated, the behaviour circuit cannot be changed by
user anymore but it is simulated. Only the component’s symbol is visible and possibly
animated.
The custom component behaviour circuit has to be drawn in the same project of
the custom component symbol but can be on a different document than the one
used for the symbol.
After inserting the symbol’s “Port” components, the behaviour can be created with
following steps:
9. Create a new layer in the layers manager (F5 function key) and name it “Behaviour”;
10-8
Custom Component
11. Double-click on the transformer to open its properties dialogue. In the “Data” branch,
change the value of the “Secondary voltage“ property to “110” V;
A free port in the behaviour circuit is a port that is not connected to any other port. It is
displayed in red in the diagram.
In the previous figureFigure 10-10), the behaviour circuit has 5 free ports.
A component’s port connected to another one that became invisible (or located on
an invisible layer) is also considered to be “free” since the port is displayed non-
connected and in red.
The user can create the custom component connections on an interface in which he can
10-10
Custom Component
associate each “Port” component of the symbol (see 10.2.1.2 Ports) to a free port of the
behaviour (see 10.2.2.1 Behaviour’s Free Ports). This interface is accessible via the
“Associated Port” branch in the “Port” component properties dialogue by double-clicking
on a “Port” component.
Figure 10-11 "Associated Port" Branch in the "Port" Component Properties Dialogue
Zone Description
1 Behaviour Diagram Allows to localize the project’s document in which
the behaviour circuit can be found.
Zone Description
2 Free ports on Allows to show the list of all free ports in the
Diagram diagram specified in the “Behaviour Diagram” list
(1).
The “Free” item allows including the “Port”
component in the final symbol of the custom
component to be generated, without this “Port”
component being associated to a behaviour’s free
port.
If “None” item is selected, the “Port” component
will not be included in the custom component’s
symbol to be generated.
By selecting a free port in the list, the current “Port”
component and the free selected port correspond to
each other. In this case, the current “Port”
component becomes a connexion port of the custom
component to be generated and corresponds exactly
to the free port which becomes invisible after the
creation of the custom component.
3 Legend Colour codes legend reflecting the
selection/connection state of the displayed free
ports.
4 Application Button Allows to apply the modifications made in the
dialogue.
Each free port in the “Free Ports on diagram” list is displayed with the following
syntax: internal component ID followed by a point, free port name and the
component ID between brackets. Ex.: Electro1.ET20.2 [033].
It is not possible to select more than one free port in the “Free Ports on Diagram”
list.
10-12
Custom Component
It is recommended to rename and display only the behaviour’s free ports in order
to be able to identify them easily for the association.
The alias, and not the name, is considered in the simulation parameters. In case
the alias is duplicated, it is therefore necessary to rename it.
To continue with the voltage reducing transducer example and make ports
correspondence, proceed as follows:
14. Double-click on the symbol’s “Port” component number “1” to open its properties
dialogue;
15. In the “Associated Port” branch of the properties dialogue, select the free port that
you wish to connect to the top left wire of the behaviour circuit (see following
figure) and apply via ; Note that the free ports’ names are displayed in small
characters in the behaviour diagram.
10.2.3 Logic
The Custom component can include a complex logic built with SFC. Whether you have
control sequences, animation conditions or advanced logics, the custom component
wizard gives the possibility to select and include them in the custom component to be
generated.
The user can create a custom component without “logic”. In this case, it will have
only a symbol and a behaviour circuit.
Once the ports correspondence is done (see above), you can create a logic to estimate
the component’s gain and its animation. To do this, follow the steps below:
17. Create a new SFC Diagram;
10-14
Custom Component
All the custom variables used in the SFC you wish to include in the custom
component to be generated must belong to the SFC document(s) of the logic and
not to the project, which means that, when creating the variable, its location must
be the SFC document that uses this variable.
20. Create a second custom variable with following information:
● Type: LREAL
● Measure Type: Without Unit
● Localization: the SFC Diagram that you have just created
● Name: DisplayAnimation
● Alias: DisplayAnimation
10-16
Custom Component
In order to be sure to have the correct variable, you can verify the “Location”
column of the “Variables” zone. It shows the internal ID of the component
containing the variable followed by a point and the component ID between
brackets.
● Type “/” at the end of the “Actions” zone’s second line after the variable that
you have just added.
● In the “Variables” zone, double-click on the line of the variable whose alias is
“RMS Voltage” coming from the first voltmeter (the top one in the diagram).
● Apply.
The gain is defined as the ratio between output and input. In the case of our
example, it is the ration between the output voltage measured by the bottom
voltmeter (transformer’s secondary side) and the input voltage measured by the
top voltmeter (transformer’s primary side).
25. In the second transition’s properties dialogue, type “NOT” in the “Actions” zone, then
double-click on the line of the variable whose alias is “Display-Gain” in the
“Variables” zone, apply and close the dialogue. You get following sequence:
Simulation Variables” zone, click on the link creation’s button ( ) and close the
dialogue;
You can use the filtering or marking options at the top of the “Compatible
Simulation Variables” zone in order to easily find the variable you are looking for.
29. In the layers manager (“Edit” ribbon “Editing” group “Layer Properties”
command), select the “Symbol” layer;
30. Use the drawing tools (“Home” ribbon “Drawing” group) to draw a frame for the
display box and to insert, the text “GAIN” as a title;
10-18
Custom Component
At this stage, the three elements of the custom component have been created; the
custom component can now be generated.
To continue our exercise and launch the custom component generating wizard, do the
following step:
35. Click on the “Home” tab “Custom Component” group “Custom Component”
command;
This command starts the wizard that first opens the symbol selection dialogue.
The “symbol selection” dialogue allows selecting the document containing the custom
component symbol or some of this document’s layers.
10-20
Custom Component
The “next” button will only be activated if the user makes a selection for the
symbol. This means that the creation of a custom component without symbol is
not allowed.
This dialogue is used to select the document containing the custom component
behaviour or some layers of this document.
Zone Description
3 Layer(s) name Name of the layers of each document of the
current project, except the layers already
selected for the symbol (see 10.3.1 “Symbol
Selection” ).
4 Checkboxes Allow to select the document(s) or the layer(s)
of the document representing symbol.
It is possible NOT to select any behaviour (click on the “Next >” button and keep
all boxes unchecked) which is not allowed with the symbol. In this case, the
component will not have any technological behaviour; it will only have a symbol
and logic.
This dialogue is used to select the SFC documents containing the logic of the custom
component to be generated.
It is possible not to select any logic (click on button “Next>” and keep all
checkboxes unselected), which is not allowed with the symbol. In this case, the
component will have a symbol and a behaviour but no control logic.
10-22
Custom Component
This dialogue is used to select the variables of different elements that should be visible
in the custom component to be generated.
10-24
Custom Component
Zone Description
5 “Visible Variables” Field Zone showing the variables that have been
made visible by the user. These variables will
appear in the “Variable Assignment” branch of
the custom component properties dialogue or in
the variable manager of the project in which the
custom component will be used. See 10.4.2
“Variable Assignment” Branch.
6 Filtering Criteria Allows selecting a criterion between the
available columns of the variables list in the
“Visible Variables” zone.
7 Text Field Allows to seize a text as a filter.
8 Visible Variables List Shows the list of variables made visible by the
user.
9 “Add” Button Allows to transfer the selected variables from
the “Hidden Variables” list to the “Visible
Variables” list.
10 “Delete” Button Allows to transfer the selected variables from
the “Visible Variables” list to the “Hidden
Variables” list.
A hidden variable made visible by the user will only appear in the “Variable
Assignment” branch of the custom component properties dialogue if it meets one
of the following conditions:
● The variable appears in the “Variable Assignment” branch in the properties
dialogue of a component that is used in the custom component;
● The variable is created by the user (custom variable) and belongs to the
document used for one of the following elements: symbol, behaviour or logic.
In order to distinguish components’ variables from each other, especially the ones
having the same alias, it is recommended to modify the variable alias or edit the
variable’s “description” attribute in the “Data” branch of its component properties
dialogue. A new alias or a description will then appear in the wizard dialogues
where the variable appears.
This dialogue is used to select the simulation setting variables that should be visible in
the custom component to be generated.
10-26
Custom Component
Zone Description
1 “Available Zone showing the available variables that can be set
Simulation Setting in simulation.
Variables”
2 Filtering Criterion Allows selecting a criterion between the available
columns of the variables list in the “Available
Simulation Setting Variables” zone.
3 Text Field Allows to seize a text as a filter.
4 Available Setting Shows the list of available setting variables.
Variables’ list
5 “Selected Simulation Zone showing the variables that can be set in
Settings Variables“ simulation and made visible by the user.
zone The variables setting dialogue appears in simulation
when the user clicks on a free zone of the custom
component. A free zone is a zone of the custom
component’s symbol where there are no components
with setting variables that can be configured in
simulation. See 10.5 Custom Component Simulation
6 Filtering Criteria Allows selecting a criterion between the available
columns of the variables list in the “Selected
Simulation Setting Variables” zone.
7 Text Field Allows to seize a text as a filter.
8 Visible Variables List Shows the list of the variables selected by the user.
9 “Add” Button Allows to transfer the selected variables from the
“Available Simulation Setting Variables” list to the
“Selected Simulation Settings Variables” list.
10 “Delete” Button Allows to transfer the selected variables from the
“Selected Simulation Settings Variables” list to the
“Available Simulation Setting Variables” list.
A right click on the variable line in the “Available Simulation Setting Variables” or
“Selected Simulation Settings Variables” zone opens the “Follow the link”
command that allows to localize in the schematic the component containing the
More than 9 setting variables in the “Selected Simulation Settings Variables” zone
are not allowed.
This dialogue is used to name the custom component to be generated and specify its
technology (hydraulic, pneumatic, electrotechnical IEC or electrotechnical NEMA).
10-28
Custom Component
This is the wizard’s last dialogue for the custom component creation. It also informs the
user about the possibility to create a customized help to the component (see 10.4
Custom Component Properties )
The “Custom Component” library has the same characteristics and functionalities
of any other custom library.
10-30
Custom Component
It is recommended to always keep the source project that contains the custom
component’s different elements because the generated custom component and its
subcomponent cannot be modified afterwards.
The “Data” Branch is similar to that of any other standard component but it contains by
default the following categories:
10-32
Custom Component
Note that the component’s context help displays exactly the text previously entered in
the “Help” property of the custom component properties’ dialogue.
The “Variable Assignment” branch is identical to that of any other standard component.
The “Component Variables” zone displays the variables made visible by the user in the
variables configuration dialogue (see 10.3.4 “Variables Configuration” ) only if those
meet one of the following conditions:
● Variable appeared in the “Variable Assignment” branch in the properties dialogue
of a component that is used in the custom component.
● Variable created by the user (custom variable) and belongs to the document of
one of the following elements: symbol, behaviour or logic.
Any other variable that the user chose to be visible and that does not meet one of
these conditions will be displayed in the “Variables Manager” of the project into
which the custom component is inserted but NOT in the custom component’s
“Variables Assignment” branch.
Note that the “Component Variables” zone contains both variables “Display_Gain” and
“Gain”. The “Display_Gain” variable is the assignment variable of the symbol’s HMI
switch and the “Gain” variable is a user-defined variable created on the logic’s SFC
document level.
This branch is identical to that of any standard component. See 6.2.2 “Accessories”
Branch.
This branch is identical to that of any standard components. See 2.2.14 Failure Builder.
If during simulation you click on a component of the symbol that has variables adjustable
in simulation, these variables’ setting dialogue will pop up. But if you click on any other
10-34
Custom Component
part of the symbol, the custom component’s setting configuration dialogue will pop up.
See 10.3.5 “Simulation Setting Configuration”.
The setting dialogue of the resistance on the transformer’s primary side pops up.
10-36
Custom Component
This property has been made visible in the setting configuration dialogue. The
whole component symbol is considered to be a free zone which allows displaying
this dialogue by clicking on it in simulation, except the HMI switch part because it
has its own setting parameter.
60. Modify the resistance value. The component’s gain is modified accordingly.
In this example, the component to generate is a hydraulic pump of which the model is
built in a block diagram, simplified for the purpose of example. The required block
diagram can be completed beforehand from the use case exercise of the Block Diagram
workshop guide:
Figure 10-35 : Block diagram of the source behaviour of the hydraulic pump
This model has for inputs the displacement and the driving radial speed of the pump and
calculates the output in function of the volumetric efficiency curve and the pressure
measured on the hydraulic diagram. The model includes the reservoir at the pump
suction port. At this point what remains is to create the pump’s symbol, associate the
10-38
Custom Component
free port of the block diagram’s hydraulic adapter component with the hydraulic port on
the symbol, and generate the custom component.
We now need to create the symbol that the pump will have from CAD objects. The user is
free to create the symbol he desires. Here, we will simply reuse the symbol of the pump
from the main library:
3. Insert a hydraulic pump and a hydrostatic reservoir from the main library on the
diagram and link them as show :
This CAD object is now the symbol that will be used for the custom component.
10-40
Custom Component
9. In the standard diagram, open the properties of the Port that needs to be
associated, on the “Associated Port” branch;
10. Select the block diagram as « Behaviour Diagram ». In the list of available free
ports of the block diagram, select port 3 of the Hydraulic Adapter component,
which will be listed as DiagramName.ComponentInternalID.PortNumber, for
example Block_Diagram1.B1.3 :
The port is now associated. This will ensure, in the final component, that the pressure
measured in the circuit be transmitted to the block diagram calculation, and that the flow
calculated be outputted by the port in the hydraulic circuit:
10-42
Custom Component
Figure 10-39 : Link of the hydraulic port between the symbol and the block diagram
14. Select the layer of the symbol on the standard diagram and click “Next”;
10-44
Custom Component
10-46
Custom Component
10-48
Custom Component
Notice that the displacement and the radial speed can be set during simulation, similarly
to the pump from the main library, because these variables from the source behaviour
were made available. The flow is adjusted according to these settings just like with
generic components. We can also see the effect of the volumetric efficiency on the
output flow.
10-50
Custom Component
Figure 10-50 : Adding components to monitor values on the source behaviour block diagram
10-52
Custom Component
Figure 10-52 : Adding the measurement variables to a plotter from the Variable Manager
A logic can also be added to this custom component to manage an animation of its
symbol. Or also if the animation can be simply controlled by a variable link with
the source behaviour, this link is kept in the custom component, thus retaining the
animation, without a need for a logic.
This section presents all the information needed to use the card. It explains how to create
and simulate a project, and illustrates these explanations with a practical example of an
application.
To install and configure the card, please refer to the specific documentation provided.
The I/O interface card is part of the Interface family in the Automation Studio ™ library.
The installation of the card is not included in the basic installation of Automation Studio™;
it must be completed separately. The procedure is described in the following section.
The I/O interface card facilitates interaction between the simulation modules of
Automation Studio™ and PLCs (programmable logic controllers). With the included relay
interface, users can also control circuits that are simulated on screen, and connect
simulation circuits to actual field devices such as solenoid valves, push buttons, etc., or
on sensors of an existing circuit or training panel.
The chapter is presented in chronological order to clearly map the steps to simulate a
circuit interacting with a peripheral device.
Remember that this guide does not cover the theoretical notions concerning peripheral
devices. It was written assuming that users are already familiar with communication
notions as well as input/output interfaces with peripheral devices.
1. In the Library Explorer, click on the “Interface” workshop and insert the “USB I/O
Interface Module” component.
11-2
I/O Interface Card
To access the configuration properties of the card, open the component properties
window, in the “Data” branch, add the configuration in the “Technical Characteristic”
category. In the “Identification” category, keep the default card name.
To access the variable assignment properties of the I/O interface card, click on the
“Variable Assignment” branch of the properties tree (see section 6.2.4 “Variable
Assignment” Branch).
The following figure presents the simulated PLC controlled electro-pneumatic circuit to be
built. The PLC outputs are connected to the I/O interface card inputs and the card outputs
to the PLC inputs.
11-4
I/O Interface Card
The circuit is composed of two cylinders (A1 and A2), each controlled by a double
solenoid 5/2 valve. Proximity sensors are used to detect the in and out positions of the
cylinders. A pushbutton is used to start the sequence.
This is the functioning sequence of the circuit. It is first described, and then represented
with the help of a SFC. This sequence must be programmed into the PLC. In addition, we
will translate this sequence into a ladder diagram to program the PLC.
Step 1 On step 1, by activating the A1- and A2- solenoids, both cylinders rods are
retracted.
Step 2 As soon as the START button is clicked and that both cylinders are
retracted, (A1_0 and A2_0 proximity sensors) the sequence is started. At
this moment, transition 1 is cleared and step 2 is activated. Once step 2 is
activated, solenoid A1+ is energized, therefore extracting the A1 cylinder
rod. Once the rod is fully extended, the A1_1 proximity sensor is activated.
Step 3 Transition 2 is then cleared and step 3 is activated. With step 3 activated,
the A2+ solenoid is energized; this extracts the rod of cylinder A2. Once the
rod is fully extended, the A2_1 proximity sensor is activated.
Step 4 Transition 3 is then cleared and step 4 is activated. The A2- solenoid is
engaged and the A2 cylinder rod is retracted. Once the rod is completely
retracted, proximity sensor A2_0 is activated.
Step 5 Transition 4 is cleared and step 5 activated. Solenoid A1- is activated and
the A1 cylinder rod is retracted. Once the rod is completely retracted,
proximity sensor A1_0 is activated. This clears transition 5 and returns to
the first step. The simulation is now ready for another cycle.
11-6
I/O Interface Card
The following figure presents the circuit sequence ladder logic diagram. The following
tables present the corresponding tag names for the inputs and outputs of the interface
card and of the corresponding components.
Reproduce this diagram with the use of PLC software. Once the PLC is programmed, the
sequence can be tested by starting the simulation.
When applying the program for a specific PLC, make sure that the correct I/O addresses
are used. In the following example, the addresses must correspond to the wiring
between the I/O interface card and the PLC.
11-8
I/O Interface Card
For example, a command schematic for an Allen-Bradley PLC could have the following
corresponding addresses:
Y1 B3 :0/0 N/A
A command schematic for a Modicon PLC could have the following corresponding
addresses:
Y1 01100 N/A
In order to establish a connection between the circuit components and the interface card,
the I/O variables must now be assigned. To access the variables assignment properties of
the component, select the “Variables Assignment” branch of the properties tree in the
Component Properties dialogue box.
The following is the correspondence table between the electrical components of the
circuit and the I/O interface card.
11-10
I/O Interface Card
The default input tag names must be modified according to the following table, before
linking them to the valve solenoids:
When a circuit is simulated, the output signals emitted by the simulated circuit are
transmitted via the I/O interface card to the external components with which it is
associated. All components that have tag names mapped to an output in the I/O
Interface Card dialogue box transmit a signal to a peripheral device when they are
activated. In the same manner, all components that have a tag name mapped to an input
in the I/O Interface Card dialogue box are activated by a signal emitted from the
peripheral device.
3. Activate the pushbutton that starts the circuit simulation by clicking on it. (1-
1PBNO1.START).
In the I/O interface card component symbol in the diagram, the input and output
cells change colour as they transmit or receive signals. The input cells only change
colour if they are associated with a peripheral device.
The Status bar indicates that the application is now in the Edit mode.
11-12
A Shortcuts
Shortcut keys are used to quickly access the most frequently used commands. They are
generally associated with commands that are common to all the utilities.
Project
Shortcut Command
CTRL + P Print
ALT + F4 Exit
Shortcut Command
CTRL + Z Undo
CTRL + Y Redo
CTRL + X Cut
CTRL + C Copy
CTRL + V Paste
CTRL + D Duplicate
DEL Delete
Zooms
Shortcut Command
CTRL+ + Zoom +
CTRL + - Zoom -
Layout
Shortcut Command
A-2
Glossary
Shortcut Command
CTRL + G Group
CTRL + U Ungroup
Simulation
Shortcut Command
Shortcut Command
Shortcut Command
Window Display
Shortcut Command
F4 Photo window
F5 Layers window
F6 Catalogue Manager
F7 Message window
F8 Project Explorer
F9 Library Explorer
F10 Plotter
Shortcut Command
CTRL + 1 Pointer
CTRL + 2 Text
CTRL + 6 Line
CTRL + 7 Arc
CTRL + 8 Rectangle
CTRL + 9 Ellipse
A-4
Glossary
Shortcut Command
CTRL + F9 Field
Help Menu
Shortcut Command
F1 Contextual help
Navigation keys are used to easily navigate the screen or through various windows, or to
move items.
Shortcut Movement
Go up one line
Go down one line
PAGE UP or HOME
Go to the top of the tree
Shortcut Movement
Moves the component one grid step to the right.
Moves the component one grid step to the left.
Shortcut Movement
Moves the component one grid step up.
Moves the component one grid step down.
CTRL +
Moves the screen view to the right.
CTRL +
Moves the screen view to the left.
CTRL +
Moves the screen view up.
CTRL +
Moves the screen view down.
Moves the screen view to the upper left corner.
END
Moves the screen view to the lower right corner.
CTRL +
Moves the screen view upper right corner.
CTRL + END
Moves the screen view lower left corner.
Project Explorer
Action On Effect
Left-click
a diagram Selects the diagram
Double left-click
a diagram Opens a diagram window
A-6
Glossary
Drawing Editor
Action On Effect
Left-click
a component in the Selects the component.
workspace
Double left-click
a component in the Opens the component
workspace properties window.
CTRL + left-click
a selected component Duplicates the component.
CTRL + left-click
a rotation handle Applies an orthogonal
rotation to the component.
CTRL + left-click
a resizing handle Applies a disproportional
resizing to the component.
CTRL + left-click
a rectangle Draws a perfect square.
CTRL + left-click
an ellipse Draws a perfect circle.
CTRL + left-click
an arc Draws a perfect arc of
circle.
SHIFT+ left-click
a non-selected component Adds the component to the
or in the workspace selection.
SHIFT + left-click
a selected component Removes the component
from the selection.
SHIFT+ left-click
a component in order to Moves the component and
move it severs the links.
Right-click
a component Displays the component
contextual menu.
Action On Effect
Right-click
workspace Displays the diagram
contextual menu.
ALT +
workspace Go to the previous
hyperlink.
ALT +
workspace Go to the next hyperlink.
Plotter
Action On Effect
Scroll wheel
Plot area Vertical scaling
A-8
B Glossary
Active Workshop
Alphanumeric
Consisting of both letters and numbers and often other symbols such as punctuation
marks and mathematical symbols. The main characters are the 26 letters of the alphabet
and 10 numbers.
Assembly
A group considered as a single component in reports. To view this feature, check the
Assembly checkbox in the group properties dialogue box.
Menu regrouping project management commands. It is also used to access the software
configuration dialogue box.
Automatism
Component
The basic elements used for creating diagrams. “Technical Data” are used to assess the
component’s behaviour during simulation, and catalogue properties are used to generate
reports. Components are included in libraries provided with each workshop.
Connection
A connection binds two components and/or links them together. The connections’ colour
is the same as the elements they are linked to, and is specific when not connected to
any element. Two connections from non-compatible technologies cannot be connected
together. For example, a pneumatic line cannot be connected to a SFC component and
vice-versa.
Connection Number
Connector
Element represented by a red circle when not linked. It allows the connection of two
components. A connector becomes a connection as soon as it is connected to another
element.
Contact Point
Contextual menu
Standard windows menu accessible by right-click, its contents depend on the element
under the mouse cursor.
Diagram
Display Tools
Designates the design accessories in the Diagram Editor: grid, rulers, connections and
connection numbers. Modify how they are displayed from the View menu.
B-2
Glossary
Document Manager
Displays the contents of one of the project editor's windows. The document manager lists
all of the documents that make up the project.
Edit Mode
Graphic Object
An element of the Library that cannot be simulated. Graphic objects are inserted into
diagrams strictly as non-functional elements. There are four types: rectangles, ellipses,
lines, and texts.
Grid
A network of horizontal and vertical dotted lines which covers the workspace in the
Diagram Editor and on which elements of a diagram are aligned.
Group
Library Explorer
A window containing the basic elements used for designing circuits or simulation models.
Link
Link Shape
Mechanical Contacts
Mechanical contacts connect a sensor and a receiver making it possible for a component
to modify the behaviour of another component. They are represented by a rhombus that
appears at the point of contact. Contrary to connectors, the colour of the rhombuses is
not influenced by the state of the connection.
PLC
Project
Project Explorer
The tool used to create, modify and manage “project” files. The Project Explorer includes
the document manager that manages all the documents contained in the project.
Project Label
Properties
Ribbon
The ribbon is a graphic user interface that appears in the upper part of the software
window: it consists of a table regrouping all the software functions, adapted to the data
context.
Rulers
Rulers are displayed at the edges of the window and indicate the unit of measurement
being used for the diagram. They serve as references for diagram size and the relative
position of elements.
B-4
Glossary
SFC
Sequential Function Chart (SFC). A graphic representation using basic SFC components
used to represent an automatism.
Simulation Cycle
One step in the calculation that determines the state of each component.
Simulation Mode
Sort Key
The criteria used to classify items of the Diagram list in alphanumeric order. The sort keys
are specified in the Sort box of the Tools menu in the Project Manager. The alphanumeric
order is as follows: 0, 1, and 2..9, A, B, C..Y, Z.
Status Bar
Horizontal bar located at the bottom of all utility windows. It contains various types of
information such as error messages, zoom factor, mouse cursor coordinates, etc.
Title Bar
The horizontal bar located at the top of a window that contains the title of the window.
Toolbar
A bar located under the menu bar that contains buttons for the most frequently used
commands.
User Interface
The environment made up of windows, dialogue boxes, graphic objects, etc. thanks to
which tools the user communicates with the software.
A general designation for the different types of windows in Automation Studio ™. The
Core System contains two utilities: the Project Manager and the Diagram Editor.
Worksheet
Workshop
A module that plugs into the Core System. Each workshop contains elements, diagrams
and functions that relate to its own technological specialty and to the type of diagram it
can generate.
Workspace
The part of the window that displays the project information such as graphs, tables, and
the item list of the application.
B-6
C Index
Properties ............................ 2-38, 2-66
Administration Tools ......................... 2-55
Property Alias ................................ 2-66
Analysis Tools Property Display ............................ 2-66
Dynamic Measuring Instruments.. 8-15 Property Format ............................ 2-66
Automation Studio™ Reference ...................................... 2-20
Exit ................................................. 2-11 Renumbering ................................. 2-52
Help ...................................... 2-10, 2-17 Select ............................................. 2-37
Online Support ............................... 2-11 Setting ........................................... 2-61
Options ........................................... 2-12 Component Accessory Manager ....... 2-54
Software Registration ................... 2-10
Component Tooltip ........................... 2-23
Bill of Materials ....................... 2-20, 6-12 Insert a hyperlink to audio file ..... 2-24
Insert .............................................. 6-13 Insert a hyperlink to file ............... 2-24
Modification ................................... 6-13 Insert a hyperlink to Picture ......... 2-24
Catalogue Manager ............... 2-19, 2-103 Insert a hyperlink to video ........... 2-24
Insert a text ................................... 2-24
Communication Variables ............... 2-103
Search
Component
Text ................................................ 2-37
Animation ...................................... 2-61
Common Properties ...................... 6-26 Connection
Connector ....................................... 2-41 Impossible ..................................... 2-29
Global Properties ........................... 6-26 Custom Component .......................... 10-1
Grid Snap ....................................... 2-21 Behaviour ...................................... 10-6
Identification ................................. 2-42 Behaviour Selection .................... 10-20
In Catalogues ................................. 2-19 Behaviour’s Free Ports ................ 10-10
In Library ........................................ 2-19 Creation Confirmation ................. 10-29
Localization .................................... 2-29 Data ............................................. 10-30
Picture Viewer ............................... 2-54 Elements ........................................ 10-1
C-2
Glossary
C-4
Glossary
C-6
Glossary
C-8