Control Expert Asset Link - User Guide
Control Expert Asset Link - User Guide
User Guide
06/2023
EIO0000004195.10
www.se.com
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its
subsidiaries referred to in this guide are the property of Schneider Electric SE or its
subsidiaries. All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
EIO0000004195.10 3
ASP Templates and Pattern Names.................................................... 112
Process Patterns......................................................................... 112
Device Patterns .......................................................................... 113
SCADAPack Patterns.................................................................. 114
Appendices .............................................................................................. 117
Library Installation .................................................................................. 118
........................................................................................................ 118
Glossary ................................................................................................... 120
Index ......................................................................................................... 122
4 EIO0000004195.10
Safety Information
Safety Information
Important Information
Read these instructions carefully, and look at the equipment to become familiar
with the device before trying to install, operate, service, or maintain it. The
following special messages may appear throughout this documentation or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.
The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.
! DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
! WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
! CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only
by qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction
and operation of electrical equipment and its installation, and has received safety
training to recognize and avoid the hazards involved.
EIO0000004195.10 5
Qualification of Personnel
Qualification of Personnel
A qualified person is one who has the following qualifications:
• Skills and knowledge related to the construction and operation of electrical
equipment and the installation.
• Knowledge and experience in industrial control programming.
• Received safety-related training to recognize and avoid the hazards involved.
The qualified person must be able to detect possible hazards that may arise from
parameterization, modifying parameter values and generally from mechanical,
electrical, or electronic equipment. The qualified person must be familiar with the
standards, provisions, and regulations for the prevention of industrial accidents,
which they must observe when designing and implementing the system.
6 EIO0000004195.10
Proper Use
Proper Use
This product is a library to be used together with the automation control systems
and is intended solely for the purposes described in the present documentation as
applied in the industrial sector.
Always observe the applicable safety-related instructions, the specified conditions,
and the technical data.
Perform a risk evaluation concerning the specific use before using the product.
Take protective measures according to the result.
Since the product is used as a part of an overall system, you must ensure the
safety of the personnel by means of the concept of this overall system (for
example, machine concept).
Any other use is not intended and may be hazardous.
EIO0000004195.10 7
Before You Begin
WARNING
UNGUARDED EQUIPMENT
• Do not use this software and related automation equipment on equipment
which does not have point-of-operation protection.
• Do not reach into machinery during operation.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
8 EIO0000004195.10
Start-up and Test
WARNING
EQUIPMENT OPERATION HAZARD
• Verify that all installation and set up procedures have been completed.
• Before operational tests are performed, remove all blocks or other temporary
holding means used for shipment from all component devices.
• Remove tools, meters, and debris from equipment.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
Follow all start-up tests recommended in the equipment documentation. Store all
equipment documentation for future references.
Software testing must be done in both simulated and real environments.
Verify that the completed system is free from all short circuits and temporary
grounds that are not installed according to local regulations (according to the
National Electrical Code in the U.S.A, for instance). If high-potential voltage
testing is necessary, follow recommendations in equipment documentation to
prevent accidental equipment damage.
Before energizing equipment:
• Remove tools, meters, and debris from equipment.
• Close the equipment enclosure door.
• Remove all temporary grounds from incoming power lines.
• Perform all start-up tests recommended by the manufacturer.
EIO0000004195.10 9
Operation and Adjustments
10 EIO0000004195.10
About the Book
Validity Note
This document has been updated for the release of EcoStruxure™ Control Expert
Asset Link V4.0.
The characteristics that are described in the present document, as well as those
described in the documents included in the Related Documents section below,
can be found online. To access the information online, go to the Schneider Electric
home page www.se.com/ww/en/download/.
The characteristics that are described in the present document should be the
same as those characteristics that appear online. In line with our policy of constant
improvement, we may revise content over time to improve clarity and accuracy. If
you see a difference between the document and online information, use the online
information as your reference.
Related Documents
Title of documentation Reference number
Modicon Libraries 2022 - General Purpose for EIO0000002094
AVEVA System Platform (OMI)
Technical Support
Visit https://www.se.com/myschneider/ for support, software updates, and latest
information.
EIO0000004195.10 11
About the Book
WARNING
LOSS OF CONTROL
• Perform a Failure Mode and Effects Analysis (FMEA), or equivalent risk
analysis, of your application, and apply preventive and detective controls
before implementation.
• Provide a fallback state for undesired control events or sequences.
• Provide separate or redundant control paths wherever required.
• Supply appropriate parameters, particularly for limits.
• Review the implications of transmission delays and take actions to mitigate
them.
• Review the implications of communication link interruptions and take actions
to mitigate them.
• Provide independent paths for control functions (for example, emergency
stop, over-limit conditions, and error conditions) according to your risk
assessment, and applicable codes and regulations.
• Apply local accident prevention and safety regulations and guidelines.1
• Test each implementation of a system for proper operation before placing it
into service.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
1For additional information, refer to NEMA ICS 1.1 (latest edition), Safety
Guidelines for the Application, Installation, and Maintenance of Solid State Control
and to NEMA ICS 7.1 (latest edition), Safety Standards for Construction and
Guide for Selection, Installation and Operation of Adjustable-Speed Drive
Systems or their equivalent governing your particular location.
Examples described in this manual are provided for information only.
WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and
requirements of your industrial application before you implement them.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
Standard Description
12 EIO0000004195.10
About the Book
Standard Description
In addition, terms used in the present document may tangentially be used as they
are derived from other standards such as:
Standard Description
Finally, the term zone of operation may be used in conjunction with the description
of specific hazards, and is defined as it is for a hazard zone or danger zone in the
Machinery Directive (2006/42/EC) and ISO 12100:2010.
NOTE: The aforementioned standards may or may not apply to the specific
products cited in the present documentation. For more information concerning
the individual standards applicable to the products described herein, see the
characteristics tables for those product references.
EIO0000004195.10 13
Securing the Environment
14 EIO0000004195.10
Introducing EcoStruxure™ Control Expert Asset Link
Product Objectives
Asset Link is a build-time engineering tool that assists you in the engineering of
the ASP supervisory application by automating the creation and updating of
application based on data extracted from EcoStruxure™ Control Expert or
EcoStruxure™ Machine Expert control projects.
These are the main design principles of Asset Link:
• AVEVA System Platform IDE (formerly ArchestrA Integrated Development
Environment) drives the process while Asset Link is delivered as an ASP
template.
• Asset Link can retrieve and combine multiple data from one or more variables
in the control project and use them from AppObjects modeling Assets.
• Asset Link serves the entire lifecycle of an automation system.
NOTE: This document refers to the PlantStruxure General Purpose Library for
ASP, but you can use your own libraries.
By delivering mechanisms that facilitate the reuse of information already available
from a Control Expert project that controls both process machines and the
process, the engineering of the supervisory application has these benefits:
• quality: The number of detected errors in the ASP supervisory layer can be
greatly reduced.
• cost: The engineering effort and the risk of errors can be significantly reduced
because process-control information is reused from the supervisory
application.
• delivery: The reduced engineering effort accelerates the time of delivery for
automation systems. The introduction of small changes during production is
shorter and helps to limit risks due to those incremental changes.
• innovation: Patterns that are automatically recognized and that require a
minimal effort to model increase flexibility in the implementation of different
integration strategies (for example, naming conventions that are applied).
EIO0000004195.10 15
Introducing EcoStruxure™ Control Expert Asset Link
Product Licensing
Asset Link is a licensed product. Observe this license activation process:
Stage Description
2 Activate the Asset Link License. Refer to the Activating a License, page 16.
NOTE:
• You can use the trial version for 30 days with full functionality.
• After trial period is expired, only 3 pattern files can be loaded.
• If the license is activated, restart the Asset Link tool to see the updated
status of license.
• Asset Link 1.0 is node-locked license, so it uses the License Manager for
the license activation. However, Asset Link 2.1 and greater versions have
a floating license, so you must activate the license using the Floating
License Manager.
Activating a License
Activating software licenses is required to use Asset Link. The licensing
mechanism involves using two software applications:
• The Floating License Manager (FLM): Allows you to activate licenses on a
computer.
• The License Manager (LM): Indicates to the software on which computer the
FLM that hosts the required licenses is installed.
Once you receive your license Activation ID from Schneider Electric, activate the
license by using the Floating License Manager.
The following methods are available to activate a license:
• By Web: Default method when the local computer has an internet connection.
• By Web portal: Alternate method when no Internet connection is available on
the PC where you wish to activate the license.
For a detailed description of each method, refer to the Schneider Electric Floating
License Manager help.
16 EIO0000004195.10
Introducing EcoStruxure™ Control Expert Asset Link
Product Overview
Conversion Overview
Introduction
The graphics below offer high-level views of some of the larger concepts
associated with the use of EcoStruxure™ Control Expert Asset Link.
Preparation Activities
Before the conversion, create and fully test the operational control project logic
and the corresponding ASP AppObject for each type of asset (a pump for
example) through the regular services of the PAC Modicon engineering tools and
the System Platform IDE:
• Create control resources, such as DFB types, DDT, etc.
• Create the Supervisory ASP Templates.
• Test the functionality with examples that can later serve as references for the
Pattern Discovery process.
NOTE: When naming conventions are applied systematically for control
variables, Asset Link discovers the variables and applies them for all
assets of the same type.
EIO0000004195.10 17
Introducing EcoStruxure™ Control Expert Asset Link
Pattern Discovery
Asset Link provides services that auto-discover the rules for generating
AppObjects and storing them in pattern files (.xml) that you can refine:
• Use this implementation, which is based on an ASP template, to launch the
engineering tool from the System Platform IDE without leaving the ASP
environment.
NOTE: You must import these templates to proceed with the pattern
discovery process.
• Select a control project and ASP AppObject to use for pattern discovery. The
rules that are applied to the automatic identification of assets and their
(optional) associated services are generated and stored in files that are used
later in the Bulk Processing. You can adjust the automatically discovered
patterns.
Pattern Refinement
You can use this (optional) activity to refine the rules in patterns that Asset Link
discovers. You can enhance patterns to increase the automation of Bulk
Processing or reuse data from the control project.
Bulk Processing
Asset Link supports the Bulk Processing, to generate or update AVEVA System
Platform AppObjects based on information found in the control project variables
and existing patterns:
• Trigger the exploration of the control project file that describes the variables in
the controller and search for occurrences of defined patterns.
• The Asset Link application shows a list of ASP AppObjects that can be
created or updated and allows you to select or deselect them as needed.
Software Requirements
These are the versions that are required for use with Asset Link V4.0 operations:
• AVEVA System Platform 2020 and later
• EcoStruxure™ Process Expert for AVEVA System Platform 2021 and later
• EcoStruxure™ Control Expert V14.0 and later
• EcoStruxure™ Machine Expert V2.1 and later (formerly SoMachine V4.3 and
later)
• OPC DA server v3.61 and later or OPC UA Server v1.0 and later
18 EIO0000004195.10
Introducing EcoStruxure™ Control Expert Asset Link
• An XML editor (For example: Altova XMLSpy for Schemas and XML
Documents)
• Schneider Electric License Manager 2.9.0.0
• .Net Framework 4.7.2 or later
• Telemetry Server Communication Drivers 2020 (Build 82.7416)
• Remote Connect R2.5.1
• Microsoft Office Excel (Required to support SCADAPack)
Display Settings
In your computer Display settings, select these Scale and layout settings to
implement the resolution of the Asset Link tool on your monitor:
• size (text, apps, etc.): 100%
• resolution: 1920 x 1080
• orientation: landscape
Prerequisites
Readers of this document should have a working familiarity with these software
programs:
• EcoStruxure™ Control Expert is a configuration tool for PAC Modicon
projects. Your choice of libraries is not limited to the PAC Modicon General
Purpose Library (GPL), but Asset Link applies systematic rules that Asset
Link applies to other libraries to automatically determine which ASP
application objects are created and retrieved from the Control Expert project.
• EcoStruxure™ Machine Expert reduces engineering time through intuitive
machine programming.
• OPC Factory Server (OFS): Asset Link manages application object I/O
references that indicate OPC DA Items through the AVEVA DIO OP client
when it is connected to the OFS.
• AVEVA System Platform (ASP): This is the industrial software platform for
HMI operations management, SCADA supervision, and production and
performance management. ASP contains an integrated set of services and an
extensible data model to manage plant control and information management
systems. It supports both the supervisory control layer and the manufacturing
execution system layer, presenting them as a single information source.
• General Purpose Library - EcoStruxure Process Expert for AVEVA
System Platform 2021 General Purpose Library for AVEVA System
Platform Hotfix 80887: Ensure that AVEVA System Platform galaxy is
created with GPL templates in ready to use state.
Before you begin the usage of Asset Link tool, export the appropriate source file,
page 20.
EIO0000004195.10 19
Introducing EcoStruxure™ Control Expert Asset Link
20 EIO0000004195.10
Introducing EcoStruxure™ Control Expert Asset Link
Step Action
Step Action
2 In the Project Explorer, right/click Project Name > Add Object > Add Symbol
configuration.
4 Select (check) the sections you want to include in the variable (.xml) file.
6 Save the project to generate a source project in a directory with this extension:
*_Application.MyController.XML extension
Step Action
3 From the Context Menu select Additional Functions and click on Export to Excel
File.
4 A pop-up window appears. Click Browse and select the folder in which the file has to be
saved and provide the name for the .xls file.
NOTE: Ensure that the .xsy and .xls have the same names and are saved in the
same location.
EIO0000004195.10 21
Installation
Installation
Asset Link Installation
Instructions
Install the EcoStruxure™ Control Expert Asset Link software in the Galaxy
Repository (GR) node:
Step Action
2 Wait for the installation wizard to open and click the Next button.
3 If you agree, accept the licensing agreement and click the Next button.
4 Enter the appropriate information on the Customer Information page and click the
Next button.
5 In the Destination Folder dialog box, click the Change button to navigate to a storage
location for the installation files.
In the Program Files Destination Folder dialog box, click the Change button to
navigate to an installation file path.
Alternately, you can accept the default program files destination folder:
22 EIO0000004195.10
Installation
Step Action
Enter Password and Confirm Password and click Generate and Install button. This
installs certificates for Asset Link server client secure communication.
NOTE: Password set: At least 8 character and a combination of upper case,
lower case, symbols and numbers.
NOTE: Reset Password: To reset the password of the certificates, use the Repair
option from the Asset Link installer. The new generated root certificate has to be
reinstalled in remote client machines for Asset Link.
On the GR node machine, root certificate AssetLinkRoot.pfx is installed and this
file is copied to C:\ProgramData\Schneider Electric\Ecostruxure Control
Expert - Asset Link\Certificates.
8 Service Port: Default port is 9150 or enter other available port in the computer. This
port is used for Asset Link server/client communication.
EIO0000004195.10 23
Installation
Installation Contents
The installation folder contains these sub-folders:
Folder Description
Asset Link Template This folder contains $EsxCEAssetLink.aaPKG Asset Link template
and Pattern Schema and PACConnectorSchema.xsd file. The .xml schema in the
PACConnectorSchema.xsd file can be used by .xml editors to
manually create patterns that conform to the appropriate syntax and
structure, page 76. When you copy this file to every folder that contains
patterns, Asset Link verifies their validity too.
GPL Patterns The General Purpose Library includes a set of patterns that are copied to
folders that can be accessed by Asset Link or used as examples for the
creation of new patterns. You can dedicate any folder to this purpose, but
the use of a shared folder allows Asset Link to access the patterns from
workstations that run System Platform IDE.
GPL ASP Templates The ASP base template $EsxCEAssetLink and its derived template
$aESxPACConnector are delivered in an ASP object export file (.
aaPDF), which is imported to Galaxy where Asset Link is used from, via
System Platform IDE from the Galaxy.Import.Object(s) action.
Once imported, ASP templates appear under the Template Toolbox
‘EcoStruxure Plant.’
User guide This folder contains a .pdf version of the EcoStruxure Control Expert
Asset Link user guide (EIO0000004195).
Control Expert This is a variable file for the control project that is used to get asset
Variable File details.
Demo Templates and These default patterns are used for demonstration purposes.
Patterns
Also contains Application Project XML schema and sample file which can
be referenced to create the application project instances data file for
sources other than Process Expert, to read the application instance data
by configuring the Pattern Action and provide this file as input in Asset
Link configuration. For Process Expert this file is generated from
Ecostruxure Process Expert for AVEVA System Platform application.
Machine Expert These patterns include templates that are used in Machine Expert and
Template and the patterns that are created for those templates.
Patterns
SCADAPack Demo These patterns include templates and patterns that are used in
Templates and SCADAPack for demonstration purposes.
Patterns
Release Notes These release notes accompany the Asset Link delivery.
24 EIO0000004195.10
Installation
Step Action
1 Open Demo Templates and Patterns folder from the installed location of the Asset Link.
7 Configure Demo Patterns in the patterns path and then Browse Control Project in the
Generation tab.
Step Action
1 Copy the Asset Link root certificate AssetLinkRoot.pfx to the client machine or share
the certificates folder location in GR Node and access it from the client machine.
NOTE: The default location is C:\ProgramData\Schneider Electric
\Ecostruxure Control Expert -Asset Link\Certificates.
EIO0000004195.10 25
Installation
4 In the password field, enter the password created during certificate installation from
Asset Link installer in server GR node machine.
26 EIO0000004195.10
Installation
5 In Certificate store, click Browse and select the Trusted Root Certificate Authorities as
shown.
Then, post installing certificates open System Platform IDE then open Asset Link
template. At opening of Asset Link template it tries to connect to Asset Link
service running in GR Node. If unsuccessful, Asset Link detects an error and
displays a message with possible causes. Open the Monitor Tab and verify
whether the value in the port number is same as the value entered during the
Asset Link installation in GR node (This installation time entered port number is
displayed in the Asset Link template Monitor Tab in GR node machine). Enter the
correct port number and click on Test Connection button.
NOTE: If you reinstalled the Asset Link or if you had to repair Asset Link in GR
node machine, then the certificates are reinstalled. Whenever the certificates
are reinstalled, it is required to reinstall the new generated AssetLinkRoot.
pfx in the remote client machine for Asset Link in remote System Platform
machine to communicate with the server.
EIO0000004195.10 27
Installation
Troubleshooting Tips:
• During Generation from the System Platform GR node PC or remote client
PC, if it could not communicate with the Asset Link service, then an error is
displayed at the end of the Generation. Restart the PC and open Asset Link.
Further, verify if the service port is blocked.
• If the error message "Could not connect to Asset Link Service" is displayed at
the opening of Asset Link, or during Browse or Generation operations, verify
whether the Asset Link Service is running on the GR Node PC and that the
Service Port, by default 9150 configured during installation, is not blocked. If
the Asset Link Service is stopped, restart the service, and if still it does not
run, contact your system administrator.
28 EIO0000004195.10
Work Flow
Work Flow
Process Overview
Getting Started
Follow these steps in System Platform IDE:
Step Action
4 Open the Asset Link object from the System Platform IDE:
• Asset Link automatically connects to the Galaxy from which it was instantiated.
• The login credentials are requested if Galaxy is secured by password.
Configuration Process
Select the configuration options:
Step Action
2 In the Source field, select the type of source project in the pull-down menu:
• Control Expert/UnityPro (.xsy files)
• SoMachine/Machine Expert (.xml files)
• Process Expert (.xsy files)
• SCADAPack (.xsy files)
EIO0000004195.10 29
Work Flow
Step Action
6 Click the Refresh button to fetch the updated DIO name in the pull-down menu.
7 The Configure Scan Groups option provides the capability to configure the I/O source
attributes of an asset with different scan group, so that these attributes can be scanned
in different frequency based on your requirement. Click Configure Scan Groups to
display the scan groups used in the patterns. For more details refer to Configure Scan
Groups, page 37.
10 Click the browse button (...) associated with the Patterns Path field and navigate to the
folder that contains the respective Pattern.
11 Click the browse button (...) associated with the Pattern Project field to view control
projects that were exported with the updated variables.
NOTE: The selection of a pattern project is required only when you need new
patterns for generation or obsolete patterns that need to be updated.
12 Click the browse button (...) associated with the Control Project field to view control
projects in the .xsy and .xml formats that (by default) exported variables for instance
generation.
NOTE:
• If Process Expert is selected as a source, associate only one System in
Ecostruxure Process Expert for AVEVA System Platform (EPEforASP) to
one galaxy in the AVEVA System Platform. If multiple systems from
EPEforASP are associated to the same galaxy, any identically named
objects coming from two different systems from EPEforASP create issues in
the AVEVA System Platform.
13 Click the browse button (...) associated with the Application Project (Optional) field to
configure the application .xml file.
NOTE:
• This field can be edited for all Sources except for Process Expert. When
you configure the control project for process expert, by default, the
application XML is present in the same location as the control project, hence
it is automatically filled. For more details refer to Application Project, page
59.
• Ensure that the source files have the necessary inputs that must be
generated into ASP attributes.
14 Navigate to the Patterns tab. Open a pattern for editing and modify as required. Save
and close the pattern.
NOTE: For more details refer to Pattern Editor, page 46.
15 Navigate to the Generation tab and click Browse Control Project. Once the object are
loaded, select and generate the required objects by clicking Generate Objects.
NOTE: For more details refer to Generation tab, page 61.
30 EIO0000004195.10
Work Flow
DNP3 Configuration
The DNP3 Protocol has nine parameters out of which three parameters
Telemetry Server Name, Outstation (refer to Configuration Tab, page 34), and
Hierarchy refer to Configure Hierarchy, page 64) must be configured by you and
the remaining are configured internally by Asset Link.
Follow the steps mentioned below to verify the addressing format for the ASP
Objects.
Step Action
1 Open the Object Editor by double clicking on the generated object in the Model tab of
ASP.
2 Open the Attributes Tab in the Object Editor.
Create Patterns
Use these steps to create a new pattern after you have browsed the pattern
projects for the updated or new variable tags:
Step Action
1 In the AVEVA System Platform object browser, create an instance of a pattern tag name
(with or without a prefix name) for the pattern to be generated
2 On the Asset Link Patterns tab, click the Create Pattern button to open the Create
Pattern dialog box.
Update Patterns
Update an existing pattern:
Step Action
2 Click the Refresh Pattern button to load the latest .xml pattern files in the Patterns
grid.
3 Click the Update Pattern button to open the Update Pattern dialog box.
4 Change the rule for a new tagname and enter the new value for Tagname to update the
pattern rules.
NOTE: This step is optional because Asset Link retrieves a tagname from the
existing pattern by default.
5 Enter a new value in the Prefix in the Tagname field to update the pattern rule.
6 Click the Update Pattern button in the Update Pattern dialog box to update the
existing pattern.
EIO0000004195.10 31
Work Flow
Update Galaxy
After browsing the control project pattern in the configuration procedure (above),
follow these steps to generate an AppObject:
Step Action
2 Click the Browse Control Project button populate the Generation grid with a list of
possible instances.
3 Click the check boxes that correspond to the instances you want to generate.
4 Click the Generate Object button and wait for the generation process to finish.
5 Confirm the completed generation by viewing the generated objects in the AVEVA
System Platform's object browser.
Restore Galaxy
Restoring a backup Galaxy having Asset Link generated assets using the Asset
Link version 4.0 requires the synchronization of the Asset Link generation cache
content. Hence, for the first time when you open Asset Link and perform Browse,
the following message is shown to synchronize the generation cache content.
32 EIO0000004195.10
Work Flow
Migration
Upgrade Asset Link 1.0.0/ Asset Link Asset Link Asset Link Asset Link Asset Link Asset Link
to Asset 1.0.1 user 1.0.2 SP2 user 1.0.2 SP2 user 1.0.2 SP2 user 2.0.0/ 2.0.1/ 2.1/ 2.2 user 3.0/ 3.0.1
Link 4.0 (Imported (Imported (Imported 2.0.2 user user
$EsxCEAsset- $EsxCEAsset- $EsxCEAsset-
Link without Link after Link without
deleting deleting deleting
existing 1.0.1 existing 1.0.1 existing 1.0.2
template) template) SP2 template)
Installa- Uninstall Asset Uninstall Asset Uninstall Asset Uninstall Asset Uninstall Install Asset Install Asset
tion Link 1.0.0/ 1.0.1 Link 1.0.2 SP2 Link 1.0.2 SP2 Link 1.0.2 SP2 Asset Link Link 4.0 for Link 4.0 for
Proce- and install Asset and install Asset and install and install 2.0.0/ 2.0.1/ upgrading. upgrading.
dure Link 4.0. Link 4.0. Asset Link 4.0. Asset Link 4.0. 2.0.2 and
install Asset
Link 4.0.
Using Re-create Asset Re-create Asset Import Asset Import Asset Import Asset Import Asset Import Asset
Asset Link object in Link object in Link 4.0 Link 4.0 Link 4.0 Link 4.0 Link 4.0
Link- System Platform System Platform template - template - template - template - template -
Tem- IDE. Delete IDE. Delete $EsxCEAs- $EsxCEAs- $EsxCEAs- $EsxCEAs- $EsxCEAs-
plate existing Asset existing Asset setLink. setLink. setLink. setLink. setLink.
Link 1.0.0/ 1.0.1 Link 1.0.1 aaPKG. aaPKG. aaPKG. aaPKG. aaPKG.
template and template and (Above the (Above the (Above the
Import Asset Link Import Asset (above existing (above existing existing 2.0.0/ existing 2.1/ existing 3.0/
4.0 template - Link 4.0 1.0.2 SP2 1.0.2 SP2 2.0.1/ 2.0.2 2.2 template) 3.0.1
$EsxCEAsset- template - template ) template ) template) template)
Link.aaPKG. $EsxCEAsset-
Link.aaPKG.
Impact Since previous Since previous Since it is new
version of Asset version of Asset import of Asset
Link template is Link template is Link, there is no
deleted, re-enter deleted, re-enter impact.
Since it is imported from a previous version of Asset Link
settings of Asset settings of Asset
No impact in templates, there is no impact.
Link. Link.
already
No impact in already generated ASP AppObjects.
No impact in No impact in generated ASP
already already AppObjects.
generated ASP generated ASP
AppObjects. AppObjects.
Patterns migration: The patterns files migration takes place while migrating from
any of the previous versions of Asset Link to Asset Link 4.0. In case there are files
that are not migrated then refer to the log file to identify these files.
NOTE: Backward compatibility: If you want to use the pattern files of the
previous versions then use the backup files created during migration of
patterns.
EIO0000004195.10 33
Asset Link Operations
Tabs
Configuration Tab
Galaxy Settings
Configure the Galaxy Settings on the Configuration tab:
Parameter Description
Root Area* Select the type of Root Area in the pull-down menu.
For more details refer to the section Create/
Recreate, page 36.
NOTE:
• This option is available only for Source of
type Process Expert.
Device Name** This device name is an alias for the PAC Modicon
controller in the OFS configuration.
NOTE: A Machine Expert control project does
not require the selection of an OPC UA device.
34 EIO0000004195.10
Asset Link Operations
Parameter Description
DNP3 Configuration*** Telemetry It is an editable field in which you enter the name of
Server Name the Telemetry server.
NOTE:
* This option is disabled for the source SCADAPack
** This option does not appear when the selected source is SCADAPack
*** This option appears only when the SCADAPack is selected as the source
EIO0000004195.10 35
Asset Link Operations
Create/ Recreate
Root Area:
Step Action
1 Configure the Galaxy Settings in the Configuration tab by providing the pattern folder
location and variable file.
2 Select Process Expert in the Source and select the type of Root Area.
3 Open Generation tab and click Browse Control Project to update the objects list.
Result:
• If the galaxy does not have the Root Area then depending on the selected Root
Area type the plant hierarchy is created.
• If there is already a Root Area in the galaxy, but the selected Root Area is
different from the existing one then the hierarchy is deleted and a new one is
created depending on the plant hierarchy. A pop-up message displays the
elapsed time for recreating the hierarchy.
Area:
Step Action
1 Configure the Galaxy Settings in the Configuration tab by providing the pattern folder
location and variable file.
2 Select Process Expert in the Source and select the type of Area.
3 Open Generation tab and click Browse Control Project to update the objects list.
Result:
• If the galaxy does not have an Area then depending on the selected Area type
the plant hierarchy and the Area are created.
• If there is already an Area in the galaxy, but the selected Area is different from the
existing Area then the hierarchy is deleted and a new one is created depending
on the plant hierarchy.
NOTE:
• You can see the created objects in the Model tab of the ASP
• If the parameters required for Runtime Navigation Service do not exist for
the selected Root Area then an alert message (shown below) will appear.
36 EIO0000004195.10
Asset Link Operations
Update/ Move
Root Area:
Step Action
1 Configure the Galaxy Settings in the Configuration tab by providing the pattern folder
location and variable file.
2 Select Process Expert in the Source and select the type of Root Area.
3 Open Generation and click Browse Control Project to update the objects list.
Result: In the existing system change in plant hierarchy may change the internal ASP
attributes of the Root Area, then the corresponding attributes of that system is updated
and displayed in the Attributes tab of that system.
Area:
Step Action
1 In the ASP Model tab drag and drop the objects to the required folder.
2 In Generation tab, click Browse Control Project to update the objects list.
Result: Depending on the change in the plant hierarchy the corresponding Areas are
moved to the respective folders.
By default it displays the first available associated scan group. By default the first
available scan group in DIO is associated with the default scan group in Pattern
which is 1. Additionally you can associate the same DIO's scan group with more
than one Pattern's scan group. Click to add a new scan group association
EIO0000004195.10 37
Asset Link Operations
and to delete an existing scan group. You configure up to ten scan groups
and associate them in OPC Client.
Based on the association done in Configure Scan Groups and the scan group
position set in the pattern as shown in the figure below, perform Browse and
Generate, then the generated attribute values has the configured scan groups, so
that these attributes are read at different intervals.
38 EIO0000004195.10
Asset Link Operations
Step Action
1 Using the Windows search utility (found either in the Start menu or in the Task bar), find
and open the Operation Control Management Console.
2 Expand the navigation tree in the SMC console to find the first part of the OI address in
the OI.GATEWAY configuration. This information corresponds to user-defined names.
In this case, OPCUA.DeviceGroup is the first part of the OI address:
3 In the navigation tree, click DeviceGroup to open the Node Type dialog box.
4 On the DeviceGroup Parameters tab, click the Browse OPCUA Server button to view
the variable tags.
EIO0000004195.10 39
Asset Link Operations
Patterns Settings
Configure the Patterns Settings on the Configuration tab:
Parameter Description
Patterns Path Enter the path to the .xml pattern files that Asset Link applies (The
common pattern schema .xsd files has to be in this same folder). These
patterns are scanned each time this path changes after you reopen
Asset Link or press the Refresh Patterns button in the Patterns tab.
Pattern Project This is the .xsy file that is used to create and update the pattern.
If the trial period has expired, it displays a message “Asset Link trial period
expired. Activate a license and restart Asset Link Tool ”. For more details, refer to
Product Licensing, page 16.
Parameter Description
Control Project This field contains the full name of the file that Asset Link scans for
variables:
• .xsy : Files with this extension correspond to the selection of a
Control Expert project in the Source field.
• .xml file of same name as .xsy file has to be available in the same
path for Plant Model creation, page 71.
• .xml : Files with this extension correspond to the selection of a
Machine Expert project in the Source field .
Application Project This field contains the path where the .xml application file is present.
(Optional): This file is used during Browse operation to Generate the system
platform attribute values based on application data, as per the
configuration of the Action Retrieve elements of the pattern. For more
details refer to Application Project, page 59.
Object Wizard
The attributes and graphics can either be enabled or disabled depending on the
choices and options in the instances using the Object Wizard feature. The
primary requirements to use this feature are:
• Template must be upgraded with the Object Wizard
• The Patterns must be upgraded with the Object Wizard parameters.
Steps Action
40 EIO0000004195.10
Asset Link Operations
Asset Link provides the flexibility to browse the source project from different source
type. By default, the Source Project is prepopulated based on Configuration Tab
inputs. You can still change these if necessary.
4 Configure the Naming Convention of control variable as per the naming convention
followed in the control project, to identify the assets from the control project.
5 Prefix and Suffix text input controls are enabled based on the naming conventions
control variable requirements. Prefix and Suffix are case sensitive.
• The control variable name Starts with Tagname then the suffix is enabled.
• The control variable name Ends with Tagname then the prefix is enabled.
• The control variable name Contains with Tagname then the prefix and suffix are
enabled.
NOTE: If the control variable name Contains %Tagname% or %Tagname%_, then
the prefix is mandatory. If the variable name Contains _%Tagname% then the
suffix is mandatory.
6 The TagName must be configured for creating the pattern and template based on well-
known tags or user preferred tags.
The TagName is optional field if the selected Naming Convention used in the control
variable contains an underscore, otherwise the field is mandatory. More than one
TagName can be configured by using comma (,) separator. Tagname is case sensitive.
For example, if the control variable name for one of the analog input assets is
AnalogInput1_AInputGP_ST, then enter the TagName as AnalogInput1. The system
finds this asset AnalogInput1 from the .XSY file and displays it in the Create Patterns
and Templates dialog box on click of the Create button.
9 The Pattern Save Location is pre-populated based on the inputs from the
Configuration Tab. Patterns created are saved to this configured location. You can
modify these if necessary.
EIO0000004195.10 41
Asset Link Operations
10 Click on Analyze.
Result: It displays a dialog box with the assets from the source control project file based
on configuration inputs and displays these assets in the summary to create patterns and
templates.
Result: This displays the pattern content which are rules to identify the assets based on
control variable names in the source file, and set the Actions in each rule to assign the
control variable data to the corresponding System Platform attributes.
In Create Rule to exclude or include the control variable. Based on condition this control
variable exists in the source project, assets are identified.
42 EIO0000004195.10
Asset Link Operations
The attributes listed in template are the attributes selected in the Action set or Action
Retrieve actions of each regular rule. Auto creation of template will create with the
attributes displayed in this dialog box.
12 Edit the proposed template and pattern name to a unique name. The proposed pattern
and template name column is editable, and when a new name is entered, the system
validates that the name is unique within the grid and also verifies whether the pattern
name and the template name already exist.
The proposed pattern and template name is derived from the asset name. Select the
Parent Template from which to create the derived template. By default, $UserDefined
is the parent template.
13 Select the desired Proposed Pattern Name and Template, and then click on Create.
14 Navigate to Generation Tab. Perform a Browse to identify assets based on the auto
created pattern and template. Then you can Generate assets. For more details, refer to
Generation Tab, page 61.
EIO0000004195.10 43
Asset Link Operations
Patterns Tab
Introduction
Each row in the Patterns table represents a single .xml file in the configured
folder. You can select or deselect patterns in this list.
License Availability
The availability of patterns depends on the license activation status:
Status Behavior
License is not activated. Only three patterns are loaded. Only instances related to those
templates are available for generation.
License is activated. All available patterns are loaded. Instances related to the templates
are available for generation.
Buttons
These buttons appear on the Patterns tab:
Button Description
Refresh Patterns Click this button to reload the configured pattern files.
Save Button Click this button to save the changes you made for the active pattern.
Create Pattern Click the Create Pattern button to open the Create Pattern dialog box
and define these parameters:
• TagName: Enter the name of the instance for which the pattern is
created. (For example:AnalogInput1_1).
• Prefix in the Tagname: Assign a tagname prefix to the new
pattern.
Click the Generate Pattern button in the Create Pattern dialog box to
apply the changes you made in the Create Pattern dialog box.
44 EIO0000004195.10
Asset Link Operations
Button Description
Add Pattern Click Add Pattern to open the Add Pattern file(s) dialog box. Select
the pattern files (.xml format) and click Open.
Result: The pattern files are copied to the configured location and is
added in the patterns grid.
Update Pattern Click the Update Pattern button to open the Update Pattern dialog box
and define these parameters:
• Version: This field shows the implemented pattern version.
• Updated: This field shows the time of the last pattern update.
• Tagname: Assign a tagname to the new pattern.
• Prefix in the Tagname: Assign a tagname prefix to the new
pattern.
Click the Update Pattern button to apply the changes you made in the
Update Pattern dialog box.
Another dialog box Source Pattern Found appears which indicates the
detection of the source pattern .xml file.
• Clicking on Keep Changes opens the pattern in the Pattern
Editor, page 46.
NOTE: The Save button is enabled only if the Version is
changed or changes are made to the pattern.
• Clicking on New Pattern opens the pattern in the Pattern Editor,
page 46.
NOTE: The Save button is enabled only after a new name is
provided to the pattern.
Table Columns
These columns appear on the Patterns tab:
Column Description
Pattern File This column displays the names of the available pattern files.
Last This column displays the file saved time stamp for the Pattern File.
Modification
Date Time Applies when the pattern file is generated or modified by the Asset Link tool or
manually saved.
Valid This box is selected (checked) only when the pattern has passed the validation
process, including the alignment to the expected pattern schema.
Template ID This ASP template identifier is associated with the attribute in the Pattern File.
View Click View to open the pattern file in the read-only mode. The content of the
pattern file is displayed in the Pattern Editor, page 46.
Edit Click Edit to open the pattern file in the edit mode. The content of the pattern
file is displayed in the Pattern Editor, page 46.
NOTE:
• If you have opened a pattern file in the edit mode and try to edit the
same pattern file in another derived template instance, it opens in
read-only mode.
• To edit the pattern file in the derived template instance, you have to
close it in the first instance and then reopen the pattern file in the
derived template instance.
These columns contain values only after you enter a valid path in the Patterns
Path field on the Configuration tab, page 40.
You can create a copy of existing pattern file or delete it.
EIO0000004195.10 45
Asset Link Operations
• To create a copy of pattern file, right click on the required pattern file and click
Duplicate. A message is displayed with the pattern file name having a suffix
_Copy.xml. Clicking OK creates a copy of pattern file which is then displayed
in the grid.
• To delete a pattern file, right click on the required pattern file and click Delete.
A message is displayed asking for confirmation, click Yes to delete.
Pattern Editor
When you click View or Edit, the pattern editor displays the content of pattern file
in the Patterns tab itself.
Section Description
click on Other details Version Displays the version of the pattern file.
button
Created using Displays the TagName used in the XSY
file.
Last Modified Displays the most recent time stamp of
the modified pattern file.
Description
Displays the description of the different options in the Pattern Editor when the
mouse pointer is placed on them.
46 EIO0000004195.10
Asset Link Operations
Pattern Rules
Section Description
Add Click Add Rule to add a new rule in the pattern file.
Rule
The newly added rule is displayed under the Rules node.
When you click on rule, the associated details are displayed in the Rule Details section.
EIO0000004195.10 47
Asset Link Operations
Section Description
Add Click Add Include Rule to add a new include rule in the pattern file.
Include
Rule Include Rules are common rules which are created in one pattern, can be included in
the multiple patterns.
A pop-up is displayed asking to choose if the rule has to be added as New or Existing.
• New: Provide a name for the rule and then the rule is created as illustrated in the
graphic below.
• Existing: Select an existing Include Rule from the location, it is saved in your
system. The selected rule is added as illustrated in the graphic below.
When you click on Include Rule, the associated details are displayed in the Rule
Details section.
48 EIO0000004195.10
Asset Link Operations
Rule Details
Section Description
Settings Enable Enable this option to activate and consider the rule during Browse
the rule Control Project.
during
Browse By default, this option is enabled.
Control
Project
Negate • Enabled: If the criteria for the rule element is not satisfied, the
elements and the rules are executed in the opposite way.
• Disabled: If the criteria for the rule element is not satisfied, the
elements and the rules are not executed.
By default, this option is enabled.
◦ You can either type the variable name in the Search bar
or scroll down to find the respective attribute.
EIO0000004195.10 49
Asset Link Operations
Section Description
50 EIO0000004195.10
Asset Link Operations
Section Description
EIO0000004195.10 51
Asset Link Operations
NOTE: You can perform the following actions on the header rows of Variables
and Actions: tabs.
• Sort Ascending: This option allows you to arrange the Variables or
Actions in ascending order.
• Sort Descending: This option allows you to arrange the Variables or
Actions in descending order.
• Clear Sorting: This option is enabled only if you have selected either
Sort Ascending or Sort Descending.
• Conditional Formatting: This options allows you to format the different
cells of the column based on their values.
• Column Chooser: This option opens another pop-up window which
displays the hidden columns which can be dragged and dropped to the
grid.
• Hide Column: This option allows you to hide the selected column.
• Pinned State: There are three options available:
◦ Unpin Column: This option allows you to move the column to its
default position.
◦ Pin at Left: This option allows you to move the column to the left
◦ Pin at Right: This option allows you to move the column to the right
• Best Fit: This option resizes the columns depending on their contents.
Save Changes
Click to save the changes you made in the pattern editor. A message is
displayed asking for confirmation, click Yes to save. All the changes made in the
pattern editor are saved to the pattern files.
52 EIO0000004195.10
Asset Link Operations
Step Action
3 Select one of the Pattern then Click on Edit and open the Pattern Editor.
4 Configure the default naming convention for the control variable as required. By default,
the %Tagname%_ is configured under Starts With.
5 Configure the default naming convention as per requirements. For more details refer to
Naming Convention.
EIO0000004195.10 53
Asset Link Operations
Step Action
7 Click on Apply to apply this naming convention to the control variables used in this
pattern rules.
The naming convention is to be applied in the pattern rules for both the new and existing
control variables, or exclusively for the new variable.
8 Click on Existing And New Control Variables to apply the configured naming
convention to the existing control variables in the pattern rules and also applies to the
new control variables added in existing rules or in new rules.
NOTE: If the variables could not be modified with new naming convention as they
do not match with previous configured naming convention, then it is displayed as
follows
Result: The control variables are updated with the new name standard after the
modifications are applied.
9 Navigate to one of the Pattern Rule and click on Configure in Action Grid.
Result: The System Platform attributes are displayed in a new pop-up window for action
configuration with the default naming convention values already applied.
10 Optionally, with Action type set to Action Set, you can prefix/suffix the destination value
as per the control variable names in the Destination Value columns. For example, to
access safety-related control variables, Starts With column value can be prefixed with
"Safe."
54 EIO0000004195.10
Asset Link Operations
Step Action
NOTE: Browse of Control Project detects and displays the assets and with
proposing the asset name, as per control variable condition in the pattern creation
rule.
13 Select/Select All the necessary assets and perform Generate.
Token Mechanism
Token mechanism allows you to configure the pattern for detection of multiple
variable for single asset using the Pattern editor. Once the pattern is configured,
clicking on Browse Control Project will identify the assets within same variable
based on the input from the variable file and the token which matches with the
pattern file. The table below with an example explains the identification of assets
using the token mechanism.
Stage Description
TypeName = AINPUT1_ST_DDT
3 If the variable satisfies the criteria from the pattern then the tokens are:
%1% = FI1001
%2% = AINPUT1
%3% = AI4
4 With the use of the token values in the previous stage, the asset is identified from the
Actions in the Creation Rule.
5 Assets are identified based on the input provided in ActionCreate value. The asset of
the above variable is AI4 which is determined by fetching the value of %3% from the
Token.
EIO0000004195.10 55
Asset Link Operations
The various scenarios for Action Create, Local Tokens and Global Tokens are
explained below.
1. Action Create: The Action Create in the pattern file is modified based on the
scenarios mentioned in the table below. The inputs considered for the
creation rule are:
Name =FI1001_AINPUT1_ST
TypeName = AINPUT1_ST_DDT
Pattern Condition
Scenario Object ID
Action Create Criterion Found
Prefix as a pre- Test_%1% %%_AINPUT1_ST Test_FI1001
defined text.
Suffix as a pre- %1%_Test %%_AINPUT1_ST FI1001_Test
defined text.
Pre-defined text Test_%1%_Test %%_AINPUT1_ST Test_FI1001_Test
for both prefix and
suffix.
Only the prefix as Test_%1% %%_AINPUT1_ST Test_FI1001
a pre-defined text
(With attribute
filled in generated
instance)
2. Local Tokens: The inputs considered for the creation rule in the below
mentioned scenarios are:
Name =FI1001_ONE_AINPUT1_ST
TypeName = AINPUT1_ST_DDT
Pattern Condition
Scenario Object ID
Tag Name Value
56 EIO0000004195.10
Asset Link Operations
3. Global Tokens: The table below explains the support of global tokens for the
regular rules.
EIO0000004195.10 57
Asset Link Operations
Step Action
1 In the Configuration tab, add a Variable file having multiple variables with one asset
existing in galaxy with different wizard configuration.
2 Navigate to the Patterns tab and edit the Patterns in the Patterns editor.
3 Add the Options and Choices for the selected rule (For more details see, page 58)
The Object Wizard consists of two components the Choice Groups and
Options.
• Choice Group consists of a prompt and a set of two or more possible
responses (Choice Group).You can add or remove Choice Group by
clicking on or . It contains a minimum of two Choices. By default the
first Choice is selected which can be changed manually.
◦ Choice is an element of Choice Group and only one Choice can be
selected at a time. You can add or remove Choices by clicking on or
respectively.
• Option represents a binary choice (TRUE if check box is selected and FALSE
if unselected) and the various options are not mutually exclusive. Unlike
Choices there is no limitation on the number of Options that can be selected.
You can add or remove Options by clicking on or respectively.
Click to save and close the object editor once the necessary modifications of
Choices and Options are complete.
58 EIO0000004195.10
Asset Link Operations
Application Project
The Application Project allows to generate the SCADA application related data
based on supervision values present in Application Project file. You have the
capability to configure the attributes of an asset to fetch the data from the
application project file (.xml) like that of the control project file (.xsy).
In the Pattern Editor, page 46 the Regular/ Include rules refer to the application file
(.xml) for setting the System Platform attributes. In the Actions tab, page 50 of the
pattern editor the Source Type by default is set to Control Data which means that
the data is retrieved from the control project file. You can select Instance Data if
the data has to be retrieved from Application project. This is allowed only when the
Action is set to Action Retrieve.
In case the Source Type, is Process Expert, the application project .xml is
generated during the EPEforASP build operation. When you select the .xsy in the
Asset Link Configuration tab, the application project .xml is automatically filled in
the Application Project field as shown in the following figure (it is a read-only
field in this case).
EIO0000004195.10 59
Asset Link Operations
For the other sources, you must browse for the location where the application
project .xml is present. Refer to the sample .xml present in the following path
C:\ProgramData\Schneider Electric\Ecostruxure Control Expert -
Asset Link\Demo Template and Patterns\Application Project
Schema to create this file.
This Application Project .xml can be used to configure the Source Variable
details, for example the Name and Value in the Actions tab of the pattern editor.
60 EIO0000004195.10
Asset Link Operations
The details can be found under the Parameter Identifier present in the
Application Project .xml.
During Browse operation, for the assets whose tag name matches with the
Application Project .xml ApplicationInstance element identifier, the attributes are
fetched from the instance data depending on the Parameter identifier configured
in the Name and Value fields in the Pattern and then the attribute values are
generated.
Generation Tab
Introduction
Use the features on the Generation tab to browse variables in the configured
control project file to find matches for the selected patterns
NOTE: By default, the Generation tab is available only when valid
configuration data is configured and saved on the Configuration tab, page
34.
Overview
Generate and update an ASP objects:
Stage Description
3 Create and update an ASP AppObjects. The browsed list in the Generation tab is
selectable. Only selected objects instances are created and updated.
EIO0000004195.10 61
Asset Link Operations
Browse Variables
Click the Browse Control Project button to start the process of exploring
variables in the control project to find those that match the modeling that is
described in the currently described patterns. Then the tool automatically explores
Galaxy to find the appropriate an ASP AppObjects to create, update, or re-create.
This table shows the multiple combinations for which Asset Link impacts the
generation of instances:
Asset available Pattern match Available Tool detects this object to create.
- with 5 for all 5
variables variables
Pattern is Not Available Tool does not find this object and hence it is
available for not listed in the Generation Tab.
matching all 5
variables This object (if it is HMI variable) is ignored,
it is available in the log file at the following
location: C:\ProgramData\Schneider
Electric\Ecostruxure Control Expert - Asset
Link
No match with Available Tool does not find this object and hence it is
the pattern not be listed in the Generation Tab.
available for all
5 variables This object (if it is HMI variable) is ignored,
it is available in the log file at the following
location: C:\ProgramData\Schneider
Electric\Ecostruxure Control Expert - Asset
Link\Logs\BrowseControlProject_Log_
datetimestamp.txt
Pattern Available Tool does not find this object and hence it is
matches with 3 not listed in the Generation Tab.
variables out of
5 variables This object (if it is HMI variable) is ignored,
it is available in the log the file at the
following location: C:\ProgramData
\Schneider Electric\Ecostruxure Control
Expert - Asset Link\Logs
\BrowseControlProject_Log_
datetimestamp.txt
Pattern does Available Tool does not find this object and hence it is
not exist not listed in the Generation Tab.
62 EIO0000004195.10
Asset Link Operations
Click OK and then click Browse Control Project button to browse the control
project.
Considerations:
• If this option is not selected, then the Browse Control Project only displays
the ASP AppObject which is in Create, Re-Create, or Update status.
EIO0000004195.10 63
Asset Link Operations
Configure Hierarchy
Hierarchy: Editable field allowing you to enter the Asset location for all the
selected rows.
Object ID, Template ID, Hierarchy Information: Read-only fields displaying the
rows which are selected in the generation table.
64 EIO0000004195.10
Asset Link Operations
Table Columns
These columns appear on the Generation tab:
Column Description
Select Select the check box in this column to select the instance in the
corresponding row.
Object ID This column reports the name of the ASP object that will be created,
updated, or re-created.
Template ID This column reports the name of the ASP template that will be applied.
Action This table reports the action that applies to the ASP object:
• Create: If the ASP AppObject does not already exist in Galaxy, it is
created.
• Update: Update an ASP AppObject in Galaxy if it is derived from the
same ASP template that is defined in the pattern that matches that
object.
• Re-Create: Sometimes, an ASP object in Galaxy is derived from an
ASP template that is different than the one defined in the pattern that
matches the object. In such cases you can use the Re-Create action
to delete the original object and create one that is based on the
appropriate template.
• No Action: When an ASP object in Galaxy is derived from the
template that is defined in the pattern that matched that object, the
No Action confirms that the object does not change.
No action is displayed usually in grey color. When displayed in red
color, it indicates that the template or pattern needs correction as
some of the AVEVA System Platform template attributes mentioned
in Pattern Actions are not found in the template or are not writable,
the details are found in the CSV file path displayed below the
progress bar in the Generation tab.
• To be Resolved: If any conflict has been detected in the asset name
(comes from control project file), To be Resolved is displayed. To
resolve the conflict, click the Resolve button, page 74.
• Rename: When the Process Expert folder is renamed then the
Action column for that folder is updated as “Update”, see, page 75
NOTE: The above options are enabled only when the browsing of a
control project discovers at least one instance to generate.
EIO0000004195.10 65
Asset Link Operations
Column Description
Result This column reports the result of the action that applies to the ASP object.
Description This column describes the objects that are found in Galaxy.
Proposed Area This column reports the area in which the respective asset will be
assigned.
Area This column reports the Assigned Area that corresponds to the ASP
AppObject (if the object is found in Galaxy).
Container This table reports the container of the ASP AppObject if the object is found
in Galaxy and is contained in another ASP AppObject.
Hierarchical Name For ASP AppObjects that are found in Galaxy, this table reports the
hierarchical object name in this format: <Container>.
<ContainedName>
Derived From This column reports the ASP template that was used to create the object if
the object is found in Galaxy. Use this column to identify the template that
was previously used to suggest the re-creation of the ASP AppObject.
Hierarchy This column provides the Asset location. The Asset location can be
Information manually entered for each of the objects separately or you can use the
Hierarchy option to provide the same information for multiple objects.
NOTE: Ensure the hierarchy information provided here is same as
what is configured in the Telemetry Server.
Buttons
These buttons appear on the Generation tab:
Button Description
Select All Candidates Click this button to select the objects that require processing (Create,
Update, Re-create), objects with No Action will not be selected. The
default actions are taken into consideration, which means that if the
same object could be updated or re-created, only the row related to
Update is selected.
Unselect All Click this button to deselect all objects for processing.
Resolve Click this button to resolve the conflicts of objects and folders.
Check Boxes
These check boxes appear on the Generation tab:
Select Create Click this button to add to the list of selected objects for which the
Create action is proposed.
Select Re-Create Click this button to add to the list of selected objects for which the Re-
Create action is proposed.
Select Update Click this button to add to the list of selected objects for which the
Update action is proposed.
Select No Action Click this button to add to the list of selected objects for which No
Action is proposed.
66 EIO0000004195.10
Asset Link Operations
Generate Objects
Use these buttons to stop or start the generation process:
Button Description
Generate Objects Click this button to process the selected rows and update Galaxy
accordingly.
• Generate Objects button is enabled only if at least one selected
candidate available in the data grid.
• Generate Objects button is in disabled state while generation is in
progress.
NOTE: Accordingly, a summary of the number of selected objects
per action appears.
The status for each processed object appears in the Result column:
Action Result
Select Create Displays Created when the object was successfully created. If
unsuccessful, it displays the reason for not being created.
Select Re-Create Deletes the existing object and recreates the object. Displays Created
when the object was successfully created. If unsuccessful, it displays the
reason for not being created.
Select Update Displays Updated when the object was successfully updated. If
unsuccessful, it displays the reason for not being updated.
Select No Action No changes were made to the object. Displays Updated to inform that it
is up to date.
EIO0000004195.10 67
Asset Link Operations
Monitor Tab
Overview
The Monitor tab allows you to notify for any modifications in the Control Project
file (.xsy) (such as file replaced or edited) and .xml file while it is in use based on
the time interval.
Configuration
Configure the following settings:
Settings Description
Default: Enabled
Disable Select this to disable the monitoring feature.
The Asset Link for EcoStruxure Control Expert offers you the choice of enabling or
disabling the Auto Browse and Auto Generate actions. By default Auto Browse
and Auto Generate are disabled.
NOTE:
• The Monitor Tab must be enabled with mandatory Time Interval settings
to enable Auto Browse and Auto Generate.
• Auto Generate is applied to assets with the Create action, only in GR
node.
• If Auto Generate is enabled, Auto Browse is enabled automatically.
68 EIO0000004195.10
Asset Link Operations
The following table describes the Auto Browse and Auto Generate procedures:
Step Action
Result: When the configured control project source file is modified, and if this
option Auto Browse is enabled, it automatically triggers the browse operation.
Also if Auto Generate is enabled, after browse, it automatically performs the
Generation.
NOTE: Auto Browse and Auto Generate actions are triggered only in the
Asset Link opened in GR node. If working with Asset Link template opened on
more than one computer, the Auto Browse and Auto Generate actions are
skipped.
When the configured control project source file is modified, if the option Auto
Browse is enabled , it automatically triggers the browse operation. The Check
Source Changes option is enabled by default. However, you can choose to
modify the browse option to Check All Changes or Check AppObjects Changes
and the Auto Browse is still functional.
EIO0000004195.10 69
Asset Link Operations
Auto Generation is triggered after the browse action if Auto Generate is enabled.
Auto Generate happens only for assets of Create action. Assets with Update,
Re-create, No Action or Resolved are not considered for automatic generation.
NOTE: During generation if the System Platform got abruptly closed, then
after reopened System Platform and on opening of Asset Link, it shows a
message in the Generation Tab as last generation was not successful,
perform another browse and generate to generate the remaining assets.
Information Tab
The Information tab displays the following details of Ecostruxure Control Expert
Asset Link.
Field Description
Log Files Displays the path where the log files are saved.
User Guide Displays the path where the user guide is present.
70 EIO0000004195.10
Asset Link Operations
Configuration Tab
Configure the following settings:
Galaxy Source Select Process Expert (.xsy files) from the pull-down menu.
Settings
Protocol For details, refer to configuration, page 34.
Device Name
DIO Name
Scan Group
OI Address
Reference
Optional Prefix
of the AppObject
Tagname
Patterns Patterns Path Enter the path to the .xml pattern files that Asset Link applies.
Settings
For example: C:\ProgramData\Schneider Electric\Ecostruxure
Control Expert - Asset Link\GPL Patterns
NOTE: The common pattern schema .xsd files has to be in
this same folder.
These patterns are scanned each time and this path changes after
you reopen Asset Link or press the Refresh Patterns button in the
Patterns tab.
Pattern Project This is the .xsy file that is used to create and update the pattern.
EIO0000004195.10 71
Asset Link Operations
Control Project This field contains the full name of the file that Asset Link scans for
variables.
Application When you configure the control project for process expert, by
Project default, the application XML is present in the same location as the
control project, hence it is automatically filled. For more details
refer to Application Project, page 59.
Patterns Tab
For details about this tab, refer to the patterns tab, page 44 chapter.
Generation Tab
For more details about this tab, refer to the generation tab, page 61 chapter.
These columns appear on the Generation tab:
Column Description
Object ID This column displays the asset or the area name which is configured in the
input file (.xsy).
• If you have resolved asset name generated in ASP AppObject, then the
Object ID displays “Original Name(Resolved Name)”.
• If you have resolved area name generated in ASP AppObject, then the
Object ID displays “Original Name(–>)” to refer to the resolve area
name in Area column.
Template ID This column displays the respective derived type of template for asset and
area.
Proposed Area This column reports the hierarchical area name that corresponds to the
EcoStruxure™ Process Expert .xml file.
NOTE:
• Areas are modified based on hierarchy given in the .xml file.
• Areas which are modified with updated hierarchy are displayed in
the Model tab of the ASP.
• If the area of the object is already deployed, it un-deploys and
regenerates the area.
NOTE: The Area object listed here are of derived template type
$aPSxAreaGP. If any area object created by you using derived template type
$PSxAreaGP, then it is not managed by Asset Link. You have to select the
respective area along with the asset in order to generate the asset at the right
location.
72 EIO0000004195.10
Asset Link Operations
Create
You can create the objects based on the hierarchy of EcoStruxure™ Process
Expert for AVEVA System Platform Plant Model provided in the .xml file:
Step Action
1 In the Generation tab, select the objects with status displayed as Create in the Action
column.
2 Click Generate Objects, page 67.
Result: The Result column displays the status as Created when the objects are
successfully created.
Result: The Proposed Area column displays the hierarchy of created objects with
corresponds to the Process Expert Plant Model .xml file and the Area column displays
the ASP hierarchy.
NOTE:
• For the object of type “Area”, the Proposed Area column is empty.
• If the object of type “Area” is selected to generate, the Proposed Area
column displays the hierarchy of area.
• If only instance is selected without respective area, only instance is created
under unassigned area.
You can see the created objects in the Model tab of the ASP.
Move/Update
You can move the objects to other folders in the Model tab of the ASP hierarchy.
To move the objects:
Step Action
1 In the Model tab, drag and drop the objects to the required folder.
2 In the Generation tab, click Browse Control Project to update the objects list.
Result: The Area column displays the ASP hierarchy of the newly moved object and
Proposed Area column displays the hierarchy corresponds to the Process Expert Plant
Model .xml file.
To retain the hierarchy of the Process Expert Plant Model in the Model tab of ASP,
click Generate Objects.
EIO0000004195.10 73
Asset Link Operations
Resolve Conflicts
You can resolve the conflicts of objects and folders. Conflicts are detected when
there are identical names of objects and folders, incorrect naming format, or
exceeding 32 characters limit.
The status of conflict is displayed as To be Resolved in the Action column.
NOTE:
• You cannot generate the objects in To be Resolved status.
• If renamed object has a conflict, it is detected as To be Resolved status.
Post resolve, it will process as a new object with Create action.
Step Action
3 Click OK.
Result: The selected conflicts are resolved and the status is displayed as Resolved
in Action column and the respective item is selected in the Generation tab.
Resolve Window
These columns appears on the Resolve window:
Column Description
Select Select the check box in this column to select the object which has a detected
conflict to resolve.
Object ID This column displays the name of the ASP object that is in conflict status.
Template ID This column displays the name of the ASP template that is in conflict status.
Proposed Name This column displays the proposed name of object. You can edit and provide
your own name.
Description This column displays the description of conflict of the respective objects.
Select All Select this check box to select all the objects which have a detected conflict to
resolve.
Unselect All Select this check box to unselect the objects.
74 EIO0000004195.10
Asset Link Operations
Rename
In the System Platform you can handle the EcoStruxure™ Process Expert folder
rename by renaming the respective areas.
Step Action
1 Navigate to the Configuration tab and provide the folder path for the Variables
and the Patterns files.
2 Navigate to the Generation tab and click Browse Control Project.
3 The Action column of the renamed folder is updated as “Update” and the Result
column displays "Diff: Renamed".
NOTE:
• If the unique identifier is the same for two different objects from the
Process Expert source, then, the object does not detect as "Diff:
Renamed". In this case, "Create" action is performed.
• If the respective object is in deployed state, the Result column displays
“Source object rename/ location change detected. Undeploy
application object to continue”.
5 The selected folder is renamed and this can be viewed in the Modal tab of the
System Platform.
The actual Root Area coming from EcoStruxure™ Process Expert is named as
“Root” and converted into system name when you execute using Asset Link. This
is notified to you in the Result column of the Generation tab.
Step Action
1 Navigate to the Configuration tab and provide the folder path for the Variables and
the Patterns files.
2 Navigate to the Generation tab and click Browse Control Project.
3 If the Action column of the Root Area which has been replaced with System Name
displays “Create”, then Result column displays Root from source is replaced with
System Name.
EIO0000004195.10 75
Pattern Files
Pattern Files
Introduction to Syntax and Structure
Pattern File Syntax
Introduction
The source pattern file is an exported control project file that serves these
functions:
• The file defines the method for extracting control project variables that
correspond to specific asset types.
• The file defines the reprocessing of this information to create or update the
corresponding ASP AppObjects through the use of ASP templates.
• The file determines the presence of asset instances in the control project.
• The file indicates the ASP template to be used in the supervision and control
of such asset types from the ASP.
• The file includes the ASP AppObject attributes according to data found in the
control project.
Structure
This table describes the main components of the pattern file:
Component Description
Pattern Header The header describes the main data of the pattern, like the ASP template
that is associated with it, the ASP AppObject that was used to create it,
and the date and time of the most recent modification.
List of Rules This list describes the exploration of control project variables to determine
the presence of an asset that needs to be created as an ASP AppObject in
the ASP Galaxy. The list determines the data to be retrieved from control
project variables (not only ASP AppObject IO references, but also
descriptions, initial values, etc.). The list also includes ASP AppObject
user-defined attributes so you do not have to enter the same information
separately for control and supervisory purposes. Each rule is defined by
these components:
• Rule Header: This header identifies the rule, provides details about
the rule creation, indicates if the rule was manually modified. etc.
• List of Criteria: These criteria determine the data that constitutes
ASP AppObjects. The syntax of the criteria allows you to define
naming conventions that are expected from control project variables
to detect the presence of the asset and collect data that can be used
later from the list of actions that are required for the ASP AppObject
User Defined Attribute(s) (UDAs).
• List of Actions: The actions in this list are executed when the
criteria that is defined for the rule is satisfied. The list also provides
the creation of ASP AppObjects and the manner in which they
contribute to the ASP AppObject UDAs with information found within
the criteria.
Syntax Components
This is a simple example of the syntax that is used in the patterns:
</variables>
76 EIO0000004195.10
Pattern Files
start-tag <section>
end-tag </section>
EIO0000004195.10 77
Pattern Files
<VariablesExchangeFile>
<dataBlock>
[…]
</variables>
[…]
</variables>
[…]
[…]
</variables>
</dataBlock>
</VariablesExchangeFile>
The set of variables elements contain two attributes, name and typeName.
Variables Element
Each variables element contains a set of different elements that define more
information about the variable:
<variables name="RUB1_CONDSUM1" typeName="CONDSUM1">
<comment>RUB1 COMMENT</comment>
<instanceElementDesc name="COND01">
<instanceElementDesc name="REQREARM01">
</instanceElementDesc>
<instanceElementDesc name="SAFEPOS01">
</instanceElementDesc>
<instanceElementDesc name="BYPASSDIS01">
</instanceElementDesc>
</variables>
78 EIO0000004195.10
Pattern Files
Pattern Definition
About Pattern Definitions
Pattern Definition Elements and Sub-elements
Access the pattern definition elements and their sub-elements by expanding a
visible element:
Header Element
The Header element contains these sub-elements:
EIO0000004195.10 79
Pattern Files
Element Description
ASPTemplateId This identifier is the exact name of the ASP Template, used for generating
new instances when this pattern is matched.
UpdateDateTime This sub-element reports the date and time of the last modification to the
pattern.
<Header>
<ASPTemplateId>$aPSxMotor</ASPTemplateId>
<Version>1.0</Version>
<UpdateDateTime>2017-10-18 12:00:00</UpdateDateTime>
<ASPAppObjectTagname>MOTOR1</ASPAppObjectTagname>
<PrefixLength>0</PrefixLength>
<SourceControlFile/>
</Header>
Rules Element
Rules Element
This topic describes the functionality of the elements and sub-elements that you
see when you expand (+) the Rules element in the pattern definition flowchart,
page 79 through this path:
PAC_WSP_Pattern/Rules
Expand (+) the Rules child element to see these sub-elements:
80 EIO0000004195.10
Pattern Files
Element Description
<Rules>
<RuleInclude file="iPSxCondsum1.ixml"/>
</Rules>
CreationRule
Introduction
This topic describes the functionality of the elements and sub-elements that you
see when you expand (+) the Rules element in the pattern definition flowchart,
page 79 through this path:
PAC_WSP_Pattern/Rules/CreationRule
CreationRule Element
CreationRule element descriptions:
Element(s) Description
attrib- Id The attributes for this element provide practical information about the
utes element.
Comment
RuleHeader This element establishes information for the rule.
Criteria This element contains a set of criteria that are satisfied to execute the
rule.
Actions This element contains actions that are executed when the Criteria
are satisfied.
EIO0000004195.10 81
Pattern Files
RuleHeader Element
Follow this path to access this element:
PAC_WSP_Pattern/Rules/CreationRule/RuleHeader
Expand the RuleHeader element to access these elements in the
RuleHeaderType area:
• Auto: This Boolean determines the way that the rule was created:
◦ TRUE: The rule is generated automatically through the pattern discovery
process.
◦ FALSE: You created the rule manually.
• Updated: This Boolean value has these values:
◦ TRUE: The value is TRUE for manually created rules and for automatically
generated rules that you can edit.
◦ FALSE: You cannot edit the rule with Asset Link.
• Enabled: This Boolean controls the application of the rule during bulk
processing:
◦ TRUE: The rule is applied during bulk processing.
◦ FALSE: The rule is ignored during bulk processing but retained in the
pattern file.
This is an example of a RuleHeader element:
<RuleHeader>
<Auto>true</Auto>
<Updated>false</Updated>
<Enabled>true</Enabled>
</RuleHeader>
Criteria Element
Follow this path to access this element:
PAC_WSP_Pattern/Rules/CreationRule/Criteria
The Criteria element contains a set of criteria that are satisfied for the
execution of actions. Every criterion in the Criteria element resolves to TRUE
before the execution of an action.
Expand the Criteria element to access these elements in the
CriteriaCreateType area
• CriterionFound: This element tries to locate specific kind of name for
variables in the control project.
• CriterionLike: For each match found by CriterionFound, this element
assesses the validity of the match.
The Criteria element represents a sequence from 1 to n of:
• CriterionFound
• CriterionLike
The combination of CriterionFound and CriterionLike is one set of
conditions in the Criteria Element.
CriterionFound Element
Follow this path to access this element:
PAC_WSP_Pattern/Rules/CreationRule/Criteria/CriterionFound
82 EIO0000004195.10
Pattern Files
<Value>%%_DEVCTL_ST</Value>
</CriterionFound>
<comment>MOTOR1</comment>
</variables>
</variables>
<comment>MOTOR2</comment>
</variables>
</variables>
CriterionLike Element
Follow this path to access this element:
PAC_WSP_Pattern/Rules/CreationRule/Criteria/CriterionLike
Expand the CriterionLike element to access these elements:
• attributes: The name attribute provides practical information about the
element.
• Subelement: This element corresponds to the components of the
SubelementType area:
◦ VariableAttribute: This element is a component of the definition of
the search. The criterion is satisfied when all instances of
VariableAttribute are found. The VariableAttribute element
searches for a specific value for an attribute inside an element (specified
in Subelement) in the control project, inside the Variables selected in
the CriterionFound element. The attributes for this element represent
the name and value of the attribute.
◦ ElementValue: This element contributes to the search definition. The
criterion is satisfied when all instances of ElementValue are found. The
attribute for this element represents the value of the attribute.
◦ Subelement: This element indicates whether the search takes place in
the same variable element or in one of the sub-elements in the control
project file (separated by a period [.]). This element contains the
VariableAttribute and ElementValue sub-elements.
EIO0000004195.10 83
Pattern Files
<Subelement name="">
</Subelement>
</CriterionLike>
<CriterionLike Id="3">
<Subelement name="attribute">
</Subelement>
</CriterionLike>
The CriterionLike element searches in the control project file for specific
values for variables elements that were discovered by the CriterionFound
element.
This is an example of a CriterionLike element in the control project file:
<comment>MOTOR1</comment>
</variables>
</variables>
</variables>
<CriterionLike Id="2">
<Subelement name="">
</Subelement>
</CriterionLike>
<CriterionLike Id="3">
<Subelement name="attribute">
</Subelement>
</CriterionLike>
84 EIO0000004195.10
Pattern Files
<CriterionLike Id="2">
<Subelement name="">
<Subelement name="attribute">
</Subelement>
</Subelement>
</CriterionLike>
<Criteria>
<CriterionFound Id="1">
<Value>%%_DEVCTL_ST</Value>
</CriterionFound>
<CriterionLike Id="2">
<Subelement name="">
<Subelement name="attribute">
</Subelement>
</Subelement>
</CriterionLike>
<CriterionFound Id="4">
<Value>%1%_DEVCTL</Value>
</CriterionFound>
<CriterionLike Id="5">
<Subelement name="">
</Subelement>
</CriterionLike>
</Criteria>
EIO0000004195.10 85
Pattern Files
<comment>MOTOR1</comment>
</variables>
</variables>
</variables>
This is an example, there can be more than one condition within CriteriaLike
as shown below.
Type name "AALARM_CFG_DDT" and Comment value is "0" are two conditions.
<Criteria>
<CriterionFound Id="1">
<Value>%Tagname%_AALARM_CFG</Value>
</CriterionFound>
<CriterionLike Id="2">
<Subelement name="">
<Subelement name="instanceElementDesc">
<Subelement name="comment">
<ElementValue value="0"></ElementValue>
</Subelement>
</Subelement>
</Subelement>
</CriterionLike>
</Criteria>
Actions Element
Follow this path to access this element:
PAC_WSP_Pattern/Rules/CreationRule/Actions
Expand the Actions element to access these elements:
• attributes: The Id attribute provides practical information about the
element.
• Value: This element corresponds to the variable name.
In a CreationRule, the Actions element instantiates an object from the
template that is defined in Header.ASPTemplateID. The instance name is
provided in the Value element:
86 EIO0000004195.10
Pattern Files
<Actions>
<Value>%1%</Value>
</ActionCreate>
</Actions>
The value %1% is the value for the first token (%%) that is satisfied by the
CriterionFound element (MOTOR01):
<Value>%%_DEVCTL_ST</Value>
</CriterionFound>
</variables>
When the CreationRule is executed, the new instance name is available for
reference in other rules as %Tagname%.
Rule
Introduction
This topic describes the functionality of the elements and sub-elements that you
see when you expand (+) the Rule element in the pattern definition flowchart,
page 79 through this path:
PAC_WSP_Pattern/Rules/Rule
This set of 0 to n rule elements follows the CreationRule, page 81.
Rule Element
Expand the Rule element to access these sub-elements in the RuleType area:
Element(s) Description
EIO0000004195.10 87
Pattern Files
• If the criteria for the Rule element are not satisfied while the NoNegated
attribute is TRUE, the rule does not execute and no Actions elements are
executed.
These sub-elements of the Rule are described below:
• RuleHeader, page 88
• Criteria, page 88
• Actions, page 89
• ActionSet, page 89
• WSPAppObjectAttribute, page 90
• Value, page 90
• ActionRetrieve, page 91
• WSPAppObjectAttribute, page 91
• Subelement, page 92
• GetElementValue, page 93
• GetVariableAttribute, page 93
RuleHeader
Follow this path to access the sub-elements for the RuleHeader element in the
RuleHeaderType area:
PAC_WSP_Pattern/Rules/Rule/RuleHeader
This is an example of a RuleHeader element:
<RuleHeader>
<Auto>true</Auto>
<Updated>false</Updated>
<Enabled>true</Enabled>
</RuleHeader>
Criteria
Follow this path to access the sub-elements for the Criteria element in the
CriteriaType area:
PAC_WSP_Pattern/Rules/Rule/Criteria
The Criteria element is a set of criteria that are satisfied before the Actions
element is executed. Each criterion in the element resolve to TRUE before the
Actions elements can execute normally.
Expand the Criteria element to access these elements:
• CriterionAlways: This element indicates that the rule is executed under
any conditions.
• CriterionFound: This element searches for specific kinds of names for
variables in a control project file.
88 EIO0000004195.10
Pattern Files
Actions
Follow this path to access the sub-elements for the Actions element in the
ActionsType area:
PAC_WSP_Pattern/Rules/Rule/Actions
The value of the Actions element represents the combined number of
ActionSet and ActionRetrieve elements.
Element execution:
• When the required criteria are satisfied, the Actions elements execute
normally.
• When the required criteria are not fully satisfied, the Actions elements
execute inversely.
These different executions of the Actions element write values to the User
Defined Attribute of the newly created instance:
Expand the Actions element to access these elements:
• ActionSet, page 89: This element writes a specific constant value on one
UDA.
• ActionRetrieve, page 91: This element writes a value that was obtained
from the control project in a specific UDA.
ActionSet
Follow this path to access the sub-elements for the ActionSet element in the
ActionSetType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionSet
Expand the ActionSet element to access these elements:
• attributes (Id)
• WSPAppObjectAttribute, page 91:
◦ attributes (type)
◦ attributes (ContainedName)
• Value, page 90
Element execution:
• When the required criteria are satisfied, the Actions element writes the
value specified in Action.
• When the required criteria are not fully satisfied, the Actions element writes
the opposite value in the UDA (if it exists):
◦ Boolean: opposite value
◦ integer, double, float: 0
◦ string: “”.
This is an example of an ActionSet element:
EIO0000004195.10 89
Pattern Files
<ActionSet Id="0">
<WSPAppObjectAttribute type="Boolean">Config.Ref.Disable</
WSPAppObjectAttribute>
<Value>True</Value>
</ActionSet>
<ActionSet Id="1">
<WSPAppObjectAttribute type="String">DevCtl.St.CFGW.InputSource</
WSPAppObjectAttribute>
<Value>%DataSource%%Tagname%_DEVCTL_ST.CFGW</Value>
</ActionSet>
WSPAppObjectAttribute
Follow this path to access the sub-elements for the WSPAppObjectAttribute
element in the WSPAppObjectAttributeType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionSet/
WSPAppObjectAttribute
The WSPAppObjectAttribute element defines the UDA of newly created
instances in ASP.
Expand the WSPAppObjectAttribute element to access these elements:
• type: This attribute defines the UDA datatype (Boolean, integer, string,
double, float).
• ArrayIndex: This attribute defines the UDA Array Index value.
• ContainedName: When present, this element indicates that the UDA is not
from the created instance. Instead, the UDA is from a child instance that was
created when the template was instantiated. The name is separated by '.' of
each ContainedName element.
This graphic shows different values assigned to ContainedName:
Value
Follow this path to access the sub-elements for the WSPAppObjectAttribute
element in the WSPAppObjectAttributeType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionSet/Value
The Value element defines the value that is written to the UDA.
Example:
90 EIO0000004195.10
Pattern Files
• %1%: This Value refers to the first match %% that is found in the rule.
• %Tagname%: This Value refers to the instance name.
• %DataSource%: This Value refers to the prefix information used for the
connection in the ASP.
• composed: %Tagname%_Text_whatever:
◦ %Tagname%_Text_whatever
ActionRetrieve
Follow this path to access the sub-elements for the WSPAppObjectAttribute
element in the ActionRetrieveType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionRetrieve
When an ActionRetrieve element is executed, a value that was extracted from
the variables in the control project file and matched with the required criteria is
written to a UDA of the newly created instance.
Element execution:
• When the required criteria are satisfied, the ActionRetrieve element
writes the value match in Action.
• When the required criteria are not fully satisfied, the ActionRetrieve
element writes the opposite value in the UDA (if it exists):
◦ Boolean: opposite value
◦ integer, double, float: 0
◦ string: “”.
Expand the ActionRetrieve element to access these elements:
• WSPAppObjectAttribute, page 91: This element defines the UDA to be
written.
• Subelement: This element defines new criteria (if any) that is examined in
sub-elements of the variables(xsy) element to point exactly to the value
to be written.
• GetElementValue, page 93: Choose this element to obtain a value that
corresponds to an element.
• GetVariableAttribute, page 93: Choose this element to obtain a value
that corresponds to an attribute.
This is an example of an ActionRetrieve element:
<ActionSet Id="0">
<WSPAppObjectAttribute type="Boolean">Config.Ref.Disable</
WSPAppObjectAttribute>
<Value>True</Value>
</ActionSet>
<ActionSet Id="1">
<WSPAppObjectAttribute type="String">DevCtl.St.CFGW.InputSource</
WSPAppObjectAttribute>
<Value>%DataSource%%Tagname%_DEVCTL_ST.CFGW</Value>
</ActionSet>
WSPAppObjectAttribute
Follow this path to access the sub-elements for the WSPAppObjectAttribute
element in the WSPAppObjectAttributeType area:
EIO0000004195.10 91
Pattern Files
PAC_WSP_Pattern/Rules/Rule/Actions/ActionRetrieve/
WSPAppObjectAttribute
The WSPAppObjectAttribute element defines the UDA of newly created
instances in ASP.
Expand the WSPAppObjectAttribute element to access these elements:
• type: This attribute defines the UDA datatype (Boolean, integer, string,
double, float).
• ContainedName: When present, this element indicates that the UDA is not
from the created instance. Instead, the UDA is from a child instance that was
created when the template was instantiated. The name is separated by '.' of
each ContainedName element.
• ScanGroup, page 93: This attribute defines the scan group value between
1 to 10.
This graphic shows different values assigned to ContainedName:
Subelement
Follow this path to access the Subelement element in the SubelementType
area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionRetrieve/Subelement
Expand the Subelement element to access these elements:
• attribute (name): The name attribute contains a set of
VariableAttribute and ElementValue elements.
• VariableAttribute:
◦ attribute (name)
◦ attribute (value)
• ElementAttribute:
◦ attribute (value)
When Subelement is present, it defines new criteria that are applied to sub-
elements inside the variables(xsy) element selected in the
CriterionFound of the executed Rule:
Subelement: present Subelement defines the conditions for selecting a specific sub-
element in the variables element in the .xsy file in the
CriterionFound element of the executed Rule. It is used to obtain
the value that is written to the UDA.
Subelement: not present The selected value is the first one selected from the
GetElementValue, page 93 or GetVariableAttribute, page
93 elements.
92 EIO0000004195.10
Pattern Files
GetElementValue
Follow this path to access the sub-elements for the GetElementValue element
in the GetElementAttType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionRetrieve/Subelement/
GetElementValue
When GetElementValue is defined in the ActionRetrieve element, the value
that is written to the UDA is the value of the element defined in this subelement
attribute.
The path defined in this attribute starts in the element that is selected by the
Subelement that is defined above.
GetVariableAttribute
Follow this path to access the sub-elements for the GetElementValue element
in the GetElementAttributeType area:
PAC_WSP_Pattern/Rules/Rule/Actions/ActionRetrieve/Subelement/
GetVariableAttribute
Expand the GetVariableAttribute element to access the subelement and
attribute attributes. When GetVariableAttribute is defined in the
ActionRetrive element, the value that is written to the UDA is the value of the
attribute defined in attribute of the element that is defined by the subelement
attribute of GetVariableAttribute.
The path defined in this subelement starts in the element that is selected by the
Subelement that is defined above:
<ActionRetrieve Id="1" >
<WSPAppObjectAttribute type="String">ShortDesc</WSPAppObjectAttribute>
<GetElementValue subelement="comment"/>
</ActionRetrieve>
<comment>RUB1 COMMENT</comment>
</variables>
EIO0000004195.10 93
Pattern Files
<WSPAppObjectAttribute type="String">Ilck.Legend1</WSPAppObjectAttribute>
<Subelement name="instanceElementDesc">
</Subelement>
<GetElementValue subelement="comment"/>
</ActionRetrieve>
<comment>RUB1 COMMENT</comment>
</instanceElementDesc>
</instanceElementDesc>
</variables>
94 EIO0000004195.10
Pattern Files
<WSPAppObjectAttribute type="String">Ilck.Legend1</WSPAppObjectAttribute>
<Subelement name="instanceElementDesc">
</Subelement>
</ActionRetrieve>
<comment>RUB1 COMMENT</comment>
</instanceElementDesc>
</instanceElementDesc>
</variables>
RuleInclude
Introduction
Follow this path to access the RuleInclude element in the RuleIncludeType
area:
PAC_WSP_Pattern/Rules/Rule/RuleInclude
This set of 0 to n rule elements follows the Rules.
EIO0000004195.10 95
Pattern Files
iXML File
The RuleInclude element one attribute named file. The file attribute
contains the name of an iXML file.
The iXML files contains rules that are added to the pattern file.
The RuleInclude elements follow the same rules for patterns. The use of these
files facilitates the sharing of rules among multiple patterns.
Prerequisites
Readers of this section should have a working familiarity with these products:
• PAC Modicon
• Control Expert
• AVEVA System Platform (ASP)
• EcoStruxure™ Control Expert Asset Link
• General Purpose Library for Modicon and ASP
Project Engineering
Control Projects
The pre-built set of GPL patterns need a concrete naming convention to allow
Asset Link to recognize the assets that are automated in the control project. Such
a naming convention, then, is applied to variables when the control project code is
written. This means you do not have to adjust the patterns later.
You can apply a different naming convention, but in that case the pattern files
require editing to conform to any adjustments. This case might also require the
manual refinement of the sophisticated GPL patterns because all rules cannot
necessarily be found during the pattern discovery process.
Supervisory Projects
The GPL patterns use the GPL application templates that start with this prefix:
$aPSx
The GPL patterns are in the folders that are configured from the Asset Link objects
in the ASP Galaxy.
96 EIO0000004195.10
Pattern Files
Include Rules File Service DFB Type Variable Naming Variable Data Type Comments
Convention
iPSxAAlarm Analog Alarms AALARM <obj>_AALARM_ AALARM_CFG_ Alarm setpoints are
CFG DDT enabled. Customize
other types of
combinations as the
actual setpoints to
be managed cannot
be inferred from
control project
variables.
iPSxAoutputlp Analog Output Local AOUTPUTLP <obj>_ AOUTPUTLP_ST_
Panel AOUTPUTLP _ST DDT
EIO0000004195.10 97
Pattern Files
Include Rules File Service DFB Type Variable Naming Variable Data Type Comments
Convention
iPSxCondsum1Ana- Interlock Conditions CONDSUM1 <obj>_CONDSUM1 CONDSUM1 The interlock
log Summary (for condition
Analog Assets) <obj>_ CONDSUM1_ST_ descriptions are
CONDSUM1_ST DDT retrieved from the
DFB CONDSUM1
pin descriptions
COND##.
iPSxCondsum1- Interlock Conditions CONDSUM1 <obj>_CONDSUM1 CONDSUM1 The interlock
Discr Summary (for condition
Discrete Assets) <obj>_ CONDSUM1_ST_ descriptions are
CONDSUM1_ST DDT retrieved from the
DFB CONDSUM1
pin descriptions
COND##.
iPSxCondsumF2 Error Conditions CONDSUM <obj>_RC_ CONDSUM The detected error
Summary (for 2 CONDSUM condition
direction/speed) descriptions are
<obj>_RC_ CONDSUM_ST_ retrieved from the
CONDSUM_ST DDT DFB CONDSUM pin
descriptions
COND##.
iPSxCondsumFC Error Conditions CONDSUM <obj>_FC_ CONDSUM The detected error
Summary (for CONDSUM condition
sequences and descriptions are
equipment modules) <obj>_FC_ CONDSUM_ST_ retrieved from the
CONDSUM_ST DDT DFB CONDSUM pin
descriptions
COND##.
iPSxCondsumIC Initial Conditions CONDSUM <obj>_IC_ CONDSUM The initial condition
Summary (for CONDSUM descriptions are
sequences and retrieved from the
equipment modules) <obj>_IC_ CONDSUM_ST_ DFB CONDSUM pin
CONDSUM_ST DDT descriptions
COND##.
iPSxDevlp On/Off Device Local DEVLP <obj>_DEVLP_ST DEVLP_ST_DDT
Panel
iPSxDiPSx- On/Off Device DEVMNT <obj>_DEVMNT_ST DEVMNT_ST_DDT
Devlpvmnt Maintenance
Asset Types
Process Patterns
This table describes the contents of the pattern files (.XML) and the asset types for
which they help to automate their supervisory responsibilities:
NOTE: The variables that appear in bold type in the table below are required
from the AppObject creation rule in the pattern.
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxAlarmSummary Alarms DINPUT <obj>_DINPUT DINPUT $aPSxA- The description of the Asset is
Summa- larmSumma- retrieved from the description
*iPSxCondsum ry DA- <obj>_DI_ST DINPUT_ST_DDT ry of the DFB.
LARM
<obj>_DALARM_ DALARM_ST_
ST DDT
98 EIO0000004195.10
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxAnalogInput Analog AINPUT <obj>_AINPUT AINPUT $aPSxAna- The description of the Asset is
Input logInput retrieved from the description
*iPSxAAlarm (legacy) <obj>_AINPUT_ AINPUT_ST_DDT of the DFB.
ST
From the constant Range
<obj>_AINPUT_ AINPUT_CFG_ variable:
CFG DDT
Engineering Units is extracted
<obj>_PV_RNG RANGE_DDT from the comment of the field
HI if fulfilled.
<obj>_ CVALVELP_ST_
CVALVELP_ST DDT
aPSxDigitalInput Digital DINPUT <obj>_DINPUT DINPUT $aPSxDigi- The description of the Asset is
Input talInput retrieved from the description
*iPSxDevmnt <obj>_DINPUT_ DINPUT_ST_DDT of the DFB.
ST
aPSxDigitalOutput Digital DOUT- <obj>_DOUTPUT DOUTPUT $aPSxDigi- The description of the Asset is
Output PUT talOutput retrieved from the description
*iPSxCondsum1Discr <obj>_DOUTPUT_ DOUTPUT_ST_ of the DFB.
ST DDT
*iPSxDevmnt
EIO0000004195.10 99
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxDiscreteSP Discrete n/a <obj>_ BOOL $aPSxDis- The description of the Asset is
Setpoint DISCRETESP creteSP retrieved from the description
of the variable.
aPSxDualOutput- Dual DVALVE <obj>_DVALVE DVALVE $aPSxDua- The description of the Asset is
Valve Output lOutputValve retrieved from the description
Valve <obj>_DVALVE_ DVALVE_ST_ of the DFB.
*iPSxCondsum1Discr ST DDT
*iPSxCondsum
*iPSxDevmnt
aPSxDurationSP Duration n/a <obj>_ TIME $aPSxDura- The description of the Asset is
Setpoint DURATIONSP tionSP retrieved from the description
of the variable.
aPSxEquipmentMod- Equip- EMCTL <obj>_EMCTL EMCTL $aPSxE- The description of the Asset is
ule ment quipment- retrieved from the description
Module <obj>_EMCTL_ST EMCTL_ST_DDT Module of the DFB.
*iPSxCondsumIC
<obj>_EMCTL_ EMCTL_CFG_
*iPSxCondsumFC CFG DDT
<obj>_IC_ CONDSUM_ST_
CONDSUM_ST DDT
<obj>_FC_ CONDSUM_ST_
CONDSUM_ST DDT
aPSxHandValve Hand HVALVE <obj>_HVALVE HVALVE $aPSxHand- The description of the Asset is
Valve Valve retrieved from the description
<obj>_HVALVE_ HVALVE_ST_ of the DFB.
ST DDT
aPSxIBPhase InBatch IB- <obj>_IBPHASE IBPHASE $aPSxIB- The description of the Asset is
Phase PHASE Phase retrieved from the description
*iPSxCondsumIC <obj>_IBPHASE_ IBPHASE_ST_ of the DFB.
ST DDT
*iPSxCondsumFC A maximum of one of the
<obj>_IBPHASE_ IBPHASE_CFG_ IBPAR05, IBPAR10 and
CFG DDT IBPAR16 variables are
expected at a time.
<obj>_IBPAR05_ IBPAR05_ST_
ST DDT The description of each
parameter is retrieved from
<obj>_IBPAR10_ IBPAR10_ST_ the description of the related
ST DDT field 'IP##' and 'OP##'.
<obj>_IBPAR16_ IBPAR16_ST_
ST DDT
aPSxIC Exten- CON- <obj>_IC CONDSUM The description of the Asset is
ded DSUM retrieved from the description
Initial <obj>_IC_ST CONDSUM_ST_ of the DFB.
Condi- DDT
tion Once the AppObjects are
generated, you have to
contain them in their related
AppObject Container
manually.
100 EIO0000004195.10
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxIMCtl Internal IMCTL <obj>_IMCTL IMCTL $aPSxIMCtl The description of the Asset is
Model retrieved from the description
*iPSxCondsum1Ana- Control- <obj>_IMCTL_ST IMCTL_ST_DDT of the DFB.
log ler
<obj>_IMCTL_ IMCTL_CFG_ From the constant Range
DDT DDT variables:
*iPSxDevmnt
*iPSxDevlp
EIO0000004195.10 101
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxMotor2 Motor 2 MO- <obj>_MOTOR2 MOTOR2 $aPSxMo- The description of the Asset is
speeds/ TOR2 tor2 retrieved from the description
*iPSxCondsum1Discr direc- <obj>_MOTOR2_ MOTOR2_ST_ of the DFB.
tions ST DDT
*iPSxCondsum
*iPSxCondsumF2
*iPSxDevmnt
*iPSxMotor2lp
aPSxMotorizedValve Motor- MVALV- <obj>_MVALVE MVALVE $aPSxMo- This Pattern manages the
ized E torizedValve related Container and its
*iPSxCondsum1Discr Valve <obj>_MVALVE_ MVALVE_ST_ Contained objects.
MVAL- ST DDT
VELP The description of the Asset is
<obj>_MVALVE_ MVALVE_CFG_ retrieved from the description
MO- CFG DDT of the DFBs 'MVALVE',
TOR2 'MOTOR2', 'DINPUT' and
<obj>_ MVALVELP_ST_ 'AINPUT1'.
CON- MVALVELP_ST DDT
DSUM The detected error condition
<obj>_M2_ST MOTOR2_ST_ descriptions are retrieved
DINPUT DDT from the DFBs CONDSUM
pin descriptions 'COND##'.
AIN- <obj>_M2_FC CONDSUM
PUT1 Engineering Units is extracted
<obj>_M2_FC_ST CONDSUM_ST_ from the comment of the field
DDT HI if fulfilled.
<obj>_M2_RC CONDSUM
Numeric Format is extracted
from the comment of the field
<obj>_M2_RC_ST CONDSUM_ST_
LO if fulfilled.
DDT
<obj>_M2_MNT_ DEVMNT_ST_
ST DDT
<obj>_ZSH_ST DINPUT_ST_DDT
<obj>_ZSL_ST DINPUT_ST_DDT
<obj>_AI_ST AINPUT1_ST_
DDT
<obj>_AI_CFG AINPUT1_CFG_
DDT
<obj>_PV_RNG RANGE_DDT
aPSxMotorized- Discrete MVALV- <obj>_MVALVED MVALVED $aPSxMo- This Pattern manages the
ValveD Motor- ED torizedValve related Container and its
ized <obj>_MVALVED_ MVALVE_ST_ Contained objects.
*iPSxCondsum1Discr Valve MVAL- ST DDT
VELP The description of the Asset is
*iPSxMValvedlp <obj>_MVALVED_ MVALVE_CFG_ retrieved from the description
MO- CFG DDT of the DFBs 'MVALVED',
TOR2 'MOTOR2' and 'DINPUT'.
<obj>_M2_ST MOTOR2_ST_
CON- DDT The detected error condition
DSUM descriptions are retrieved
<obj>_M2_FC CONDSUM from the DFBs CONDSUM
DINPUT pin descriptions 'COND##'.
<obj>_M2_FC_ST CONDSUM_ST_
AIN- DDT
PUT1
<obj>_M2_RC CONDSUM
<obj>_M2_RC_ST CONDSUM_ST_
DDT
<obj>_M2_MNT_ DEVMNT_ST_
ST DDT
<obj>_ZSH_ST DINPUT_ST_DDT
<obj>_ZSL_ST DINPUT_ST_DDT
aPSxMotorVS Motor SDDEV- <obj>_SDDEVCTL SDDEVCTL $aPSxMo- The description of the Asset is
Variable CTL torVS retrieved from the description
*iPSxCondsum1Discr Speed <obj>_ SDDEVCTL_ST_ of the DFB.
SDDEVCTL_ST DDT
*iPSxCondsum From the constant Range
variables:
102 EIO0000004195.10
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
<obj>_ SDDEVCTL_
*iPSxDevmnt SDDEVCTL_CFG CFG_DDT Engineering Units is extracted
from the comment of the field
<obj>_PV_RNG RANGE_DDT HI if fulfilled.
aPSxPWM Pulse PWMC- <obj>_PWMCTL PWMCTL $aPSxPWM The description of the Asset is
Width TL retrieved from the description
*iPSxCondsum1Ana- Modula- <obj>_PWMCTL_ PWMCTL_ST_ of the DFB.
log tor ST DDT
<obj>_PWMCTL_ PWMCTL_CFG_
DDT DDT
aPSxRamp Ramp ARAMP <obj>_ARAMP ARAMP $aPSxRamp The description of the Asset is
retrieved from the description
<obj>_ARAMP_ ARAMP_ST_DDT of the DFB.
ST
From the constant Range
<obj>_ARAMP_ ARAMP_CFG_ variable:
CFG DDT
Engineering Units is extracted
<obj>_SP_RNG RANGE_DDT from the comment of the field
HI if fulfilled.
<obj>_ RATIOCTL_CFG_
RATIOCTL_DDT DDT
aPSxRealSP Real n/a <obj>_REALSP REAL $aPSx- The description of the Asset is
Setpoint RealSP retrieved from the description
of the variable.
EIO0000004195.10 103
Pattern Files
Pattern File (& ref. to Asset DFB Variable Naming Variable Data ASP Comments
specific Include Type Type Convention1 Type Template
Rules)
aPSxSequentialCon- Sequen- SEQCT- <obj>_SEQCTL1 SEQCTL1 $aPSxSe- The description of the Asset is
trol tial L1 quentialCon- retrieved from the description
Control <obj>_SEQCTL1_ SEQCTL1_ST_ trol of the DFB. A maximum of
*iPSxCondsumIC ST DDT one of the SEQPAR05,
SEQPAR10 and SEQPAR16
*iPSxCondsumFC <obj>_SEQCTL1_ SEQCTL1_CFG_ variables are expected at a
CFG DDT time.
<obj>_ SEQPAR05_ST_ The description of each
SEQPAR05_ST DDT parameter is retrieved from
the description of the related
<obj>_ SEQPAR10_ST_ field 'IP##', 'OP##' and
SEQPAR10_ST DDT 'RPT##'.
<obj>_ SEQPAR16_ST_
SEQPAR16_ST DDT
aPSxSplitRangeCtl Split SPLRG- <obj>_SPLRGCTL SPLRGCTL $aPSxSpli- The description of the Asset is
Range CTL tRangeCtl retrieved from the description
*iPSxCondsum1Ana- Control- <obj>_ SPLRGCTL_ST_ of the DFB.
log ler SPLRGCTL_ST DDT
From the constant Range
<obj>_ SPLRGCTL_ variables:
SPLRGCTL_CFG CFG_DDT
OP Engineering Units is
<obj>_SP_RNG RANGE_DDT extracted from the comment
of the field HI if fulfilled.
<obj>_OP_RNG RANGE_DDT
OP Numeric Format is
extracted from the comment
of the field LO if fulfilled.
<obj>_TOTAL_ TOTAL_CFG_
CFG DDT
aPSxValve On/Off DEVCT- <obj>_DEVCTL DEVCTL $aPSxValve The description of the Asset is
Valve L retrieved from the description
*iPSxCondsum1Discr <obj>_DEVCTL_ DEVCTL_ST_ of the DFB.
ST DDT
*iPSxCondsum
*iPSxDevmnt
*iPSxDevlp
Device Patterns
This table describes the contents of the device pattern files (.XML) and the asset
types for which they help to automate their supervisory responsibilities:
104 EIO0000004195.10
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_COMPACT_ COMPACT_ST_
ST DDT
<Obj>_COMPACT_ COMPACT_
MEA MEA_DDT
<Obj>_COMPACT_ COMPACT_
MEAExt MEAExt_DDT
<Obj>_COMPACT_ COMPACT_
MEAExt1 MEAExt1_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMaster- Circuit MBUMAS- <Obj>_ MBUMASTER- $PSxMas-
pactMTZwoC Breakers TER- MBUMASTER- PACTMTZ ter-
(Master- PACTMTZ PACTMTZ pactMTZ-
*iPSxCommon. pactMTZ woC
ixml* Protection Unit <Obj>_ MASTERPACT_
without MASTERPACT_CFG CFG_DDT
Chassis)
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
EIO0000004195.10 105
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMaster- Circuit MBUMAS- <Obj>_ MBUMASTER- $PSxMas-
PACTNxC Breakers TER- MBUMASTER- PACTNxC ter-
(MasterpactNx PACTNxC PACTNxC PACTNxC
*iPSxCommon. Protection Unit
ixml* with Chassis) <Obj>_ MASTERPACT_
MASTERPACT_CFG CFG_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMasterPACT- Circuit MBMAS- <Obj>_ MBMASTER- $PSxMas-
woC Breakers TERPACT MBMASTERPACT PACT terPACT-
(Masterpact woC
*iPSxCommon. Protection Unit <Obj>_ MASTERPACT_
ixml* without MASTERPACT_CFG CFG_DDT
Chassis)
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMaster- Circuit MBUMAS- <Obj>_ MBUMASTER- $PSxMas-
pactMTZC Breakers TER- MBUMASTER- PACTMTZC ter-
(Master- PACTMT- PACTMTZC pactMTZC
*iPSxCommon. pactMTZ CZ
ixml* Protection Unit <Obj>_ MASTERPACT_
with Chassis) MASTERPACT_CFG CFG_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMasterPACTC Circuit MBMAS- <Obj>_ MBMASTER- $PSxMas-
Breakers TER- MBMASTERPACTC PACTC terPACTC
*iPSxCommon. (MasterPACT PACTC
ixml* Protection Unit <Obj>_ MASTERPACT_
with Chassis) MASTERPACT_CFG CFG_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
106 EIO0000004195.10
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxMaster- Circuit MBUMAS- <Obj>_ MBUMASTER- $PSxMas-
PACTNxwoC Breakers TER- MBUMASTER- PACTNx ter-
(MasterpactNx PACTNx PACTNx PACTNx-
*iPSxCommon. Protection Unit woC
ixml* without <Obj>_ MASTERPACT_
Chassis) MASTERPACT_CFG CFG_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ST ST_DDT
<Obj>_ MASTERPACT_
MASTERPACT_MEA MEA_DDT
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt_DDT
MEAExt
<Obj>_ MASTERPACT_
MASTERPACT_ MEAExt1_DDT
MEAExt1
aPSxSepam20CB Digital MBSE- <Obj>_ MBSEPAM20CB $PSxSe-
Protection PAM20CB MBSEPAM20CB pam20CB
*iPSxCommon. Relays (Digital
ixml* Protection <Obj>_SEPAM_CFG SEPAM_CFG_
Relays Sepam DDT
20C Modbus
Serial; Sepam <Obj>_SEPAM_ST SEPAM_ST_DDT
20C MB TCP I/
O Scanning ) <Obj>_SEPAM_ SEPAM_VMEA_
VMEA DDT
<Obj>_SEPAM_IO20 SEPAM_IO20_
DDT
aPSxSe- Digital MBSE- <Obj>_ MBSE- $PSxSe-
pam20CSTM Protection PAM20CS- MBSEPAM20CSTM PAM20CSTM pam20CS-
Relays (Digital TM TM
*iPSxCommon. Protection <Obj>_SEPAM_CFG SEPAM_CFG_
ixml* Relays Sepam DDT
20C STM
Modbus Serial; <Obj>_SEPAM_ST SEPAM_ST_DDT
Sepam 20C
STM TCP I/O <Obj>_SEPAM_ SEPAM_AMEA_
Scanning) AMEA DDT
<Obj>_SEPAM_IO20 SEPAM_IO20_
DDT
aPSxSepam40C Digital MBSE- <Obj>_ MBSEPAM40C $PSxSe-
Protection PAM40C MBSEPAM40C pam40C
*iPSxCommon. Relays (Digital
ixml* Protection <Obj>_SEPAM_CFG SEPAM_CFG_
Relays Sepam DDT
40C Modbus
Serial; Sepam <Obj>_SEPAM_ST SEPAM_ST_DDT
40C MB TCP I/
O Scanning) <Obj>_SEPAM_IO40 SEPAM_IO40_
DDT
<Obj>_SEPAM_MEA SEPAM_MEA_
DDT
aPSxSepam80C Digital MBSE- <Obj>_ MBSEPAM80C $PSxSe-
Protection PAM40C MBSEPAM80C pam80C
*iPSxCommon. Relays (Digital
ixml* Protection ESE- <Obj>_ESEPAM80C ESEPAM80C
Relays Sepam PAM80C
80C Modbus <Obj>_SEPAM_CFG SEPAM_CFG_
Serial; Sepam DDT
80C MB TCP I/
O Scanning) <Obj>_SEPAM_ST SEPAM_ST_DDT
<Obj>_SEPAM_IO80 SEPAM_IO80_
DDT
<Obj>_SEPAM_MEA SEPAM_MEA_
DDT
EIO0000004195.10 107
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_ACCUSINE_ ACCUSINE_ST_
ST DDT
<Obj>_ACCUSINE_ ACCUSINE_
MEA MEA_DDT
<Obj>_PM_MEA PM1200_MEA_
DDT
aPSxPM5350 Power Meters MBP- <Obj>_MBPM5350 MBPM5350 $PSxP-
(Power Meter M5350 M5350
*iPSxCommon. PM5350 MB <Obj>PM_CFG PM_CFG_DDT
ixml* Serial)
<Obj>_PM_ST PM_ST_DDT
<Obj>_PM_MEA PM_MEA_DDT
<Obj>_PM_MEA PM82xx_MEA_
DDT
aPSxPM710 Power Meters MBPM700 <Obj>_MBPM700 MBPM700 $PSxP-
(Power Meter M710
*iPSxCommon. PM710 MB <Obj>PM_CFG PM_CFG_DDT
ixml* Serial)
<Obj>_PM_ST PM_ST_DDT
<Obj>_PM_MEA PM_MEA_DDT
<Obj>_PM_MEA PM_MEA_DDT
108 EIO0000004195.10
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_ATV_IO ATV6xx_IO_DDT
<Obj>_ATV_IOEXT ATV6xx_IOEXT_
DDT
aPSxATV9xxAllDa- Speed Drives ATV9xx <Obj>_ATV9xx ATV9xx $PSxAT-
ta (Altivar V9xxAllDa-
Process <Obj>_ATV_CFG ATV9xx_CFG_ ta
*iPSxCommon. Variable Speed DDT
ixml* Drives
ATV9xx) <Obj>_ATV_ST ATV9xx_ST_DDT
<Obj>_ATV_IO ATV9xx_IO_DDT
<Obj>_ATV_IOEXT ATV9xx_IOEXT_
DDT
aPSxATV6xxAllDa- Speed Drives ATV6xx <Obj>_ATV6xx ATV6xx aPS-
taandWarnings (Altivar xATV6x-
Process <Obj>_ATV_CFG ATV6xx_CFG_ xAllDa-
*iPSxCommon. Variable Speed DDT taand-
ixml* Drives ATV6xx Warnings
with Process <Obj>_ATV_ST ATV6xx_ST_DDT
Warnings)
<Obj>_ATV_IO ATV6xx_IO_DDT
<Obj>_ATV_IOEXT ATV6xx_IOEXT_
DDT
<Obj>_ EMATVWARN_
EMATVWARN_CFG CFG_DDT
EIO0000004195.10 109
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
<Obj>_ EMATVWARN_
EMATVWARN_ST ST_DDT
<Obj>_ EMATVWARN1_
EMATVWARN_CFG CFG_DDT
<Obj>_ EMATVWARN1_
EMATVWARN_ST ST_DDT
<Obj>_ EMATVWARN_
EMATVWARN_CFG CFG_DDT
<Obj>_ EMATVWARN_
EMATVWARN_ST ST_DDT
<Obj>_TESYST_ TESYST_
MEAEXT MEAEXT_DDT
110 EIO0000004195.10
Pattern Files
Pattern File (& ref. Asset Type DFB Type Variable Naming Variable Data ASP Comments
to specific Include Convention1 Type Template
Rules)
BOLD indicates the variables are needed from the AppObject creation rule in the Pattern.
EIO0000004195.10 111
Pattern Files
Process Patterns
Mapping Table
This table shows the correspondence for the sequence of AVEVA System
Platform templates and the Asset Link process pattern names:
112 EIO0000004195.10
Pattern Files
Enineering Units
The following templates are supported in pattern files:
• aPSxAnaloglnput
• aPSxAnalogInput1
• aPSxAnalogOutput
• aPSxASelect1
• aPSxControlValve
• aPSxIMCtl
• aPSxLeadLagCtl
• aPSxMAnalogInput1
• aPSxMotorizedValve
• aPSxMotorVS
• aPSxPID
• aPSxPWM
• aPSxRamp
• aPSxRatioCtl
• aPSxSplitRangeCtl
• aPSxStep3Ctl
• aPSxTotal
Device Patterns
Mapping Table
This table shows the correspondence for the sequence of AVEVA System
Platform templates and the Asset Link device pattern names:
EIO0000004195.10 113
Pattern Files
SCADAPack Patterns
Mapping Table
The table below explains the mapping of SCADAPack Patterns for demo
Templates.
114 EIO0000004195.10
Pattern Files
NOTE: Library set for SCADAPack is not included. The demo template and
patterns are in the installation default location C:\ProgramData
\Schneider Electric\Ecostruxure Control Expert - Asset Link
\SCADAPack Demo Templates and Patterns.
Step Description
Number
1 The figure below illustrates the RTU objects configured in Remote Connect.
2 The figure below illustrates the control logic along with the respective function block.
EIO0000004195.10 115
Pattern Files
Step Description
Number
3 The figure below is a screenshot of the Pattern Editor wherein the pattern is designed to
match the respective function block.
4 The figure below shows the Action set parameters for the respective RTU object
parameter named STW, CFGW and PV. The respective System Platform attribute must be
named as shown below. For example, the input source STW named as AInput.St.
STW.InputSource, wherein, STW mapped with RTU object parameter is same as STW.
Similarly, it is applicable for other parameters like CFGW, PV.
116 EIO0000004195.10
Appendices
What’s in This Part
Library Installation ........................................................................................ 118
EIO0000004195.10 117
Library Installation
Library Installation
What’s in This Chapter
.................................................................................................................. 118
Overview
You can install the Modicon Libraries - General Purpose for AVEVA System
Platform in System Platform IDE. Default installation location for library template is
C:\ProgramData\Schneider Electric\Ecostruxure Control Expert -
Asset Link\GPL WSP Templates.
You can use the following libraries files to install in the System Platform IDE:
• Script function libraries.
• The Galaxy style library.
Step Action
118 EIO0000004195.10
Library Installation
Step Action
EIO0000004195.10 119
Glossary
A
ASP:
AVEVA System Platform. This industrial software platform uses ArchestrA
technology for HMI operations management, SCADA supervision, and production
and performance management. ASP contains an integrated set of services and
an extensible data model to manage plant control and information management
systems. ASP supports both the supervisory control layer and the manufacturing
execution system layer, presenting them as a single information source. Modular
applications sit on top of the ASP Platform.
E
EcoStruxure™ Machine Expert:
EcoStruxure™ Machine Expert is a unique solution software for developing,
configuring, and commissioning the entire machine in a single software
environment, including logic, motion control, robotics/mechatronics, simulation,
diagnostics, intelligent motor and load management and drives, HMI (Vijeo
Designer), IIoT and related network automation functions.
G
Galaxy:
A Galaxy is your entire production environment, including all computers and
components that run your application. It is a collection of graphics, objects,
engines, templates, and attributes that you define as a set of component parts of
an InTouch HMI or OMI application.
O
OFS:
(OPC Factory Server) OFS enables real-time SCADA communications with the
Control Expert family of PLCs. OFS utilizes the standard OPC data access
protocol.
OPC DA:
(OLE for Process Control Data Access) The Data Access Specification is the
most commonly implemented of the OPC standards that provide specifications for
real-time data communications between clients and servers.
OPC UA:
OPC UA (Open Platform Communications United Architecture) is a data
exchange standard for industrial communication (machine-to-machine or PC-to-
machine communication).
P
PAC:
programmable automation controller. The PAC is the brain of an industrial
manufacturing process. It automates a process as opposed to relay control
systems. PACs are computers suited to survive the harsh conditions of an
industrial environment.
120 EIO0000004195.10
S
System Platform IDE:
ArchestrA Integrated Development Environment. This framework is incorporated
with the AVEVA System Platform to facilitate the building of InTouch OMI
ViewApps and managed InTouch HMI applications.
EIO0000004195.10 121
Index
A
activating
licenses.............................................................16
antivirus software
using antivirus software ......................................14
Asset Link
configuration......................................................34
function overview ...............................................17
GPL patterns .....................................................96
installation .........................................................22
introduction .......................................................15
operation...........................................................34
pattern file syntax...............................................76
work flow ...........................................................29
C
computers
hardening computers .........................................14
cybersecurity
network interface card settings............................14
H
hardening
hardening computers .........................................14
I
installation
demo templates .................................................25
library installation ............................................. 118
L
licensing
activating licenses..............................................16
N
network interface cards
cybersecurity guidelines .....................................14
122 EIO0000004195.10
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+ 33 (0) 1 41 29 70 00
www.se.com