20.2 - Engineering User Guide 2of3
20.2 - Engineering User Guide 2of3
2.5 Delete Plant Displays with all underlying Plant Displays............................................................. 110
Manual scheduling is also imported. Imported diagram scheduling may require special attention.
Project Nodes or diagrams can be imported at any client computer. The data to be imported is contained in a file
(either a Zip (*.zip) or Java (*.jar) file format). The file must be stored on a drive available to the client computer.
When importing Project Nodes and diagrams it is also possible to modify them according to the copy and modify rules
set by the user. The IDs of imported items can be modified to match those which are required for a project (this is very
useful when diagrams from other projects are imported). It is also possible to preview the effect of the copy and modify
rules on the import data without actually importing the data.
1. All diagrams in the complete project (of all the users) must be committed prior to importing new nodes and
diagrams.
The import does not interfere with any other work that is being carried out.
The user is able to easily rollback, and thereby remove the imported nodes and diagrams if required.
2. Select the destination node for the nodes or diagrams to be imported into.
3. Select the Extras menu, then Import, then Project Nodes/Diagrams from the drop down menus.
4. A dialog box appears to select the file to be imported.
5. Enter the path and filename of the file to be imported in the Source Archive File field. Alternatively, click on
the button (on the right hand side of the field) to find the file using a browser.
6. Check that the Destination Node is correct, this can be changed if required by clicking on the button and
using the hierarchy browser.
7. If the imported diagrams are to be modified according to the copy and modify rules, click on the Modify
Diagrams/Nodes check box.
o The Preview check box can also be checked. If preview is selected, the user is able to view the
results of the import operation in the protocol file without actually importing the nodes and diagrams into the
project.
8. Click on Import to load the file, otherwise click on Cancel.
9. After the file has been read in, a dialog box will appear containing summary information of errors or warnings
from the file import. To view detailed information click on the Open Protocol button to open a protocol report
browser, otherwise click on OK.
The imported nodes and diagrams can now be treated like any others configured in the system.
Elements will not be imported if they conflict with elements already existing in the project (e.g. identical Tag
Names). Errors will be recorded in the protocol file.
Illegal characters are not permitted in the names of imported elements. If illegal characters exist they will
automatically be replaced by the underscore symbol (_).
The system automatically checks for, and closes any signal connections that may exist between components
in the existing, and imported Function Diagrams.
In the cases where this action leads to the inheritance of parameters between connected symbols, a dialog
box will appear listing the inherited parameters.
If the imported diagrams include instances of the Generic PROFIBUS Interface proxy FD_GENERIC, the
corresponding GSD files are checked. If the GSD files do not exist in the system, they are imported with the
Function Diagrams. If they do already exist, they are not imported and the user gets a message.
Imported GSD files (GSD files not preinstalled with the system) are not covered by any warranty. A Warning
dialog will appear during import of these files.
The import data may also contain linked documents. These will be imported and the links to Automation
Functions will be made.
The hardware design is also of relevance for the software design in the SPPA-T3000 system since the IO devices and
bus components must also be configured here. The hardware engineering data can be transferred from the hardware
engineering tool into a file, and imported into the SPPA-T3000 system. This concept is shown in the schematic
diagram below:
The hardware engineering data is exported to an Import Data file which is formatted in Extensible Markup Language
(XML) specifically for hardware import. This file is imported into SPPA-T3000. In this way the hardware engineering
data only has to be entered once, and the data will be consistent. Unnecessary repetition of work (and resulting
inaccuracy) is eliminated.
When hardware engineering is imported the software representation of the hardware components in the system (i.e.
Hardware Proxies in Function Diagrams) is created automatically. The required connections to these components
which have been imported into Function Diagrams are also automatically created . This allows the user to first create
the software design then import the hardware configuration later, and the connections between the two will be
automatically made.
Wiring diagrams created by the hardware tool can also be imported into the system. The wiring diagrams are
automatically linked to Automation Functions and proxies from which they can be opened.
When the user carries out a hardware import, the configuration of the import data is checked by the system as part of
the import process. The system automatically identifies if the data is new or modified and will import the data so that
the hardware and software designs are consistent.
Existing software designs made for a FUM project can be converted to a SIM project. Conversion from SIM to FUM is
also possible.
The software design for the hardware IO configuration in the system is created automatically from the hardware import
data. The hardware layout consists typically of racks of IO modules arranged in cabinets. An example of a hardware IO
rack is shown below:
The rack consists of a number of slots into which modules can be inserted. The layout above consists of:
Each IO module has a number of terminals available to which the cabling for the IO signals is connected.
The way in which the various components of the hardware design are used to create the software design are
explained below.
Function Diagrams
For each hardware rack a single Function Diagram is created. In this way all of the hardware components associated
with a hardware rack will be represented in the same Function Diagram. The name of the diagram is imported with the
hardware import data.
The new Function Diagram inherits its Runtime Container Assignment from the superordinate Project Node.
Hardware Proxies
For each of the bus interface and IO modules in the rack, a Hardware Proxy will be automatically placed in the
Function Diagram. For each of these devices the hardware import data file contains the following information:
• The product number of the module: from this the type of proxy required for the device is determined.
• The location of the module: this is normally an alphanumeric ID code and is used for the tag name of the
proxy.
• The slot number in which the module is inserted: this slot number is automatically entered as a parameter in
the proxy.
• A description of the module: this is used for the comment in the proxy mask.
For ET200M configurations, the parameters ID_RACK0, ID_RACK1, and SLAVE_NO in the signal IO
hardware proxies will not be automatically entered. These parameters are necessary for the PROFIBUS
network configuration. They must be entered manually by using the Diagram Editor or by using Spreadsheet
Engineering.
For EU90x configurations, the connections between the bus interface and IO modules are made automatically.
Channel Parameters
Signal IO is designed for connection to the terminals of the IO modules using the hardware design tool. Information
about the IO signals is used to automatically set the parameters of the Hardware Proxies.
The terminal numbers are used to determine the channel number in the proxy. The parameters of this channel will then
be set according to the hardware import data:
• The tag name and signal name for each input signal are set. The signal name is automatically appended with
_HW.
• For analog IO signals, the engineering units and upper and lower limits are set.
The user may import hardware data at any time. The system automatically compares the new and existing
configuration, identifies any new or modified data and reconfigures the software accordingly. This is a powerful feature
as it means that the hardware configuration in the hardware engineering tool and the SPPA-T3000 system can be kept
completely consistent whenever the hardware design is changed.
The way in which various components are handled for modified hardware is described below:
Function Diagrams
If a Function Diagram already exists that contains elements of the modified hardware configuration (and has the same
diagram name), no new Function Diagram will be created. Should a new Function Diagram be required, it will be
created in a new Project Node named imported diagrams.
Hardware Proxies
If any modules have been added or removed from a rack, the corresponding Hardware Proxies will be added or
removed in the Function Diagram for that rack.
Channel Parameters
When signals have been added or removed, or any parameters modified, the Hardware Proxy parameters will be
changed accordingly.
IO signals being sent or received with Hardware Proxies must be connected to AF Blocks. These connections are
automatically made in one of two ways:
Some AF Blocks have Ports which are normally connected directly with Hardware Proxies for signal IO (e.g. drive on
and off feedback signals, or analog signal monitors). For these Automation Functions the relevant Ports have been
predefined for automatic connection during hardware import. During the import process, the system searches for the
relevant AF block and makes the required signal connections.
For each IO signal in the Import Data file the system attempts to make an automatic connection to an AF Block in the
following way:
1. The system searches for an AF Block that has a tag name identical to the signals tag name.
2. If a matching AF Block is found, the system searches for a matching predefined Port in the AF Block. The
import data file from the hardware tool provides the information required for the system to find a matching
Port.
3. For AFs with defined main output Ports an additional check is performed. The system checks for a match
between the signal names of the proxy signal and the AF main output Port signal. If a match is found then the
automatic connection procedure will continue.
The match between the input signal name and the output Port signal name only applies to AFs with
defined main output Ports. For these types of AFs the signal name of the input port has meaning (e.g.
XQ01 is the signal name for an analog signal). The same signal name should be used in further logic
in the system.
If the match is not found, the automatic connection will not be made. The user can still create a
manual connection, if desired.
4. For analog input signals the AF Blocks Port parameters will be set for :
o Engineering Units (EU).
o Upper Limit (UL).
o Lower Limit (LL).
5. The connection between the Hardware Proxy and the AF Block is created.
Automatic connections can also be made to Ports which are not predefined for automatic connection. In these cases
however, the user must manually configure Source Connectors or Destination Connectors at these Ports before the
hardware import is made.
For certain AFs a signal name that matches the signal name of imported signal must be given to the
main output Port .
For these types of AFs the signal name of the imported signal has meaning (e.g. XQ01 is the signal
name for an analog signal). The same signal name should be used in further logic in the system.
If the match is not found, the automatic connection will not be made. The user can still create a
manual connection is desired.
For output signals the signal definition can also be entered directly in the mask for the AF Block. If a new
connection exists after the hardware import, a Source Connector will be automatically created.
When importing Failsafe Hardware Proxies, the system does not automatically establish the connections to AF
Blocks. Therefore the user has to manually configure the Connectors after the Hardware Import has been
carried out.
Wiring diagrams are actually a type of linked document which have extended functionality for the hardware import.
Automatic Linking
Wiring diagrams are automatically linked to Automation Functions and proxies as part of the import process. This
obviates the need for linking the documents manually and ensures that the navigation facilities work properly.
Wiring diagrams are automatically linked to Automation Functions which have automatic connections made to them.
The wiring diagram must be named the same as the Automation Function tag.
Hardware Proxies gather together all the wiring diagrams which are relevant to them. This works in the following way:
Wiring diagrams for power supplies are also automatically linked to the corresponding Hardware Proxy.
File Structure
All the files for a wiring diagram import must be packed in a single zip file. The zip file may not contain any
subdirectories. The following files are contained in the zip file.
Diagram Files
Each diagram must be a single .pdf document. The file names must be the same as the tags to which they must be
linked.
Meta File
A meta file must accompany the diagrams. The meta file is named document_info.xml. This XML file contains the
following additional information for each diagram:
• Designation
• Document type
• Revision version
• Revision date
The meta file must conform to the following document type definition which can be found in the system installation
directory:
wiringDiagramImport.dtd
1. All diagrams (of all the users) in the complete project must be committed prior to importing new nodes and
diagrams.
The import does not interfere with any other work that is being carried out.
The user is able to easily rollback, and thereby remove the imported nodes and diagrams if required.
The hardware and the wiring diagram import can be carried out:
o Simultaneously: Make the required entries for both the hardware engineering and the wiring
diagrams in the dialog box.
o Separately: Leave the entry blank for the import that is not required. Automatic linking to wiring
diagrams will not be carried out if the corresponding Automation Functions and proxies are imported
separately afterwards.
5. For the hardware engineering proceed as follows:
1. Enter the path and filename of the import file in the Import File field (alternatively, click on the
browse button and open the file browser to find the file).
2. Check the Destination Node . This can be changed by clicking in the field and using the hierarchy
browser.
If the import data contains modified hardware, this will be imported into existing Function
Diagrams in the project. The existing diagrams may exist anywhere within the Project
Hierarchy.
Any new Function Diagrams will be created in a new Project Node named
importedDiagrams. This Project Node is intended to be used on a temporary basis. The
new Function Diagrams can be moved to a more suitable location in the Project Hierarchy.
1. Click on Open Protocol to open a protocol report browser . The protocol browser will display a list of
the changes to be made to the SPPA-T3000 database, and any existing errors or warnings.
2. Click on Continue to accept the changes and proceed with the import.
OR
Click on Cancel to abort the import.
9. The system performs the second step of the import process and the Result of Preparation of Hardware
Import dialog box appears. The dialog box contains summary information about the number of warnings or
errors related to the import.
1. Click on Open Protocol to open a protocol report browser containing detailed information.
2. Click on Continue to proceed with the import.
OR
Click on Cancel to abort the import.
10. The system performs the data import. The changes will be implemented in the SPPA-T3000 database. The
Result of Import Hardware Engineering dialog box appears. The dialog box contains summary information
about the number of warnings or errors related to the import.
Click on Open Protocol to open a protocol report browser containing detailed information, or click on OK.
11. The system performs the wiring diagram import. The Result of performing wiring import dialog box
appears. The dialog box contains summary information about the number of warnings or errors related to the
import.
Click on Open Protocol to open a protocol report browser containing detailed information, or click on OK.
The hardware will be created in the system, automatic connections will be made and the wiring diagrams will be
imported.
The imported data can be removed by rolling back all Function Diagrams. Any modifications will then be
removed, and any new Function Diagrams will be deleted.
The import data file is an XML file, the structure of which complies to a document type definition (.dtd file). The
document type definition file is named hwImport.dtd and can be found in the system installation directory.
The import file for interface revision 2.0 has the following structure:
hwImport
This is the uppermost level in the structure. The import mode is set here (i.e. complete or partial). The following
parameters can be set:
• projectName: Free for editing, must always be the same for the same project.
• interfaceRevision: The ID of interface described in the dtd file. New interface revisions are always backwards
compatible with previous versions.
• creationTool: Free for editing. The software used to create the file can be entered here.
During an import SPPA-T3000 expects that the importNumber will be incremented by 1 for further partial
imports. If the importNumber does not follow the expected sequence the import will fail.
hwDevice
Hardware devices are the hardware modules that are being used. The following parameters can be set:
• planId: The diagram name of the Function Diagram in which the Hardware Proxy for the device is to be
placed.
• deviceName: The product number of the module.
• location: The ID of the physical location of the device.
• slotNo: The slot number of the device in the hardware rack.
• description: Optional text.
• deviceType: Relevant for FUM modules, indicates specific module application.
• powerSupplyDiagram: The ID for a wiring diagram for the power supply.
• removed: Relevant for a partial import, indicates when a device has been removed. Set to TRUE or FALSE
accordingly.
hwPinCollection
Contains all the information about individual signals, including the hwFunction and hwPin. The following parameters
are optional, and are only relevant for analog signals:
hwFunction
This is the assignment of the signal to a pin collection, and is used for automatic connections between the Hardware
Proxies and Automation Functions.
hwPin
• pin: The name of the pin, consisting of a number or letters, and is obtainable from the manual for the
hardware module.
• connIdOrion: This field is used for the signal name for binary signals. This is the identification of the pin as
defined in the connIdOrionList0.xml file, which can be found in the system installation directory.
• connName: This field is relevant for binary signals only. This entry is normally same as connIdOrion, but may
be language specific. This entry is visible to the user, and will be displayed in the Diagram Editor.
An existing FUM project consists of collection of Function Diagrams containing FUM Hardware Proxies and FUM
Automation Functions. The FUM Automation Functions can have connections to other logic as well as process
connections to Pictograms on Plant Displays.
1. Create the hardware design using SIM modules in a hardware design tool. Use the same signal tagnames
that were used in the FUM project.
2. Export the hardware design to the Import Data File.
3. Prepare the existing FUM project in SPPA-T3000 by deleting the FUM Hardware Proxies. The FUM
Automation Functions will be left with open destination connectors.
4. Carry out a Hardware Import using the import data file containing the SIM hardware design.
5. The existing FUM project will be converted to a SIM project as follows:
o Function Diagrams containing the new SIM Hardware Proxies will be created.
o The FUM Automation Functions will be replaced with the corresponding SIM Automation Functions.
o Parameter settings in the FUM Automation Function will be transferred to the corresponding
parameters in the SIM Automation Functions.
o Connections between the Hardware Proxies and Automation Functions and to other logic will be
maintained.
o The process connections to existing Pictograms on Plant Displays will be maintained.
The procedure described above is also used to convert an existing SIM project to a FUM project.
This conversion procedure can also be used with project containing both FUM and SIM hardware.
The mapping between FUM and SIM Automation Functions are shown in the tables below:
There are certain AFs which could have multiple mappings. For example a FUM_ASMON could be converted to
ASMON or ASMON_R. In such cases the AF created during AF conversion is determined by the value of
redConnection in the hwPinCollection in the import file. A value of 1 or 2 indicates a redundant AF ( i.e.
ASMON_R, BSMON_R) has to be created. For all other values a nonredundant AF (i.e. ASMON, BSMON) will be
created.
Port Mapping
During a FUM/SIM conversion Port parameters and connections will be transferred from the original AF to the new AF
using the mappings in the tables below. If a Port or parameter setting cannot be transferred, it will be logged in the
Result of Import Hardware Engineering protocol. If the new AF contains a new Port parameter that didn't exist in the
original AF, the default setting will be used. If the range of the parameters for a Port are not the same for a specific
port, in the old and new AF, the default setting will be used.
FUM_MOTOR/MOTOR
Port Type Name Description
I QUALITY Quality code processing
I P1_STOP Protection 1 Command STOP
I P2_STOP Protection 2 Command STOP
I EN_STOP Enabling STOP
I A_STOP Automatic Command STOP
I P1_START Protection 1 Command START
I P2_START Protection 2 Command START
I EN_START Enabling START
I A_START Automatic Command START
I A_RESET Automatic Command RESET
I UV_TS Undervoltage Threshold Signal
I FB_LOC Feedback LOCAL Control
I BL_A Blocking Automatic Commands
I BL_M Blocking Manual Commands
I EN_AM Enabling AUTO/MANUAL Mode
FUM_SOV/SOV
Port Type Name Description
I QUALITY Quality code processing
I P1_CLOSE Protection 1 Command CLOSE
I P2_CLOSE Protection 2 Command CLOSE
I EN_CLOSE Enabling CLOSE
I A_CLOSE Automatic Command CLOSE
I P1_OPEN Protection 1 Command OPEN
I P2_OPEN Protection 2 Command OPEN
I EN_OPEN Enabling OPEN
I A_OPEN Automatic Command OPEN
I A_RESET Automatic Command RESET
I FB_LOC Feedback LOCAL Control
I BL_A Blocking Automatic Commands
I BL_M Blocking Manual Commands
I EN_AM Enabling AUTO/MANUAL Mode
I FP_MODE (*) First Pass Mode
I T_TRAV Valve Travel Monitoring Time (sec)
O CLOSED Status CLOSED
O OPENED Status OPENED
O TRBL_AL Trouble Alarm
O LOCAL LOCAL Control
O COM COMMISSIONING Mode
O TAGOUT TAGOUT Mode
O AUTO AUTO Mode
O MAN MANUAL Mode
O RESET RESET Command
FUM_ACTUATOR/ACTUATOR
Port Type Name Description
I QUALITY Quality code processing
I P1_CLOSE Protection 1 Command CLOSE
I P2_CLOSE Protection 2 Command CLOSE
I EN_CLOSE Enabling CLOSE
I A_CLOSE Automatic Command CLOSE
I A_STOP Automatic Command STOP Moving
I P1_OPEN Protection 1 Command OPEN
I P2_OPEN Protection 2 Command OPEN
I EN_OPEN Enabling OPEN
I A_OPEN Automatic Command OPEN
I A_RESET Automatic Command RESET
FUM_SERVO/SERVO
Port Type Name Description
I QUALITY Quality code processing
I P1_CLOSE Protection 1 Command CLOSE
I P2_CLOSE Protection 2 Command CLOSE
I EN_CLOSE Enabling CLOSE
I A_CLOSE Automatic Command CLOSE
I A_STOP Automatic Command STOP Moving
I P1_OPEN Protection 1 Command OPEN
I P2_OPEN Protection 2 Command OPEN
I EN_OPEN Enabling OPEN
I A_OPEN Automatic Command OPEN
I EN_OL Enabling OPEN LOOP
I A_OL Automatic Command OPEN LOOP
I EN_CL Enabling CLOSE LOOP
I A_CL Automatic Command CLOSE LOOP
I EXT_FLT External Fault
I A_RESET Automatic Command RESET
I FB_LOC Feedback LOCAL Control
I BL_A Blocking Automatic Commands
I BL_M Blocking Manual Commands
I EN_AM Enabling AUTO/MANUAL Mode
I FP_MODE (*) First Pass Mode
I T_TRAV Valve Travel Monitoring Time (sec)
I T_STEP STEP Mode Time Period (sec)
I T_TQCL Torque Time Bypass CLOSE (sec)
I T_TQOP Torque Time Bypass OPEN (sec)
I SEAL_CL (*) Sealing direction CLOSE
I SEAL_OP (*) Sealing direction OPEN
I ER System Deviation
I DB Deadband
I MINPAU Minimum Pause Duration (sec)
I MINPUL Minimum Pulse Duration (sec)
I GAIN Gain Factor
I TN Integration Time
I ANTI_W Limitation of I-Content
I BL_CL Blocking Closed Loop Direction CLOSE
I BL_OP Blocking Closed Loop Direction OPEN
FUM_MOTOR2SR/MOTOR_2SR
Port Type Name Description
I QUALITY Quality code processing
I P1_START1 Protection 1 Command START 1
I P2_START1 Protection 2 Command START 1
I EN_START1 Enabling START 1
I A_START1 Automatic Command START 1
I P1_START2 Protection 1 Command START 2
I P2_START2 Protection 2 Command START 2
I EN_START2 Enabling START 2
I A_START2 Automatic Command START 2
I A_RESET Automatic Command RESET
I UV_TS Undervoltage Threshold Signal
I FB_LOC Feedback LOCAL Control
I BL_A Blocking Automatic Commands
I BL_M Blocking Manual Commands
I EN_AM Enabling AUTO/MANUAL Mode
I FP_MODE (*) First Pass Mode
I T_CHO Command Changeover Delay Time (sec)
I UV_TO Maximum Undervoltage Timeout (sec)
I UV_ST Undervoltage Staggering Time (sec)
O STOPPED Status STOPPED
O RUNNING1 Status RUNNING 1
O RUNNING2 Status RUNNING 2
O TRBL_AL Trouble Alarm
O UV Undervoltage Present
O TEST Test position
O LOCAL LOCAL Control
O COM COMMISSIONING Mode
O TAGOUT TAGOUT Mode
O AUTO AUTO Mode
O MAN MANUAL Mode
O RESET RESET Command
FUM_ASMON/ASMON
Port Type Name Description
I T1 Smoothing Time in seconds
I LV1 Limit Value 1
I LV2 Limit Value 2
I LV3 Limit Value 3
I LV4 Limit Value 4
I DB Dead Band in %
I SUB_V Substitution Value
I UL Upper Limit
I LL Lower Limit
I EU Engineering Unit
I LSG1 (*) Limit Signal Generation 1
I HI_LOW1 (*) Upper/Lower Limit 1
I LSG2 (*) Limit Signal Generation 2
I HI_LOW2 (*) Upper/Lower Limit 2
I LSG3 (*) Limit Signal Generation 3
I HI_LOW3 (*) Upper/Lower Limit 3
I LSG4 (*) Limit Signal Generation 4
I HI_LOW4 (*) Upper/Lower Limit 4
I SUB_VS (*) Substitution Value Selection
I LS_GQ (*) Limit Signals GOD Quality
I AL_SUPQ1 (*) Alarm Suppression Output Q1
I AL_SUPQ2 (*) Alarm Suppression Output Q2
I AL_SUPQ3 (*) Alarm Suppression Output Q3
I AL_SUPQ4 (*) Alarm Suppression Output Q4
O OUT Output Value
O Q1 Limit Signal 1
O Q2 Limit Signal 2
O Q3 Limit Signal 3
O Q4 Limit Signal 4
O OUT_GQ GOD Quality Output Value
FUM_ASMON/ASMON_R
Port Type Name Description
I MINMAX (*) Minimum/Maximum Selection
I T1 Smoothing Time in seconds
I LV1 Limit Value 1
I LV2 Limit Value 2
I LV3 Limit Value 3
I LV4 Limit Value 4
I DB Dead Band in %
I DEV_DB Deviation Deadband
I T_MON Deviation Monitoring Delay Time (sec)
I SUB_V Substitution Value
I UL Upper Limit
I LL Lower Limit
I EU Engineering Unit
I LSG1 (*) Limit Signal Generation 1
I HI_LOW1 (*) Upper/Lower Limit 1
I LSG2 (*) Limit Signal Generation 2
I HI_LOW2 (*) Upper/Lower Limit 2
I LSG3 (*) Limit Signal Generation 3
I HI_LOW3 (*) Upper/Lower Limit 3
I LSG4 (*) Limit Signal Generation 4
I HI_LOW4 (*) Upper/Lower Limit 4
I SUB_VS (*) Substitution Value Selection
I LS_GQ (*) Limit Signals GOD Quality
I AL_SUPQ1 (*) Alarm Suppression Output Q1
I AL_SUPQ2 (*) Alarm Suppression Output Q2
I AL_SUPQ3 (*) Alarm Suppression Output Q3
I AL_SUPQ4 (*) Alarm Suppression Output Q4
O OUT Output Value
O Q1 Limit Signal 1
O Q2 Limit Signal 2
O Q3 Limit Signal 3
O Q4 Limit Signal 4
O OUT_GQ GOD Quality Output Value
O TRBL_AL Trouble Alarm
FUM_BSMON/BSMON
Port Type Name Description
I T_MON Deviation Monitoring Delay Time [s]
I SUB_VS (*) Substitution Value Selection
I AL_SUP Alarm Suppression
O OUT Binary Output
O OUTN Negated Output
O OUT_GQ GOD Quality Binary Output
O TRBL_AL Trouble Alarm
FUM_BSMON/BSMON_R
Port Type Name Description
I T_MON Deviation Monitoring Delay Time [s]
I SUB_VS (*) Substitution Value Selection
I AL_SUP Alarm Suppression
O OUT Binary Output
O OUT_GQ GOD Quality Binary Output
O OUT_IN1 Output equal to LINK_FUM1
O OUT_IN2 Output equal to LINK_FUM2
O TRBL_AL Trouble Alarm
O OUT_AL Output Quality Alarm
O DEV_AL Deviation Alarm
O Q_AL1 Quality Alarm IN1
O Q_AL2 Quality Alarm IN2
FUM_TTMON/ASMON
Port Type Name Description
I T1 Smoothing Time in seconds
I LV1 Limit Value 1
I LV2 Limit Value 2
I LV3 Limit Value 3
I LV4 Limit Value 4
I DB Dead Band in %
I SUB_V Substitution Value
I UL Upper Limit
I LL Lower Limit
I EU Engineering Unit
I LSG1 (*) Limit Signal Generation 1
I HI_LOW1 (*) Upper/Lower Limit 1
I LSG2 (*) Limit Signal Generation 2
I HI_LOW2 (*) Upper/Lower Limit 2
I LSG3 (*) Limit Signal Generation 3
I HI_LOW3 (*) Upper/Lower Limit 3
I LSG4 (*) Limit Signal Generation 4
I HI_LOW4 (*) Upper/Lower Limit 4
I SUB_VS (*) Substitution Value Selection
I LS_GQ (*) Limit Signals GOD Quality
I AL_SUPQ1 (*) Alarm Suppression Output Q1
I AL_SUPQ2 (*) Alarm Suppression Output Q2
I AL_SUPQ3 (*) Alarm Suppression Output Q3
FUM_TTMON/ASMON_R
Port Type Name Description
I MINMAX (*) Minimum/Maximum Selection
I T1 Smoothing Time in seconds
I LV1 Limit Value 1
I LV2 Limit Value 2
I LV3 Limit Value 3
I LV4 Limit Value 4
I DB Dead Band in %
I DEV_DB Deviation Deadband
I T_MON Deviation Monitoring Delay Time (sec)
I SUB_V Substitution Value
I UL Upper Limit
I LL Lower Limit
I EU Engineering Unit
I LSG1 (*) Limit Signal Generation 1
I HI_LOW1 (*) Upper/Lower Limit 1
I LSG2 (*) Limit Signal Generation 2
I HI_LOW2 (*) Upper/Lower Limit 2
I LSG3 (*) Limit Signal Generation 3
I HI_LOW3 (*) Upper/Lower Limit 3
I LSG4 (*) Limit Signal Generation 4
I HI_LOW4 (*) Upper/Lower Limit 4
I SUB_VS (*) Substitution Value Selection
I LS_GQ (*) Limit Signals GOD Quality
I AL_SUPQ1 (*) Alarm Suppression Output Q1
I AL_SUPQ2 (*) Alarm Suppression Output Q2
I AL_SUPQ3 (*) Alarm Suppression Output Q3
I AL_SUPQ4 (*) Alarm Suppression Output Q4
O OUT Output Value
O Q1 Limit Signal 1
O Q2 Limit Signal 2
O Q3 Limit Signal 3
O Q4 Limit Signal 4
O OUT_GQ GOD Quality Output Value
O TRBL_AL Trouble Alarm
O OUT_AL Output Quality Alarm
O DEV_AL Deviation alarm
O Q_AL1 Quality Alarm 1
O Q_AL2 Quality Alarm 2
O OUT_IN1 Output equal to LINK_FUM1
O OUT_IN2 Output equal to LINK_FUM2
Any new Automation Functions will automatically be made available for use in the SPPA-T3000 Library.
If an AF which is being imported has already been used in the project (i.e. placed as an AF Block in a Function
Diagram), then the imported AF will replace the existing AF, in both the Project Container and the Runtime Container.
Replaced AFs become active immediately in the system after the import. Ensure that any necessary
precautions have been taken prior to replacing the AFs (e.g. informing operating staff of the change, or
ensuring relevant controls are put into manual where required).
Automations Functions can be imported at any client computer. The update information is contained in a file (either a
Zip (*.zip) or Java (*.jar) file format). The file must be stored on a drive available to the client computer.
There can be up to several files associated with each AF being imported. The files associated with AF can be
categorized into one of the following types:
• Engineering Information: Information for creating and parameterizing the Automation Functions, e.g.
Prototypes, Automation Function types, profiles containing information for offline calculation, or foreign
language text files.
• Runtime Information: Information required by the Runtime Containers for executing Automation Functions.
• For Java Runtime Containers these are Java classes; and for S7 Runtime Containers it is the S7 CPU
Execution Frame, which is executed in an S7 CPU.
1. Select the Extras menu, then Import, then Automation Function from the drop down menus.
2. A dialog box appears to select the file to be imported.
3. Enter the path and filename of the file to be imported (alternatively, click on the browse button and open the
file browser to find the file).
4. Click on Load to load the file, otherwise click on Cancel.
5. After the file has been read the Import Result dialog box appears.
6. For detailed information of the content of the import file open the protocol, otherwise click on Continue.
7. The import file gets stored on the Application Server. The result is committed by a dialog box. Click on OK.
8. If runtime information was included in the import file the Activate updated AFs dialog box will appear. This
dialog box lists the Runtime Containers affected by the newly imported Automation Functions. Proceed to
update the affected Runtime Containers.
Another import is only possible, after all of the affected Runtime Containers has been updated.
Macros and Compound Components can be imported at any client computer. The data to be imported is contained in a
file (either a Zip (*.zip) or Java (*.jar) file format). The file must be stored on a drive available to the client computer.
When importing Macros it is also possible to modify them according to the copy and modify rules set by the user. It is
also possible to preview the effect of the copy and modify rules on the import data without actually importing the data.
1. All diagrams in the complete project (of all the users) must be committed prior to importing Macros and
Compound Components.
The import does not interfere with any other work that is being carried out.
The user is able to easily rollback, and thereby remove the imported Macros if required.
2. Select the destination Library Node for the Macros to be imported into.
3. Select the Extras menu, then Import, then Macros/Compound Components from the drop down menus.
4. The Import Macro(s) dialog box appears to select the file to be imported.
5. Enter the path and filename of the file to be imported in the Source Archive File field (alternatively, click on
the browse button and open the file browser to find the file).
6. Check that the Destination Node is correct, this can be changed if required by clicking on the button and
using the hierarchy browser.
7. If the imported Macros are to be modified according to the copy and modify rules, click on the Modify
Macros/Nodes check box.
o The Preview check box can also be checked. If preview is selected, the user is able to view the
results of the import operation in the protocol file without actually importing the nodes and Macros into the
project.
8. Click on Import to load the file, otherwise click on Cancel.
9. After the file has been read in, a dialog box will appear containing summary information of errors or warnings
from the file import. To view detailed information click on the Open Protocol button to open a protocol report
browser, otherwise click on OK.
The imported Macros and Compound Components can now be treated like any others in the library.
Elements will not be imported if they conflict with elements already existing in the project (e.g. identical Tag
Names). Errors will be recorded in the protocol file.
Illegal characters are not permitted in the names of imported elements. If illegal characters exist they will
automatically be replaced by the underscore symbol (_).
Prototypes can be imported at any client computer. The data to be imported is contained in a file (either a Zip (*.zip) or
Jar (*.jar) file format). The file must be stored on a drive available to the client computer.
1. Select the destination Library Node for the Prototypes to be imported into.
2. Select the Extras menu, then Import, then Prototypes from the drop down menus.
3. The Import/Update Prototype dialog box appears.
4. Enter the path and filename of the file to be imported in the Prototypes (Zip-File) field (alternatively, click on
the browse button and open the file browser to find the file).
5. Click on Load to load the file, otherwise click on Cancel.
6. After the file has been read in, a dialog box will appear containing summary information of errors or warnings
from the file import.
The imported Prototypes can now be treated like any others in the Prototypes.
Elements will not be imported if they conflict with elements which already exist in the project (e.g. identical Tag
Names). Errors will be recorded in the protocol file.
Illegal characters are not permitted in the names of imported elements. If illegal characters exist they will
automatically be replaced by the underscore symbol (_).
The profiles are always on the secondary Server in the parameterized folder. If a second profile was generated in the
Admin Console for a Runtime Container then this one can also be imported.
1. Select the Extras menu, then Import, then Application Profile from the drop down menus.
2. The Import Application Profile dialog box appears.
3. Enter the path and filename of the file to be imported in the Application Profile field (alternatively, click on
the browse button and open the file browser to find the file).
4. Click on Import to load the file, otherwise click on Cancel.
5. After the file has been read in, a dialog box will appear containing summary information of errors or warnings
from the file import.
The imported Application Profile can now be assigned to the Runtime Container.
1. Select the Extras menu, then Import, then GSD file... from the drop down menus.
The user must have access right Project administration to select the menu option.
3. The Import GSD File dialog box opens beneath the Warning dialog. Click on OK to close the Warning dialog
box.
4. Select the Import GSD File dialog box and enter the path of the GSD File, or click on the browse button (on
the right hand side of the field) to find the file using a browser.
Only .gsd and .gse type files are supported for import. If another type of definition file is required
(e.g. .gsg, .gss, .gsf), the extension can be changed to .gsd and imported.
5. Click on Import to import the GSD file. Otherwise, click Cancel to close.
6. The file is checked for version and syntactical correctness. If the file (either same or different version) already
exists in the system, the user is then given the option to overwrite the existing file or to cancel the import.
Existing instances of the GSD file and their parameterization in FD_GENERIC blocks are not
affected. The process to update or change the GSD assignment (including version) of existing
FD_GENERIC blocks is described separately.
7. The Result of Import GSD dialog box appears and lists the Number of Errors and the Number of
Warnings:
Report Types can be imported at any client computer. The data to be imported is contained in a *.jar file. The file must
be stored on a drive available to the client computer.
1. Select the Extras menu, then Import, then Report Type from the drop down menus.
2. The Import Report Type dialog box appears.
3. Enter the path and filename of the file to be imported in the Report type File field (alternatively, click on the
browse button and open the file browser to find the file).
4. Click on Import to load the file, otherwise click on Cancel.
5. After the file has been read in, a dialog box will appear containing summary information of errors or warnings
from the file import. To view detailed information click on the Open Protocol button to open a protocol report
browser, otherwise click on OK.
The imported report types can now be treated like any others in the Project.
When forcing Ports care must be taken. There may be safety implications e.g. a drive interlock may be
overridden, or some other undesired effect on the control system may take place.
1. Select the Extras menu, then Import, then Forced Ports from the drop down menus.
3. Enter the name of the file containing the Forced Ports Table, or click on the browse button to find the file
using a browser.
4. Select or deselect the Reset Existing Forcing as required.
The Reset Existing Forcing check box has the following effect:
o If Reset Existing Forcing is selected then Ports in the project that are currently forced, but not
listed in the import file, will be reset.
o If Reset Existing Forcing is not selected then and Ports in the project that are currently forced, but
not listed in the import file, will be left as forced.
5. Click on Import.
6. The Forced Ports dialog box will appear with a list of all Ports to be forced to the corresponding Value.
7. Click on Force.
1. All diagrams (of all the users) in the complete project must be committed prior to importing new nodes and
diagrams.
• The import does not interfere with any other work that is being carried out.
• The user is able to easily rollback, and thereby remove the imported nodes and diagrams if
required.
If the import data contains modified TDY Automation Functions, this will be imported into existing
Function Diagrams in the project. The existing diagrams may exist anywhere within the Project
Hierarchy.
3. Select the Extras menu, then Import, then TDY Engineering from the drop down menus.
4. A dialog box appears to select the file to be imported.
1. Enter the path and filename of the file to be imported in the TDY Configuration File field
(alternatively, click on the browse button and open the file browser to find the file).
2. Check that the Destination Node is the Project Node that was selected in Step 2. This can be
changed, if required, by clicking in the field and using the hierarchy browser.
3. Click on Import to load the hardware import data file, otherwise click on Cancel.
5. The system performs the first step of the import process. In this step the changes that will be made to the
SPPA-T3000 database are detected. The Result of Preparation of Hardware Import dialog box appears.
The dialog box contains summary information about the number of warnings or errors related to the import.
1. Click on Open Protocol to open a protocol report browser . The protocol browser will display a list of
the changes to be made to the SPPA-T3000 database, and any existing errors or warnings.
2. Click on Continue to accept the changes and proceed with the import.
OR
Click on Cancel to abort the import.
6. The system performs the data import. The changes will be implemented in the SPPA-T3000 database. The
Result of Import Tdy Engineering dialog box appears. The dialog box contains summary information about
the number of warnings or errors related to the import.
Click on Open Protocol to open a protocol report browser containing detailed information, or click on OK.
The TDY Function Diagram will be created in the system. The Function Diagram uses the PKZ as the diagram name.
Any matches that are found for input and output signals of the TDY AF blocks will be automatically closed.
The imported data can be removed by rolling back all Function Diagrams. Any modifications will then be
removed, and any new Function Diagrams will be deleted.
If importing configuration data for an existing TDY Function Diagram, the AF blocks on the Function Diagram
must be deactivated. If one or more AF blocks on the Diagram are still activated, the import will be cancelled.
Project Nodes or diagrams can be exported by a user situated at any client computer. The data is exported in a file,
with a Java (*.jar) file format. The file will be stored on the Application Server.
When a Project Node is selected, the entire contents of the node and its structure will be exported.
2. Select the Extras menu, then Export, then Project Nodes or Diagrams from the drop down menus.
3. A dialog box appears to confirm the node or diagrams to be exported.
o Source Node/Diagram indicates the node to be exported. This can be changed by clicking on the
browse button and selecting a new node.
o Archive File is the name of the file that will be exported.
The node name may contain illegal characters or characters that are not in the normal English character set.
In this case the characters may be replaced by underscores (_) or the node ID may be used.
4. Click on Export to export the file, otherwise click on Cancel.
5. After the file has been exported, a dialog box will appear containing summary information about errors or
warnings from the file export. To view detailed information click on the Open Protocol button to open a
protocol report browser, otherwise click on OK.
Exported files can be downloaded from the server. The files are located in the following directory:
Orion/OrionImport/, and are all of type jar archive (i.e. file extension .jar).
If the exported diagrams include instances of the Generic PROFIBUS Interface proxy FD_GENERIC, the
corresponding GSD files are exported.
If the exported diagrams contain Automation Functions and proxies with linked documents, then the links to
these documents will also be exported.
The documents themselves can be exported using the linked document export function.
Macros and Compound Components can be exported by a user logged in on any client computer. The data is exported
in a file, with a Java (*.jar) file format. The file will be stored on the Application Server.
Library Nodes can also be selected. In this case the node, all subordinate Library Nodes and any
Macros and Compound Components contained in them will be exported.
2. Select the Extras menu, then Export, then Macros/Compound Components from the drop down menus.
3. The Export Macros/Compound Components dialog box appears to confirm the node or Macros to be
exported.
o Source indicates the node to be exported. This can be changed by clicking on the browse button
and selecting a new node.
o Archive File is the name of the file that will be exported.
The node name may contain illegal characters or characters that are not in the normal English character set.
In this case the characters may be replaced by underscores (_) or the node ID may be used.
4. Click on Export to export the file, otherwise click on Cancel.
5. After the file has been exported, a dialog box will appear containing summary information about errors or
warnings from the file export. To view detailed information click on the Open Protocol button to open a
protocol report browser, otherwise click on OK.
Exported files can be downloaded from the server. The files are located in the following directory:
Orion/OrionImport/, and are all of type jar archive (i.e. file extension .jar).
Prototypes can be exported by a user logged in on any client computer. The data is exported in a file, with a Java
(*.jar) file format. The file will be stored on the Application Server, and can later be accessed and imported into other
projects.
Library Nodes can also be selected. In this case the node, all subordinate Library Nodes and any
Prototypes contained in them will be exported.
2. Select the Extras menu, then Export, then Prototypes from the drop down menus.
3. The Export Prototypes dialog box appears to confirm the node or Prototype to be exported.
o Source Node/Prototype indicates the node to be exported. This can be changed by clicking on the
browse button and selecting a new node.
o Archive File is the name of the file that will be exported.
The node name may contain illegal characters or characters that are not in the normal English character set.
In this case the characters may be replaced by underscores (_) or the node ID may be used.
4. Click on Export to export the file, otherwise click on Cancel.
5. After the file has been exported, a dialog box will appear containing summary information about errors or
warnings from the file export. To view detailed information click on the Open Protocol button to open a
protocol report browser, otherwise click on OK.
Exported files can be downloaded from the server. The files are located in the following directory:
Orion/OrionImport/, and are all of type jar archive (i.e. file extension .jar).
In the upper section, the Replace Prototype dialog box provides four Expression Fields:
• Old Library Node and Old Prototype display the prototype, selected in the library. These are just for
information and are displayed phantom.
• New Library Node displays a proposal for the library node, which keeps the new prototype. This can be
overwritten by the keyboard or by using the browse button.
• New Prototype displays a proposal for the name of the new prototype. This can be overwritten by the
keyboard or by using the browse button.
• The browse button opens a Prototype Chooser. Specifying a prototype in the Prototype Chooser overwrites
the New Library Node and the New Prototype boxes.
In the lower section, the two options determine whether the new prototype will be stored under the old name in the
library or not:
• Yes, old Prototype will be removed : the prototype will be overwritten. No old version is kept in the library.
• No, old Prototype won't be removed : the old prototype will be kept beside a copy of the new one (with the
new name).
The new Prototype inherits the properties and mappings (including Special Mappings) of the old Prototype to the
extent possible.
Report types can be exported by a user logged in on any client computer. The data is exported in a file, with a Java
(*.jar) file format. The file will be stored on the Application Server, and can later be accessed and imported into other
projects.
1. Select the Extras menu, then Export, then Report Type from the drop down menus.
2. The Export Report Type dialog box appears.
3. Select the Report Type to be exported from the drop down list.
4. The name of the file that will be exported is displayed in the Archive File field.
5. Click on Export to export the file, otherwise click on Cancel.
6. After the file has been exported, a dialog box will appear containing summary information about errors or
warnings from the file export. To view detailed information click on the Open Protocol button to open a
protocol report browser, otherwise click on OK.
Exported files can be downloaded from the server. The files are located in the following directory:
Orion/OrionImport/, and are all of type jar archive (i.e. file extension .jar).
• Signal Information:
o Tag Name
o Signal Item
o Signal Name
o Designation
o The signal data type.
• The Instance Id of the AF or proxy, and the Port ID of the Port that sources the signal.
• For analog signals:
o The Variation Min and Variation Max.
o The Engineering Unit (EU).
• For binary signals: The Active Alarm Text.
The file can be exported to any drive available to the Thin Client.
1. Select the Project Node or Function Diagram containing the signals to be exported.
The signals in all subordinate Project Nodes will be included on the signal list.
2. Select the Extras menu, then Export, then Signals from the drop down menus.
3. The Export Signals dialog box will appear.
A Hierarchy Browser will then open, and a different node or diagram can be selected.
Wildcard searches can be made as follows: Enter an asterisk (*), to represent any number of
characters, or a blank. Enter an question mark (?), to represent any single character.
User Administration
• engineering
• operation
• maintenance of the I&C system
The intent is to give appropriate allowances to personnel in accordance to their duties, responsibilities and authority.
After the roles are defined, each person allowed to have access to the system is registered as an individual
user. Additionally Thin Clients can be restricted with specific roles. To each of the registered users one, or if
necessary more, of the roles may be assigned, enabling them to fulfill their specific tasks and responsibilities.
It is possible to limit the authorization to a specific part of the plant, e.g. to give the authorization for operation
to a certain part of the plant to the operators. A users access rights can be further limited to specific devices
within a plant area.
The relationship between any individual user and the assigned role is controlled by the login to the system.
Safeguards are also put in place to prevent users with administration access rights from inadvertently deleting
themselves from the system.
These functions are provided for higher level controls sometimes required for a project. These functions are not
intended for everyday use, but rather for problem solving in more exceptional circumstances or for setting up specific
system behavior.
1. Select the Admin menu, then Roles from the drop down menu.
2. The Roles dialog box will open.
From this dialog box, the following activities can be carried out:
• deleting roles,
• to adding roles, or
• to copying roles, or
• editing existing roles.
To delete a role open the window Roles in the Admin menu of the Project View.
1. Select the role with the mouse. The role name is highlighted.
2. Press Delete Role.
3. Confirm the pop-up box with Yes, or abort the action with No.
Finally in the window Roles press the button Save to make the changes valid in the system, or press the button
Cancel to discard the changes.
Finally in the window Roles press the button Save to make the changes valid in the system, or press the button
Cancel to discard the changes.
1. Select the existing role, afterwards press the button Edit Role. The Edit Roles dialog box appears (an
example is shown).
The dialog box contains a list of all the permissions that can be allocated to a role.
2. Mark the desired permission for the role by selecting the check box in the column Enable.
To remove a selection click the check box again.
3. Use the button Close for this window.
4. Finally in the window Roles press the button Save to make the changes valid in the system, or press the
button Cancel to discard the changes.
The changes will apply only after the next login with the associated role.
The column Functional Rights indicates which of the rights are classified as a not-node selective.
The classification is preset on the system implementation level and can therefore not be changed, even with
administrator rights.
For details about the permissions refer to the access rights description.
4. Click on Save in the Roles window to complete the process. Otherwise click Cancel to discard the changes
and close the window.
The new role is created using the original role as a template. The newly created role can now be edited.
1. In the Project View select the Admin menu, then Working Place Manager.
2. The Working Place Manager dialog box will open:
From the Working Place Manager dialog box, the follows functions can be performed:
• Delete an OWP
• Create an OWP
• Copy an OWP
• Edit existing OWPs including defining the OWP Access Rights.
Access from the Thin Client corresponding to the deleted OWP (IP address) will revert to the Default OWP
permissions.
3. The Working Place Properties dialog box opens showing the data copied from the base OWP:
To avoid duplicate OWP assignments, the OWP name is automatically changed by adding a 1 to the
end of the Name field.
4. Modify as necessary the properties of the new OWP. All fields are mandatory:
o Name: Name of the OWP.
o Description: Description of the OWP.
o Network Address: IP Address of the OWP.
5. Confirm the OWP creation by clicking on Save. Otherwise click on Cancel.
The access rights are identical to the one of the original OWP.
The OWP is copied into a new OWP definition. The Access Rights can now be modified.
5. Click on Access Rights to edit the access rights. The Define Access Rights dialog box will open. The OWP
Access Rights can be defined.
6. Click on Save to save the changes. Otherwise click on Cancel.
To assign new users to the system login to the Workbench. From the menu Application select Project View . In the
Project View select the menu Admin, then User Manager.
• to delete a user,
• to add a user, or
• to copy a user, or
• to edit existing users.
1. Select the login name with the mouse. The name is highlighted.
2. Press Delete User.
3. Confirm the box which subsequently appears by clicking Yes, this will immediately remove the user in the
system, or abort the command with No.
o Login name: mandatory; name assigned to the new user automatically populated.
o Name: optional; freely editable name of user.
o Description: mandatory; description of user.
o Password: mandatory; the password must be kept confidential to avoid misuse. When typing in the
password each character is displayed as an asterisk (*).
o Confirm password: mandatory; confirmation is necessary to ensure that there are no typing
mistakes and the user can successfully login.
o Email ID : optional; mandatory for Call Home function.
o Phone Number: optional; phone number of the user.
2. To adjust the access rights click on Access Rights.
The user must confirm that the new user data will be stored, in order to adjust the access rights. Click
on Yes to proceed.
3. Finally in the window User Properties press the button Save to make the changes valid in the system, or
press the button Cancel to discard the changes.
After this action a new user is assigned to the system with standardized settings.
o Login name: mandatory; name assigned to the new user automatically populated.
o Name: optional; freely editable name of user.
o Description: mandatory; description of copied user is suggested.
o Password: mandatory; the password must be kept confidential to avoid misuse. When typing in the
password each character is displayed as an asterisk (*).
o Confirm password: mandatory; confirmation is necessary to ensure that there are no typing
mistakes and the user can successfully login.
o Email ID : optional; mandatory for Call Home function.
o Phone Number: optional; phone number of the user.
3. Finally in the window User Properties press the button Save to make the changes valid in the system, or
press the button Cancel to discard the changes.
After this action a new user is assigned to the system with standardized settings.
The access rights are identical to the one of the original user.
Proceed as follows:
1. Select the login name and press the button Edit User
2. The window User Properties is opened, entries can be edited.
Clicking on Access Rights will open the Define Access Rights dialog where rights can be set and edited.
Finally save the changes with the button Save or abort the action with the button Cancel.
Before you can assign a role to a user the specific role must exist.
Details are described in Administration of User Roles.
Proceed as follows:
The window Define Access Rights allows configuration of the access rights
o with respect to different plant areas, or
o with respect to different user roles.
A detailed explanation of the different user rights follows in Explanation of Access Rights
Changing the User Rights or the Access Rights Individually for Plant Areas
1. In the window Project View select the area (preferably the Node in the Tree View) and drag it into the
window Define Access Rights below the column Plant Area.
2. On releasing the mouse button the selected area and sub-areas are added to the list.
3. If the access should be allowed to only a single area, without sub-areas included, delete the asterisk * in the
respective entry:
1. In the window Project View select the Function Diagram containing the AF block for the device and drag it
into Define Access Rights window below the column Plant Area.
2. On releasing the mouse button the Function Diagram name and location in the Project Hierarchy are added to
the list.
3. Beside the Function Diagram name insert a forward slash i.e. '/ '.
4. In the same field specify the tagname of the device in one of the following ways:
o Explicitly enter a single tagname using the following structure:
<tagname><tag separator><tag item>
To see the structure of the tagname open the Function Diagram in the Diagram Editor and set the
view to Show Tagname.
After all changes are made close the window Define Access Rights with the button Save to make the changes valid
in the system, or press the button Cancel to discard the changes.
1. The not-node selective access rights are valid for actions which are not related to a specific node in the
Project Hierarchy. The role for not-node selective access rights is modified in the field Functional Rights.
Examples of not-node selective rights are:
o administration rights,
o creating and changing Automation Functions Blocks,
o activation of the Operation Mode for the Workbench .
2. The node selective access rights are restricted to a certain node or Plant Area. These rights are related to
operation and engineering actions like
o reviewing function diagrams
o creating and changing function diagrams
o operation
o simulation or forcing of signals
Diagram Editor:
Workbench:
Project View:
Project View :
Alarm Printer
Archive Archive administration Project View : No
administration
Extras -> Export -> Archive Data
Storage on removable Manual burning of DVDs Project View: No
media (DVDs)
In the Swap out Archive Data dialog box,
the Burn DVD check box is enabled
Define and change Define and change user Project View : No
user rights (Change specific access rights.
login rights) Admin -> User Manager
If Macro or CC selected:
Diagram Editor :
If Macro or CC selected:
Operating View:
Title Block
Diagram Editor :
also:
Operating View:
Point View:
Edit Parameters
Force Values
Change parameters Allows the change of Diagram Editor : (selected function diagram) Yes
(Level 2) parameters (set point
adjustment, controller tuning) Edit parameters in parameter dialog
Operating View:
Point View:
Edit Parameters
Force Values
Operating View:
Point View:
Edit Parameters
Force Values
Diagram Editor :
Point View:
Preview Activation
Project View :
Export of Project
nodes and diagrams
checks, if the user has
the permission to read
diagrams in the
selected folder
Operating View:
Point View:
Acknowledge
System logging Configuration and Diagnostic View : No
selection of logs.
Register Tab Logging
is enabled/disabled
according to right.
Remote diagnosis
button of containers is
en/disabled according
to right.
Change notes Allows changes of Operating View: Yes
notes of other users
(editing and deleting) Delete button in
Notes Dialog is
en/disabled according
to right.
Notepad is opened in
ReadOnly mode
according to right.
Force Ports Changes of Project View : Yes
Automation Functions
input / output values Extras ->
by manually input Documentation -
>Forced ports
Extras ->Import-
>Forced Ports
Operating View:
Faceplate Button
Point View:
Project View :
Report View
Selection of displayed
alarms
Workbench :
Operating View:
Before you can assign a role to a user or OWP the specific Role must exist or be created.
Access Rights can be set for Functional Rights or Plant Area Rights.
A detailed explanation of the different user rights follows in Explanation of Access Rights
3. After all changes are made, click on Save to make the changes valid in the system, or click on Cancel to
discard the changes.
1. Select the not-node-related Functional Rights from the drop down list.
2. Click on Save to save. Otherwise click on Cancel.
Access rights must be assigned to specific plant areas and specific devices, or, if desired, the plant as a whole. To add
a new plant area, proceed as follows:
1. In the Project View , select the area (preferably the Node in the Tree View) and drag it into the window
Define Access Rights below the column Plant Area.
2. On releasing the mouse button the selected area and sub-areas are added to the list.
3. If the access should be allowed to only a single area, without sub-areas included, delete the asterisk * in the
respective entry:
The new Plant Area is added to the list and can now have specific access rights assigned to it.
1. In the Project View , select the Function Diagram containing the AF block for the device and drag it into
Define Access Rights window below the column Plant Area.
2. On releasing the mouse button the Function Diagram name and location in the Project Hierarchy are added to
the list.
3. Beside the Function Diagram name insert a forward slash i.e. '/ '.
4. In the same field specify the tagname of the device in one of the following ways:
o Explicitly enter a single tagname using the following structure:
<tagname><tag separator><tag item>
To see the structure of the tagname open the Function Diagram in the Diagram Editor and set the
view to Show Tagname.
The new Device is added to the Plant Area list and can now have specific access rights assigned to it.
If a given right is granted for the superordinate node, that right is available to all subordinate nodes.
This is true even if that right is restricted by the Role given to the subordinate node.
In order to restrict a right in the subordinate node, that right must not be granted to the superordinate node.
1. For the desired Plant Area, select the node-related Role from the drop down list:
1. Select the Plant Area whose access needs to be removed from the list and click on Delete. The Plant Area
is removed from the list.
2. Click on Save to save.
These safeguards are implemented for any user that is assigned the access right: Define and change user rights.
The system prevents such users from:
Disconnecting or Reconnecting a Runtime Container is not a commonplace activity, and is not recommended
at a running plant.
The implications for disconnecting and reconnecting Runtime Containers depend on the type of Runtime Container.
Both types are described below:
Disconnecting an S7 Runtime Container will terminate the execution of all Automation Functions. All output values for
modules in the affected ET200M stations will be frozen.
The disconnection is triggered by a user action, that means, the user can decide, at which state of the process the
function should be executed.
The disconnection should only be used for initializing a SIMATIC S7 CPU, that has been added to the system or if an
irreparable system fault has appeared.
For S7 Runtime Containers Reconnecting will cause a reinitialization of the hardware proxies with the current
values, which are available.
The procedures for disconnecting and reconnecting a Runtime Container are described below:
Disconnecting or Reconnecting a Runtime Container is only performed in exceptional circumstances. The user must
be aware that the execution of the Runtime Container could be interrupted, and many system features will be
bypassed or overridden (especially those involving Project and Runtime Container consistency).
When a Runtime Container is disconnected, it continues running but engineering changes committed in the Project
Container will not be reflected in the Runtime Container. The Runtime Container continues to run and process logic,
but no changes can be made to the Runtime Container. To the Project Container, the disconnected Runtime Container
is seen as a dummy and engineering changes can still be made, no consistency checks are made.
When a Runtime Container is reconnected it is completely restarted. The complete configuration is reloaded from the
Project Container. After the Runtime Container has been reconnected the consistency checks return to normal and
functions are no longer bypassed or overridden.
The procedures for disconnecting and reconnecting a Runtime Container are described below:
These functions are only available for users with suitable user rights.
1. Select the Admin menu, then Runtime Container , then Disconnect Runtime Container from the drop
down menu.
2. A dialog box appears.
3. Select the Runtime Container to be disconnected from the drop down list.
1. Select the Admin menu, then Runtime Container , then Reconnect Runtime Container from the drop
down menu.
2. A dialog box appears.
3. Select the Runtime Container to be reconnected from the drop down list.
Only disconnected Runtime Containers are displayed in the drop down menu.
• A file containing runtime information for new or updated Automation Functions is being imported.
• An SPPA-T3000 upgrade has been performed. After a system upgrade an update of the S7 Execution Frame
is necessary. The procedure described here performs the update online.
The Project View is open. An AF update file has been imported or an SPPA-T3000 system upgrade has been
performed.
1. Select the Admin menu, then Runtime Container , then Activate Updated AFs from the drop down menus.
This step is not necessary if an AF import is being carried out since the Activate Updated AFs
function is automatically started.
2. The dialog box Activate Update AFs appears. This is a list of all Runtime Containers in the system.
If an AF import is being carried out the Contains Imported AFs check boxes will be selected for all the
Runtime Containers which support the AF types being imported.
4. Click on Activate to updated the Runtime Container online, otherwise click on Cancel.
5. The Activate Result box appears.
Click on the Open Protocol button to open a Protocol Report Browser for further information.
6. Click on OK to update the Runtime Container and close the box.
7. After the update the Runtime Container will remain in the list. If the Contains Imported AFs check box was
selected before the update, it will now appear as deselected.
8. Select the next Runtime Container to be updated and then repeat the steps to Activate the updated AFs.
9. When all affected Runtime Containers have been updated click on Close to close the dialog box.
Updates to currently executing AFs become active immediately in the system after the Runtime Container has
been updated. Ensure that any necessary precautions have been taken prior to updating the Runtime
Containers containing the AFs (e.g. informing operating staff of the change, or ensuring relevant controls are
put into manual where required).
The update of a non S7 Runtime Container is also possible by stopping it and afterwards starting it again in
diagnostic view.
Another AF import is only possible, after all of the affected Runtime Containers have been updated.
Committing or Rolling Back all diagrams is not a commonplace activity, and is only performed in special cases.
Sometimes, in exceptional circumstances, a user with the appropriate access rights may have to commit or rollback all
the diagrams in a project. This could occur for example when uncommitted changes exist, but the user who made the
changes is unavailable to activate them.
Committing and rolling back all diagrams works in the same way as discussed in transaction handling, except that:
• The multiuser access measures are overridden, all changes made by all users will be committed or rolled
back.
• Both Function Diagram and Plant Display changes are committed or rolled back.
1. Select the Admin menu, then Commit All from the drop down menu.
2. A dialog box appears to confirm the action. To commit all diagrams click on Yes, otherwise click on No.
1. Select the Admin menu, then Rollback All from the drop down menu.
2. A dialog box appears to confirm the action. To rollback all diagrams click on Yes, otherwise click on No.
1. Select the Admin menu, then Localized Texts, then Export from the drop down menus.
2. The Export Localized Texts dialog box will open.
3. Select a Language from the drop down list. This language is the source language that will be used for
localizing (i.e. the source language that will be localized from).
4. Select a Category from the drop down list, either the:
o System User Interface, or the
o Library.
5. Select the export file in the File Name field. For this, click on the browse button on the right hand side of the
field, a browser will then open for entry of the file name.
6. Click on Export to export the file, otherwise click on Cancel. During the export, the progress is reported in a
dialog box.
An online help for the system can be imported in the same way. This file will have a .jar file extension.
1. Select the Admin menu, then Localized Texts, then Import from the drop down menus.
2. The Import Localized Texts dialog box will open.
3. Select a Language from the drop down list. This language identifies the language for the localized text that is
being imported.
The category of the import file (i.e. System User Interface, Library or online help) is automatically
recognized by the system.
4. Select the import file in the File Name field. For this, click on the browse button on the right hand side, a
browser will then open for entry of the file name.
5. For the system default languages (i.e. English (United States) and German (Germany)), the user has the
option of returning these components to their delivered states (if changes have been made). Tick Reset to
Default and select the system component to be reset from the drop down list.
6. Click on Import to import the file, otherwise click on Cancel.
7. A dialog box reports on the progress of the import.
If the language already exists in the system, the user is given the option of whether or not the old
data will be overwritten.
The file will be imported and the new language becomes available in the system.
1. Select the Admin menu, then Import Temp. Licenses, then Enable service level... from the drop down
menus.
2. The Enable Service Level dialog box will open.
3. Enter the path and name for the license file in the License File field. Alternatively, click on the browse button
(on the right hand side of the License File field) to browse for the file.
4. Select the temporary license file from the browser window.
5. Click on Import to import the file, otherwise click on Cancel.
The license will be imported and the service level information will be available within the system.
1. Select the Admin menu, then Import Temp. License, then Enable Compound Component Access Mode
from the drop down menus.
2. The Compound Component Access Mode dialog appears.
3. Click on the browse button (on the right hand side for the License File field) to find the *.lic file using the
browser.
4. Click on Import to import the license, otherwise click on Cancel.
The access rights of the temporary license will be immediately active for the user.
The import will not be carried out if the CC with the same GUID as the license does not exist or if the CC does
not require a license.
Temporary Compound Component licenses are only available for Siemens service personnel.
1. Select the Admin menu, then Engineering Logs, from the drop down menu.
2. SPPA-T3000 will toggle between archiving engineering changes and non archiving engineering changes.
A tick beside Engineering Logs indicates that tracking of engineering change is enabled.
The user name and a time stamp is recorded with each logged action.
Messages can be sent to plant management, operators or maintenance staff to alert them to important events.
Additionally the messages can be configured to be sent to the Siemens Remote Expert Center for service support.
This section describes the necessary steps to preconfigure the automatic dispatch of alarm notifications. The manual
dispatch of alarm data is described with the ASD.
The Call Home function requires the creation of a Call Home Container in the Administration Console.
1. Select the Admin menu, then Call Home, then Call Home Configurator from the drop down menus.
The Call Home Configurator will not be accessible if the user does not have the appropriate Access
Rights.
If no subscriber groups exist, an error dialog box will appear. In that case, a subscriber group must
first be created.
3. Select the group to configure from the drop down list. This is the subscriber group to be assigned alarms.
4. Click Modify to open the Call Home Configurator.
The Call Home Configurator is now open and displays the current alarm subscriptions. The alarm subscriptions can
be modified (add or remove alarms) and the members of the subscriber group can be modified.
1. Select the node to search using the browse button (on the right hand side of the Selected Node field).
2. If desired, modify the Search Pattern using Tag, Item and Match Case.
Specific Alarm Types may be filtered during the search by selecting the Find Alarms check box.
4. Signals may be added to or removed from the subscriber group by selecting the signal and then clicking the
buttons:
o Add Item
o Remove Item
o Add All
o Remove All
Alternatively, add or remove signals via the context menu (right mouse click > Add Item, etc. ) after
selecting the signal.
Clicking on Configure Subscribers will open the Subscriber Manager dialog box.
1. Subscribers may be added to the subscriber group by selecting the user from the Available Users and then
clicking the button:
o Add user to group when a single user is selected.
Only users with an email address assigned under user administration can be added to a subscription
group.
2. Subscribers may be removed from the subscriber group by selecting the user from the Associated Users
and then clicking the button:
o Remove user from group when a single user is selected.
o Remove all users from group when multiple users are selected.
Alternatively, add or remove users via the context menu (right mouse click > Add User, etc. ) after
selecting the user.
3. When user assignment is complete click Save. Otherwise click Cancel to close the Subscriber Manager
dialog box.
1. Select the Admin menu, then Call Home, then Call Home Group Manager from the drop down menus.
The Call Home Group Manager will not be accessible if the user does not have the appropriate
Access Rights.
Delete Group
The subscriber group is deleted and is removed from the Existing Groups list.
Create Group
The new subscriber group is created and appears in the Existing Groups list.
Configure Subscriber
Rename Group
The subscriber group is renamed and appears in the Existing Groups list.
1. Select the Admin menu, then Call Home, then Send General Data from the drop down menus.
2. The General Data dialog box will open.
3. Click on the browse button (on the right hand side of the To field) to select the recipients.
4. The Receiver Selection dialog box will open.
5. Receivers may be added as email recipients by selecting the user from the Available Users and then clicking
the button:
o Select user when a single user is selected.
Only users with an email address assigned under user administration can be added as an email
recipient.
6. Receivers may be removed as email recipients by selecting the user from the Associated Users and then
clicking the button:
o Remove user from selection when a single user is selected.
o Remove all users from selection when multiple users are selected.
Alternatively, add or remove recipients via the context menu (right mouse click > Select User, etc. )
after selecting the user.
7. Click OK to confirm the selection and close the window. Otherwise click Cancel to cancel without modifying
the recipients.
8. Enter text in the Comments field to accompany the data.
9. Enter an Attachment by typing in the filename, or click on the browse button (on the right hand side of the
field) to find the attachment using a browser.
10. Click Send to send the data. Otherwise click Cancel to cancel without modifying the recipients.
After the SPPA-T3000 Workbench is started, select Applications > Plant Display Hierarchy View. The editor window
for the hierarchy view is opened.
If the window is empty, the Plant Display Hierarchy has not been initialized before or the displays have been deleted.
In that case reset the Plant Display Hierarchy as described in Resetting the Plant Display Hierarchy.
• Select the File menu, then Exit from the drop down menu.
Alternatively the Plant Display Hierarchy View can be closed via the standard window close button.
Modifications to the Plant Display Hierarchy are possible when the Plant Display Hierarchy View is open in
engineering mode. The mode is displayed in the title bar (i.e. (Engineering)).
For editing the Plant Display Hierarchy the following menu items and command buttons are available:
1. File menu:
o Menu item Exit:
For details refer to Exiting the View.
This function can also be selected with the button
2. Edit menu:
o Menu item Delete Single Plant Display.
This function can also be selected with the button
o Menu item Delete Plant Display with all subordinate Plant Displays.
This function can also be selected with the button
3. View menu:
o Menu item Toolbars:
For details refer to Plant Display Hierarchy Toolbar.
4. Extras menu:
o Menu item Find Partial Hierarchy Roots:
For details refer to Find Partial Hierarchy Roots.
This function can also be selected with the button
2.2.1 Toolbar
The Plant Display Hierarchy View has one toolbar available, called the Default Toolbar. This toolbar can be
customized by the user.
1. Select the View menu, then Toolbars from the drop down menu.
2. A further drop down menu appears with the Default Toolbar in the menu.
3. To select or deselect the toolbar, click on it in the drop down menu. When the toolbar is selected it has a tick
next to it in the menu.
• Any user (with the appropriate access rights) can view or edit the Plant Display Hierarchy.
• Should any user make a change to the Plant Display Hierarchy, the views of all users are updated with the
change.
1. The editor window for the hierarchy view is opened and the Plant Displays can be seen.
When the window is empty the Plant Display Hierarchy has not been initialized before or the displays
have been deleted.
In that case reset the Plant Display Hierarchy as described in Resetting the Plant Display Hierarchy.
2. Select a diagram in the Tree View of the hierarchy and remove the diagram with one of the following
commands:
o select the Edit menu, then Delete Single Plant Display from the drop down menu, or
o with the button
Deleting or reorganizing displays in the Plant Displays Hierarchy does not influence the organization of the
Plant Displays that exists in the Project View.
Select a single item, then pressing the CTRL key select more items. OR
Select a single item, then pressing the SHIFT key select another item. Both the items and all the items in
between them will be selected.
1. The editor window for the hierarchy view is opened and the Plant Displays can be seen.
When the window is empty the Plant Display Hierarchy has not been initialized before or the displays
have been deleted.
In that case reset the Plant Display Hierarchy as described in Resetting the Plant Display Hierarchy.
2. Select a diagram in the Tree View of the hierarchy and remove the diagram with one of the following
commands:
o select the Edit menu, then Delete Plant Display with all underlying Plant Displays from the drop
down menu, or
o with the button
Deleting or reorganizing displays in the Plant Displays Hierarchy does not influence the organization of the
Plant Displays, that exists in the Project View.
Select a single item, then pressing the CTRL key select more items. OR
Select a single item, then pressing the SHIFT key select another item. Both the items and all the items in
between them will be selected.
Possible reasons:
• In the editor window for the Plant Display Hierarchy select Edit > Reset Hierarchy. This will create the
structure of the existing Plant Displays according to the Project Hierarchy as displayed in the Project View.
This is the default setting.
•
The reset command is not limited to a certain sub area of the plant. All Plant Displays will be reset. Hence a
very few (probably only one) of the user logins for engineering activities will have the exclusive rights for a
reset of the Plant Display Hierarchy.
Both, the Project View must be opened and the editor window for the Plant Display Hierarchy must be opened in the
Workbench.
• Drag the desired Plant Display from the Project View and drop it at the desired position in the Plant Display
Hierarchy.
If the Plant Display is dragged on top of another display in the Plant Display Hierarchy it will be placed in an
subordinate layer in the hierarchy.
Deleting or reorganizing Plant Displays in the Hierarchy View does not influence the organization of Plant
Displays existing in the Project View.
Select a single item, then pressing the CTRL key select more items. OR
Select a single item, then pressing the SHIFT key select another item. Both the items and all the items in
between them will be selected.
Various situations might require defining a node in the Plant Display Hierarchy as Partial Hierarchy. A possible reason
is the fast access to a Plant Display specific to the operators area of work.
The editor window for the hierarchy view is open and the Plant Displays can be seen.
The partial hierarchies thus created can be viewed in the PDH in operation mode as separate tabs.
To define a node as a Partial Hierarchy Root and/or change the definition of a partial hierarchy proceed as follows:
The editor window for the hierarchy view is open and the Plant Displays can be seen.
1. Select a diagram in the Tree View of the hierarchy to be defined as the root of the partial hierarchy.
2. Select the Edit menu, then Partial Hierarchy Root from the drop down menu.
Alternatively, select the function via the Context Menu (Right Mouse Click > Partial Hierarchy Root
).
In this case, the selected plant display will appear at the first level of its subhierarchy when viewed in
a Partial Hierarchy tab in the operation mode.
o Partial Hierarchy Name: The name of the partial hierarchy that will appear on the partial hierarchy
tab in operation mode (default is the diagram name).
5. Enable the visibility of a defined partial hierarchy in the Visibility section.
Select the Partial Hierarchy Visible in Operation Mode check box to define the visibility of defined partial
hierarchy in operators PDH view.
An operator can also open the Partial Hierarchy Root Definition dialog box and define the visibility
of defined partial hierarchies in the PDH view.
The icon beside the diagram thus defined as Partial Hierarchy Root changes as shown:
To get a list all partial hierarchy roots and find them in the PDH proceed as follows:
The editor window for the Plant Display Hierarchy is open and the Plant Displays can be seen.
1. Select the Extras menu, then Find Partial Hierarchy Roots from the drop down menu.
2. The Find Partial Hierarchy Roots dialog box appears listing all partial hierarchy roots.
3 Diagram Editor
The Diagram Editor is the graphic tool which is used for editing Plant Displays and Function Diagrams. All functionality
required for engineering of the Function Diagrams and Plant Displays is available in the Diagram Editor.
Starting the view and its general layout are discussed. Many users may work simultaneously on a project, this multi
user operation has a certain arrangement. There are a number of diagram functions applicable to Function Diagrams
and Plant Displays, and edit functions for working with symbols in the diagrams.
The methods for working with Function Diagrams and working with Plant Displays are explained. Integrated
engineering is an SPPA-T3000 feature that removes the separation between Function Diagram and Plant Display
engineering and improves the effectiveness and efficiency of the engineering process.
• Select the File menu, then Exit from the drop down menu.
Alternatively the Diagram Editor can be closed via the standard window close button.
If any Plant Displays or Function Diagrams are open when exiting the Diagram Editor, any changes that have
been made are saved automatically (but not committed).
A useful feature of the Diagram Editor is that actions can be carried out in Single and Permanent Mode.
The Diagram Editor has a number of options that can be set by the user.
Diagrams open in the Diagram Editor can be refreshed by pressing the F5 key on the keyboard.
3.2.1 Toolbars
The Diagram Editor has the following toolbars available:
• Standard
• Links
• Alignment
• Graph Layout
• Interactors
• Font: To set the font used for text.
The user can choose which toolbars are to be opened in the Diagram Editor.
• Select the View menu, then Toolbars from the drop down menu. A further drop down menu will appear with
the toolbar options.
o To open a toolbar click on it in the menu. When a toolbar has been opened a tick appears next to it
in the menu.
o To close a toolbar click on it in the menu. The tick will also disappear.
3.2.1.1 Standard
The Standard toolbar contains the icons for:
• Format Painter Copies the common format from a selected object and applies it to the object, which is
clicked on next.
•
4. Deselect the check boxes for the properties which are not to be copied.
5. Click on Copy.
6. Select the object to which the selected properties are to be copied.
• Zoom control.
•
• Printing diagrams.
•
• Object Properties: Opens a dockable window containing the selected object properties.
•
• Preview Activation, Activating and deactivating selected AF Blocks, or a whole Function Diagram.
•
3.2.1.2 Links
Free Graphic symbols may be linked together to form networks. To make these links use the icons on the links toolbar.
These links must not be used to make SPPA-T3000 Connections in Function Diagrams.
The Node creation mode is on the far left of the toolbar, the different types of links are available to the right of this.
3.2.1.3 Alignment
The Alignment Toolbar has the controls for aligning, flipping or rotating symbols:
Align Left: Aligns the selected objects on their left hand side.
Align Horizontal Center: Shifts the objects horizontally so that they are aligned on their vertical median.
Align Right: Aligns the selected objects on their right hand side.
Align Vertical Center: Shifts the objects vertically so that they are aligned on their horizontal median.
Align Grid: Aligns the selected objects with the grid if the grid is set to Active.
Align Connections: Aligns the connection points of the selected objects with one another. These objects have
been connected by a graphic connection.
Distribute Horizontal: Shifts the objects horizontally, positioning them at equal distance from each other.
Distribute Vertical: Shifts the objects vertically, positioning them at equal distance from each other.
The last selected object is used as the reference to Align objects. If the objects have been selected
simultaneously (i.e. by dragging and dropping a lasso), then the position of the outermost object will be the
alignment reference.
3.2.1.5 Interactors
The Interactors Toolbar has icons for:
The Connection Point for objects in Plant Displays can be defined. These objects can be connected using
the Graphic Connection. To add a connection point click on the interactor then select an object. Hold down
the CTRL key and click on the object at the position of the connection point.
Graphic Connection: Creates connections between graphics. Connection is possible from one Connection
Point to another. Right-angles lines are created.
Rotate: To rotate symbols, press and hold on one of the selection handles, and rotate the symbol.
To create a label for normal text. Also used to edit an existing label.
To create a zoomable label for text (i.e. displayed text will resize when the diagram is zoomed). To create
multiline text by clicking into the text after selecting the label for normal text:
To create a zoomable label for text (refer to the description of zoomable label above), with additional text
color and background color features. (Note: This type of zoomable label increases the CPU load. Use
sparingly.)
To create a text on spline. After entering the text press Enter. To manipulate the spline, press and hold the
Left Mouse Button on any selected point and drag the point to the desired position.
To create a line. Click once at start point and once at end point.
To create a polyline. Click once at start point, once at every intermediate point, then double click at the
endpoint.
To create a polyline with an arrow. Click once at start point, once at every intermediate point, then double
click at the endpoint.
To create a polygon. Click once at start corner, once at every intermediate corner, then double click at the
last corner.
To create an outlined polygon. Click once at start corner, once at every intermediate corner, then double
click at the last corner.
To create a spline. Click once at start corner, once at every intermediate corner, then double click at the last
corner.
To create a closed spline. Click once at start corner, once at every intermediate corner, then double click at
the last corner.
To create a filled spline. Click once at start corner, once at every intermediate corner, then double click at the
last corner.
To create a rectangle. Press and hold the Left Mouse Button on the first corner, then drag the box to the
opposite corner and release the mouse button.
To create a filled rectangle. Press and hold the Left Mouse Button on the first corner, then drag the box to
the opposite corner and release the mouse button.
To create a relief rectangle. Press and hold the Left Mouse Button on the first corner, then drag the box to
the opposite corner and release the mouse button.
To create a shadow rectangle. Press and hold the Left Mouse Button on the first corner, then drag the box to
the opposite corner and release the mouse button.
To create a filled round rectangle. Press and hold the Left Mouse Button on the first corner, then drag the
box to the opposite corner and release the mouse button.
To create an ellipse. Press and hold the Left Mouse Button on the first corner, then drag the box to the
opposite corner and release the mouse button.
To create a filled ellipse. Press and hold the Left Mouse Button on the first corner, then drag the box to the
opposite corner and release the mouse button.
To insert an imported image. Click on the icon, then click on the position on diagram for the image. A dialog
will appear. Select one of the images from the drop down list in the dialog.
To create a rectangular scale. Press and hold the Left Mouse Button on the first corner, then drag the box to
the opposite corner and release the mouse button.
To create a circular scale. Press and hold the Left Mouse Button on the first corner, then drag the box to the
opposite corner and release the mouse button.
To create a marker. Click on the position in the diagram for the marker.
To create an arc. Press and hold the Left Mouse Button on the first corner, then drag the box to the opposite
corner and release the mouse button.
To create a filled arc. Press and hold the Left Mouse Button on the first corner, then drag the box to the
opposite corner and release the mouse button.
• Rename
• Edit Links
• Navigate
• Copy
• Paste
• Delete
• Duplicate
• Group
• Ungroup
• View
o Fit to View
o Zoom 200%
o Zoom 50%
o Zoom Original Size
• Align or Distribute
• Flip or Rotate
• Arrange
• Macro
o Move to embedded macro
o Macro from selection
o Macro from diagram
o Compound Component from diagram
o Convert Compound Component to Macro
• Connections
o Convert to Connector
o Convert Connector to Link
o Reroute Connection
• Pictogram
o Exchange Prototype
• Help
Single Mode
For single mode select the symbol or icon with a single mouse click. The function can then be carried out once.
Permanent Mode
For permanent mode select the symbol or icon with a double mouse click, a red Frame then appears around the item
(indicating permanent mode). The function can then be carried out successively. For each successive repetition of the
function it is not necessary to reselect it.
To deselect permanent mode click again on the item and the red border will disappear, or select another function or
icon. Alternatively click on the Select icon on the toolbar:
3.2.4 Options
The Diagram Editor has a number of options available that may be set by the user. The settings are user specific and
are stored for each user individually.
1. Select the Tools menu, then Options from the drop down menu.
2. The Options dialog box will appear.
Edit
• Aspect Ratio of rectangular interactors: Sets the aspect ratio of interactors that draw rectangular shapes.
This is the ratio between the height and the width of the rectangle shape.
• Editors background same as windows desktop: The background color of the Work Area of the Diagram
Editor will be set to the background color used for the computers Windows operating system.
• Editors background color if opaque: The background color of the Work Area of the Diagram Editor can be
manually set here, if the above option has not been used (i.e. the same as Windows).
• Opaque Move/Ghost Move on all views: Controls the appearance of symbols when they are being moved.
The whole symbol can be seen when it is being moved, otherwise only a frame representing the symbol is
displayed.
• Keeping aspect ratio on all views: The ratio between the height and width of objects in a diagram is
maintained when zooming.
• Anti aliasing on all views: Utilizes high resolution to give rounded symbols a smoother appearance.
• Coordinate tracker on all views: The coordinates of the cursor are shown at the left hand bottom of the
Diagram Editor.
Fit to view after load: The diagram is zoomed when opening diagrams, all symbols in the diagram (or the frame) will
be displayed.
Graph Layout
Use progress bar: A bar at the left hand bottom of the Diagram Editor, will indicate the progress when graph layouts
are drawn by the system.
Use multithreading: Ensures that the overall computer load is minimized when graph layouts are drawn by the
system.
3.2.5 Window
The Diagram Editor has window functions available to help arrange the diagrams open in the editor.
Select Next
Click on Select Next to page between open diagrams. Each diagram that is selected will appear on top of the others.
Select directly
Any opened diagram can be selected by its name. The selected diagram will appear on top of the others.
Arrange
1. Select the Window menu, then Arrange from the drop down menu.
2. The Arrange Windows dialog box appears.
Proceed as follows:
The toolbar settings, and the relative sizes of the Library and Work Area, are saved. The Property Sheet and
Reference list will also reopen if they were included in the saved view.
The next time the user logs in, the same settings as saved in the previous session are available.
It is possible to open and view any Function Diagram or Plant Display in the configuration mode in the Diagram Editor.
Should the user wish to make changes to diagrams this access is controlled, and is different for Function Diagrams
and Plant Displays.
Different users may make changes to the same Function Diagram at the same time, as long as they do not try to make
changes to the same symbol in the diagram.
• When a user makes a change, the item the user has changed becomes locked. When an item is locked only
the user who has made the change can make further changes to that item.
• Changes are locked at a module level. This means that if changes are made to an AF Block, or if an AF Block
has been placed, only that AF Block will be locked. All other unlocked AF Blocks in the same diagram can be
accessed and changed by other users.
• When a user commits changes, all locks on the changes are removed and any other user can again access
the items and change them.
When a Function Diagram is changed by different users, the diagram is not updated automatically for all users. In this
case the diagram has to be refreshed to view any changes by other users.
Diagrams open in the Diagram Editor can be refreshed by pressing the F5 key on the keyboard.
Only one user at a time may make changes to any particular Plant Display.
• When a user makes a change the complete diagram becomes locked. No other user can then make changes
in the same diagram.
• When a user commits changes, the lock on the diagram is removed and other users can make changes in the
diagram.
In the Diagram Editor any open diagram can be singly printed out. In the Project View, batch printing of diagrams can
be done.
The Page Setup provides the settings for the printer, Function Diagram page formats and special print options. The
procedure for printing hard copy is described, as well as a feature for producing image files.
1. Select the File menu, then Page Setup from the drop down menu.
2. The Page Setup dialog box will appear, with a sheet each for Printing Page, Drawing Page and Special
Print Options.
3. Select the sheet and make any changes required.
4. Click on Save to make the changes, otherwise click on Cancel.
• The Paper Size can be selected from the drop down list. This will be the size of the paper that the diagram is
printed out on.
• The Paper Orientation (either portrait or landscape) can be selected. This will be the printed out orientation.
• There is a Setup button that can be clicked on which will bring up a dialog box for further print setup settings.
The contents of this dialog box are specific to the printer and the printer driver software.
To transform a Function Diagram in the Diagram Editor into a printed hard copy the following method is used:
• The diagram is divided into a number of pages, and the pages are automatically numbered.
• Allowance is made for the title block and margins in the printout. Each page then has an available logic area
i.e. an area that can be used to print Function Diagram contents.
• In the Diagram Editor the available logic area for each page is represented by a frame. The user can see
which logic will appear on each page of the printed hard copy, and also ensure that no blocks are placed over
a page border.
• Where connections between pages occur, an internal connector is automatically created in the printed hard
copy. A special area is reserved for internal connectors in the printed pages.
• The size and number of pages (number of available logic areas) for a diagram can be set by the user. If the
amount of logic in a diagram increases or decreases the number of pages can then be set accordingly.
The access right for Printer Administration is required for most Function Diagram Page Setup settings. This is
to keep the setup consistent throughout the project.
The following settings can be made on the Drawing Page sheet for the function diagram page setup:
• Page Size: Either a predefined size from the drop down list, or a custom size can be entered.
• Page Orientation: A portrait or landscape orientation can be selected.
• Margins: The size of the page margins can be entered.
• Connector Margins: The size of the margin in which the automatically generated internal connectors will
appear, can be set.
• Title Block Height: The height of the title block in the printed hard copy.
• Page Numbers: The amount of pages required for the diagram can be set here. The pages occur in a grid,
the number of horizontal and vertical pages in the grid can be set.
The Page Numbers are also used for Plant Displays. For Plant Displays the frame is used, not virtual pages
as for Function Diagrams.
Horizontal: 50
Vertical: 1000
If an imported diagram exceeds these limits, the symbols and contents contained in the diagram are
automatically shifted to reduce the amount of pages.
are identical to those explained for Connector Information, except that they apply for printed out connectors.
There is also an option Activate where all the settings can be switched either on or off.
Any AF Block Information visible in the diagram will also be printed out in the diagram.
If the lines in the diagrams are not printing out well, then check the link width.
A diagram is open in the Diagram Editor (if more than one diagram is open, select the diagram to be printed, by
clicking on it).
1. Select the File menu, then from the drop down menu either:
o Print: To print out all or selected pages of the diagram.
o Print in one page: To print out all the pages in the diagram on one sheet.
2. A dialog box will open giving the printer options, and the commands for printing.
Printing PDF
If an Adobe PDF printer has been added on the users Thin Client then diagrams can be printed to *.pdf files. Printing
to *.pdf files requires several Adobe PDF Printer settings.
When a *.pdf is printed the file name corresponds to the diagram name of the diagram that is being printed.
The performance of the Workbench may deteriorate momentarily during PDF printing.
1. Create a folder on the Thin Client. The *.pdf files that are created will be saved here.
2. Set the Adobe PDF printer proprieties with the following settings:
Type of Setting Required Setting
Adobe PDF Conversion Deselect settings to
Settings View Adobe PDF Results
and
Prompt for Adobe PDF filename
Ports Add an Adobe PDF port and select the folder, created in Step 1, where the .pdf files will
be written to.
Ensure that this newly created port has been selected as the port that the Adobe PDF
printer will write to.
The next time the user selects to Print to the Adobe PDF printer, a .pdf file will be created in the selected folder on the
Thin Client.
A diagram is open in the Diagram Editor (if more than one diagram is open, select the diagram to be printed, by
clicking on it).
1. Select the File menu, then Print to Image from the drop down menu.
2. A dialog box will appear.
The tag browser is used in the Diagram Editor to locate AF Blocks when assigning process connections on Plant
Displays, ports individually to faceplates, and ports individually to pictograms. Here is an example of the tag browser,
with the search results to locate AF Blocks:
The tag browser is used to locate signals to assign in Trend Displays, in XY Displays, in Point Groups, in Report
Definitions and as report trigger events. Here is an example of a tag browser with the search results, to locate signals:
The tag browser is used to locate Point Groups to assign in Report Definitions. Here is an example of a tag browser
with the search results, to locate Point Groups:
A universal explanation on how to use the tag browser is given here. There are check boxes and fields that appear in
some tag browsers but not in others. Their appearance is dependent on the application for which the browser is being
used. All possible check boxes and fields are described here.
1. The opened dialog box displays the project structure as a tree view. Select the node in the tree or a single
function diagram where the AF Block , signal or Point Group is located. The selection will be displayed in the
Search Node field.
2. Enter a search pattern for the tag in the Search Pattern field, or leave it as the pre-set asterisk.
o Container Ports : Tick this check box to enable the selection of a container port as a signal. Select
a container from the drop down list. Enter a search pattern in the Search Pattern field as additional search
criteria.
o AF Type: This field shows the type of AF Block that appear in the search results. The displayed AF
type corresponds to the Pictogram being parameterized and cannot be changed by the user.
o Type: This criteria shows the type of tag being searched for. It corresponds to the application for
which the tag browser is being used. It cannot be changed by the user.
7. After selecting the tag the user has the following options:
o Click on Ok to simultaneously assign the tag and close the browser.
o Click on Apply to select the tag and keep the browser open.
o Click on Cancel to abort the selection and close the browser.
Alternatively, double clicking on the selected tag in the list will simultaneously assign the tag and
close the browser.
Alternatively, close the diagram with the standard window close button.
The Library is arranged in a tree with the different libraries as Nodes in the tree. Libraries exist in the tree for:
• Automation Functions
• Macros
• Hardware Proxies
• Prototypes
Each library can again be subdivided into Nodes. New Nodes can be created with the create Library Node, and Nodes
can be renamed or deleted as with Project Nodes.
Should the Library be closed via the standard window close button, the Library can then be reopened with this
function. To open the Library in the Diagram Editor proceed as follows:
• Select the File menu, then Open Library from the drop down menu.
The Library will open and dock on the left hand side of the Work Area.
3.4.5 Zoom
The zoom functions allow the user to control the magnification of a selected diagram in the Diagram Editor. When
zooming in the objects in the diagram will appear larger, when zooming out they will appear smaller.
The zoom control functions are available in the View menu of the Diagram Editor, or directly on the toolbar.
Fit to View
Select the View menu, then Fit to View from the drop down menu. Alternatively click on the icon on the toolbar:
The diagram is zoomed to a size where every symbol in the diagram is shown. The outermost symbols will be at the
edges of the diagram window. The diagram may appear distorted in this mode.
Zoom by 200%
Select the View menu, then Zoom by 200% from the drop down menu. Alternatively via the context menu (Right
Mouse Click > View > Zoom 200%), or click on the icon on the toolbar:
Zoom by 50%
Select the View menu, then Zoom by 50% from the drop down menu. Alternatively via the context menu (Right Mouse
Click > View > Zoom 50%), or click on the icon on the toolbar:
Select the View menu, then Zoom Original Size from the drop down menu. Alternatively click on the icon on the
toolbar, or via the context menu (Right Mouse Click > View > Zoom):
Zoom in Rectangle
Using the cursor, drag a rectangle around the area to be zoomed in the diagram.
1. Select the View menu, then Pan and Zoom from the drop down menu.
2. A window appears for the Pan and Zoom function. This window can be resized and can also be docked
3. The Pan and Zoom window shows the complete drawing, all symbols in the drawing are shown in the
window. The Frame within the drawing with the four handles (one on each corner) shows the contents of the
diagram in the window in the Work Area. If the diagram window is resized, the Frame is also automatically
resized.
4. To Pan the diagram: the Frame must be moved within the Pan and Zoom window.
o Click in the Pan and Zoom window anywhere outside the Frame. The Frame will be moved, the
cursor position will be the midpoint of the Frame in its new position. OR
o Press and hold the mouse button with the cursor anywhere within the Frame. The Frame will then be
dragged with the cursor as it is being moved within the Pan and Zoom window. Release the mouse button
when the Frame is at the desired position.
5. To Zoom the diagram: the Frame must be resized within the Pan and Zoom window. Press and hold the
mouse button with the cursor on any of the handles of the Frame. By dragging the handle the Frame can be
resized. Release the mouse button when the Frame is at the desired size.
The Pan and Zoom window can be closed via the windows close button, or will close automatically if no diagram is
open.
1. Press and hold the middle mouse button. This activates a square magnifying area.
pressing on the ALT key, then pressing and holding the left mouse button or,
pressing the CTRL key then pressing and holding the middle mouse button to activate a round
magnifying glass or,
pressing on the CTRL and ALT keys, then pressing and holding the left mouse button to activate a
round magnifying glass.
2. Drag the mouse cursor over the objects that require magnification.
The magnifying glass utility is also available in Operation Mode and the Prototype Editor.
The grid is represented with small dots in the diagram. From these dots the vertical and horizontal spacing of the grid
can be seen. When placing or moving symbols in the diagram the symbol will align itself with the grid; no intermediate
position between the grid lines is possible.
In Function Diagrams the size and shape of symbols is dependent on the grid. If the horizontal or vertical grid spacing
is changed, then the symbols (which are aligned with the grid) will change accordingly. The size and shape of symbols
in Plant Displays are not affected by the grid.
The Grid properties can be viewed by the user. The settings apply to the diagram that is selected in the Diagram
Editor.
1. Select the Tools menu, then Grid from the drop down menu.
2. The grid properties dialog box will now open.
3. Edit the grid properties where required, and click on Ok to effect the changes, otherwise click on Cancel to
ignore any changes.
• Visible: When the Visible box is selected, the small dots in the diagram which indicate the grid can be seen.
When Visible is not selected the dots are invisible, but the grid is still active.
The grid is only visible when the Spacing is not less than 6 or the diagram is zoomed in by 200%.
The default grid of 4x4 for Plant Displays will not be visible in the 1:1-zoom.
Visible grid consumes a lot of client CPU load. The Workbench will then operate slower.
In Operation Mode the grid is not displayed, and cannot be made visible.
• Active: When the Active box is selected, the grid functionality is active. With Active not selected the grid is
not active, symbols can be positioned anywhere in the diagram with no grid alignment.
• Spacing: Edit the Horizontal Spacing and Vertical Spacing to adjust the grid resolution. With smaller
spacing symbols can be positioned at finer intervals. The spacing can only be set for Plant Displays using this
dialog box. For Function Diagrams it is set as a project setting.
• Origin: The Origin X and Origin Y starting point of the grid. The figures are the distance the grid starts from
the left hand top corner of the diagram. The origin settings cannot be edited.
3.4.9 Navigate
Functions are provided to navigate in diagrams. These include:
• Internal to diagrams.
• External to, or between diagrams.
• From Macros.
1. Select the signal to navigate along. Signal links or connectors at either sources or destinations can be
selected.
2. Click the right mouse button to open the context menu, select Navigate from the context menu, then
Source/Destination from the drop down menu.
3. One of the following will occur:
o If the signal has no corresponding source or destination a message will appear.
o If a signal source has been selected that has only one destination, then this destination will be
navigated to immediately. The destination will be selected automatically, if this destination is on another
diagram, the diagram will be opened automatically.
o If neither of the above occur the Select a navigation target dialog box will open. Using the functions
in the dialog box navigation can be made to either a signal source, or to one of the multiple signal
destinations.
o
o
4. The Select a navigation target dialog box consists of the following:
o The signal Source.
o External applications: all signal destinations external to the source diagram.
o Internal applications: all signal destinations internal to the source diagram.
5. To navigate to the source or any of the destinations proceed as follows:
o To navigate to the signal source: Select the source signal by clicking on it.
o To navigate to any of the signal destinations: Select any internal or external destination by clicking
on it.
For Specialized S7 Applications, the directly connected Automation Function Blocks ware listed as
well as the logical communication partner of a connection via Global Resources. The type of the
connection is also listed in the dialog.
6. To navigate to the source or destination click on OK. The source or destination will be selected automatically,
if this is on another diagram, the diagram will be opened automatically. Otherwise click on Cancel.
A diagram is open in the Diagram Editor or open as a Dynamic Function Diagram, with the embedded diagram
contained in it.
1. Select the symbol for the embedded diagram in the Function Diagram.
2. Click the right mouse button to open the context menu, select Navigate from the context menu, then
Embedded Diagram from the drop down menu.
Make a click with the right mouse button to open the context menu, select Navigate from the list, then Up from the
drop down menu.
If no selection is made, the navigation will be performed to the Plant Display that has a diagram
assignment.
2. Click the right mouse button to open the context menu, select Navigate from the context menu, then Plant
Display from the drop down menu.
o If there is no process connection, a message appears.
o If there is a process connection to a single Plant Display, the Plant Display will open. The element to
which the process connection is made will be automatically selected.
o If the AF Block or proxy has more than one process connection, the user will be prompted to choose
the required connection from a drop down list. The selected Plant Display will open. The element to which the
process connection is made will be automatically selected.
Navigation to Plant Displays can also be performed from Dynamic Function Diagrams.
Navigation to Dynamic Function Diagrams can also be performed from Pictograms in Plant Displays that are
open in the Operation Mode.
To Navigate from an AF Block in a Function Diagram to the Plant Manual, proceed as follows:
The Plant Manual for the tag will open. If no corresponding Plant Manual document exists for the tag, then the user is
informed with a message.
Navigation to the Plant Manual can also be performed from Dynamic Function Diagrams.
If more than 1 document has been linked, then the user can choose which document to open. If no document has
been linked to the tag, then the user is informed with a message.
Navigation to linked documents can also be performed from Dynamic Function Diagrams.
3.4.9.8 Notes
Users can navigate from any Automation Function to the notepad of the Automation Function
Navigation to the notepad of an AF can also be performed from Dynamic Function Diagrams.
1. Select the View menu, then Buffer Information Window from the drop down menu.
2. The Buffer Information Window will appear. The window can be docked against the side of the editor.
The number of objects, nodes and links contained in the diagram is shown, as well as the manager bounding box. The
manager bounding box is the smallest possible rectangle surrounding the objects in a diagram. The first two numbers
are the values of the x and y axes of the upper left corner of the box, and the last two numbers are its width and height.
When using the Shapes > Arrange menu functions (e.g. Bring Forward), new layers are created automatically
if required.
1. Select the View menu, then Layers Editor from the drop down menu.
2. The Layers Editor dialog box will appear.
3. All the layers existing in the diagram are listed. The layers can be edited as follows:
o Add: Clicking on the Add button adds a layer to the diagram.
o Remove: Clicking on the Remove button removes a selected layer from the diagram.
o Remove Empty: Clicking on the Remove Empty button will remove unused layers from the diagram.
4. When completed close the dialog box by clicking on the window close button.
The find tag function is also available for Dynamic Function Diagrams open in the Workbench.
1. Select the Edit menu, then Find Tag from the drop down menu.
2. The Find Tags in Diagram dialog box will open.
A wildcard search is made by entering an asterisk (*). The asterisk represents any group of
characters. Even if the exact tag name is known the asterisk (*) must be included in the entry.
The find tag function can also be used to find Macros in the Diagram.
A project typically requires many process connections which have to be established and maintained. Using the Find
Open Plant Display Mappings function in the Diagram Editor can locate open connections on a single Plant Display.
Open plant display mappings are mappings which are either non-existent or non-functional, and can have the following
states:
Invalid The mapped AF Block does not exist, or no mapping has been assigned.
Offline The mapped AF Block exists but is not active.
Online The mapped AF Block is active but has been deleted. When the deletion is activated the mapping will
Delete become invalid.
Reserved The Pictogram has been placed in Integrated Engineering mode, but the AF Block has not yet been
placed (i.e. still exists in the reference list).
Connectable A Pictogram has been mapped to an existing AF, but the connection is not closed. This might occur if
the mapped AF was deleted then added again.
To find open Plant Display mappings on a single Plant Display, proceed as follows:
1. Select the View menu, then List Open Mappings from the drop down menu.
2. The Open Mappings window will open above the Plant Display.
Each row in the list in the dialog box contains details about a single open default or special mapping.
3. Click on an item in the list to highlight it's corresponding pictogram on the Plant Display.
4. Click on pictogram on the Plant Display to highlight it's corresponding item in the list.
5. Click on Map to close the process connections of all items with Connectable AF Status.
6. When complete use the standard close button on the Open Mappings window to close it.
To navigate directly to the location of a Function Diagram or Plant Display in the Project View, proceed as follows:
The Project View will appear with the diagram selected in the List View .
• copied
• pasted
• duplicated, or
• deleted
Properties of symbols placed in diagrams can be viewed and edited in the property sheet. Symbols can be hidden and
unhidden.
Symbols in diagrams can be arranged in graphic networks and layouts. There are a number of graphic shape functions
for manipulating symbols in diagrams.
The symbols can be selected individually (single selection), or a number of symbols can be selected at once (multi
selection).
• Single Selection: Place the cursor over the symbol and click the left mouse button.
• Multi Selection: Press the left mouse button and drag the lasso over the symbols to be selected.
Selected symbols are marked with handles. In the example below these are the eight small square blocks around the
AND block.
Alternatively, a multi selection can be made by pressing the CTRL or SHIFT key and selecting additional
symbols with mouse clicks (as for single selections). If a selected symbol is clicked on in this mode, it
becomes deselected.
• Select the Edit menu, then one of the following options from the drop down menu:
o Select All: Every symbol in the diagram is selected.
o Select All Nodes : Every block (e.g. AF Block, Pictogram) in the diagram is selected.
o Select All Links: In Function Diagrams, all signal links will be selected.
The appearance of a symbol that is being moved (Opaque Move or Ghost Move) can be selected via the
Options.
Simultaneously press and hold the SHIFT key to move the symbol in smaller steps.
When the Grid is activated, the symbol will move in steps according to the Grid spacing.
1. Select the symbol. The bounding box of the symbol is represented by handles which are used for resizing the
symbol.
When resizing using a corner handle, simultaneously press the SHIFT key to keep the aspect ratio of
the symbol constant.
Alternatively, select the function via the Context Menu (Right Mouse Click > Copy).
A diagram is open in the Diagram Editor. A selection must be copied into the Paste Buffer before it can be pasted.
The symbols from the Paste Buffer are copied into the diagram in the area of the last mouse click.
AF Blocks and Pictograms are copied and pasted with the same parameters.
Alternatively, select the function via the Context Menu (Right Mouse Click > Paste).
A diagram is open in the Diagram Editor, the symbols to be duplicated are in the diagram.
The selected symbols are copied immediately into the same diagram.
When duplicating, the symbols are NOT copied into the Paste Buffer
Alternatively, select the function via the Context Menu (Right Mouse Click > Duplicate).
4. To delete the symbols click Yes, otherwise to cancel the function click on No.
When activated symbols are deleted they turn to a light gray color, and then disappear when the Function
Diagram has been committed and activated (see Status Indication). Symbols which are not activated
disappear immediately when they are deleted.
Alternatively, select the function with the Del key, or via the context menu (Right Mouse Click > Delete).
Further steps are required for deleting Intelligent Field Devices or S7 Hardware Proxies.
4. The properties can be edited. Some properties cannot be changed directly, but have a button which is clicked
to lead to a further editing box.
The properties of several objects can be changed simultaneously. Select multiple objects, then make the
required change in the property sheet. All the selected objects will then be changed.
Properties can be reset to the initial values, as when the symbol or object was placed in the diagram:
In the left column of the property sheet click on the name of the property with the Right Mouse Button. A
RESET button appears. Then click on the RESET button with the Left Mouse Button.
The symbol will be hidden. When the symbol is hidden it cannot be seen or selected.
• Select the Edit menu, then Show Hidden Objects from the drop down menu.
All hidden symbols in the diagram will now become visible (their visible properties will be set to True).
Graphic Networks
Nodes can be converted back to graphics using the Convert to Graphic function in the Shapes menu.
Graph Layouts
A diagram is open in the Diagram Editor. A graphic network has been created in the diagram.
The selected graphic layout can be edited via the Layout Parameters.
A detailed description of the Hyperlink Layout Graph Layout can be found in the description for Connection
Routing.
To access the graphic shape functions, select the Shapes menu, then the required function from the drop down
menus.
Align or Distribute
To automatically align or distribute selected symbols. See the alignment toolbar for a description of each function.
Flip or Rotate
To flip or rotate selected symbols. See the alignment toolbar for a description of each function.
Arrange
To arrange the order of overlapping symbols by manipulating the layer of the symbol/s. Move selected symbols
completely to the top or bottom layer select Bring to Front or Send to Back. To move selected objects a single layer
up or down, select Bring Forward or Send Backward.
When using the Arrange functions, new layers will be automatically created where required.
Editing Shapes
To manipulate free graphic symbols, a union, intersection or subtraction of selected symbols can be made, or symbols
can be flattened. Zoomable labels can be converted to graphical shapes.
To group a selection of symbols together, or to ungroup them to their constituent symbols. Symbols can be grouped in
2 ways:
• Group Set: Is the simpler of the 2 options. The symbols are grouped and can also be used in Function
Diagrams.
• Group: With this option the group contains more properties. This allows more manipulation after the symbols
are grouped. The grouped symbol cannot be used in Function Diagrams.
These functions are also available via the Context Menu (Right Mouse Click: Group or UnGroup).
To convert graphic objects to fixed size or transformed handles, or to unwrap the graphic handles.
Graphical Attributes
• Reshapeable / Unreshapeable.
• Moveable / Unmoveable.
Symbols in a Function Diagram must be appropriate to the type of Runtime Container to which the Function
Diagram is assigned. For example, a Management Proxy can only be placed in a Function Diagram that is
assigned to a Management Container.
To select a symbol from the SPPA-T3000 Library and place it in a Function Diagram proceed as follows:
The Function Diagram is open in the Diagram Editor, the SPPA-T3000 Library is open .
1. Select the diagram window of the target diagram for the new symbol.
2. Find the required symbol in the Library . Select the symbol from the SPPA-T3000 Library, with a single mouse
click.
3. Move the cursor to the target Function Diagram. The symbol moves with the cursor over the Function
Diagram.
4. Move the cursor to the desired position in the Function Diagram, and click again.
The symbols can also be selected in permanent mode. A symbol will then be placed in the diagram with every
successive mouse click.
Whenever a mask is saved, the layout of the mask (e.g. size and column width) is also saved, and
becomes the default setting for the mask layout when it is reopened.
When AF Blocks and Proxies are created, the symbol properties and parameters are also automatically set.
Depending on the application of the logic, the user may wish to edit these. This chapter provides information on how
these parameters are created, and how to set them manually.
The Symbol Properties are set in the Properties sheet of the mask.
• Symbol Type: The type of Automation Function. This field is grayed out (the user cannot change it) and is set
automatically.
• Type Id: An internal ID number for the symbol type. This field is grayed out (the user cannot change it) and is
set automatically.
• Tag Name: The Tag Name is inherited directly from the diagram name when the symbol is placed, but can be
edited by the user. Any changes to the diagram name will also be inherited, except in cases where the Tag
Name has already been manually changed by a user.
The inheritance of the new name may result in the renaming of signals. In this case, a message appears, and
the user can confirm whether or not the signals should also be renamed.
• Tag Item: A number assigned by the system, but can be edited by the user.
• Instance Id: An internal ID number for the instantiated AF. This field is grayed out (the user cannot change it)
and is set automatically.
• Designation: The designation is inherited from the diagram designation when the symbol is placed, but can
be edited by the user. Any changes to the diagram designation will also be inherited, except in cases where
the designation has already been manually changed by a user.
• Comment: Free for editing.
The combination of Tag Name and Tag Item (called the symbol tag) must be unique. If the user attempts to
enter a duplicate, the system will automatically reassign it uniquely.
The Tag Name and Tag Item can also be edited with the Rename function.
The parameters sheet displays all the input and output ports which are accessible to the user. The parameters may be
distributed over more than one sheet (e.g. Parameter Set 1 .. Parameter Set 3).
Some parameters in the parameter sheet may be involved in inheritance between symbols.
Since changing parameters may result in the breaking of inheritance or changing parameters in connected
symbols, knowledge of inheritance effects must be understood before making any changes.
The first column Type indicates whether the Port is an input Port I or an output Port O.
The next column shows the Name of this Port as displayed in the symbol of the AF Block.
The column Value >> shows the presetting of a Port. Editable cells can be made more visible by selecting a
background color for these cells in Diagram Styles.
If the data type of a Port is Boolean, the cell will contain a check box. A selected box means TRUE, not selected means
FALSE.
There are ports where theValue is edited using a Port specific dialog. The details of these Port specific dialogs can be
found in the Library description of the AF.
The settings in the Visible Port and Visible Parameter columns determine the visibility of Ports and parameter values
in Function Diagrams.
If a Port is of the data type int or float and is editable, a number can be typed into column Value.
There are Ports that have connections for which the Values can be edited. In this case the connection will override the
entered value if the connection is activated. If the connection is deactivated the entered Value will be read.
The Value >> column can be expanded with a mouse-click, the Parameter Key column then becomes visible. The
Parameter Key is available for all Ports, and can be freely edited by the user. The Parameter Key can be used to
group parameters, and is particularly useful as selection criteria for spreadsheet engineering.
Archive Parameters
The Archive >> column can be expanded with a mouse-click. Additional columns Variation min, Variation max,
Variation Percent and EU will appear as shown in the following picture:
If the Archive >> column is checked the Ports data will be archived.
The Variation Percent is a delta-band, representing a minimum change of the analog data that is needed to trigger a
transfer to the archive. This value is expressed as a percentage of the range between Variation Min and Variation
Max. A typical value is 1%.
Inheritance
the Variation min, Variation max, Variation Percent and EU are inherited from the input ports LL, UL, DB, and EU,
respectively.
Alarm Parameters
The Alarm >> column can be expanded with a mouse-click. Additional columns Alarm Type , Priority, Active Alarm
Text, Deactive Alarm Text, Acknowledge Mode and Suppress Audible Alarm will appear as shown in the following
picture:
The bright cells of the Alarm column can be checked to declare the signal as an alarm.
After the Alarm column has been selected, the expanded columns also become bright for editing.
Whenever the Alarm cell is selected, the Archive cell will be automatically selected by the system. This
ensures that all alarms are archived.
In the column Alarm Type , an Alarm Type for the alarm can be selected.
A Priority can be defined to each alarm, superordinate to the Alarm Type . It can be used to establish a user-
designed alarm hierarchy based on the functional areas of a plant.
The Active Alarm Text and Deactive Alarm Text are displayed in the ASD, depending on the alarm status. The
alarm text can be inherited using standard and user defined inheritance rules as defined in the Project Settings.
If no text is entered for the deactive alarm, then in the ASD the deactive alarm text will be the same as the active alarm
text, but will be enclosed in square brackets. For example, in the ASD:
The Acknowledge Mode is used to select the automatic acknowledgement mode for the alarm. The following options
can be set:
• No automatic acknowledgement
• Automatic acknowledgement of gone alarms
• Automatic acknowledgement of raised alarms
• Automatic acknowledgement of raised and gone alarms
• Manual Operator Response
The Suppress Audible Alarm box can be checked, to prevent the alarm source from initiating an alarm sound.
Signal Parameters
The Signal >> column can be expanded with a mouse-click. Additional columns Tag Name, Signal Item, Signal
Name and Designation will appear as shown in the following picture:
• Tag Name: The Signal Name is inherited directly from the AF Block Tag Name when the signal is defined,
but can be edited by the user. Any changes to the AF Block Tag Name will also be inherited, except in cases
where the signal Tag Name has already been manually changed by a user.
• Signal Item: A number assigned by the system, if one is required to make the signal definition unique. This
number can be edited by the user.
• Signal Name: This is inherited from the port name, but can be edited by the user.
• Designation: Can be freely edited by the user.
This data can be displayed (see Connector Information) and also transferred to the archive.
If editing of the signal definition results in the creation of a new Global Connection, a Source Connector will be
automatically created for the signal.
A dependency may exist between parameters. If one parameter is changed it may be required that other
parameters are automatically changed. In this case, when the parameter sheet is saved, the user will be asked
to confirm these changes.
Alternatively, a function exists to quickly access and edit the Tag Name and Item of the symbol.
Renaming the Tag Name and Item in a Pictogram on a Plant Display, will also rename its
corresponding AF Block or Proxy on the Function Diagram, and vice versa.
2. Click the right mouse button to open the context menu then select Rename from the context menu.
3. A dialog box will open containing the Tag Name and Tag Item of the symbol.
The combination of Tag Name and Tag Item must be unique. If the user attempts to enter a duplicate, the
system will automatically reassign it uniquely.
Multiple AF Blocks and Proxies can be selected and renamed with a common Tag Name. In this case the Tag
Item will remain unchanged to keep the combinations of Tag Names and Tag Items unique.
To restore inheritance and overwrite the existing assignments click on Yes, to retain these existing assignments click
on No, otherwise click on Cancel to cancel the renaming operation and return to the Rename Tag name dialog.
Inheritance of Archive parameters from the input Ports is indicated and modified by the check boxes. The functionality
of the check boxes is shown in the following sequence:
Inheritance active
2. If the user deselects the check box...
Inheritance disabled
3. Modify the text within the field...
Content modified
4. Select the check box again. The modified value is overwritten by the original inherited value...
Inheritance restored
1. The rule for each alarm text can be inherited from the Default Rule setting of the specific block type.
2. The rule for each alarm text can be selected specifically from the list of available rules in a drop down list.
The option to insert free text in the field for the alarm text is always available.
The inheritance of the default rule remains until the default rule inheritance link is broken (see below). Until that occurs,
changes to the default rule setting will be inherited to all existing placed blocks. If this link is broken, then the user may
still select an inheritance rule from the drop down list.
The state of active inheritance of the default rule is indistinguishable from the state of broken default rule inheritance.
If the default rule setting is <No Inheritance>, the field will appear empty:
If the default rule setting is set so that inheritance is enabled the field will display the inherited rule. This cell is grayed
out with the check box selected:
To remove the inheritance link click on the Active Alarm Text field. This will cause the setting to become active and
no longer grayed out:
The default rule inheritance link is still active and the port has been selected to produce an alarm when the condition is
reached.
1. The default rule inheritance link was broken (in this example by deselecting the check box):
2. Then turning inheritance back on by selecting the check box and selecting the same rule from the drop down
list as the default rule:
The difference is that in the second case, the default Rule Inheritance link is broken and will not be updated if the
default rule setting is changed.
Any modification of the Active Alarm Text or Deactive Alarm Text will break the default rule inheritance
specified for the block type.
This change in state is not announced by the system and the result is visually indistinguishable from the active
default rule inheritance.
Instead of relying on the default rule setting, the user may select a inheritance rule independent of the default.
Inheritance of Alarm Text based on rules constructed from the input Ports is indicated and modified by the check
boxes:
To view a list of Plant Displays to which an AF Block has been mapped, proceed as follows:
Alternatively select the function via the context menu (Right Mouse Click > Display Plant Display Mapping ).
• Plant Manual
• Linked Documents
These links are created using a link editor in the Diagram Editor. To open the link editor proceed as follows:
Alternatively, select the function via the context menu (right mouse click > Edit Links).
• Local Connections: Connections made between symbols on the same Function Diagram.
• Global Connections: Connections made between symbols on different Function Diagrams.
These are made with SPPA-T3000 Connections. Two tools are available to make Local SPPA-T3000 Connections:
• Graphical Interactor
• Click Interactor
Symbols may only be connected using the graphic and click interactors. The links available on the links toolbar
may not be used for this purpose.
Inheritance
To ensure the consistency of engineered values between connected symbols, certain parameters are inherited
between connected symbols.
Other Functions
It is also possible to modify or delete local connections. Connections can be made to multiple destinations with local
connections.
A Function Diagram is open in the Diagram Editor, the symbols to be connected have been placed in the diagram.
2. Move the cursor over the source block, the Ports available for connection are highlighted.
3. Click on the source Port. A line is connected to the source Port.
4. As the cursor is moved the line moves with it.
5. Move the cursor to the destination block, the Ports available and suitable for connection are highlighted.
6. Click on the destination Port.
Be sure to click inside the symbol when selecting the source or destination Port.
Connections will only be made if the Port types are consistent. It is not possible to connect Ports which have
different signal types (e.g. a binary output Port cannot be connected to an analog input Port).
The Connection (Graphical Interactor) can also be selected in permanent mode, connections can then be
made repeatedly.
A Function Diagram is open in the Diagram Editor, the symbols to be connected have been placed in the diagram.
2. Move the cursor over the source block, the Ports available for connection are highlighted.
3. Click on the source Port, the Port remains highlighted.
4. Move the cursor to the destination block, the Ports available and suitable for connection are highlighted.
5. Click on the destination Port.
Be sure to click inside the symbol when selecting the source or destination Port.
Connections will only be made if the Port types are consistent. It is not possible to connect Ports which have
different signal types.
The Connection (Click Interactor) can also be selected in permanent mode, connections can then be made
repeatedly.
When a connection is created the system automatically routes the connection (i.e. decides the path the connector link
follows between source and destination). In some cases the user may wish to modify this routing, this can be done as
follows:
1. Select the connection to be modified. Note the small squares or handles on the connection.
2. Click on a handle and drag it to its new position.
Select the connection, then select the re-routing function from the context menu (Right Mouse Click > Reroute
Connection).
A Function Diagram is open in the Diagram Editor, the connection to be deleted exists.
1. If only part of a multiple connection is to be deleted, then click on the section to be deleted.
2. The color of the section to be deleted will change to green.
3. Select the Edit menu, then Delete from the drop down menu.
4. A dialog box appears to confirm the delete function.
5. To delete the connection click on Yes, otherwise click on No to cancel the function.
Alternatively, select the function with the Del key, or via the context menu (Right Mouse Click > Delete).
To do this simply make further connections in the same way as the first connection was made (i.e. click on the source
Port, then the destination Port when making the connection).
For a description of the components of Global Connections i.e. connectors, signal definitions and how the connections
are made see Signal Connectors, Signal Definitions and Connections
It is possible to make Direct Connections between diagrams, or the Source Connector and Destination Connector can
be created independently.
Inheritance
To ensure the consistency of engineered values between connected symbols, certain parameters are inherited
between connected symbols.
Other Functions
Connectors can be edited, modified or deleted. Multiple signal destinations can be connected with global connectors.
There is a function to automatically convert local connections to global connections.
Signal Connectors
In the example below a Global Connection has been made between two Function Diagrams. The Source Connector is
connected to the signal source, and the Destination Connector is connected to the signal destination. The Connectors
contain information about the signal.
It is possible to connect one Source Connector to many Destination Connectors. A Destination Connector can only be
connected to one Source Connector.
A signal definition can be created for output Ports of AF Blocks, proxies and Macros in Function Diagrams in the
Diagram Editor. The signal definition uniquely identifies the signal. When creating Source Connectors the signal
definition and signal settings are assigned automatically according to the connected Port of the source symbol.
• Tag Name
• Signal Item
• Signal Name
• Designation
• Upper and Lower Limits (for analog signals)
• Unit (for analog signals)
• Setting (for binary signals)
The signal definition and signal settings can be edited at either the source connector or the source symbol parameter
mask.
A connection is established between a Source Connector and a Destination Connector when the signal definition of
the source signal is entered in the Destination Connector.
With direct Global Connections the source and destination connectors are created and connected automatically.
When the source connectors and destination connectors are made independently, the connectors can be edited by the
user to close the connection.
In the Diagram Editor the connection state is indicated by the connector color.
The source and destination Function Diagrams are open in the Diagram Editor, the symbols to be connected have
been placed in the diagrams.
3. Move the cursor over the source block, the Ports available for connection are highlighted.
4. Click on the source Port. The selected Port is highlighted.
2. In the Destination Diagram :
1. Select the window of the destination diagram.
2. Move the cursor to the destination block, the Ports available and suitable for connection are
highlighted.
3. Click on the destination Port.
When selecting the source or destination Port, click inside the symbol.
The Connection (Click Interactor) can also be selected in permanent mode, connections can then be made
repeatedly.
The Function Diagram is open in the Diagram Editor, the symbol for the signal source has been placed in the diagram.
2. Move the cursor over the source block, the Ports available for connection are highlighted.
3. Click on the source Port. The selected Port is highlighted.
4. Move the cursor over the diagram, a block indicating the outline of a Source Connector moves with the
cursor.
5. Click the mouse button when the Source Connector is satisfactorily positioned.
The Connection (Click Interactor) can also be selected in permanent mode, connections can then be made
repeatedly.
When Source and Destination Connectors are created independently, Global Connections can be made
between symbols in the same Function Diagram.
The Function Diagram is open in the Diagram Editor, the symbol for the signal destination has been placed in the
diagram.
2. Move the cursor over the destination block, the Ports available for connection are highlighted.
3. Click on the destination Port. The selected Port is highlighted.
4. Move the cursor over the diagram, a block indicating the outline of a Destination Connector moves with the
cursor.
5. Click the mouse button when the Destination Connector is satisfactorily positioned.
The signal definition is empty when the Destination Connector is created, this can be edited.
The Connection (Click Interactor) can also be selected in permanent mode, connections can then be made
repeatedly.
When Source and Destination Connectors are created independently, Global Connections can be made on the
same Function Diagram.
• Source Connectors: This involves changing the signal definition or signal settings.
• Destination Connectors: Making or breaking connections can be done manually or automatically using the
signal browser function.
o
o A binary signal
When a field in the signal Source Connector is edited, the corresponding field in the source symbol is
also changed.
4. If the signal is connected (i.e. if a corresponding Destination Connector exists) the following conditions apply:
o If a field in the signal definition (Tag Name, Signal Item or Signal Name) is changed, a dialog will
appear to confirm if all the corresponding Destination Connectors should also be changed (i.e. the connection
kept closed).
o If a signal setting (designation, upper or lower limit, unit or setting) is changed, all Destination
Connectors will be updated automatically.
5. If the signal is not connected (i.e. no corresponding Destination Connector exists) any field can be changed
without affecting any Destination Connectors.
6. Click on Save to effect any changes, otherwise click on Cancel.
The section at the bottom of the Edit Source Signal dialog box is for selecting the Connector Information to
be displayed.
o
o A binary signal
o
4. If the signal is connected (i.e. if a corresponding Source Connector exists) the following conditions apply:
o If a field in the signal definition (Tag Name, Signal Item or Signal Name) is changed, the connection
will be opened.
o The signal settings (designation, upper or lower limit, unit or setting) cannot be changed, they are
dependent on the Source Connector.
5. If the signal is not connected (i.e. no corresponding Source Connector exists) any field can be changed
without affecting any Source Connectors.
6. The fields can be edited either manually, or the Signal browser can be used to search for, and connect to an
existing source signal:
1. Click on the browse button to the right of the Tag Name field.
3. Select the Project Node, or diagram to be searched in the left hand Frame in the Signal Browser
dialog box (navigate through the tree if necessary). This Node or diagram will appear in the Search
Node field.
4. Enter a search pattern in the Search Pattern field. This pattern corresponds to the signal Tag
Name. The search pattern can contain an asterisk (*) for wild card searches.
5. Click on Start Search.
6. The signals found in the search are shown in a list at the bottom of the dialog box (if none are found
a message is given).
If a connection is made to a source signal for which no Source Connector exists, then the Source Connector
will be automatically generated.
The section at the bottom of the Edit Source Signal dialog box is for selecting the Connector Information to
be displayed.
A Function Diagram is open in the Diagram Editor, containing a connector that needs modifying.
1. Select the connection between the symbol and the connector. Note the small squares or handles on the
connection.
2. Click and hold with the cursor over the handle at the symbol Port (the cursor will change to a small cross).
3. Drag the cursor to the new Port, then release the mouse button.
4. The connection will be modified.
The connection routing between the Port and the Source or Destination Connector can also be modified.
The connection state is not affected when a Connector is modified. Corresponding source and destination Connectors
will remain connected.
• The signal is removed from the original source symbol (i.e. in the parameter mask the signal is deactivated).
• The signal is automatically assigned to the new Source Port.
A Function Diagram is open in the Diagram Editor, that contains a connector that needs to be deleted.
1. Select the connector symbol to be deleted (the connection line from the symbol to the connector can also be
selected).
2. Select the Edit menu, then Delete from the drop down menu.
3. A dialog box appears to confirm the delete function.
4. To delete the connector click Yes, otherwise to cancel the function click on No.
Connected Source When a connected Source Connector is deleted, the signal is also removed from the
Connector source symbol (i.e. in the parameter mask the signal is deactivated).
Unconnected Source When an unconnected Source Connector is deleted, the signal is not removed from
Connector the source symbol (i.e. in the parameter mask the signal remains defined).
If this signal is defined as an Alarm Source, or is archived, the user may decide if the
signal is deleted or not.
Alternatively, select delete with the Del key, or via the context menu (Right Mouse Click > Delete).
To do this simply make further connections in the same way as the first connection was made (i.e. click on the source
Port, then the destination Port when making the connection).
Connections can only be made to AF Ports, not to existing connection lines or to signal connectors.
Functions are provided to convert connections within a single Function Diagram between these two types of
connection.
Convert to Connector
2. Select the Edit menu, then Convert to Connector from the drop down menu.
3. The connection will be converted to a connection with a Source Connector and a Destination Connector.
A diagram is open in the Diagram Editor. A connection with a Source Connector and Destination Connector exists.
2. Select the Edit menu, then Convert Connector to link from the drop down menu.
3. The connection will be changed to a link type connection.
The Function Diagram for the Macro or Compound Component is open in the Diagram Editor.
2. Move the cursor over the AF Block from which the Port Reference is to be made and the Ports available for
connection are highlighted.
3. Click on the Port to which the Port Reference is required.
4. A Port Reference will appear connected to the Port. Drag the connector to the desired position.
The Port Reference that is created will automatically have a Port Definition assigned to it. The Port Definitions can be
edited in Macros and Compound Components if required.
In a Macro it is possible to connect the same Port Reference to multiple input ports. When the same Port
Reference is used for more than one input Port, the respective Values of the Ports must be equal. This is
necessary so that the system can set the Value for the Macro Port.
The Port Reference icon can also be selected in permanent mode, from which connections can then be made
repeatedly.
• how to enable and disable the connection routing function for individual Function Diagram and for individual
connections on a Function Diagram.
• how to arrange the AF Blocks on a Function Diagram to optimize the results of the connection routing
function.
• the Layout Parameters that can be edited for connection routing function.
To enable or disable the automatic execution of the connection routing algorithm, on individual diagrams, proceed as
follows:
1. Select the Tools menu, then Graph Layout , then Hyperlink Layout from the drop down menus.
2. Select the Tools menu, then Graph Layout, then Parameters from the drop down menus.
To manually initiate the connection routing algorithm, on individual diagrams, proceed as follows:
1. Select the Tools menu, then Graph Layout , then Hyperlink Layout from the drop down menu.
2. Select the Tools menu, then Graph Layout, then Perform Layout from the drop down menus.
A manual initiation of the algorithm can be done when autoLayout is set to either True or False.
When a connection is manually modified in a Function Diagram, the connection will not be recalculated on subsequent
executions of the routing algorithm.
To optimize the results of the connection routing function, AF Blocks should be arranged on a diagram according to the
Column Layout. If the routing algorithm can clearly identify regions on the Function Diagram with the column layout,
the algorithm can more effectively minimize overlapping lines, crossing lines, and lines crossing over other AF Blocks.
The layout options are described below:
Follow the guidelines below as much as possible to create the column layout:
• Arrange the AF Blocks in identifiable columns with sufficient space between each column. The column does
not have to be only one AF block wide. A column may be several AF Blocks wide.
• Horizontally stagger the AF Blocks between columns.
• Connections should be made between columns and not within columns.
• At least one horizontal area of free space should be provided.
By default, the connection routing algorithm will consider separate rows of pages of the Function Diagram to be
separate regions. It will try to locate a single column layout in each region. The algorithm performs separate routing
calculations for each region.
The algorithm's objectives can sometimes be easier to achieve if the algorithm identifies multiple column layouts on a
single page. The algorithm will be able to create multiple regions on a page if large empty horizontal areas exists within
the page that separate multiple column formats. Or if the minAdditionalBordersPerPage layout parameter is set to a
number greater than 0.
Layouts to Avoid
Less than optimal connection routing may result from the following AF Block arrangements:
• Not enough horizontal staggering if the blocks are placed relatively close together:
• Not creating distinguishable columns. The algorithm will identify the blocks as being in one large column:
•
The Hyperlink Layout of the Graph Layout routes connections between AF Blocks. When this Graph Layout is
performed the connection routing algorithm is executed.
Parameters can be modified on the Graph Layout Parameter dialog which influences the way in which the connections
are calculated by the routing algorithm. The default settings are shown below:
The default parameter settings will be sufficient for relatively uncomplicated Function Diagrams.
• checkBordersEnabled: True enables the algorithm to create a region that overlaps two pages, if an AF has
been placed on a page border.
• eliminateOverlapsEnabled: True enables the algorithm to minimize crossing and overlapping of connection
lines.
• eliminateStairCasesEnabled: True enables the algorithm to minimize connections being drawn in a form
resembling a staircase.
• eliminateUShapedEnabled: True enables the algorithm to minimize connections being drawn in a form
resembling a U.
• gridEnabled: True enables the algorithm draws connections on the routing grid.
• horizontalGridBase: The value determines how far the routing grid is horizontally shifted from the diagram
grid.
• horizontalGridOffset: The value determines the horizontal resolution of the routing grid .
• horizontalMinOffset: The value determines the minimum distance between horizontal connections and other
entities on the page (e.g. AF blocks, connection lines).
• maxNumberOfEliminationIterations: The maximum iterations that the eliminateOverlap,
eliminateStaircase, and eliminateUShape algorithms will be performed. A higher value will result closer to
optimum routing layouts, but at the expense of processing time.
• maxSlotSize:This value defines the column width in pixels. A new column will not be detected if the AF
Blocks are arranged in the column of this width or less.
• minAdditionBordersPerPage: This is the minimum number of regions which algorithm has to create on a
single page. Increasing the number of regions may help the algorithm achieve better results.
• parametersUpToDate: This is an internal variable. Leave as default value.
• properCheckEnabled: This is an internal variable. Leave as default value.
• relaxedGridRoutingEnabled: True allows lines to be drawn between points on the routing grid.
• verticalGridBase: This value determines how far the routing grid is vertically shifted from the diagram grid.
• verticalGridOffset: This value determines the vertical resolution of the routing grid.
• verticalMinOffset: The value determines the minimum distance between vertical connections and other
entities on the page (e.g. AF blocks, connection lines).
• Expert check box: This is a standard check box for parameter sheets. It has no function for this parameter
sheet.
Note that the routing grid and the diagram grid are two different grids. The routing algorithm draws
connections along the routing grid. The position and resolution of the routing grid are determined by the
Hyperlink Layout parameters.
To match the routing grid to the diagram grid use the following settings:
horizontalGridBase= 0
verticalGridBase= 0
The inheritance of these parameters is triggered and updated during any of these actions:
Modification of inherited parameters in the destination symbol will break the inheritance.
Once inheritance is broken in the destination symbol, the inheritance is lost until the existing connection is
deleted and a new connection is made.
Inheritance Information
When inheritance of parameters between connected symbols leads to a parameter change, the changes are
previewed in a dialog box:
Connection of Symbols
Modification of Parameter in
Source Symbol
The only scenario where the inheritance described in the dialog box can be canceled is during the modification of
parameter in the source symbol. Otherwise the dialog box is for information purposes only.
The inheritance connection is established by interconnecting symbols that have inheritable parameters. Without having
to connect the upper limit (UL), lower limit (LL), or engineering unit (EU) ports directly, these values are transferred to
the destination symbol automatically:
The inheritance of parameters continues in a chain until the inheritance is interrupted. Symbols connected after the
interruption will not inherit the parameters from the original source:
In the interrupted chain example above, a new inheritance chain begins when symbols that have inheritable
parameters are connected:
When connecting two source symbols to a single destination, all having inheritable parameters, the system checks to
make sure that both source symbols have the same values for their inheritable parameters. If not, the second
connection will not be possible:
The CONV Automation Function acts both a source and destination for inheritance depending on the port
involved.
The value at the output EU_OUT is transferred to symbol connected to its output OUT.
The value at the input EU_IN is inherited from the input IN from connected symbols.
AF Block and connector information can be viewed as text in the Diagram. Information regarding the Status of AF
Blocks and connectors (e.g. if the logic is active), is represented using color. The connection state (i.e. if a connector is
open or closed), is also represented using color.
The visibility of AF Block information is stored individually for each diagram (whenever the diagram is closed).
The same AF Block information is also made available in the Dynamic Function Diagram.
Tag Names
Tag Names are shown at the left hand top side of the AF Blocks (The Tag Name and Item are shown).
This function can also be used for Pictograms in Plant Displays. The Tag Name of the AF Block to which a
Pictogram is mapped will be displayed.
Symbol Comments
Symbol comments are shown at the right hand top side of the AF Blocks.
Parameter Values
Port Information
Cycle Times
Cycle times are shown at the right hand bottom side of the AF Blocks.
Sequence Numbers
The sequence numbers are shown at the left hand bottom side of the AF Blocks. The sequence numbers show the
order in which the logic in a Function Diagram is executed. This may be useful for in-depth analysis of logic where the
execution sequence is critical. If the component has been manually scheduled, it will appear with a red border.
If changes are made to a diagram the sequence numbers will be deselected automatically. This is done because the
sequence numbers will then be re-allocated during transaction handling. For this reason the sequence numbers can
only be made visible after a Function Diagram has been opened.
The execution sequence of Macros is indicated by the first and last sequence numbers of AF Blocks within the
Macro.
1. Select the View menu, then the desired Symbol Information from the drop down menu.
2. The Symbol Information will now appear in the Function Diagrams in the position described above.
• When the menu option has been selected a tick appears on the left hand side of the View drop down menu.
• To make Symbol Information invisible, select the item again from the drop down menu. The tick will also
disappear.
Displaying as Ports
When this option Show Parameters as Ports is selected, an input Port is displayed in the AF Block for each Port
which is:
When the parameters are made visible, they are displayed on the left hand side of the input Port.
Displaying Separately
When this option Show Parameters as Ports is not selected, an input Port is displayed in the AF Block for each Port
which is identified as a visible Port.
• Those of visible Ports are displayed on the left hand side of the input Port.
• Those of visible parameters are listed below the right hand corner of the AF Block.
Parameter values correspond to the status indication colors. If a parameter in an activated AF Block is
changed, the parameter value will change color to black in the diagram. In this way, the user can see that the
parameter has been changed but is not yet activated. When the change is activated, the parameter value will
change color to blue in the diagram.
Each connector always has at least the signal Tag Name and Signal Name visible inside the connector. All other
information is optional and can be selected by the user.
The various components of the signal definition are separated by a tag separator.
Item
The designation and setting are shown on the right hand side. For analog signals the upper and lower limit and the unit
are shown.
• For Source Connectors: All the signal destinations are shown, along with the drawing page number of the
destinations. Destinations on the same diagram are shown in square brackets [.....].
• For Destination Connectors: Only the signal source is shown. The destination connector also contains the
drawing page number of the source connector.
This mode is particularly useful for viewing multiple destinations which are on the same diagram.
The connector information is shown by default as set in the user and project specific styles for connectors.
For individual Function Diagrams the connector information to be shown can be set via the View menu.
• Show All Signal Data: The Designation and Setting, and Source/Destination will be shown.
• Show Signal Settings: The Designation and Setting will be shown.
For individual connectors the connector information to be shown can be set via the connector mask.
Where:
• a is an ID number unique to the connection between two AF blocks in the same diagram.
• b is the page number in the Function Diagram of the source/destination.
The example above shows connection with ID 12, between AF blocks on page 2 and page 1 of the Function Diagram.
The colors used for the status indication can be modified to suit user preference, and are adjustable in the
project and user settings.
All Symbols
Active Symbols
Active symbols, which have been changed are represented with a dark blue color.
New Symbols
New symbols which are added to the logic (e.g. new AF Blocks, new connections), and are not yet activated are
represented with a black color.
Deleted Symbols
Active symbols which have been deleted are represented with a light gray color.
Uncommitted Symbols
• Select the View menu, then Show Uncommitted Modules from the drop down menu.
The uncommitted symbols in the diagram will be represented with a green color.
During this mode the color representation for active symbols will not be in operation.
The uncommitted symbols will only be displayed temporarily, until some other action is carried out in the Diagram
Editor.
S7 Hardware Proxies
The following appearances apply to S7 Hardware Proxies, and inform users about the status of the hardware
configuration.
The following appearances apply to turbine (FM458) and fail safe symbols.
Needs Loading
The state of a connection (i.e. if it is open or closed), is indicated by the color of the connector symbol.
Open Connection :
Closed Connection :
3.6.8 Macros
Macros consist of user developed logic which is grouped together as a single unit and may have signal input and
output. In this way the user can create functions which are represented in Function Diagrams as single blocks which
look the same as, and can be connected in the same way as AF Blocks.
• Reuse of Logic: The same logic can be easily reproduced and used many times.
• Simplicity: Unnecessary details are hidden, making the overall functionality clearer.
There are various options for creating Macros, both the logic and connections to Macros are created. When a Macro
has been created, it can be stored in the SPPA-T3000 Library, and from there placed into diagrams. The logic in a
Macro can be modified or deleted in the same way as any Function Diagram.
Macros are similar to Compound Components. But there are some fundamental differences as to how the two
entities are handled in the system. The user should be aware of these differences to decide whether a Macro
or Compound Component should be used for a specific application.
The logic used to create Macros can consist of AF Blocks or even other Macros i.e. Macros themselves may
contain other Macros.
2. Select the Edit menu, then Macro , then Move to embedded Macro from the drop down menus.
Alternatively, select the function via the Context Menu (Right Mouse Click > Macro , then Move to
embedded Macro ).
3. A dialog box appears. Enter a name for the embedded Macro, then click on OK, otherwise to cancel the
function click on Cancel.
The embedded Macro will now be created, this has the following effects:
• A new Function Diagram is created automatically which contains the logic in the Macro. This diagram opens
automatically in the Diagram Editor. Signals entering and leaving the Macro are made automatically with
Macro Port References.
• The Function Diagram containing the Macro will appear in the Tree View of the Project View. When the
diagram is selected in the Tree View all Macros contained in the diagram appear in the List View.
2. Select the Edit menu, then Macro , then Macro from selection from the drop down menus.
Alternatively, select the function via the Context Menu (Right Mouse Click > Macro , then Macro
from selection).
1. First select the Library Node in which the Macro is to be stored, by clicking on it in the dialog box. A
new Library Node can be created if required.
2. Enter a Macro Name.
The Macro will now be created, this has the following effects:
• The Macro will appear in the SPPA-T3000 Library. The Macro can then be used as often as required in
Function Diagrams.
1. Create the logic for the Macro. Macro Port References are used for signals to and from the Macro.
2. Select the Edit menu, then Macro , then Macro from diagram from the drop down menus.
Alternatively, select the function via the context menu (Right Mouse Click > Macro , then Macro from
diagram).
The Macro will now be created, this has the following effects:
• The Macro is stored in the selected Library Node. The name of the Macro is the same as that of the Function
Diagram
• The Macro is created automatically as a new Function Diagram which contains the logic in the Macro. The
Macro opens automatically in the Diagram Editor.
• The Macro will appear in the SPPA-T3000 Library. The Macro can then be used as often as required in
Function Diagrams.
1. Select the Library Node under which the Macro is to be stored (in either the Tree View or the List View) by
clicking on it.
2. Select the Project menu, then New, then Macro from the drop down menus.
Alternatively, you can select the function via the context menu (Right Mouse Click > Create New
Macro ).
• The Macro which has been created contains no logic. The Macro must be edited in the Diagram Editor to
create the logic.
• The Macro will appear in the SPPA-T3000 Library. The Macro can then be used as often as required in
Function Diagrams.
• A Compound Component on a Function Diagram can be converted. Only the Compound Component on the
Function Diagram will be converted. The Compound Component will still exist in the Library and can still be
placed on Function Diagrams.
• The Compound Component in the Library can be converted. The Compound Component will no longer be
available to place on Function Diagrams.
Alternatively, select the function via the context menu (right mouse click > Macro/Compound
Component > Convert Compound Component to Macro )
The Compound Component will be replaced by a Macro with the same name in the same Library Node. The macro is
represented by the macro symbol:
Any existing instances of the Compound Components on Function Diagrams remain as Compound Component
instances.
• The Port References remain unchanged when a Compound Component is converted to a Macro
• Any Prototype assignments made with the Compound Component are kept in the Macro.
• If the Compound Component logic contained component scheduling, the component scheduling settings will
not exist in the Macro.
When a Compound Component is converted to a Macro the GUID is removed from the Macro. If this Macro is
later converted to a Compound Component a new GUID will be created.
This example shows how Port References are implemented and represented.
The AF Blocks for a Macro have been implemented, but no external connections using Port References have been
made:
The Port References are then connected to the AF Blocks in the Macro. Note that it is possible to use the same Port
Reference more than once for input signals. This is done by editing the Port Definition.
When a Macro has been placed in a diagram, it appears as a block with Port names the same as those of the Port
References.
The Macro is connected in the same way as an AF Block. In the Macro diagram the connection state of the Port
References is indicated by the Port Reference color.
The mask for the Port Definitions appears. All Port References for the Macro are included in the mask in a table (any
Port Reference mask in the Macro can be opened to access the same table).
The Port Definition mask has a different presentation and content depending on whether it was opened from:
• Module Graphic
• Port Type
• Port Graphic
• IO Mapping
Changes can be made in the mask if required, click on Save to accept the changes, otherwise click on Close. Note
that only fields that are not grayed out may be changed by the user.
• Macro Definition
• The Module Graphic, Port Type and Port Graphic sheets. These sheets are the same as for a Macro in a
Function Diagram as described above.
For a Macro in a Library Node, the Port Definition mask opens as a dockable window in the Diagram Editor. Changes
can be made in the mask if required and are accepted immediately. Note that only fields that are not grayed out may
be changed by the user. To close the mask click on the window close button.
Module Graphic
Module Graphic
Module Graphic is one of the sheets in the Port Definition mask. The Module Graphic sheet is used to set the
appearance of the property sheet names and the symbol styles of the Macro.
The user can change the parameter sheet names in the parameter mask of the Macro. To change the parameter sheet
names proceed as follows:
The new parameter sheet name will appear in the parameter mask of the Macro the next time it is opened in a
Function Diagram.
Symbol Appearance
The graphic that appears in Macro symbols, when either the IEC with Icon or the SAMA symbol styles are in use, can
be set here. The following settings are required:
• No Icon: Text will appear, the same as with the IEC without Icon representation.
• Predefined Icon: An existing icon used for an AF supplied with the system.
• Image: Any image in the system.
• Text: Any text entered by the user in the Text field.
• Free Graphic Prototype : A free graphic Prototype.
Select the Alignment from the drop down list, this is the position that the graphic will occupy inside the Macro block:
• Centered
• Top
Select the Icon from the drop down list. This is the individual graphic that will be used. The contents of the drop down
list depend on the Icon Type that was chosen.
Port Type
Port Type
Port Type is one of the sheets in the Port Definition mask. The columns of the Port Type sheet are listed below:
Column Description
Name Name of the Port Reference, appears at the Macro Port when the Macro is placed
as a block in a diagram.
Description Freely assignable, becomes the Port description for the Macro.
Type Input or output signal.
Data Type Signal type e.g. boolean or floating point.
Connectable Is set if the Macro Port can be connected to.
Editable Is set if the default value for the Port can be edited.
Options Is set if the default value for the Port consists of options in a list.
Value The signal default value. Is set equal to the default value for the AF.
Minimum The smallest value Parameter can assume.
Maximum The largest value Parameter can assume.
Alarm Is set equal to the default value for the AF.
Alarm Type Is set equal to the default value for the AF.
Active Alarm Is set equal to the default value for the AF.
Deactive Alarm Is set equal to the default value for the AF.
Archive Is set equal to the default value for the AF.
Variation Min Is set equal to the default value for the AF.
Variation Max Is set equal to the default value for the AF.
EU Is set equal to the default value for the AF.
Id Automatically generated Port Id.
The contents of the Port Type sheet can be sorted in ascending or descending order by clicking on the
column title.
Port Graphic
Port Graphic is one of the sheets of the Port Definition mask. The user sets the appearance of the ports in the Port
Graphic parameter sheet. The columns of the Port Graphic sheet are listed here:
Column Description
Visible Name Name of the Port Reference, appears at the Macro Port when the Macro is placed
as a block in a diagram.
Visible Port To make the Port visible when the Macro is placed as a block in a diagram.
Name Visible To make the name of the Port visible when the Macro is placed as a block in a
diagram.
Alignment Which side of the block the Port appears when the Macro is placed as a block in a
Orientation diagram.
Alignment Order The vertical position of the Port in the block when the Macro is placed as a block in
a diagram.
Register Page Which sheet the Port will appear on in the mask for the Macro block when the
Macro is placed as a block in a diagram.
Register Order The vertical position of the Port in the sheet of the mask for the Macro block when
the Macro is placed as a block in a diagram.
Function Diagram To make the Port visible in the mask for the Macro block when the Macro is placed
View as a block in a diagram.
Plant Display View To make the Port available for Mapping to Faceplates.
Diagnostic View To make the Port available to the Diagnostic View.
Point View Editable To make the Port available for changes in the Point View.
The contents of the Port Graphic sheet can be sorted in ascending or descending order by clicking on the
column title.
Macro Definition
The Macro Definition is one of the sheets in the Port Definition mask. This sheet is used document general
information about the Macro.
Io Mapping is one of the sheets in the Port Definition mask. These settings are used when generating Function
Diagrams with the IO-List View functions. Generated Function Diagrams can contain Macros.
• Category: The Category is used to filter data fields in the IO-List when editing profiles and exporting data.
• SubFunctions: The SubFunctions define how the IO-List data fields are mapped to the input and output
ports of the Macro.
The correspondence between the fields in the Mapping for IoList parameter mask and the IO-List fields are
explained in Macro and Compound Component IoMapping.
1. Select a category in the Category List that best fits the Macro.
2. Click on New to add a new subfunction.
To edit a subfunction select one of the existing Subfunctions in the list. Then click on Edit.
5. Select one of the Macro output ports in the OutPorts drop down list. The signal subfunction will be mapped to
this port.
6. Click on Add in the Data Fields area. A dialog to select a data field from the IO-List will appear.
7. Select one of the Data Fields. The selected data field will appear in the Field list.
8. Click on the data field in the list. Then select the InPort of the Macro. This is the input port to which the data
field will be mapped.
To delete a mapping select an item in the Data Fields list and click on Delete.
Publish the Library each time a change is made to the Io Mapping . The mapping changes will take effect in
the next synchronization.
When a Macro has been assigned to a Prototype, the Prototype properties have to be mapped to the Ports of the
Macro. The Ports of the Macro first have to be prepared before this mapping can be made.
Macros also have to be prepared if the Ports are to be assigned individually to a Pictogram or Faceplate.
Macro Size
Users may place many AF Blocks and proxies in a Macro, all of these having their own input and output Ports. If all of
these Ports were to be made available for the property mapping it would be extremely confusing and difficult to find the
Ports when making the mapping.
For this reason the Ports to be used for property mapping have to be explicitly defined by the user.
When AF Blocks are placed in Macros, they contain All HMI Ports. For some Automation Functions there are Ports
which are defined for HMI, but not I&C. These Ports would not normally be available in Function Diagrams, but in
Macros these Ports are also available.
These HMI Ports also have to be explicitly defined for use in Property Mapping.
In order for a Macro Port to be made available for property mapping, it has to have a Port Reference connected to it.
Only Macros in Library Nodes can be prepared for property mapping. Macros already existing in Function
Diagrams cannot be prepared.
To prepare the Ports contained in a Macro for property mapping, proceed as follows:
The prepared Ports will now become available for assignment in the property mapping of the Macro.
Port References made for Ports defined for HMI only, will not be visible in Macros when they are placed in
Function diagrams.
How to Select a Macro from the Library and Place it in a Function Diagram
The Function Diagram is open in the Diagram Editor, the Library is open .
1. Select the diagram window of the target diagram for the new Macro.
2. Find the required Macro in the Library. Select the Macro from the Library, with a single mouse click.
3. Move the cursor to the target Function Diagram. The Macro moves with the cursor over the Function
Diagram.
4. Move the cursor to the desired position in the Function Diagram, and click again.
5. A dialog box appears, the Macro may be placed either as an embedded Macro, or as a network in the
diagram.
o Click on Yes to place as an embedded Macro. The Macro will then be placed as a single block with
the Macro Name and Port References as defined when the Macro was created.
o Click on No to place as a network. The logic of the Macro will then be placed in the diagram, without
any Port References.
The Macros can also be selected in permanent mode, a Macro will then be placed in the diagram with every
successive mouse click.
When a Macro has been placed in a Function Diagram as an Embedded Macro, it has the following representation in
the Project View:
• In the Tree View : Function Diagrams which contain Macros are shown.
• In the List View : The Macros contained in a selected Function Diagram in the Tree View are shown.
Opening Macros
• Open the diagram in the Configuration Mode by selecting the Macro in the List View of the Project View. This
applies to both Macros stored in a Library Node , or Macros which have been placed in Function Diagrams.
• Navigate to the Macro from a Function Diagram where it has been placed.
A Macro can be viewed in the dynamic mode by selecting a Macro which has been placed in the List View of the
Project View and opening the Macro as a dynamic Function Diagram.
Changing Macros
The logic in a Macro can be changed in the same way as any Function Diagram. Logic can be changed or new Port
References may be added or deleted. The following points should be remembered:
If a Macro stored in the library is changed, the Macros which are subsequently placed will not be the same as
those placed previously.
• If a placed Macro is changed it will differ from the others which have been placed.
Macros can be renamed in the Library, in the same way that diagrams are renamed.
Macros that are placed in diagrams cannot be renamed. Only the Tag Name and Tag Item can be modified. This is
handled in the same way as for renaming AF Blocks and Proxies.
The new name of the Macro will be inherited by the embedded diagram. If the values of blocks or signals within the
embedded diagram have been previously manually modified, the user can confirm whether or not the changes are
overwritten.
Handling of Compound Components is very similar to Automation Function handling for the following functions:
A Compound Component that is placed on a Function Diagram is referred to as an instance. The internal logic of a
Compound Component instance cannot be modified. Only the Compound Component in the Library can be modified.
In this way newer versions of the same Compound Component are created. When a new version is created it is
possible to replace any instances of the Compound Component with the latest version.
Compound Components can be defined with varying levels of access protection. Access protection can be used to
limit the Compound Component use, viewing or editing rights.
Localization is also possible for Compound Component. Text in multiple languages can be included in the Compound
Component definition.
Compound Components are similar to Macros. But there are some fundamental differences in how the two
entities are handled in the system. The user should be aware of these differences to decide whether a Macro
or Compound Component should be used for a specific application.
A new Compound Component that is based on the logic of an exsiting Compound Component can also be
created. The procedure involves first creating a new Compound Component in the Project View.
When a Compound Component is created it is assigned a Global Unique Identifier. This information stays with the
Compound Component when it is placed on a Function diagram, exported and imported.
Features
Restrictions
Preconditions
The following preconditions must be met before a Macro can be converted to a Compound Component:
• The Macro cannot contain other Macros, Compound Components or Hardware Proxies.
• All the users Macros and Compound Components must be committed.
• A single Port Reference cannot be connected to multiple input Ports in the Macro.
The Compound Component name cannot contain any spaces if license protection will be used.
o Unprotected - The Compound Component can be viewed or modified without entering a password.
o Password Protected - A password will be required to view or modify the Compound Component.
6. If Password Protected then the Define Password dialog box will appear.
Enter Password. Then Confirm Password and click on OK. The dialog will close.
Take care to remember the password. The password not retrievable if it is forgotten.
7. Click on OK, otherwise click on Cancel. The Create New Compound Component dialog box will close.
The Macro will be converted to a Compound Component in the same Library Node and is represented by the following
symbol:
Creating the Compound Component in this way has the following effects:
• The Port References remain unchanged when a Macro is converted to a Compound Component
• Any Prototype mappings made with the Macro are kept in the Compound Component.
• Any Alarm and Archive settings of internal AF output ports that did not have Port References will be
deselected.
All Macros and Compound Components of the user must be committed before a new Compound
Component can be created.
2. Select the Project menu, then New, then Compound Component from the drop down menus.
Alternatively, you can select the function via the context menu (Right Mouse Click > Create New
Compound Component ).
Do not uses spaces in the Compound Component name if license protection will be used.
Enter Password. Then Confirm Password and click on OK. The dialog will close.
Take care to remember the password. The password not retrievable if it is forgotten.
7. Click on OK, otherwise click on Cancel. The Create New Compound Component dialog box will close.
A Compound Component will be created in the selected Library Node and is represented with the following symbol:
The Compound Component which has been created contains no logic. The Compound Component must be edited in
the Diagram Editor to create the logic.
A Function Diagram containing a Compound Component has been imported into the Project. To add the Compound
Component to the Library proceed as follows:
All Macros and Compound Components of the user must be committed before a Compound Component can
be created.
3. A Function Diagram containing the Compound Component will open in the Diagram Editor.
4. Select the Edit menu, then Macro/Compound Component, then Compound Component from diagram
from the drop down menus.
5. The Library browser appears.
Alternatively, select the function via the context menu (Right Mouse Click > Macro/Compound
Component, then Compound Component from diagram).
6. Select the Library Node in which the Compound Component is to be stored by clicking on it.
7. Click on Ok, otherwise click on Cancel.
A Compound Component will be added to the Library and is represented with the following symbol:
The imported Compound Component retains the same name and GUID when it is added to the Library.
The user will copy a diagram in the Diagram Editor to create a new Compound Component that is based on the logic
of an existing Compound Component. To copy the logic of a Compound Component proceed as follows:
To copy a Compound Component diagram in the Project View use the Copy and Modify function. A new Compound
Component will be created with the same GUID.
The following example illustrates how a copy of Compound Component can be used as a backup.
1. A new Compound Component with the name CC_A_Rev0 was created and placed on several Function
Diagrams.
2. The user creates a new Compound Component CC_A_Rev1 by copying CC_A_Rev0 in the Project View.
CC_A_Rev0 and CC_A_Rev1 have the same GUID.
3. The user makes some changes to CC_A_Rev1 logic.
4. The user replaces all instances of CC_A_Rev0 with CC_A_Rev1 on all Function Diagrams by selecting to
change all instances of the GUID with CC_A_Rev1 in the Replace Compound Component dialog.
The following example shows how cycle times are calculated when the Compound Component is placed on a Function
Diagram.
The diagram below shows the cycle times settings for the individual AFs in a Compound Component.
In this example the NOT , RS and PULSE have the base cycle times of 100 ms. The ASMON has an cycle time setting
of 400 ms. Expressed in relative terms, the NOT , RS and PULSE AFs are executed every cycle. The ASMON is
executed every 4th cycle.
The diagram below shows the cycle times of the AFs in the same Compound Component when the CC is placed on a
Function Diagram in a Runtime Container with a base cycle time of 1000 ms.
The diagram shows that the relative cycle times of the AFs have been maintained.
• To create connections between Compound Components and other AFs on Function Diagrams where they
have been placed
• For assigning Compound Components to Prototypes
• To enable the setting of Alarm and Archive parameters in the Compound Component mask
Port References are very similar to signal connectors, except they are only used for Compound Components and
Macros.
Creating Port References for Compound Components involves the following tasks:
This example shows how Port References are implemented and represented.
The AF Blocks for a Compound Component have been implemented, but no external connections using Port
References have been made:
The Port References are then connected to the AF Blocks in the Compound Component.
When a Compound Component has been placed in a diagram, it appears as a block with the Port names the same as
those of the Port References.
The Compound Component is connected in the same way as an AF Block. When viewing the contents of the
Compound Component in a Function Diagram, the connection state of the Port References is indicated by the Port
Reference color.
The Port Definition is created automatically when a Port Reference is made, however it may be necessary to change
the definition, for example to rename a Port, or assign password protection.
To edit the Port Definition mask for a Compound Component proceed as follows:
1. Open the mask for any Port Reference in the Compound Component.
Alternatively, right mouse click anywhere on the Function Diagram and select Edit.
3. If the fields in the mask are not editable, click on Unlock on the Compound Component Definition sheet.
4. Edit the properties in the following sheets of the Port Definition dialog:
o Compound Component Definition - To edit the
o Module Graphic
o Port Type
o Port Graphic
o Io Mapping
The Port Definition mask of a Compound Component on a Function Diagram can also be viewed. But none
of the fields will be editable and the Compound Component Definition sheet will not be available.
The mask can be opened in the embedded diagram of a Compound Component that has been placed on a
Function Diagram.
The Compound Component Definition is one of the sheets in the Port Definition mask.
Clicking on the Unlock button will unlock the Compound Component for modification. The fields of the Port Definition
and the Function Diagram will be editable.
Documentation
Version
When a Compound Component is committed a new version will be created. The version number will have the following
structure:
Serial Number . Revision Number
• Serial Number - This number can be edited by the user, but only with values greater than the current value.
• The Revision Number is automatically incremented after a change in the Compound Component has been
committed. The user can overwrite the Revision Number with a number greater than the current Revision
Number. The system will continue incrementing the revision from the entered value on subsequent changes.
To enter a smaller revision number the user must increase the Serial Number.
The version number of a Compound Component in the Library appears in the Library Node Documentation.
The version number of an instance of a Compound Component on a Function Diagram can be viewed in the
Point View.
Protection
Protection - There are different access protection levels available for Compound Components.
• Unprotected - This selection allows the Compound Component to be opened in the Diagram Editor without a
password.
• Password - The selection only allows the Compound Component to be opened in the Diagram Editor after
the correct password has been entered. A password will also be required to view the Compound Component
logic in Dynamic Function Diagrams.
• To password protect the Compound Component proceed as follows:
1. Select Password.
2. Click on Edit. The Define Password dialog box will appear.
3. Enter a Password, and then enter the password again in the Confirm Password field.
• License - Access protection can be based on a specific license that must be installed to use, view or modify
the Compound Component. To select License protection the Compound Component license with write
access must be installed.
Localization
Localized Text is foreign language text for the name, port names, port descriptions and register page names of the
Compound Component.
The port names and port descriptions must first be entered in the Port Type parameter sheet before localized
text can be entered.
5. The left column of the dialog box lists the text in the current Library Language setting. The right column is
language for which localized text will be provided.
6. The user can enter the localized text using the following options:
o Enter the localized text in the right column.
o Click on Copy All to simply copy all the text in the left column to the right column.
o Enter the localized text for some fields, and then click on Copy Missing. The empty fields will be
filled with the text from the left column.
7. Click on Save to save the changes or Cancel.
The Port Reference names and descriptions will switch to the localized text when the Library Language is set to the
local language.
Module Graphic
Module Graphic is one of the sheets in the Port Definition mask. The Module Graphic sheet is used to set the
appearance of the property sheet names and the symbol styles of the Compound Component.
The user can change the sheet names in the parameter mask of the Compound Component. To change the parameter
sheet names proceed as follows:
The new parameter sheet name will appear in the parameter mask of the Compound Component the next time it is
opened in a Function Diagram.
Symbol Appearance
The graphic that appears in Compound Component symbols, when either the IEC with Icon or the SAMA symbol styles
are in use, can be set here. The following settings are required:
Select the Alignment from the drop down list, this is the position that the graphic will occupy inside the Compound
Component block:
• Centered
• Top
Select the Icon from the drop down list. This is the individual graphic that will be used to represent the Compound
Component. The contents of the drop down list depend on the Icon Type that was chosen.
The Scale (%) (or size) of the icon graphic can be adjusted.
Port Type
Port Type is one of the sheets in the Port Definition mask. The user can customize the Compound Component port
names and descriptions in the Port Type sheet. The other parameters are not editable. These settings are determined
by the parameter settings in the individual AFs in the Compound Component. The columns of the parameter sheet are
listed below:
Once a Port name is defined and committed it is not possible to edit the port name again. If a change is
required, then the port must be deleted and created again.
Column Description
Name Name of the Port Reference, appears at the Compound Component Port when the
Compound Component is placed as a block in a diagram.
Description Freely assignable, becomes the Port description for the Compound Component.
Type Input or output signal.
Data Type Signal type e.g. boolean or floating point.
Connectable Is set if the Compound Component Port can be connected to.
Editable Is set if the default value for the Port can be edited.
Options Is set if the default value for the Port consists of options in a list.
Value The signal default value. Is set equal to the set value for the AF.
Minimum The smallest value Parameter can assume.
Maximum The largest value Parameter can assume.
Alarm Is set equal to the set value for the AF.
Alarm Type Is set equal to the set value for the AF.
Active Alarm Is set equal to the set value for the AF.
Deactive Alarm Is set equal to the set value for the AF.
Archive Is set equal to the set value for the AF.
Variation Min Is set equal to the set value for the AF.
Variation Max Is set equal to the set value for the AF.
EU Is set equal to the default value for the AF.
Id Automatically generated Port Id.
Port Graphic
Port Graphic is one of the sheets of the port definition mask. The user sets the appearance of the ports in the Port
Graphic parameter sheet. The columns of the Port Graphic sheet are listed here:
Column Description
Name Name of the Port Reference, appears at the Compound Component Port when the
Compound Component is placed as a block in a diagram.
Visible Port To make the Port visible when the Compound Component is placed as a block in a
diagram.
Visible Name To make the name of the Port visible when the Compound Component is placed as
a block in a diagram.
Alignment The side of the block where the Port appears when the Compound Component is
Orientation placed as a block in a diagram.
Alignment Order The vertical position of the Port in the block when the Compound Component is
placed as a block in a diagram.
Register Page The sheet where the Port will appear on in the mask for the Compound Component
block when the Compound Component is placed as a block in a diagram.
Register Order The vertical position of the Port in the sheet of the mask for the Compound
Component block when the Compound Component is placed as a block in a
diagram.
Function Diagram To make the Port visible in the mask for the Compound Component block when the
View Compound Component is placed as a block in a diagram.
Plant Display View To make the Port available for Mapping to Faceplates.
Diagnostic View To make the Port available to the Diagnostic View
IO Mapping
IO Mapping is one of the sheets in the Port Definition mask. These settings are used when generating Function
Diagrams with the IO-List View functions. Generated Function Diagrams can contain Compound Components.
• Category: The Category is used to filter data fields in the IO-List when editing profiles and exporting data.
• SubFunctions : The SubFunctions define how the IO-List data fields are mapped to the input and output
ports of the Compound Component.
The correspondence between the fields in the Mapping for IoList parameter mask and the IO-List fields are
explained in Macro and Compound Component IoMapping.
To create mappings between the IO List and a Compound Component proceed as follows:
1. Select a category in the Category List that best fits the Compound Component.
2. Click on New to add a new subfunction.
To edit a subfunction select one of the existing Subfunctions in the list. Then click on Edit.
5. Select one of the Compound Component output ports in the OutPorts drop down list. The signal subfunction
will be mapped to this port.
6. Click on Add in the Data Fields area. A dialog to select a data field from the IO-List will appear.
7. Select one of the Data Fields. The selected data field will appear in the Field list.
8. Click on the data field in the list. Then select the InPort of the Compound Component. This is the input port to
which the data field will be mapped.
To delete a mapping select an item in the Data Fields list and click on Delete.
Publish the Library each time a change is made to the Io Mapping . The mapping changes will take effect in
the next synchronization.
When a Compound Component has been assigned to a Prototype, the Prototype properties have to be mapped to the
Ports of the Compound Component. The Ports of the Compound Component first have to be prepared before this
mapping can be made.
Compound Components also have to be prepared if the Ports are to be assigned individually to a Pictogram or
Faceplate.
Individual Automation Functions in a Compound Component are encapsulated. Hence the Ports of the individual
Automation Functions are not recognized as separate entities in any Tag Browser.
In order to make these ports visible the Ports References have to be explicitly defined by the user. The ports will then
be available for Property Mapping in pictograms.
When AF Blocks are placed in Compound Components, they contain All HMI Ports. For some Automation Functions
there are Ports which are defined for HMI, but not I&C. These Ports would not normally be available in Function
Diagrams, but in Compound Components these Ports are also available. The M_SETP input port of a SPADJ
Automation Function is an example of this type of port.
In order to use these these HMI Ports for Property Mapping, they have to be explicitly defined by the user.
To prepare the Ports contained in a Compound Component for property mapping, proceed as follows:
The prepared Ports will now become available for assignment in the property mapping of the Compound Component.
Individual Automation Functions in a Compound Component are encapsulated and are not recognized as separate
entities in the Alarm and Archive systems.
In order to make the ports of the encapsulated AFs visible the Ports References have to be created. The ports will then
be available for alarming and archiving.
In order for a Compound Component Port to be made available for archiving and alarming proceed as follows:
Preparing the Ports will for archiving and alarming has the following effects:
• The Archive and Alarm columns for the prepared Ports will appear as selected in the Port Type sheet of the
Port Definition.
• When the Compound Component is placed on a Function Diagram the Archive and Alarm settings in the
symbol mask will be selected by default. The settings can be deselected. The archive and alarming
parameters will also be editable.
•
• A Port Reference that has been prepared for alarming or archiving cannot be deleted until Alarm and
Archive are deselected in the AF parameter mask.
The user places a Compound Component on a Function Diagrams in the same way as an Automation Function. The
Compound Component is represented as a single block on the Function Diagram as shown in the following example:
Once a Compound Component is placed on a Function Diagram the logic of the Compound Component can be viewed
by navigating to the Embedded Diagram.
When a Compound Component is placed in a Function Diagram The Compound Component and it ports becomes
visible in the following Workbench functions:
• search functions:
o Find Tags
o Find Tag Usages
o Find Open Plant Display Mappings
o Documentation of Forced Ports
• Tag Browsers for configuration of:
o Reports
o Plant Displays
o Point Groups
1. Select the Compound Component to be modified from the Library Node where it resides.
2. Open the Compound Component in Configuration Mode.
3. If the Compound Component is password protected, the user will be prompted to enter the password.
4. The Compound Component will open in the Diagram Editor .
5. Edit the mask for any Port Reference in the Compound Component.
6. Click on Unlock on the Compound Component Definition sheet to allow the Compound Component to be
edited.
7. Make the changes to the Compound Component logic or Port Definition mask.
8. Commit the changes.
The latest version of the the Compound Component replaces the older version of the Compound Component in the
Library.
Compound Components which already exist on Function Diagrams are not affected. To update existing Compound
Components to the latest version, the Compound Component instances must be replaced by the user.
If Port References of a Compound Component are deleted then attention must be paid when replacing
Compound Component instances.
i.e. It is not possible to replace a Compound Component on a Function Diagram when there are connections
to external ports, which would not be available after the replacement.
The new name of the Compound Component will be inherited by the embedded diagram. If the values of blocks or
signals within the embedded diagram have been previously manually modified, the user can confirm whether or not the
changes are overwritten.
The version of the Compound Component in the Library can differ from the Compound Component version on the
Function Diagrams when:
In either case instances of the Compound Component, which already exist on Function Diagrams, are not
automatically updated. They must be replaced. The replacement function only effects those Compound Components
with matching GUIDs.
1. Select the Project Node or individual Function Diagram where the Compound Component will be replaced.
Alternatively, select a Compound Component in the Library which will replace the Compound Component
instances on the Function Diagrams.
2. Select Extras then Replace Compound Component from the drop down menus.
3. The Replace Compound Component dialog box will open.
4. Select a Compound Component from the drop down list, if the desired Compound Component is not already
selected.
5. If more than one Compound Component is listed in the field Replace instances of, then other copies of the
Compound Component exist in the project with the same GUID. Select the Compound Components in the list
to be replaced.
If only one Compound Component is listed in the Replace instances of field then the user doesn't need to
select it. The listed Compound Component will be replaced.
6. The Compound Components will be replaced in the Function Diagrams of the Selected Node . To change
the Selected Node , click on the browse button. Then select the Project Node in the browser that appears.
All the users Function Diagrams must be committed before a Compound Component can be
replaced.
7. Click on Replace.
8. An Information dialog box appears with a list of tags of instances of the Compound Component.
9. Click on OK to replace the Compound Component instances, otherwise click on Cancel.
10. The Compound Component instances will be replaced by the version of the Compound Component in the
Library.
11. The effected Function Diagrams need to be committed to save the updated Compound Component in the
Project Container.
12. The Function Diagrams must then be activated for the changes to be executed in the Runtime Container.
The updated Compound Component will start executing immediately in the Runtime Container.
Compound Component replacement is not possible when the Compound Component on the Function Diagram
has connections to its external ports, which would not be available after the replacement.
The port parameter settings made in the new Compound Component will not overwrite the parameter settings
of the CC on a Function Diagram during a Replace.
To acquire a Compound Component license a license string must be provided to Siemens. The license string must
have the following format:
CC_ (Compound Component GUID) _ (Access Level Suffix)
The prefix and GUID are displayed in the field beside the License option on the in the Compound Component
Definition mask as shown in the following example:
• Access Level Suffix determines what access rights users will have to the Compound Component.
• Use the suffix:
o _U to allow users to use the Compound Component in Function Diagrams.
o _R to allow users to read the logic of the Compound Component.
o _W to allow users to write changes to the Compound Component configuration.
Siemens uses the Compound Component license string to generate either a new License File for the project or a
temporary license for the Compound Component.
License Types
A permanent Compound Component license is part of the License File that is installed on the Application Server. All
users on the system will have the access rights to the Compound Component as determined by the permanent
license.
A temporary license is installed on a Thin Client. The access rights granted by a temporary license are only active on
the Workbench session on which the license was loaded. When the user closes the Workbench session the access
rights will be revoked. The temporary license can be installed as many times a desired until the expiry date of the
license.
Temporary Component Licenses are intended to be used only by Siemens service personnel.
Activation and deactivation of complete Function Diagrams is carried out in the Project View . In the Diagram editor it is
possible to activate single elements and deactivate single elements in Function Diagrams (e.g. AF Blocks and Proxies)
as well as complete diagrams. The process for activating and deactivating single elements is the same as for complete
diagrams, except that single elements in diagrams are selected rather than the complete diagram.
The following transaction handling functions are available directly in the Diagram Editor:
Commit
Rollback
Activate AF
Deactivate AF
Preview Activation
1. Select the Edit menu, then Preview Activation from the drop down menu.
2. A list will appear with all the AF Block updates made on the Function Diagram since the last activation.
3. Select a list item and right mouse click to access the context menu options.
To preview the updates on an individual AF block, select the AF Block then click on the Preview Activation
icon. Only updates made to the selected AF Block will be displayed.
Alternatively, the Preview Activation function can be accessed from other points in the Workbench:
If Automatic Activation Preview has been selected in Global Settings, then the Preview Activation dialog
will appear when a Function Diagram is activated from either the Diagram Editor or the Project View.
Preview Activation can be accessed from the Activation dialog in the Project View.
The Preview Activation icon is enabled in the Point View when viewing the Engineering Parameter sheet.
The AF Block will become active immediately, there is no waiting time for a transfer of code. Ensure that any
necessary precautions have been taken prior to activating e.g. informing operating staff of the change.
The diagram may not contain any uncommitted changes, and the user may not have any other uncommitted
changes in other Function Diagrams, prior to single elements being activated.
Alternatively, select the function by clicking on the Activate AF icon on the standard toolbar.
3. If Automatic Activation Preview was selected in the Global Settings then the Activation Preview dialog will
appear. The user then has the option to:
o click on Activate to activate the diagrams or
o click on Cancel
If Automatic Activation Preview was not selected in the Global Settings then the Preview
Activation dialog will be bypassed.
When viewing the Function Diagrams in the Diagram Editor, activated AF Blocks are indicated with a blue
Frame, as per the Status Indication.
The AF Block will become deactive immediately, there is no waiting time for a transfer of code. Ensure that
any necessary precautions have been taken prior to deactivating e.g. informing operating staff of the change.
Alternatively, select the function by clicking on the Deactivate AF icon on the standard toolbar.
When viewing the Function Diagrams in the Diagram Editor, deactivated AF Blocks are indicated with a black
Frame, as per the Status Indication.
Each signal in the system has a quality code. The quality code of a signal leaving some logic should be dependant on
the quality code of the signals entering the logic. This concept is shown in the diagram below:
The quality of the output signal leaving the AND gate is BAD , since the worst quality state of the inputs is propagated
at the output.
When the logic contains a feedback loop the quality of the output is no longer dependant only on the input signals, but
also on the quality state of the feedback signals internal to the logic. This concept is shown in the diagram below:
In the sequence 1..2..3, the quality of the input starts as GOD , changes to BAD , then back to GOD again. Note that
the output remains BAD , even after the input changes back to GOD . This is clearly unacceptable since the quality of
the output should depend on the quality of the input signal.
The problem is solved by ensuring that all feedback signals within logic always have a GOD quality state. In this way
the functioning of the logic will not be affected, but the computation of the quality code of the logic outputs will be
correct.
Most Automation Functions have a QUALITY input Port that can be set to control the quality of signals appearing at
the output Ports of the Automation Function. When an AF Block has any input Port connected to a feedback loop, the
QUALITY Port for the AF Block can be set to FALSE. This ensures that the quality of signals from the output Ports of
the AF Block are always GOD .
AF blocks are provided for quality monitoring of binary and analog signals. These AF Blocks can also be be used to
provide signals that always have a GOD quality state. Examples are given below for a solution for both binary and
analog logic.
• Binary Logic: Insert an BSQMON (Binary Signal Quality Monitor) AF Block before the feedback,
parameterized to ensure the quality is always GOD .
• Analog Logic: Insert an ASQMON (Analog Signal Quality Monitor) AF Block before the feedback,
parameterized to ensure the quality is always GOD .
•
If the Library is not visible in the Diagram Editor it needs to be activated in the menu bar of the Diagram
Editor. File > Open Library
3. Move the cursor to the Plant Display. The symbol moves with the cursor over the Plant Display.
4. Move the cursor to the desired position in the Plant Display, and click again.
The symbols can also be selected in permanent mode, a symbol will then be placed in the diagram with every
successive mouse click.
After these steps the Pictogram needs to be connected with the appropriate AF Block because the AF Block supplies
the Pictogram with the process information, needed for monitoring and operation.
How to assign these connections is described in the part Setting the Pictogram parameters.
Any changes have to be activated in the system to be available for the operator. The procedure for committing and
activation of changes is described in Transaction handling
A Plant Display is open in the Diagram Editor and a Prototype has been placed.
Typically when the Exchange Prototype function is used, the Prototype has also already been parameterized
including the process connection.
Otherwise it might make more sense just to delete the existing Pictogram and place the new Pictogram.
4. The New Prototype list contains Prototypes which allow default mapping to the current Prototype. Select the
replacement Prototype from the drop down list.
5. Click OK to complete the exchange. Otherwise click Cancel to close the dialog box without exchange.
The new Prototype will be appear in the Plant Display with the same properties and mappings as the old Prototype.
Alternatively, select the function via the context menu (Right Mouse Click > Pictogram > Exchange
Prototype...).
The following description is not for S7-CPU Faceplates. They only have to be assigned to the S7 Runtime
Container.
3. After clicking in the edit field Tag-Name click the browse button which appears at the right side of the edit
field. This opens the Tag Browser window.
4. Select the desired Automation Function Block from the tag browser.
5. The edit fields Tag Name and Tag Item in the section Select Default Mapping will display the assigned
Automation Function Block.
6. Close the window with Save or abort with Cancel
Alternatively, the Tag Name and Tag Item can be manually entered.
Finally the changes above must be activated in the system in order to be available for the operator.
The following description is not for S7-CPU Faceplates. They only have to be assigned to the S7 Runtime
Container.
Automatic Checks
The system automatically attempts to make a process connection to an AF and checks the process connection after
the manual assignment. There are different possibilities:
o If the Symbol-Type of the AF is permissible (i.e. occurs in the Symbol-Type drop down list): The
Symbol-Type will be adjusted automatically, and the process connection will be made.
o If the Symbol-Type of the AF is not permissible (i.e. does not occur in the Symbol-Type drop down
list): An error message will appear, and no process connection will be made.
• Tag-Name and Tag-Item do not match an existing AF: No process connection will be made. The Symbol-
Type setting has no relevance in this case and will be reset to the default setting.
1. After the diagram is opened in the Diagram Editor double-click the Pictogram; the parameter window appears:
2. If supported for the specific function, the user can select an alternative Automation Function:
o open the drop down list Symbol-Type to select an alternative AF type.
3. Confirm the selection by clicking Save or abort with Cancel.
In the case where it is necessary to use an interface other than the default Faceplate proceed as follows:
1. After the diagram is opened in the Diagram Editor double-click the Pictogram; the parameter window appears:
2. If supported for the specific function, the user can select an alternative faceplate:
o open the drop down list Faceplate-Type to select an alternative symbol
3. Confirm the selection by clicking Save or abort with Cancel.
Finally, the changes made have to be activated in the system to be available for the operators.
1. The plant display, which contains the symbol to be changed, needs to be opened in the diagram editor.
2. Double-click the Pictogram. The dialog Parameterize Pictogram and Faceplate appears.
3. In the section Parametrize Pictogram / Faceplate click the button Pictogram Parameter
A Dialog may appear stating that the user must save the mapping before a special mapping can be
created. Click on Yes to save the current mapping and continue. Otherwise click on No to exit the
function.
6. To confirm the changes click the button Save in the dialog Parameterize Pictogram . Otherwise click the
button Cancel to abort the changes.
7. To select the symbol in the Faceplate, click the button Faceplate Parameter and repeat steps 4, 5, 6.
8. To confirm the changes click the button Save in the dialog Parametrize Pictogram and Faceplate .
Otherwise click the button Cancel to abort the changes.
9. The alternative symbol appears in the diagram,
10. Finally, the changes have to be committed and activated. For details refer to Transaction Handling for Plant
Displays.
With individual assignment of ports to faceplates or pictograms, it is possible to ensure the same appearance and
operating behavior for each device, even when the interfaces differ from the default requirements of SPPA-T3000.
To perform these modifications successfully, some principles, which are explained below, have to be considered
carefully. The process of connecting ports to faceplates or pictograms is called mapping.
To ensure that an individual port is enabled for HMI, refer to the detailed description of the
Automation Functions in the SPPA-T3000 library. Those ports are crossed in the column HMI
3. Elements in faceplates which send signals from the faceplates to an Automation Function have to be
connected to an input port. Usually such signals are operator commands. In the detailed mapping list of
faceplates these element names in the column Port start with M_***. Note that *** is the place holder for the
individual command. E.g. the element M_START conveys the manual start command from the faceplate to
the Automation Function.
4. Elements in faceplates which indicate an enabled or not enabled condition for operation, have to be
connected to an output port. Such signals change the appearance of command buttons. In the detailed
mapping list of faceplates these element names in the column Port end with ***_P. Note that *** is the place
holder for the individual command / permission. E.g. the element START_P conveys the permission to start a
device from the Automation Function to the faceplate.
5. Elements in faceplates or symbols which display a condition, can only be mapped to input or output ports of
Automation Functions. These element descriptions do not start with M_*** or end with ***_P, e.g. RUNNING
provides the visual indication of a running device via display of the color selected for this indication.
For details on how to perform the individual mapping, refer to the following descriptions.
The other tab of the Parameterize Pictogram and Faceplate dialog displays the AF Properties.
If the process connection has been established, then the tab mirrors the information of the Property
Sheet of the Automation Function.
3. Within the section Special Mapping click the button Map Pictogram . A table Mapping Details Pictogram is
opened:
If Symbol Type (none) is selected, then the fields Tag Name and Port will be restricted.
2. Use the tag browser to search for the individual Automation Function Block in the project structure.
Select the applicable Automation Function Block from the search result.
3. Select the desired port of the alternative Automation Function Block.
4. If Symbol Type (none) was selected in Step 1, then the user has the option to enter a constant
Value or, when available, to map the property to the variation min, variation max or engineering unit
of another Pictogram property.
Copy, Paste and Reset Binding functions are accessible by clicking the right mouse button
to open the context menu.
Select Copy to copy the selected row into the paste buffer.
Select Paste to paste the previously copied row into the currently selected row.
Select Reset Binding to undo the changes to the selected row. i.e. the information will be
reset to state when the table was last opened.
5. Click Save to confirm the changes or Cancel to abort. The default mapping can be restored by
clicking on Reset.
The corresponding Faceplate inherits all Pictogram ports by default. Until inheritance in the Faceplate
is turned-off, the special mapping applies to both objects.
5. After the changes are confirmed, in the section Special Mapping the check box Select special tag becomes
selectable.
If special mapping has been made to an alternative AF Block, the user has the option of replacing the default
process connection, with this special mapping. In this case any reference to the process connection is
changed to the AF Block that has been specially mapped (e.g. in the Faceplate, or the tag name visible in the
Plant Display).
To select a special tag, select the Select special tag check box, then select the alternative AF Block from the
Special tag drop down list.
Finally the changes above have to be activated in the system to be available for the operator.
To adjust the appearance of the Pictogram refer to Parameterize the Pictogram Parameters
For detailed information concerning the interfaces refer to the description Automation Functions.
The same steps apply to the inheritance mapping of individual Faceplate Properties.
To enable the context menu with the inheritance menu items visible, the Symbol Type must be set to
(none) for the given property. Otherwise the context menu will only have the standard Reset
Binding, Copy, and Paste options visible :
The context menu will have Use Variation Min..., Use Variation Max..., or Use EU... options
available as permitted by the type of Property. Otherwise they will be visible but unavailable.
5. Select the Prototype Property from the drop down list. The list contains all the prototype properties available
from the Mapping Details Pictogram table for mapping of the chosen inheritance type.
6. Click OK to confirm the mapping or Cancel to abort.
7. The mapping is displayed in the Value field.
The other tab of the Parameterize Pictogram and Faceplate dialog displays the AF Properties.
If the process connection has been established, then the tab mirrors the information of the Property
Sheet of the Automation Function.
3. Within the section Special Mapping click the button Map Faceplate . A table Mapping Details Faceplate is
opened:
3. Use the tag browser to search for the individual Automation Function Block in the project structure.
Select the applicable Automation Function Block from the search results.
4. Select the desired Port of the alternative Automation Function Block.
Copy, Paste and Reset Binding functions are accessible by clicking the right mouse button
to open the context menu.
Select Copy to copy the selected row into the paste buffer.
Select Paste to paste the previously copied row into the currently selected row.
Select Reset Binding to undo the changes to the selected row. i.e. the information will be
reset to state when the table was last opened.
5. If Symbol Type (none) was selected in Step 1, then the user has the option to enter a constant
Value or, when available, to map the property to the variation min, variation max or engineering unit
of another Faceplate property.
6. Click Save to confirm the changes or Cancel to abort. The default mapping can be restored by
clicking on Reset.
5. After the changes are confirmed, in the section Special Mapping the check box Select special tag is
selectable.
If special mapping has been made to an alternative AF Block, the user has the option of replacing the default
process connection, with this special mapping. In this case any reference to the process connection is
changed to the AF Block that has been specially mapped (e.g. in the Faceplate, or the tag name visible in the
Plant Display).
To select a special tag, select the Select special tag check box, then select the alternative AF Block from the
Special tag drop down list.
Finally the changes above have to be activated in the system in order to be available for the operator.
To adjust the appearance of the Pictogram refer to Parameterize the Faceplate Parameters
For more detailed information concerning the interfaces refer to the description Automation Functions.
Inheritance active
2. If the user deselects the check box then...
Content modified
4. Select the check box again so that to restore the inheritance. The modified value is overwritten by the original
inherited value...
Inheritance restored
To change the appearance of the Pictogram from the default, proceed as follows:
3. Within the section Parameterize Pictogram / Faceplate click the button Pictogram Parameter. The table
Parameterize Pictogram is opened:
The contents in the column Value is assigned based on the default definitions.
The values which are displayed here, have to be previously defined in the project settings.
For an explanation of these settings, refer to the corresponding descriptions for the Property sheet, and how the
number format is set.
Similar to the inheritance of the color and text properties (see Info-box above), the setting of the Other Properties can
also be carried through:
The setting for properties in the Pictogram, of which names begin with spec_, will be carried through to the
same property in the Faceplate.
Property names can be edited in the Prototype Editor. For more information, refer to The Property Table Page.
Finally the changes above have to be committed and activated in the system to be available for the operator.
Click on the parameter to select it, then reset the value using the context menu (right mouse click > Reset).
3. Within the section Parameterize Pictogram / Faceplate click the button Faceplate Parameter. The table
Parameterize Faceplate is opened:
4. When the user clicks in the field, a drop down menu appears providing alternative settings. Click one to
select.
5. Click Save to save the changes or Cancel to close without saving the changes.
Inheritance
Inheritance of Faceplate parameters from the Pictogram is indicated and modified by the check boxes:
• Deselect the check box so that inheritance is inactive for that field:
•
• Select the check box again so that inheritance is restored. The modified value is overwritten by the original
inherited value:
•
After the changes have been applied, click the Save button to confirm the changes, or click Cancel to abort.
The values which are displayed here, have to be previously defined in the project settings.
For an explanation of these settings, refer to the corresponding descriptions for the Property sheet, or how the number
format is set.
Finally the changes above have to be committed and activated in the system to be available for the operator.
Click on the parameter to select it, then reset the value using the context menu (right mouse click > Reset).
The Parameterize Pictogram and Faceplate / Set Process Connection dialog box is open for the prototype.
o If a process connection has just been created and not yet saved, a dialog box will open to allow the
user to do this.
3. The signals which will appear in the trend display are shown in the dialog box.
The signals selected for a Faceplate trend may consist of archived and non-archived signals. When a
trend display that contains non-archived signals is opened, no historic data will be shown for any of
the curves in the trend display. The curves will be plotted only from the time of the opening the trend
display.
The number format is set using two settings in the Pictogram or Faceplate parameters:
• numberOfDigits: The width of the display area available for the number.
• Format: A pattern that defines the exact way in which the value will appear. Format is described below in
more detail.
Format
These characters can be combined to achieve the desired result. Examples are provided below for both decimal and
scientific notation.
Decimal Notation
Value Format Displayed Value
123 0.0 123.0
123.4 0.0 123.4
0.05 0.0 0.1
123 00.# 123
123.4 00.# 123.4
0.05 00.# 00.1
Scientific Notation
Value Format Displayed Value
123 0.00E0 1.23E2
100 0.##E0 1E2
1000 00.##E0 10E2
0.000123 00.####E0 12.3E-5
A navigation button can be configured to perform 1 of these tasks. Both options are described below.
The Plant Display containing the navigation button has to be committed and activated for the new button or changed
parameters to become effective.
Links to Documents
The Plant Display containing the navigation button has to be committed and activated for the new button or changed
parameters to become effective.
The initial configuration of the Trend Display is done in Configuration Mode. To configure a Trend Display in
Configuration Mode proceed as follows:
A Plant Display is open in the Diagram Editor and the SPPA-T3000 Library is open.
1. Select the TrendDisplay prototype in the Trends Node of the Prototype Library.
2. Place the TrendDisplay prototype on the diagram.
3. Double click anywhere within the Prototype to open the configuration dialog.
4. Edit the settings in the General, Time, Tags, and Appearance tabs of the configuration dialog.
5. Click on Save to store the settings, otherwise click on Cancel.
The Trend Display configuration dialog is described in detail in the Operation User Guide.
The Trend Display configuration settings made in Configuration Mode are the permanent configuration settings .
Configuration changes can be made to the Trend Display in Operation Mode. If the Trend Display is part of a Plant
Display, the changes will be lost when the display is closed. If the Trend Display is on a User Specific Plant Display,
the changes will be saved when the display is closed.
The initial configuration of the XY Curve Display is done in Configuration Mode. To configure an XY Curve Display
proceed as follows:
A Plant Display is open in the Diagram Editor and the SPPA-T3000 Library is open.
1. Select the CurveDisplay prototype in the XY-Diagrams Node of the Prototype Library.
2. Place the CurveDisplay prototype on the diagram.
3. Double click anywhere within the Prototype to open the configuration dialog.
4. Edit the settings in the General, Time, Op Points tabs of the configuration dialog.
The XY Curve Display configuration dialog is described in detail in the Operation User Guide.
The XY Curve Display configuration settings made in Configuration Mode are the permanent configuration settings .
Configuration changes can also be made to the XY Curve Display in Operation Mode. If the XY Curve Display is part
of a Plant Display, the changes will be lost when the display is closed. If the XY Curve Display is on a User Specific
Plant Display, the changes will be saved when the display is closed.
2. Match the X and Y axes scaling of the background image to the XY Curve Display by:
o matching the x- and y-axes ranges set in the configuration dialog with the axes ranges on the
background image
and,
o cropping the image exactly along the x- and y-axes.
3. Import the image into the project using the Import utility in the Project View.
The image will now be selectable in the General tab of the XY Curve Display configuration dialog.
• For every dynamic element in a Plant Display there is a corresponding AF Block in a Function Diagram.
• A process connection must be made between every Pictogram and an AF Block.
• Function Diagrams and Plant Displays often correspond to each other e.g. The AF Blocks in a single Function
Diagram may all have process connections to Pictograms in a single Plant Display.
Integrated Engineering is an SPPA-T3000 feature that removes the separation between Plant Display and Function
Diagram Engineering. Integrated engineering makes the engineering process much more effective and efficient.
For example: When placing a new Pictogram into a Plant Display, the corresponding AF Block is made available
automatically in the Function Diagram, the process connection is made automatically.
1. Corresponding Function Diagrams and Plant Displays are linked together with a diagram assignment.
2. When objects are placed in a diagram, the matching symbols in the corresponding diagram automatically
appear in a reference list for that diagram.
3. The symbols can simply be dragged from the reference list into the diagram, the process connections are
made automatically.
There are different options available for this process as described in Placing New AF Blocks and Placing New
Pictograms. There are also considerations when deleting AF Blocks or Pictograms.
In many cases the majority of elements in a Plant Display have process connections to elements in the same Function
Diagram, or vice versa. In these cases a diagram assignment can be made between the two diagrams. This can be
represented graphically as:
Elements in a Plant Display often have process connections to elements in more than one Function Diagram. To allow
for this possibility, many Function Diagrams can be assigned to the same Plant Display. This is shown graphically as:
• Automatically, when creating a diagram: When a Function Diagram or Plant Display is created a
corresponding diagram can be created simultaneously. In this case the diagram assignment is made
automatically between the two diagrams.
• Manually, for existing diagrams: The diagram assignments of existing diagrams can be set manually.
Diagram assignments are always bidirectional i.e. when an assignment is made in one direction, then the
assignment in the reverse direction is made automatically.
1. Select the diagram (Function Diagram or Plant Display) for which the diagram assignments are to be made.
2. Select the Edit menu, then Diagram Assignment from the drop down menu.
3. A dialog box will appear containing the diagram assignments for that diagram. All other diagrams assigned to
this diagram are shown in the list in the dialog box.
The Default column is only available for the Plant Display assignment dialog box. The information is
used when placing new Pictograms in integrated engineering mode.
Alternatively select the function via the context menu (Right Mouse Click > Diagram Assignment).
1. Select the File menu, then Open Reference List from the drop down menu.
2. The reference list will open, docked on the left hand side of the Diagram Editor.
The reference list will stay open, it can be closed via the standard window close button.
The contents of the reference list can be sorted. Click on the column header cell of any column to sort the list
by that column.
An Automation Function may have more than one Pictogram type available for it, that can be placed in a Plant Display.
The user may wish to change the type of an item in the reference list.
A filtering function is available in the Plant Display reference list to hide selected AF Blocks. This allows the user to
filter out AF Blocks that will not be represented on a Plant Display (for example, an AND block).
To show all AF Blocks in the Plant Display reference list as well as the Filtered check box column proceed as follows:
1. Click the right mouse button anywhere in the reference list to open the context menu.
To select AF Blocks to hide or show in the Plant Display reference list, proceed as follows:
1. Select the AF Block in the reference list to be hidden or shown by clicking on it.
Multiple AF Blocks can be selected by selecting a single item, then pressing the CTRL key and
selecting more items
or
selecting a single item, then pressing the SHIFT key then selecting another item. Both the items and
all the items in between them will be selected
Any AF Blocks that were placed on the assigned Function Diagram while Integrated Engineering was
off, will automatically be set as Filtered in the reference list.
To hide the selected AF Blocks in a Plant Display reference list proceed as follows:
1. Select any AF Block in the reference list, and click the right mouse button to open the context menu.
2. Click on Show Only Unfiltered.
3. The AF Blocks with selected Filtered check boxes will disappear from the reference list. The Filtered check
box column will also disappear.
A Function Diagram and a Plant display have been created, and the diagram assignment between them has been
made. The Function Diagram is open in the Diagram Editor.
1. Place the AF Block (which has operating and monitoring functionality) in the Function Diagram.
2. Open the assigned Plant Display.
3. The reference list for the Plant Display will contain an entry for the Pictogram corresponding to the AF Block
that was placed in the Function Diagram.
4. Select the Pictogram in the reference list be clicking on it.
5. The Pictogram can now be placed in the Plant Display, in the same way as placing a Pictogram from the
SPPA-T3000 Library.
6. The process connection to the AF Block is made automatically.
The reference list for the Plant Display will contain a list of all Pictograms that need to be placed in the
diagram, to match up with the AF Blocks placed in the Function Diagram.
• Integrated Engineering Off: There will be no integrated engineering functionality. Placing Pictograms on
Plant Displays and making process connections will not effect the reference lists of any Function Diagram.
• Integrated Engineering On:In this mode two options are available:
o Create new AF for Pictogram: An AF Block will appear in the reference list of assigned diagrams.
o Map new Pictogram to existing AF: A tag browser automatically opens to make a process
connection to an existing AF Block.
The procedure for setting the integrated engineering mode, and the two options available when integrated engineering
is on are explained below.
To set the integrated engineering mode for placing new Pictograms, proceed as follows:
• Select the Edit menu, then Integrated Engineering from the drop down menu.
The integrated engineering mode will now toggle to either on or off. The engineering mode can be changed at any
time.
A Function Diagram and a Plant display have been created, and the diagram assignment between them has been
made. The Plant Display is open in the Diagram Editor and Integrated Engineering has been toggled on.
When a Plant Display has multiple function Diagram assignments, the initial search node in the tag
browser is the diagram that was ticked as Default in the Diagram Assignment dialog.
If the AF block for Pictogram does not already exist on a Function Diagram then proceed as follows:
1. In the Pictogram parameter window, enter the Tag Name and Tag Item for the AF Block that is to be created.
2. Click on Save. The Pictogram parameter window and the Tag Browser will close.
3. Open the assigned Function Diagram.
4. The reference list for the Function Diagram will contain an entry for the AF Block corresponding to the
Pictogram that was just placed in the Plant Display.
In cases of multiple diagram assignment, the AF Block will appear in the reference list of all assigned
Function Diagrams. When the AF Block is placed in one of the Function Diagrams, it will disappear
from all the reference lists.
If the AF Block to which the process connection is to be made has already been placed in the Function Diagram then
make the process connection to the AF Block using the tag browser (as described in Assigning the Process
Connections).
If the Plant Display had been committed before the deletion, then the Pictogram is set as Filtered in the
reference list.
Similarly, if a AF Block is deleted from a Function Diagram (that had a process connection to an Pictogram in a Plant
Display), the AF Block will reappear in the reference list for the Function Diagram.
If the Plant Display had been committed before the deletion, then the AF Block will disappear from the
Function Diagram reference list.