Schneider Electric EcoStruxure Process Expert 2020 R2 Platform User Guide

Object Model Concept ...................................................................................19

What’s in This Chapter

System Engineering Life Cycle Concept..........................................................26

Overview

This chapter describes the object model concept and how it is applied within the software. It also describes the concept of engineering an automation system in stages.

Object Model Concept

Overview

This section describes the concept of object model and the resulting templates that are used to engineer automation systems by using the software.

Object Based Engineering

Description of the System

In EcoStruxure Process Expert a system is the representation of a physical automation system and is defined by three independent parts:

• The application : Defines the functions of the system and the corresponding process hierarchy.

• Projects : Define the Participant projects that implement the logic and function of the system:

◦ Control Projects

◦ Supervision Projects

• The topology : Defines the hardware and software infrastructure of the system. It consists of:

◦ Controllers

◦ Devices connected to field buses

◦ Networks

◦ Station nodes (their hardware and software components)

Object Model Concept

Object models represent the application and topology of a system.

There are different types of object models representing the application of the system based on their purpose:

• Process objects representing, for example, the I/Os of pumps, valves, and sensors in several tanks.

• Device objects representing, for example, the functions to control a process object such as a motor by using a drive.

• Communication objects representing, for example, the functions to manage communication with device objects through the port of an M580 controller with Modbus TCP explicit messaging.

Likewise, object models representing the topology of the system are called topological objects. They can represent, for example, the CPU module of an M580 controller.

EIO0000001114.15

Global Templates Explorer , page 645 . These templates can be

The approach of representing any entity or function that exists in the real world with the use of object models is referred to as object-oriented modeling and is based on the abstraction principle: Process of reducing the information to retain only what is relevant for a particular component or function independently of the context.

The following figure illustrates the application object-oriented modeling of a conveyor.

From Object Model to Object Template

The next step consists in creating, based on the object model, a component that models an item or a function of the real world. This component needs to be generic enough to be reused in different systems.

The standardization principle is used to achieve this objective: Process of finding the common characteristics of different items or functions.

The resulting component is called an object template .

The following figure illustrates the process of standardizing an object model representing a conveyor to create a template, which allows modelling conveyors and similar items (such as a mixer) in different systems.

Object Template Description

Overview

Schneider Electric object templates created from object models are called Global

Templates and are grouped in libraries. When a library is installed, its templates appear in the

used in any system that is created by using EcoStruxure Process Expert.

To make reading easier, the word templates is used to refer to Global Templates.

Templates provide collaboration and data sharing between Participants and the software platform.

20 EIO0000001114.15

By doing so, templates reduce the engineering effort and provide consistency.

Object Template Classification

Templates can be placed one inside the other, linked, and can include several capabilities to model an item or a functionality of the real world. Therefore, the distinction is made between three types of templates:

• Facet templates : They are the smallest templates available. They encapsulate a constituent, which is provided by a specific Participant to deliver the respective service. As such there are:

◦ Control facet templates providing Control services. For example, in the

General Purpose Library, the service that is provided by the $MOTORGP_

UL facet template is the on/off motor management functionality. The functionality is implemented by using the MOTORGP function block, which is encapsulated inside the template.

◦ Supervision facet templates providing Supervision services. For example, in the General Purpose Library, the service that is provided by the

$BlowerLeftGP_m_CG genie facet template is the animated graphical representation of a motorized blower, which can be displayed on an operator station. The animated graphic is encapsulated inside the template.

• Composite templates : They consist of one or more facet templates and/or other composite templates. Composite templates that are included inside another composite template are called composite references.

Depending on their composition, composite templates can be:

◦ Control composite templates: Contain only Control references.

◦ Supervision composite templates: Contain only Control references.

◦ Control module templates: Highest level of composite template, which contains both Control and Supervision references.

NOTE: Facet templates that are included inside a composite template are called facet references.

• Interface models : They are considered as a template because they are generic and can be reused but they are actually a mechanism that allows linking to each other:

◦ Any combination of facet and composite templates.

◦ Instances of templates.

There are different types of interface models depending on the objects that they link. You can configure interface models.

For details, refer to the help of the Schneider Electric libraries for EcoStruxure

Process Expert.

The following figure illustrates a single facet template.

The arrows represent the inputs and outputs of the facet which propagate the data.

EIO0000001114.15

The following figure illustrates a composite template including another composite template (composite reference) and two facet templates.

- - Represents interface links

Template Terminology

The following example shows the graphical representation of a sample composite template. The names of elements may vary.

NOTE: Interfaces are not represented since they are mechanisms for managing data exchange between references.

The table explains the color coding that is used in the generic composite template

Template .

Color Description

Control facet template, which encapsulates a functionality that is provided by the Control

Participant.

Supervision facet template, which encapsulates a functionality that is provided by the

Supervision Participant.

Composite template, which can contain:

• Control and/or Supervision facet templates

• Other composite templates

NOTE: This color coding is used in the user interface to differentiate the different types of templates and related services.

The table describes the items that compose the generic composite template

Template and the terminology that is used to designate these items depending on the context.

Item

Description

Template is the highest level composite template and is called a control module because it provides both the Control and Supervision functionalities that are required to manage the object that is modeled by the template.

Control is a Control composite template because it contains Control facet templates. It is also called a composite reference as it is referenced inside the composite template

Template .

EIO0000001114.15

Item

8, 9

Description

In the context of Template , Control is an element of Template

Service1 is a composite reference.

In the context of composite reference Control , Service1 is an element of Control .

The same applies to composite reference Service2 .

Both Service1 and Service2 are Control composite templates since they contain only

Control facets.

Logic and Signal1 are Control facet references.

In the context of the composite reference Service1 , they are elements of Service1 .

Signal3 is a Control facet reference.

In the context of the control module Template , Signal3 is an element of Template .

Supervision is a Supervision composite reference because it is contained in composite template Template . It contains Supervision elements (composite references Tag and

Genie ).

In the context of the control module Template , Supervision is an element of Template .

Tag is a Supervision composite reference because it is contained in composite

Supervision and contains only a Supervision element ( OnOff ).

Likewise Genie is a Supervision composite reference.

OnOff and Pump are Supervision facet references and elements of templates

SuperTagvision and Genie respectively.

Types of Object Templates

Like object models represent the application and the topology of the system, so do templates.

As a result, the following types of templates exist:

• Application templates : Facet and composite templates, which define the functional components in the application of the system.

• Topological templates : Facet and composite templates, which define hardware and software components of the topology of the system.

Application Templates

Overview

Control and Supervision facet templates encapsulate the respective Participant capabilities:

• For Control:

◦ Logic facet templates: Implement a specific functionality, for example, discrete motor management.

• For Supervision:

◦ Data facet templates: Allow defining tags and user interface messages that are required for acquiring runtime data.

◦ Genie facet templates: Represent runtime data by using an animated graphic.

Facet templates encapsulate the respective Participant capabilities. For Control, these are Logic facet templates, which implement a specific functionality, for example, discrete motor management.

Based on a combination of these, application control module templates have been created, which allow you to model the application of a system in terms of Control and Supervision services.

EIO0000001114.15

Topological Templates

Introduction

Topological templates allow you to model the hardware and software infrastructure of the topology of a system by creating topological entities.

They are located in the Foundation library and grouped by category.

Sub-Types of Topological Templates

The following subtypes of topological templates are available:

• Network : Models control and field bus networks.

For example: Ethernet LAN, Modbus, CANopen, Profibus DP, RIO S908, RIO

Ethernet, local bus for controllers and Advantys islands).

• Network devices : Models the field bus devices.

For example: Gateways.

• Station node : This template models the components of the different types of stations that are connected to the Ethernet network.

For example: network interface cards (NICs), Supervision software, OPC

Factory Server (OFS) software, and Control software.

• Controller : Models the controller hardware that is managed by the Control

Participant.

For example: Hardware of the Quantum platform.

• Device I/O : Models devices and remote I/Os including third party devices that can be connected as nodes to Ethernet networks.

For example: Advantys Island I/Os, energy devices, motor starters, and instrumentation devices.

Interface Models

Global Templates Explorer , page 645

The templates are available in the form of libraries and after installation, appear in the

where they are grouped by category.

For details, refer to the help of the Schneider Electric libraries for EcoStruxure

Process Expert.

NOTE: There is a relation between Control and Supervision facet templates because for a given Control service, which is provided by a Control facet, the

Supervision facet represents the part of the service that is visible to the user

(for example supervisory user interface and mode of operation).

Introduction

Interface models allow you to define:

• data exchange between two object instances or two object references.

• dependencies between two object instances or two object references such as compatibility or requirement rules.

Types of Interface Models

The following types of interface models are predefined:

• Physical : Allow data exchange at the physical level (modules) between:

◦ Topological instances

◦ Topological references

• Communication : Allow data exchange at the logical level (I/O scanner, OPC

Factory Server software, Supervision I/O devices) between:

24 EIO0000001114.15

◦ Topological instances

◦ Topological references

• Application : Allow data exchange between:

◦ Application instances/references

◦ Topological instances/references

• Mapping : Allow data exchange during the mapping stage between application objects (representing the logical projection of the hardware) and topological objects (representing the actual hardware defined in the topology).

Instances of Templates

From Templates to Instances

The software lets you create application and topological instances from the corresponding templates.

Because control module templates integrate a range of Control and Supervision services, editable parameters, and expose a set of interfaces, you can customize each instance to fulfill specific requirements.

The process of creating instances from templates and configuring them is called instantiation .

To access and configure their parameters, instances produce facets, which are based on the facet templates that each control module template contains.

During the instantiation, you can:

• Select services among those that the template provides. For Schneider

Electric templates, some services are mandatory (for example, Logic ) and some are optional (for example, Supervision ).

• Edit the values of parameters (for example, provide a high limit value for an analog level sensor).

• Link instances to each other (for example, link a motor instance to the instance representing the functions of the variable speed drive that controls the motor).

When you enable (select) a service, the software creates a facet, which is an instance of the facet template that provides the service. This facet is associated to the instance of the template that references the service.

The other way around, when you disable (unselect) a service, the software deletes the corresponding facet.

The following figure shows an example of several instances with different configurations that you can create from one template.

EIO0000001114.15

Object Based Engineering , page 19

Only some facets of instances Conv_1, Pump_1, and Pump_2 are shown for illustration purposes.

System Engineering Life Cycle Concept

Overview

The concept of breaking down into stages the workflow to engineer an automation system is referred to as the system engineering life cycle in this manual.

This section provides a general description of each stage using:

• A stage map showing the position of the stage within the system engineering life cycle.

• A definition to explain the purpose of the stage.

• An example to facilitate the understanding.

The System Engineering Life Cycle

Overview

For a description of the representation of a system in EcoStruxure Process Expert, refer to

Graphical Representation

The system engineering life cycle is the representation of the stages of the engineering workflow (from design to operation and maintenance) that you need to complete to

engineer a system, page 98

by using the software.

The following figure shows the system engineering life cycle.

The stages are grouped into 4 main parts where Topology, Projects, and

Application represent the components of a system. Library represents the Global

Templates, which are used in the other three parts. To each part corresponds an explorer, which provides the functionality to complete each of the stages.

The arrows represent the order in which you need to complete the stages. The horizontal double bars represent the stage gates where the previous stages have to be completed before you can proceed further in the life cycle.

The Assignment and Mapping stages make the link between the different components of the system.

EIO0000001114.15

quick reference Guides, page 98 .

You can find a list of the stages and the main tasks that you can complete in each stage in

Illustrating the Concept

When necessary, to illustrate the concept of a stage, a concrete example is used.

The example is a water tank system that collects rain water. The installation consists of the following equipment:

• 2 electrical pumps, which transfer the water from the tank into a separate reservoir.

• 3 digital switches, which indicate the rain water level in the tank.

The following figure illustrates the water tank system:

1 Pump: Pmp1

2 Pump: Pmp2

3 High-level switch: Lsh1

4 Low-level switch: Lsl1

5 Very low-level switch: Lsll1

6 Rain water tank

7 Reservoir

Pump Management Operating Mode

In the example, 1 of the 2 pumps transfers the rain water into the reservoir. The other pump serves as a back-up pump in case the transfer pump requires maintenance or is out of order. Both pumps exchange their roles periodically and are equipped with a soft starter.

Level Management Operating Mode

In the example, the 3 digital level switches act on the pumps at 3 different water levels: very low, low, and high level. The Lsh1 high level and Lsl1 low-level switches provide information on the level of the water in the tank. The Lsll1 very low-level switch is directly wired to the power supply of both pumps so that they do not run dry.

Platform Components

Overview

The software lets you engineer each part of a system (application, projects, and topology) independently by using specific tools, which provide the necessary functionality.

You can engineer several systems simultaneously.

EIO0000001114.15

Platform Managers

The following explorers are available as part of the software platform.

Explorer

Global

Templates

Explorer

Systems

Explorer

Application

Explorer

Project

Explorer

Topology

Explorer

Description

Displays the Global Templates of the installed libraries and those that you have created and/or imported.

They are organized in a folder structure, which makes the templates easily accessible.

The explorer lets you search, create, modify (see EcoStruxure ™ Process Expert,

Global Templates, Reference Manual), and manage Global Templates.

Displays the systems that exist in the database of the system server.

The explorer is the entry point to start engineering systems.

Displays the application of a system in a tree view, which lets you create a hierarchy.

The explorer lets you search, create, configure, and manage the instances that model the application of a system.

Displays, at the platform level, the projects of a system that are managed by the software Participants:

• Control projects

• Supervision projects

The explorer lets you create and manage the Control logic, Supervision data, and the executables of each project.

Displays the topology of a system in the form of a folder structure.

The explorer lets you create and manage the different topological entities that model the hardware infrastructure. Also, it allows you to interact with the controllers, devices, station nodes, and networks of a system.

Global Templates Definition Stage

Stage Map

The following figure shows the position of the Global Templates Definition stage within the system engineering life cycle:

Definition

The Schneider Electric application and topological templates that are provided in various libraries allow you to engineer systems. Yet, you have the possibility to modify or create templates.

EIO0000001114.15

The Global Templates Definition is the process of creating and/or modifying templates by:

• Using existing templates from the Global Template library and modifying them to meet your particular requirements.

• Creating new templates by using generic base elements with the help of template editors.

This process is described in a separate manual (see EcoStruxure ™ Process

Expert, Global Templates, Reference Manual).

Instantiation Stage

Stage Map

The following figure shows the position of the Instantiation stage within the system engineering life cycle.

EIO0000001114.15

Definition

The instantiation stage involves modeling:

• The process hierarchy by using a folder structure.

• Functional components by using

instances, page 25

of templates.

The resulting folder and instance organization represents the application of the system and is unique.

Once you have created a

system, page 105

, you can create instances from templates that you select among a choice of templates that are available in the

Global Templates library.

Depending on the composition of the template, during the instantiation, the template creates a set of Control and/or Supervision facets, which are associated to the instance and provide specific services.

To fulfill the specific requirements of the application, the instantiation process includes the step of configuring the application folders and the instances that they contain by:

• Selecting/deselecting optional Control and Supervision facets among those that are built into the instance template to enable/disable the corresponding services.

• Editing folder and instance properties and/or parameters.

• Creating links between instances.

implementation, page 115 .

For more information on completing the instantiation stage, refer to the chapter describing its

Example of the Process Hierarchy of the Water Tank System

The following figure shows an example of how you can organize the application of the

water tank automation system, page 27

Water tank: Water tank system root folder.

Level: Level management folder, which will contain the instances modeling the water level sensor functionality.

Pumping: Pump management folder.

Pmp1: Folder containing the instances modeling the functionality of the motor of

Pump 1.

Pmp2: Folder containing the instances modeling the functionality of the motor of

Pump 2.

Selecting Templates to Model the Application

The table shows examples of templates of the General Purpose Library that can be used to model the water tank application.

Template Application

$MotorGP Motors of Pump 1 and Pump 2

$ATS48MBGP Altistart 48 progressive starters for Pump 1 and Pump 2

$DigitalInputGP Digital switches (Lsh1, Lsl1, Lsll1)

Example of the Instances Modeling the Water Tank Application

The following figure illustrates the concept of instantiation for the water tank application.

EIO0000001114.15

Selected template

$MotorGP

Instances created from template (1)

Motor_Pmp1

Motor_Pmp2

$ATS48MBGP Motor1_ATS

Motor2_ATS

$DigitalInputGP Lsh1

Lsl1

Lsll1

NOTE: For simplicity, only the following items are represented:

• Pump 1 and level switch objects.

• Instances inside folders Pmp1 and Level.

• Facets of the Motor_Pmp1 instance.

The table describes the instances that are created during instantiation of the templates and gives an example of the configuration possibilities.

Instance description Purpose of the facet contained in the template

(2)

Configuration example (3)

Model the electrical motors of

Pump 1 and Pump 2.

Control facet for on/off logic.

Control facet to manage interlock conditions.

Supervision facet to manage runtime motor on/ off data.

Supervision facet to manage interlock data.

The on/off logic facet is selected by default and cannot be deselected.

The corresponding service is provided for the instance.

You can configure various parameters for this Control service.

The optional interlock condition summary facet is selected, created, and the service is be available for the instance.

The optional Supervision facets are selected, created, and the corresponding services are available for the instance.

You can configure several parameters for these Supervision services.

Model the management of motors for Pump 1 and Pump

2, each by an ATS 48 soft starter device.

Models a digital input for the

Lsh1 high-level detection switch.

Models a digital input for the

Lsl1 low-level detection switch.

Models a digital input for the

Lsll1 low-low-level detection switch.

Not detailed for the example.

Control facet to manage the logic.

Supervision facet for signal data.

Control facet.

(Same as for Lsh1

Supervision facet.

(Same as for

Same as for

Lsh1

)

The logic facet is selected by default and cannot be deselected. The corresponding service is provided for the instance.

You can configure several parameters for this Control service.

The optional Supervision facet is selected, created, and the corresponding service are available for the instance.

You can configure several parameters for this Supervision service.

The logic facet is selected by default and cannot be deselected. The corresponding service is provided for the instance.

You can configure several parameters for this Control service.

The optional Supervision facet is selected, created, and the corresponding service is available for the instance.

You can configure several parameters for this Supervision service.

Not detailed for the example.

(1) The name of the instance is user-defined.

(2) The actual templates contain more facet templates than shown in the table.

EIO0000001114.15

(3) The facets are created for each instance. The example shows only the configuration for instances Motor_Pmp1 and Lsh1 . In fact, each instance of a template can be configured individually.

Project Definition Stage

Stage Map

The following figure shows the position of the project definition stage within the system engineering life cycle.

Definition

The project definition is the process to define the organizational structure of projects that will be integrated into the system through the Participants. You define projects independently from specific hardware components, which gives you flexibility and allows you to use one project with different hardware infrastructures.

Ultimately, towards the end of the system engineering life cycle, to each project will be associated one or more executable files that you can deploy to the topology of the system.

For each system, you can define as many projects as required.

Each project is associated to a Participant and is therefore referred to as a

Participant project .

A system is composed of the following Participant projects:

Control

Supervision

This type of project is specific to a hardware platform (for example,

Modicon M580 platform) and manages the controller program.

This type of project allows you to manage data from the application, represent it graphically, and provide the operator with a user interface to interact with the controller.

NOTE: Supervision projects are optional and you create them depending on the requirements of the system.

Project Structure

The organizational structure of a project is specific to the Participant that it is related to because it reflects the components that the Participant manages.

A Control project consists mainly of nodes representing:

EIO0000001114.15

deployment stage, page 41

• The program structure: A Containers node containing FBD and non-FBD program sections, which are referred to generically as containers.

• The binary program: An Executables node providing access to program files and related services.

A Supervision project consists mainly of nodes representing:

• Data: A Containers node containing tag containers for each cluster.

• Graphic elements: A Pages node that contains the user interface visible to the operator.

• Components: A Cluster node for managing servers and communication for data acquisition and representation by cluster.

• The program: An Executables node providing access to services related to the program files.

Types of Projects

As you progress through the system engineering life cycle, a Participant project evolves. To distinguish between the stages that projects go through, specific terminology is used to describe them.

The software manages three types of Participant projects throughout the system engineering life cycle:

Logical Participant projects

Built Participant projects

Deployed Participant projects

Contain the information of the application and the organizational structure of the project with no relation to the hardware infrastructure of the system.

The software creates these projects during the

generation, page 35

stage.

Contain the information of the logical Participant project and associate it to the hardware infrastructure of the system. The software creates these projects during the

build, page 40

stage.

Are the built Participant projects that you have deployed to engines of the system (for example, controllers or station nodes). You deploy projects during the

The following figure illustrates at which stages of the system engineering life cycle, the different types of projects are managed.

EIO0000001114.15

For more information on completing the project definition stage, refer to the chapter describing its

implementation, page 199

Example

The following projects are defined for the

Assignment Stage

• A Control project to manage the logic (for example, variables and DFBs,) of the instances of the application. It contains three containers in the MAST task folder corresponding to the folder structure of the application:

◦ Level

◦ Pmp1

◦ Pmp2

• A Supervision project to manage the Supervision services (tags, alarms, supervision pages) of the instances of the application. It contains the following components:

◦ One tag container for the Supervision data facets of the instances of the application.

◦ One page for the Supervision genie facets of the instances of the application.

◦ Components: One of each I/O, alarm, and trend server, and I/O device with its communication port.

Stage Map

The following figure shows the position of the assignment stage within the system engineering life cycle.

Definition

The assignment is the process of associating Control and Supervision facets of instances of the application to a container of the corresponding project of the system.

The purpose is to define where the constituents that are encapsulated inside the facets will be generated in the Participant project during subsequent stages of the system engineering life cycle.

You need to assign the two types of facets to the corresponding containers:

• Control facets: To containers of Control projects, which are FBD sections.

• Supervision data facets: To containers of Supervision projects, which are tag containers.

You can assign a facet only to one container per project but you can assign a facet to several projects.

NOTE: Supervision genie facets are assigned to a page of a Supervision project during the refinement stage.

EIO0000001114.15

implementation, page 256 .

For more information on completing the assignment stage, refer to the chapter describing its

Example

The table shows an example of assignment of the facets of the instances Motor_

Pmp1 and Lsh1 of the

that you can perform.

Instance

Motor_

Pmp1

Lsh1

Facets

Control facets:

• $MOTORGP_UL : On/off logic data facet

• $INTERLOCKONGP_UL :

Optional interlock condition summary facet

Supervision facet:

• $MOTORGP_CD : Optional on/off data facet

Control facets:

• $MOTORGP_UL : Logic data facet

• $DISignal_UL : Optional digital input signal

Supervision facet:

• $DINPUTGP_CD : Optional data facet

Assigned To

FBD section Pmp1 of the Control project.

Tag container of the Supervision project.

FBD section Level of the Control project.

Tag container of the Supervision project.

Generation Stage

Stage Map

The following figure shows the position of the generation stage within the system engineering life cycle.

EIO0000001114.15

Definition

The generation is an automatic process that creates a logical Participant project by using the constituents of the assigned facets and taking into account the structure of the project. At this point, the logical Participant project has no relation with the topology of the system.

Refinement Stage

implementation, page 297 .

For more information on completing the generation stage, refer to the chapter describing its

Example

During the generation process of the facets of the

implementation, page 336 .

that are assigned to projects, the software creates:

• For Control: The program of the Participant.

• For Supervision: populates the different database files that are used by the

Participant.

Stage Map

The following figure shows the position of the refinement stage within the system engineering life cycle.

Definition

Refinement is an optional process during which you can modify and/or add information to a logical Participant project that the software has created during the generation stage.

For example, you can refine a Control project to:

• Add logic between control facets of instances.

• Create new relationships with other constituents such as interlocks or control sequences.

• Add sections in languages supported by the Participant other than FBD.

To facilitate the refinement of Control projects, the software locks and identifies visually code that it has generated.

You can refine a Supervision project, for example, to:

• Assign genie facets to a Supervision page.

• Configure user privileges.

The software opens the respective Participant allowing you to use the interface and some functionalities of the embedded software.

For more information on completing the refinement stage, refer to the chapter describing its

EIO0000001114.15

water tank system, page 27 ,

Example

During the refinement of the Control project of the

you can access and modify the control logic using the embedded editors to create or modify constituents.

The following figure illustrates the refinement of the constituents generated by the

Control logic facet of the Lsh1 high-level switch sensor instance. During this refinement, a new variable is added.

Configuration Stage

Stage Map

The following figure shows the position of the configuration stage within the system engineering life cycle.

EIO0000001114.15

Definition

The configuration stage consists in defining the topology of the system, which models the hardware and software infrastructure.

You can create topological entities by using either of two methods depending on the entity that you are defining:

• In the engineering client user interface by selecting manually the templates to be used to create entities.

• In the Control Participant by using the functionality of the embedded software.

Saving the configuration in the Participant creates the corresponding folders

implementation, page 364 .

and devices in the Topology Explorer by selecting automatically the appropriate templates of the Foundation library.

For more information on completing the configuration stage, refer to the chapter describing its

Example

For the

water tank system, page 27 , during the configuration stage, you can define

the hardware that will run the program, the Ethernet control network, and the operator station from which the operator will operate the pump, monitor the pumping process, and the water level.

The following figure shows examples of topological entities of the water tank system that you can create during the configuration stage.

Controller

STB Island

Operator station

Ethernet network

Gateway

ATS 48

Local rack with an Ethernet based architecture.

Distributed I/Os to which level switches Lsh1, Lsl1, and Lsll1 are connected, communicating with the controller through I/O scanning.

Supervision station to control and monitor the system, configured with its network interface card and the supervision software.

Networks connecting the controller, the STB Island, the gateway, and the station node.

The gateway communication instance is created in the application of the system modeling the communication functions. The device itself is not represented in the topology.

The soft starter instances are created in the application of the system modeling the motor management functions. The device itself is not represented in the topology.

NOTE: When communication with devices is performed by using Modbus TCP explicit or implicit messaging, topological instances of devices are created also in the topology to manage TCP/IP addressing.

EIO0000001114.15

implementation, page 420 .

Mapping Stage

Stage Map

The following figure shows the position of the mapping stage within the system engineering life cycle.

EIO0000001114.15

Definition

The mapping stage consists in associating facets of a project to resources of the topology of the system.

You can perform three types of mappings independently for each project:

• Service mapping : Defines which engine executes the project (for example, which controller runs the program or, which station node hosts the I/O server).

• Hardware mapping : For Control projects only. Links the logical projection of the hardware defined in the application (for example, a variable representing an I/O signal of a motor) to the hardware defined in the topology (for example, an I/O channel in an I/O module of the controller).

• Communication mapping : Defines runtime communication (for example, which controller will communicate with the I/O device and through which communication module), communication between controllers (peer to peer communication), and between controllers and devices (for example, communication with STB islands or Modbus TCP Ethernet devices by using I/

O scanning).

NOTE: You can map a project to several different engines, for example:

• To a controller in the laboratory for test purposes.

• To a controller in the production plant.

For more information on completing the mapping stage, refer to the chapter describing its

Example

The table gives examples of the mappings that you can perform for the

water tank system, page 27 .

Mapping

Control project

Service

Description

Defines to controller the program is associated for deployment and execution.

Build Stage

Mapping Description

Hardware If for instance Motor_Pmp1 , you select the optional Running Control service, the software creates the corresponding facet. It creates, for example, a boolean variable that indicates the state of the motor switch.

You can map this variable of the application to the channel of an input module of the STB island.

Communication

Defines the I/O scanner channels that are created for communication between the controller and the STB island.

Supervision project

Service

Communication

Defines the I/O, alarm, and trend servers that are used for the Supervision project and on which operation stations of the topology they are installed.

Defines from which controller I/O data is acquired and which communication module of this controller is used.

Stage Map

The following figure shows the position of the build stage within the system engineering life cycle.

Definition

The build stage consists in starting an automated process during which a

Participant merges the following information in order to create the built Participant project:

• The logical Participant project

• Mappings

• The topology

The built Participant project is the executable that you can deploy to engines of the system

The software stores the executable files resulting of this process in the contents repository.

At this point, you can view the complete Control and Supervision projects in the corresponding Participant.

Once built, a project is referred to as the built Participant project, which is the project associated to an engine for execution.

EIO0000001114.15

implementation, page 464 .

For more information on completing the build stage, refer to the chapter describing its

Example

During the build process of the

, Participants create the following files.

Participant Generated Files

Control The executable file, which is the binary to be deployed to the controller.

Supervision The master project file (.ctz) to be deployed to the operation server and operator stations.

Files of the included projects (.ctz) to be deployed to the operation server and operator stations.

The OFSOPC/OPC UA configuration files (.xml) to be deployed to the operation server.

Deployment Stage

Stage Map

The following figure shows the position of the deployment stage within the system engineering life cycle.

EIO0000001114.15

Definition

During the deployment stage, you transfer a built Participant project to the corresponding engine that is defined in the topology of the system.

Depending on the project, an engine can be:

• For Control:

◦ a controller

◦ a station node for emulating a simulator

• For Supervision: A station node acting as operation server or operator station.

Once deployed, a project is referred to as the deployed Participant project, which is the project that is loaded into the engine for execution.

The stage also includes the steps of redeploying an already deployed Participant project and to update a deployed Participant project with changes that you have made to the corresponding logical Participant project.

Execution Stage

implementation, page 481 .

For more information on completing the deployment stage, refer to the chapter describing its

Stage Map

The following figure shows the position of the execution stage within the system engineering life cycle.

Definition

The execution stage includes the steps to:

• Start and stop the execution of a deployed Participant project.

• Make online changes to a deployed Participant project.

• Update the corresponding logical Participant project with the changes that you have made online.

The execution stage takes into consideration actions that you can perform with and without stopping the controller to keep you informed of the impact of your changes.

For more information on completing the execution stage, refer to the chapter describing its

implementation, page 531 .

Additional runtime services are described in the Navigation Services User Guide

(see EcoStruxure ™ Process Expert, Runtime Navigation Services , User Guide ).

EIO0000001114.15

Starting and Quitting System Server and Clients..............................................44

Working with the Software

What’s in This Part

Multiuser Functionality ...................................................................................52

Action Traceability .........................................................................................54

Software Capabilities .....................................................................................61

Using the Help ..............................................................................................69

User Interface ...............................................................................................76

Overview

This part explains how to access and use the client user interface (UI). It describes the various functionalities of the software and provides general information to help you use them effectively.

EIO0000001114.15

Logging In and Out of System Server and Clients ............................................44

What’s in This Chapter

Locking and Unlocking the Software ...............................................................46

Starting the System Server Again ...................................................................46

Client/Server Connection ...............................................................................47

Quitting the Software .....................................................................................50

Overview

This chapter describes how to start and quit the system server and clients after a first start, and describes the client/server connection.

Logging In and Out of System Server and Clients

Overview

Any user who is a member of at least one EcoStruxure Process Expert group can log in to the system server or a client.

These groups are created automatically or must be created manually by the system/network administrator depending on the authentication type that was selected during installation. The administrator must also add users to one or more groups depending on the role of each user.

To be able to use the functionality of a given component, you must be a member of the appropriate group (for example, to use the engineering client, you must be a member of the ESX HDCS Engineer group).

NOTE: For information on how to get started with the software, refer to the topic describing the first steps to perform (see EcoStruxure ™ Process Expert,

Installation and Configuration Guide).

Authentication Domain Selection

When you log in, enter your username without domain name or any prefix.

The system server uses the authentication type setting (see EcoStruxure ™

Process Expert, Installation and Configuration Guide) to validate your credentials either locally or with the Active Directory ® domain service.

NOTE: If Domain is the configured authentication type, the domain controller must be reachable from the computer running the system server.

NOTE: If the computer that runs the client is connected to a Windows ® domain and the connection to the domain network is interrupted, users can log in locally by changing the authentication type setting to local.

For more information, refer to the topic describing role based access control

(see EcoStruxure ™ Process Expert, Installation and Configuration Guide).

Single Login and Logout

The software implements a single-login mechanism. You need to log in when you open the first software component (for example, a client). Thereafter, you are logged in automatically when you open other components on the same computer.

If several components are open on the same computer, you are logged in to all of them at once. You need to log in again only after you log out of a component on the computer.

44 EIO0000001114.15

Locking and unlocking, page 46

The software also implements a single-logout mechanism. Logging out of a software component also logs you out of the other software components to which you are logged in on the same computer.

Logging In

To log in to a software component, enter your username (without domain) and password in the log-in window. The log-in process may take a moment to complete.

The window appears when you start the first component on a computer, open a second component while no user is logged in to the first component, or by clicking

user menu, page 77 .

If you close the log-in window without logging in, the component remains open.

NOTE: Logging in to a client is subject to the same log-on policies as those that are defined locally for the computer or for the domain.

Logging Out

To log out of a software component, select the Log Out command from the

user menu, page 77 .

To be able to log out, all operations that are in progress for components running on the computer must have completed.

Logging out of a software component:

• Does not quit the component.

◦ The system server is not stopped if it is running. Further, you cannot stop the system server when no user is logged in.

◦ For clients, if you had opened additional windows by using the Open in

New Window

command, page 83

, these windows are closed. Tabs are closed.

• Logs you also out of the other software components to which you are logged in on the same computer.

NOTE: You are logged out of the software on a computer when you quit the last component to which you were logged in on this computer.

Viewing Connected Clients

From any client that is connected to a system server, you can view information about the clients that are connected to this server in the Client Details tab of the about dialog box.

For a description of the dialog box, refer to the topic describing the About

EcoStruxure Process Expert

dialog box, page 78 .

Tracing Login Attempts and Log Outs

The following actions are recorded:

• Attempts to log in to a component even if they are unsuccessful. The username that is entered is recorded.

•

a component.

• Logging out of a component.

Actions performed in the system server console appear as notifications in the console and are recorded in the system server log files. Actions performed in a client appear in the notification panel (they also appear in the system server console when client and server are running on the same computer).

For details, refer to the topic describing the

traceability of actions, page 54

EIO0000001114.15

stopped it, page 50 , proceed as follows.

Locking and Unlocking the Software

Locking Software Components

To lock a software component, select the Lock command from the

user menu, page 77 .

Locking the server still allows clients running on other computers to connect to it or remain connected.

When components are locked, the log-in window opens on top of the main window. The username of the logged-in user shown is in the User Name field in read-only mode. Only the user who has locked the software can unlock it.

Impacts of Locking Software Components

Locking a software component has the following impacts:

• Locking any software component also locks all the other components that are open on the computer and to which you are logged in.

• Dialog boxes and notifications in the notification panel are queued and suppressed. These messages are shown once the component is unlocked.

• You cannot quit a component that is locked.

• You cannot open other EcoStruxure Process Expert components on the computer.

Unlocking Software Components

To unlock a component, enter the password in the login dialog box.

Unlocking any software component also unlocks all the other components that were locked on the computer.

To unlock the software when the domain authentication type is selected requires that the domain controller be reachable from the computer running the system server.

Starting the System Server Again

Temporary Contents Repository Files

When you start the system server, it creates folders to store

temporary files, page

706

from the contents repository to speed up access to these files.

Insufficient Disk Space Notification

When you start the system server, the server console may display a notification about insufficient free disk space (see EcoStruxure ™ Process Expert, Installation and Configuration Guide).

If this notification appears, try to free some disk space.

Starting the System Server

To start the system server after you

Step

Action

Verify that Caché is running by checking the presence and the color of the Caché icon in the notification area. When Caché is running, its icon is blue.

If the system server console is not open, from the Windows ® Start menu, click

EcoStruxure Process Expert > System Server .

46 EIO0000001114.15

action is required, page 49

Step Action

Result: The log-in window opens.

Enter your username without domain or prefix, your password, and click Log In .

Result: The system server console opens.

Click Action > Start .

Result: The system server starts.

Wait until the system server console displays the following message at the bottom of the window to start engineering and operation clients (see EcoStruxure ™ Process Expert,

Installation and Configuration Guide):

Server is ready .

Client/Server Connection

Overview

Clients connect with the system server through an Ethernet cable connection, for example to:

• Access the database.

• Access software Participants.

• Launch tasks that are performed by the system server.

• Receive notifications from the system server.

• Verify digital certificates and license rights.

You cannot use clients while the connection to the system server is interrupted or while the system server is not running.

You can test the client/server connection (see EcoStruxure ™ Process Expert,

Installation and Configuration Guide).

Notifications About Client/Server Connection Interruption

The table describes the various notifications that appear client-side for different scenarios where a client cannot connect to the system server or the virtual machine anymore.

Scenario

Operation in progress at the time of the interruption

You launch a task while the connection to the system server is interrupted.

Yes

Client notification

Notification that the client is unable to connect to the system server.

Notification about an unexpected communication interruption.

Yes. An action is performed in an open software

Participant window.

Corrective action

None

Launch the task again when the connection is reestablished.

Notification that the action in the

Participant cannot be performed and indication of the possible causes.

NOTE: If you are refining a

Control project online (see

EcoStruxure ™ Process

Expert, Control Participant

Services, User Guide) and have clicked the button to build and deploy changes after the connection was interrupted, the changes

If the system server is still running, the action completes server side and the notification of clients is updated when the connection is re-established.

If the system server has stopped, an

If the connection to the system server is still functional, save changes, close the Participant window, and start over once the problem is fixed.

If the connection to the system server is interrupted, refer to scenario 3.

If the reason for the connection interruption cannot be determined, you need to contact Schneider Electric

support, page 79

EIO0000001114.15

Scenario

Operation in progress at the time of the interruption

Client notification

The system server is stopped by user intervention.

are not deployed nor saved.

Notification in the

to inform that the server is shutting down.

Corrective action

From this point on, you cannot perform any action on the client.

Restart the system server.

Contact Schneider Electric

support, page 79 .

Yes. An action is performed in an open software

Participant window.

None.

A message appears in the system server console.

NOTE: Refer also to the topic providing information to help troubleshoot client/ server communication (see EcoStruxure ™ Process Expert, Installation and

Configuration Guide).

The following figure shows an example of the notification that appears for scenario

2. The name or IP address and the port of the system server computer are indicated.

The following figure shows an example of the notification that appears for scenario

48 EIO0000001114.15

The following figure shows an example of the notification that appears for scenario

4 in case you are refining a Control project online.

After Re-establishing the Connection to the System Server

Clients automatically reconnect to the system server when the connection is reestablished or when the system server is running again. After reconnecting, clients display a notification to inform you of the communication interruption.

Unsaved changes are discarded and open windows are reloaded or closed automatically.

EIO0000001114.15

If the system server has stopped, the notification panel is empty when the system server restarts. To view the history of activity up to the interruption of the communication, open the

log files, page 59 .

After an unexpected interruption of the client/server connection, the states of both the engineering client and the system server may have become inconsistent. This can be the case, for example, if at the time of the interruption an operation was in progress such as an import of several Participant projects or pasting of many instances.

NOTICE

LOSS OF COMMUNICATION

After an interruption of the client/server connection, verify that the last operation executed by the software was completed successfully, and if necessary, repeat the last operation.

Failure to follow these instructions can result in unresponsive clients.

You are able to resume using the software when the connection to the system server is re-established or when it is running again.

start the system server, page 46 .

Restarting Clients After Closing Unexpectedly

If an engineering client closes unexpectedly (for example, because the computer on which it is running stopped working), you do not need to restart the system server. You can restart the client after 60 seconds. This is the time that is required by the system server to terminate a client session, which ended abnormally.

Restarting a client earlier may trigger messages about missing engineering client license, for example.

Quitting the Software

Overview

To quit the software, quit in the following order:

• Any clients that are connected the system server that you are stopping.

• The system server

To restart the system server, quit the software in the same order and the then

You cannot quit a component if it is

locked, page 46 .

NOTE: You are logged out of the software on a computer when you quit the last component to which you were logged in on this computer.

Quitting Clients

When you quit a client, it does not close if any task is still in progress.

To quit a client, proceed as follows.

Step

Action

Verify that any processes are finished executing by checking the information in the notification panel.

Click the close button of the client window.

Result: The client window closes, disconnecting it from the system server.

Stopping the System Server

When you stop the system server, tasks in progress are completed before the server is stopped. If any client is still connected to the system server, a notification is displayed, which indicates the identity of the logged-in user by using the format full name (computer name) .

You cannot use a client when the communication between the system server and the client is interrupted, for example, when the system server is restarted or not running.

NOTICE

LOSS OF COMMUNICATION

Stop the system server only when no client is running.

Failure to follow these instructions can result in unresponsive clients.

To stop the system server, proceed as follows.:

50 EIO0000001114.15

Multiuser Functionality ...................................................................................52

Step

Action

From the menu bar of the system server console, click Actions > Stop .

Result: A dialog box asking you to confirm the system server stop opens.

NOTE: If a client is still running, the full name of the user who is still logged in is displayed in the dialog box.

If a client is still connected, click No ; otherwise proceed to step 4.

Result: The dialog box closes without stopping the system server.

Quit the client, page 50

and stop the system server again by starting over this procedure.

When no more client is connected, click Yes .

Result: The system server completes tasks in progress and then stops.

NOTE: Click No to close the dialog box without stopping the system server.

EIO0000001114.15

Multiuser Functionality

What’s in This Chapter

Multiuser Functionality

Overview

Several clients can connect to a system server simultaneously, allowing several users to work on the same component or different components of a system at the same time.

For example, User A and User B can work on the application of the system, or

User A can work on the application and User B on the projects of the system.

These operations could also be performed by a single user.

In both cases, the software manages system-wide concurrent user access to editors and other tools to preserve the integrity of data of the system.

It may allow you to view data by granting access to certain editors in read-only mode.

When a user is finished working on a system component (for example, an instance) by closing the corresponding tool (for example, the Instance Editor ), the software allows other users to access components that manage or use data of that component.

As such, users do not need to check out or lock the component that they are working on.

Managing User Activity

At the following stages of the system engineering life cycle, the software indicates the status of objects by using icons:

•

Instantiation, page 146

•

Project Definition, page 254

At any stage, when the command that you have selected cannot be completed, you can obtain information about the reason through:

• Dialog boxes that clients display when you try to access system data that is being used or edited by another user.

• Information in the notification panel on the activity of any user that is logged in to a client of the same system server.

Virtual Machine Usage Considerations

While the type and number of activated EcoStruxure Process Expert licenses dictate how many clients can connect simultaneously to a system server, users may be restricted in the use of certain commands that require services of a virtual machine (for example, the Refine command of the Project Explorer ). Each virtual machine provides access to a limited number of instances, and each instance to a limited number of software Participant sessions.

For more information, refer to the topic describing virtual machine usage (see

EcoStruxure ™ Process Expert, Installation and Configuration Guide).

Examples

By using examples, the table illustrates some of the locking mechanisms that the software implements when two users work on the same system.

52 EIO0000001114.15

Multiuser Functionality

Action executed by User A

Editing properties of Instance A .

Refining the Control Participant project in the

Project Explorer .

Configuring a controller entity in the Topology

Explorer .

Examples of restrictions for User B

Cannot edit Instance A but can open the

Instance Editor in read-only mode.

Can generate the section to which facets of

Instance A are assigned but the facets of

Instance A are not generated. If the section contains other facets, they are generated.

Information is displayed in the notification panel.

Cannot refine the same Participant project or any section of it. Information is displayed in a dialog box.

Cannot generate the same Participant project.

Cannot build the same Participant project.

Cannot configure the same controller entity.

Cannot do mapping (hardware and communication) of the Control executable to which the engine is mapped.

Cannot build the Control Participant project executable to which the engine is mapped.

NOTE: The locking mechanisms apply also when a single user is performing these operations (if applicable).

EIO0000001114.15

Notification Panel ........................................................................................54

What’s in This Chapter

Audit Trail .....................................................................................................56

Activity Log Files ...........................................................................................59

Overview

This chapter describes how to obtain information related to the activity of the system server and clients.

Notification Panel

Overview

The notification panel allows you to view and trace engineering activity. The panel is displayed automatically when you start an engineering client. You can modify its height and show column headers.

The information that is displayed is the same for each engineering client that connects to the same system server. When you open a second engineering client, you can see in its notification panel the history of actions starting from the moment the first engineering client was opened.

Certain system server and virtual machine tasks are displayed also.

An entry is logged when you launch a task and it is updated as the execution of the task progresses. When the task is complete, the status of the task and the actions that the software has executed are indicated.

For each task, a color icon allows you to see the status at a glance.

At any time, the notification The information remains available while the system server to which the client is connected is running. Closing the client or the notification panel does not delete the entries.

You can show/hide the notification panel from the engineering client

toolbar, page

77 .

Information Availability

At any time, the notification panel can display a maximum of 2000 entries. When this limit is reached, the most recent entries replace the earliest ones on a first-in first-out basis.

The information remains displayed while the system server to which the client is connected is running. Closing the client or the notification panel does not delete the entries.

Aborting Tasks

When you select or confirm certain commands, the icon appears in the Action column of the notification panel. You can click it to cancel the task. Once the task is near completion and cannot be canceled anymore, the icon appears disabled

. Only the user who has initiated the command is allowed to abort it.

The possibility to abort and the behavior when you click the icon is described in the topics documenting the commands for which the abort functionality is

54 EIO0000001114.15

Data Description

available. For example, the Paste

command, page 157

of the Application

Explorer .

Aborted tasks are identified in the notification panel in the Message column with

(Aborted) . When you export data of the notification panel, it is the most recent subtask of the process that is identified with Aborted in the Action column, not the task itself.

The table describes the data that is displayed in the notification panel.

Column header (1)

–

Description

Icons indicate the status of the task:

• Task in progress (spinning).

• Task completed successfully (green).

Success (2)

Start Time

Elapsed Time

Message

Action

User Name

Station Node

System

Domain

Entity Path

Entity Type

Attribute

Old Value

New Value

•

Task did not complete (red).

Not successful

Task completed with notifications (yellow).

(2)

Warning (2)

• Information (blue).

Informational (2)

Date and time when the task was initiated.

The time it took to complete the task independently of its final status.

Short description of the task that was executed. The status of the task is indicated in brackets.

A task can have messages for subactions.

Expand the row by clicking the expand icon on the outer left of the row.

Keyword describing the action that was executed. Typically, this corresponds to the command you selected.

Name of the user who is logged in to the client from which the task was executed.

Format: Full name (Username)

Name of the PC on which the client from which the task was executed is installed.

Identifier of the system in which the task was executed.

When the task is not related to a system, the entry is Global .

Identification of the domain or project component on which the task was executed.

When the task is not related to a system component (for example, when a user logs in), the entry is Global .

Path the entity on which the task was executed.

Type of the entity on which the task was executed.

Identifier of the modified attribute (if applicable).

Value of the attribute before the modification was performed (if applicable).

Value of the attribute after performing and/or saving the modification (if applicable).

(1) To show column headers, right-click any row inside the notification panel and click Show Table Headers . Headers are hidden by default.

(2) Corresponding keyword in the

export file, page 56 .

EIO0000001114.15

Using the Notification Panel

For each task that you launch, it is good practice to verify in the notification panel if the task is completed and its final status.

Select a task that has subentries and press Enter (or double-click it) to expand/ collapse it. Subentries provide more detailed information about the task.

NOTE: When performing activities on a large number of entities, expanding entries in the notification panel may increase the response time of the engineering client temporarily. Such activities can be, for example, importing or generating 500 or more objects at once.

Filtering and Sorting Activity Data

Use the

filter function, page 93

on columns to view, for example, only activity of one user by filtering on the User Name column.

By default, the most recent activity is displayed at the top of the list.

Exporting Activity Data

To save the history of actions, export activity data on a regular basis and before stopping the system server.

To export to file (.csv) activity data that is displayed in the notification panel covering a selected period, proceed as follows.

Step

Action

Right-click any row inside the notification panel and click Export .

Result: The Export dialog box opens.

In the Destination field, enter a file name and location, or use the default file name and location.

In the Period field, select a start date and time, and an end date and time to define the time span of activity data to export.

NOTE: Only activity data that appears in the notification panel can be exported.

Click OK .

Result: The software creates the export file and opens the folder that contains it.

NOTE: Click Cancel to close the Export dialog box without exporting data.

NOTE: Click Reset to reset the values of the Destination and Period fields to their default values.

NOTE: If a file with the same name exists at the specified location, the software displays a dialog box asking you for confirmation before overwriting the file.

Audit Trail

Configuring Audit Trail

You can from the Audit Trail section of the System Server Configuration

Wizard .

Working Principle

This topic describes the audit trail functionality for system-engineering activities performed by users and the data that is sent to the syslog server.

Once you have enabled and configured audit trail, when the system server is started, it connects to the syslog server and sends audit trail messages.

56 EIO0000001114.15

Messages are sent in chronological order for actions that users perform on systems by using the engineering clients of the infrastructure.

Messages for certain user actions that are performed in the system server or operation clients are also sent.

The audit trail functionality of EcoStruxure Process Expert is independent of the

Event Logging setting of the Control Participant ( Project Settings > PLC

Diagnostics ).

NOTE: Syslog server software needs to be purchased and installed separately.

Scope of the Audit Trail

Typically, audit trail messages that are sent to the syslog server correspond to a user-action entry in the notification panel of the engineering client.

For each child notification pertaining to a parent entry, one message is also sent.

Messages for the main entry and its child notifications have the same Domain value.

No message is sent for system-generated entries and when a user action is canceled.

The following tables outline the type of actions for which messages are sent to the syslog server.

Actions Performed in Engineering Clients

Actions performed at the platform level

Logging in and out of the client.

Locking and unlocking the client.

Actions on systems.

Actions on system components.

Import operations.

Deployment operations.

Actions on global templates.

Actions on content repository data.

Comment

—

For example, creating, deleting, or restoring systems.

Application, topology, projects.

—

Actions performed in a

Participant

Control Participant:

• Refinement offline of project and sections

• Controller and PRM configuration

Control Participant: Refinement online.

Comment

Participant-generated messages are sent when changes are saved. Typically, this information does not appear in the notification panel of the engineering client.

Supervision Participant:

•

Refinement

Advanced settings

• Page editing

Messages are sent when the Build and Deploy command is used.

A message is sent also when you perform an action that impacts the controller directly (for example, initializing an animation table) even if you close the refinement window without building and deploying changes.

The information that is available is the same as that appearing in the notification panel.

No details are provided about Participant data that is modified.

EIO0000001114.15

Actions Performed in Operation Clients

Actions

Logging in and out of the client.

Comment

—

Locking and unlocking the client.

—

Connecting to a controller when using runtime navigation services.

A message is sent for obtaining the controller status when opening the Operation Client Viewer.

Actions Performed in the System Server

Actions

Starting and stopping the system server.

Logging in and out of the system server.

Comment

—

Audit Trail Message Format

The content of the message portion (message text or details) of a message that is sent to the syslog server uses the format defined by the syslog protocol (RFC

5424 specification), which is as follows:

<Time stamp> <Machine name> <Application name> – <User> : <Domain> :

<Action> : <Entity> : <Message> : <Attribute> : <Old value> →<New value>

Element

Time stamp

Machine name

Application name

User

Domain

Action

Entity

Attribute

Message

Old value

New value

Description

Date and time when the action was performed.

Format: YYYY-MM-DDThh:mm:ss:ms

Milliseconds (ms) are indicated with 7 digits (0000000 if not available).

The time stamp is based on the system time of the computer on which the

EcoStruxure Process Expert system server is installed in UTC.

Nevertheless, Schneider Electric recommends that the system time of computers on which EcoStruxure Process Expert clients are running be synchronized to the system time of the system server computer.

NOTE: For actions performed inside the Control Participant, the time stamp corresponds to the Participant system time in UTC.

Name of the computer on which the action was performed.

EPE

Name of the user who is logged in to the EcoStruxure Process Expert component on which the action was performed.

Format: Full name (Username) . If the full name is not defined, the username appears instead.

Domain or project component on which the action was performed.

For example, Systems or Application

Description of the action that was performed.

Name of the object on which the action was performed.

Identifier of the modified attribute (if applicable).

Description of the action. Typically, the information that is available in the notification panel of the engineering client.

Value of the attribute before the action was performed.

Value of the attribute after the action was performed.

NOTE: If an element contains no value, it is not shown.

58 EIO0000001114.15

notification panel, page 54 .

Connection to the Syslog Server

The table describes the actions of the system server when it connects to the syslog server and when the connection is interrupted.

Connection of system server to syslog server

Initial connection

Description

Connection is interrupted

A message is shown in the notification panel and sent to the syslog server to indicate the status of the connection.

In the notification panel, messages related to the connection status show Global in the System and Domain columns and

System in the User Name column.

The system server detects a disconnection when it is not able to send messages to the syslog server. In this case, it attempts to reconnect automatically up to three times. If unsuccessful, a message is shown in the notification panel.

Thereafter, the system server attempts to reconnect at the configured interval.

Connection is reestablished Two messages are shown in the notification panel and sent to the syslog server to indicate the following:

• Date and time the disconnection was interrupted.

• Date and time the connection was reestablished.

NOTE: Actions logged while the connection to the syslog server is interrupted are discarded. Notifications continue to show in the notification panel.

Activity Log Files

Overview

The software records the activity of each component (system server, engineering client, and operation client) by using log files.

In addition, the software maintains a log file that records information related to activated licenses for troubleshooting purposes.

The file size and number of files that the software maintains for each component is limited. This is done to make the log files more user-friendly to view and to save space.

NOTE: For clients, the data that is logged is different from the activity data that is displayed in the

Log File Location

Log files are located at the path C:\Users\ Username \AppData\Roaming\Schneider

Electric\Process Expert x\Logs, where x correponds to the major version of the software that is installed (the R• version suffix does not appear).

Username corresponds to the username that was entered to log on to the current session of Windows ® , independently of the username that was entered to

Log File Name Syntax

The names of log files have the following syntax: ComponentName.File number.

log

Component names are:

• Server for the system server.

• Client for engineering clients.

• OperationClient for operation clients.

EIO0000001114.15

• License is used for license-related information.

File numbers:

• The most recent log file has no file number.

• The second latest log file has number 0.

• The log files thereafter have incremental numbers from 1 to 9 where 9 represents the earliest log file containing the oldest information.

For example:

• Server.log

is the current log file in which the software is recording server activity.

• Client.1.log

is the log file in which the software recorded past engineering client activity. The file content is not updated anymore because Client.log

is currently recording activity.

Client.1.log

was created when Client.log

reached its size limit for the second time (the first time, Client.0.log

was created).

Log File Size

The size of any log file cannot exceed 4 Mb. When the size of a log file has reached this limit, the software creates a new file. Existing log file numbers are incremented.

Number of Log Files

The software keeps up to 10 log files per component. When the software needs to create a new log file because the current one has reached the size limit, and the number of files for a component is reached, the software deletes the earliest file for that component before creating the new one.

60 EIO0000001114.15

Hardware and Software Capabilities ...............................................................61

What’s in This Chapter

Supported Data Types ...................................................................................63

Naming Rules ...............................................................................................65

Hardware and Software Capabilities

Overview

The following describes the main hardware and software capabilities of

EcoStruxure Process Expert and additional capabilities of the embedded Control and Supervision software Participants.

For more information on the specific capabilities of the Control Participant and

Supervision Participant, refer to the

help of the respective Participants, page 69

Some capabilities and/or features may not be supported by the software.

Hardware Platforms

For information on the integrated and not supported hardware architectures, refer to Configuration Stage (see EcoStruxure ™ Process Expert, Control Participant

Services, User Guide).

NOTE: You can include other hardware platforms in systems engineered by using the software, however, the software will not provide any services for these platforms.

Programming Languages

The software generates the program for controllers by using the Function Block

Diagram (FBD) programming language.

The Control Participant supports additional

programming languages, page 62

for creating the user program, which can be used together in Control projects managed by EcoStruxure Process Expert.

The Supervision Participant supports a structured, proprietary programming language for monitoring and controlling plant equipment, which can be used together in Supervision projects managed by EcoStruxure Process Expert. For more information, refer to the

Supervision Participant help, page 69 .

Template Libraries

The software uses object-oriented modeling for the engineering of applications.

For this purpose, an extensive selection of Schneider Electric templates are provided in various libraries such as templates modeling signals, hardware templates modeling the system infrastructure, up to complex control module templates modeling the entire Control and Supervision functionalities of process objects.

When a library is installed, the templates are available in the Global Templates

Explorer and can be used in explorers and editors specific to the software. The encapsulated Control and Supervision constituents can be viewed in the corresponding software Participants.

For information on architectures, for which templates are available, refer to

Supported Hardware Architectures (see EcoStruxure ™ Process Expert, Control

Participant Services, User Guide).

EIO0000001114.15

Function and Function Block Libraries

The Control Participant includes an extensive library, which extends from blocks for simple boolean operations, through blocks for strings and array operations to blocks for controlling complex control loops.

For a better overview, the different blocks are arranged in libraries, which are then broken down into families.

The blocks can be used in the Control Participant in the programming languages

FBD, LD, IL, and ST and be added to Control projects managed by EcoStruxure

Process Expert.

Controller Program

In the software, the controller program is organized in:

• A Master task (MAST)

• A FAST task

• FBD sections, which are assigned to one of the defined tasks

By using the Control Participant, you can add to the controller program:

• Sections, which are assigned to one of the defined tasks

• AUX tasks (depending on the platform)

• Sections, which are assigned to AUX tasks

• Sections for processing time controlled events (Timerx)

• Sections for processing hardware controlled events (EVTx)

• Subroutine sections (SR)

The program components that are supported by the Control Participant, can be added to Control projects managed by the software. However, not all of them can be viewed in the software outside of the Control Participant (for example, non-FBD sections).

Performance Scope

The table shows the main characteristics of the software and its Participants.

Programming languages

Function Block Diagram (FBD)

Ladder Diagram (LD)

Instruction List (IL)

Structured Text (ST)

Sequential Function Chart (SFC)

Ladder Logic 984 (LL984)

Cicode

Schneider Electric Global Templates libraries

Foundation library

–

+ General Purpose and segment libraries

Function block libraries (1)

Standard library

Control library

Communication library

–

EcoStruxure

Process

Expert

–

Control

Participant

–

Supervision

Participant

62 EIO0000001114.15

Diagnostics library

I/O Management library

System library

Obsolete library

Memory card file management library

General information

Project browser/explorer

Template explorer

Instance editor

Create and modify object templates

Access control

Simulator

Context-sensitive and PDF help

Control

Encapsulate DFB constituents in templates

Create and use data structures (DDTs)

Create and use derived function blocks (DFBs)

HMI operator screens

Supervision

Encapsulate tags and genies in templates

Design pages, genies, face plates

Use tags and alarms

Clusters

Server and client events

I/O devices

I/O, alarm, trend, and report servers

Redundancy

Load balancing (operation servers)

–

EcoStruxure

Process

Expert

–

Control

Participant

–

Supervision

Participant

+ Available

(1) Availability of the function blocks depends on the hardware platform.

- Not available

Supported Data Types

Data Type Conversion

The software may use data types that are different from the types used by the

Control Participant (see EcoStruxure ™ Process Expert, Control Participant

Services, User Guide).

The conversion to Participant-supported types is done automatically.

EIO0000001114.15

Standard Data Types

The software uses the following data types.

Data Type

DateTime

Date

Time

Duration

String

Boolean

Float

Double

Decimal

Byte

Short

Integer

Long

UnsignedByte

UnsignedShort

UnsignedInt

UnsignedLong

Description

A specific instance in time

(1) .

A Gregorian calendar date

(1) .

An instant of time that recurs every day (1) .

hh:mm:ss.ms

A duration of time as specified by Gregorian day, hour, minute, second, and millisecond components (1) .

D.hh:mm:ss.ms

Example: 1.05:10:30.245

If the value contains no day or ms component, they are not shown as 0 values. For example: 11:20:30 is displayed to represent 0 days, 11 hours, 20 min., 30 sec., and 0 ms.

A sequence of unicode characters.

A binary logic value.

Represented by using the

32-bit single-precision IEEE

754 format (1) .

7-digit precision.

Represented by using the

64-bit double-precision

IEEE 754 format (1) .

15 to 16-digit precision.

A fixed-point decimal value with arbitrary precision (1) .

A maximum of 4 digits are allowed after the decimal separator.

8-bit signed integer.

16-bit signed integer.

32-bit signed integer.

64-bit signed integer.

8-bit unsigned integer.

16-bit unsigned integer.

32-bit unsigned integer.

Lower Limit

19-01-01 00:00:00.000

1900-01-01

00:00:00.000

1 character of the standard

ASCII table.

False

From approximately -3.4 x

10 38 to -1.5 x 10 -45

From approximately -1.7 x

10 308

-128 to -5.0 x 10

0.0001

-32768

-2,147,483,648

-324

-9223372036854770000

(1) Microsoft ® Windows ® Regional Options may apply to the format of the type.

Upper Limit

2100-12-31 23:59:59.999

2100-12-31

23:59:59.999

9,223,372,036,854,775,807 in ticks

NOTE: 1 tick = 100 ns

From approximately 5.0 x 10 -324 to 1.7 x 10 308

922337203685477.5807

127

32767

2,147,483,647

9,223,372,036,854,774,807

255

65,535

4,294,967,295

18446744073709551615

Size

8 bytes

8 bytes n characters of the standard

ASCII table.

True

From approximately 1.5 x 10 -45 to

3.4 x 10 38

1 character =

1 byte

4 bytes

8 bytes

12 bytes

1 byte

2 bytes

4 bytes

8 bytes

1 byte

2 bytes

4 bytes

64 EIO0000001114.15

Participant help, page 69

User-Defined Data Types

Data Type

Enum

Variant

Description

An enumeration value is stored as String.

Any data type.

Lower Limit

–

Upper Limit

–

Size

–

Naming Rules

Overview

When you change default parameters such as identifiers or Supervision element properties, EcoStruxure Process Expert validates at different stages of the system engineering life cycle if they satisfy the naming rules that are described in this topic.

These rules can apply at the platform level and/or can be Participant-specific.

NOTE: Other Participant specific rules may apply; however the software does not validate them. For more information, refer to the respective

Folder Identifiers

Folder identifiers:

• Can start only with a letter or the $ character.

• Can contain only letters, digits, underscores, the $ character, and spaces (1) .

These rules apply to the following types of folders:

• System folders

• Application folders

• Global Templates folders

• Content containers of the content repository.

Instance Identifiers

Instance identifiers can contain only letters, digits, and underscores.

The maximum character length is set through the Validation property (see

EcoStruxure ™ Process Expert, Global Templates, Reference Manual) of the

$InstanceID parameter of the template that the instance uses.

NOTE: Participants do not accept the use of certain reserved words for object names (for example, DO for the Supervision Participant). While the software allows using these reserved words as identifiers of instances in the application, doing so may prevent the corresponding Participant project from generating successfully when the reserved word is used as name of

Participant project items (for example,

equipment, page 329 ).

Topological Entity, Device and Folder Identifiers

Topological entity, device, and folder identifiers:

• Can start only with a letter.

• Can contain spaces (1) .

• Cannot contain any special character other than underscore (_).

• Cannot exceed 32 characters in length.

EIO0000001114.15

data validation before generating, page 298

Control and Supervision Participant Project Identifiers

Identifiers of Control and Supervision Participant Projects, and of their components:

• Can start only with a letter.

• Can contain spaces (1) .

• Cannot contain any special character other than underscore (_).

• Cannot exceed 32 characters in length.

Variable Names and Section Identifiers

Names of variables and identifiers of sections that are managed by the Control

Participant, must satisfy the following rules:

• Maximum length: Refer to the maximum length of identifiers as specified under Implementation-Dependent Parameters in the IEC 61131-3 standard

( Appendices of the Languages Reference manual in the Control Participant help).

• Permitted characters: Refer to naming conventions in the glossary of the

Control Participant help, Operating Modes .

Refer to the topic describing

Supervision Cluster Identifiers

Identifiers of Supervision clusters cannot exceed 16 characters in length.

Supervision Page Identifiers

Identifiers of pages must satisfy the following rules:

• Maximum length: 64 characters

• Can contain spaces (1) .

• Cannot contain these characters: \ / : * ? " < > |

(1) The software automatically removes leading and trailing spaces.

Supervision Field Lengths

For variable tags:

Rule

Maximum field length

Field

Item Name

Address

Raw Zero Scale

Raw Full Scale

Eng Zero Scale

Eng Full Scale

Eng Units

Format

Comment

Deadband

DataType

For trend tags:

254

Value

254

66 EIO0000001114.15

Rule

Maximum field length

Field

Item Name

Expression

Trigger

Format

File Name

No. Files

Comment

Period

Storage Method

Type

Eng Units

For advanced alarm tags:

Rule

Maximum field length

Field

Custom1...

to Custom8...

Paging Group

For digital alarm tags:

Rule

Maximum field length

Field

Comment

Custom1...

to Custom8...

Paging Group

Value

254

For reports (and facets assigned to ServerEvents containers):

Rule

Maximum field length

Field

Report Name

Output Device

Report Format File

Comment

Area

Action

Trigger

Time

Period

254

Value

253

For events (and facets assigned to ClientEvents containers):

Rule

Maximum field length

Field

Name

Trigger

Event (Action)

Comment

Time

Period

Value

254

Value

254

253

254

EIO0000001114.15

Supervision Fields Special Characters

The table describes the rules that the software validates during generation with regard to the contents of the following field.

Field

Name

Rule

Tag names need to have the following syntax:

[<alpha> | ’_’] *[<alpha> | <digit> | ’\’ | ’_’]

• Tag names need to begin with either an alpha character (A-Z or a-z) or the underscore.

• Any following characters need to be either of:

◦ alpha characters (A-Z or a-z)

◦ digits

◦ \

◦ _ (underscore)

◦ | (vertical bar)

If you use any other character, the compile process cannot complete successfully.

NOTE: Tag names can only begin with a digit only if the [General]

TagStartDigit parameter of the citect.ini file is set to 1 (the default value is 0).

68 EIO0000001114.15

Software Participant Help...............................................................................69

What’s in This Chapter

Using Help for Different Versions of Schneider Electric Templates.....................69

Help on User-Created Templates....................................................................71

Software Participant Help

Overview

You can open the HTML help of a Participant by clicking Help or the ?

button in the menu of the Participant when the Participant window is open (for example, after you click Configure in the context menu of a topological entity).

You can open the same help also from the Help EcoStruxure Process Expert dialog box without having to open the Participant. To access the dialog box, click the ?

button in the toolbar of a client.

Help is available for these Participants:

• The Control Participant

• The Advantys Configuration Software (ACS)

• The Supervision Participant

NOTE: ACS is used to configure STB islands during the configuration stage.

For simplicity, in this manual ACS is assimilated to the Control Participant.

NOTE: The dialog box lets you also open:

• The help describing how to use the Modicon IEC 61850 Configuration

Tool.

• The help of OPC Factory Server.

• The help of OPC UA Server Expert.

Opening the Help of a Participant

To open the help of a Participant from a client window, proceed as follows.

Step

Action

In the

of the client window, click the help button ( ?

Result: The Help EcoStruxure Process Expert dialog box opens.

In the Software Participant Help section, double-click a Participant name.

Result: The HTML help of the Participant opens in a separate window.

Using Help for Different Versions of Schneider Electric Templates

Overview

For the templates that are included with the software, each software version contains only one version of each template (the latest) and installs the help only for this version. This overwrites the help of an existing previous version if you are upgrading the software. The help is provided in compiled HTML (CHM) format.

However, your application can contain several versions of a same template, for example, if you have migrated your database and have imported a later version of the template afterwards.

EIO0000001114.15

Starting from V4.3 of the software (Process Expert), you have the possibility to retain the help that is included with any version of the software to continue using it after you upgrade to a later version.

By verifying the version of a template when you use the context-sensitive help button, the software opens the help for this version if available.

This topic provides recommendation when using several versions of the help and describes how to proceed.

NOTE: For more information on how to obtain help on templates, refer to the topic describing how to .

Considerations When Using Several Versions of the Help

The help of a given version of the software documents the templates and functionalities provided by this version only.

If you open the help for a given template and then, within the same help window, you look up another template or a platform functionality, it may be that the version of the template or the functionality that is documented differs from the version/ functionality that you are using.

This can be the case, for example, if:

• You have migrated your database and have not updated the template used by instances of the Application. In this case, the help that is provided may document a later version of templates.

• You are opening the help of an earlier version of the software. In this case, the templates that are available in the library and the functionalities provided by the platform may be of a later version than those documented.

Schneider Electric recommends the following:

• Open the help for a template only by using the context-sensitive help button, which takes into consideration the version of the template that you are selecting.

• Do not view the help for another template or platform functionality within the help window that you had opened for a template.

• Verify the version of the help you are viewing and which is indicated in the title of the help window.

Location of the HTML Help Files

On the computer running the engineering client, the help files are located in the

User Guides folder at the path C:\Program Files\Schneider Electric\EcoStruxure

\Process Expert.

The User Guides folder also contains ContextualHelpRepository.* files, which are required for the context-sensitive help on templates to work.

Preserving the Current Help Files Before Upgrading the Software

So that the help of the installed version of the software remains available after you upgrade to a later version, before proceeding with the upgrade, you need to copy the complete set of help files and their auxiliary files to a specific location on the computer running the engineering client.

Proceed as follows.

70 EIO0000001114.15

User Guides folder, page 70

Step

Action

Create the following folder structure if it does not exist yet: %localappdata%\Schneider

Electric\Process Expert\User Guides.

NOTE: By default, the value of the %localappdata% environment variable is C:

\Users\ username \AppData\Local.

A Process Expert x folder, where x corresponds to the installed major version (the

R• version suffix does not appear), may already exist in the Schneider Electric folder but do not use it.

In the User Guides folder, create a subfolder with a name containing the number of the current version. For example, Template Help Files Vx .

Mentioning the version helps you identify for which version of the software you are opening the help in case the same template version is provided and documented in different versions of the software.

Copy all the files contained in the

to the subfolder that you have created in step 2.

Opening the Help for Templates of an Earlier Version

To open the help of a template for which several versions exist, proceed as follows.

Step

Action

Click the context-sensitive help button in the

required location, page 70

of the engineering client and select a template, an instance of a template, or a facet of an instance of a template.

Result: The software verifies the version of the template and opens:

• The help of the current version from the default location if the template is provided in the current version of the software.

• The help of the earlier version of the software in which the template was provided

(given you have copied the necessary help files to the

Only one help window opens at a time.

NOTE:

• If the version of the template was provided with a version of the software for which the help is not present on the computer, not at the required location, or incomplete, no help is shown.

• If the version of the template was provided in both the current and the earlier version of the software, the Contextual Help Conflict dialog box opens, which lets you select which version of the help you want to open.

Help on User-Created Templates

Overview

You can configure the software to open the help in CHM format of a user-created template.

You can also manage the HTML help files of several versions of the same template so that clicking a given version of the template opens the corresponding help.

Only one help window opens at a time.

This topic describes the prerequisites and the steps you need to perform. It does not describe how to create HTML help files in CHM format.

NOTE: By using this feature, you can also associate your own HTML help to a

Schneider Electric global template in addition to the existing help. You can then select which one you want to open.

EIO0000001114.15

NOTE: You can also associate help files to templates and their instances that operators can open from the operation client when using runtime navigation services (see EcoStruxure ™ Process Expert, Runtime Navigation Services ,

User Guide ).

Prerequisites

The following are the prerequisites to be able to open help for user-created templates:

• You need to have help files documenting user-created templates in the

Microsoft ® compiled HTML format (.chm).

For more information on creating a help project, refer to the Windows ® online help .

• You need to know the

topic ID, page 72

of the topic documenting the template, which you want to open when you use the context-sensitive help button of the engineering client. If the help file (.chm) documents several templates, you need to have the topic ID that corresponds to each template.

For more information on topics, refer to the Windows ® online help .

Creating a Repository for Help Files of User-Created Templates

So that the help of user-created templates remains on the computer and can be opened after you upgrade the software to a later version, you need to copy your complete set of help files and the ContextualHelpRepository.xml file to a specific location on the computer running the engineering client.

Proceed as follows.

Step

Action

Browse to %localappdata%\Schneider Electric\Process Expert\User Guides.

NOTE: By default, the value of the %localappdata% environment variable is C:

\Users\{username}\AppData\Local.

In the User Guides folder, create a copy of the folder named Sample-Tobecopied in the same location and rename it by using a meaningful name describing its contents and the version of the software that was used to create the template. For example,

<MyReactor Template Help Files for V2020>.

NOTE: You can create as many copies of this folder as needed in case you want to keep the help files of different templates in distinct folders.

Copy all your help files to the subfolder that you have created in step 2.

NOTE: Uninstalling the software removes the folder named Sample-

Tobecopied but not the copies of it.

Identifying the ID of a Topic Inside a CHM Help File

The procedure describes how to identify the ID of a topic inside a CHM help file.

Step

Action

Open the user-created HTML help,

Select the topic (page) that you want to open when using the context-sensitive help button on the template and right-click somewhere on the page.

Result: The context menu of the page opens.

72 EIO0000001114.15

Step

Action

Select Properties .

Result: The Properties dialog box opens.

Copy the topic ID.

The topic ID of the page is the part of the string that starts after ::/ in the Address

(URL) attribute.

For example, if the Address (URL) attribute is mk:@MSITStore:C:\PROGRA~2

\XMLNOT~1\Help.chm::/Overview.htm

, the topic ID is Overview.htm

Editing the XML File

To edit the ContextualHelpRepository.xml file, proceed as follows.

Step

Action

In the

folder, page 72

to which you have copied your help files, open the

ContextualHelpRepository.xml file by using Notepad or an XML editor software.

Result: The file that opens contains the following entry, which serves as an example only.

<Item HelpKey="MyMotor3" FileName="PELbPrTp" MappingId="PELbPrTp_D-SE-

0014236.htm" FileType="CHM" Description="" Version="2.7.2"/>

</ContextualHelp>

Edit the following parameters of the entry:

• HelpKey : Is the identifier of the user-created template.

• FileName : Is the name of the CHM file without file extension.

• MappingId : Is the

ID, page 72

of the topic in the CHM file that documents the usercreated template. Include the .htm

file extension.

• FileType : Do not edit this parameter. Default value: CHM.

• Description : Optional. You can enter a short description by using free form text. It is used to describe the entry in the XML file and can appear in the Contextual

Help Conflict

dialog box, page 71

. To use no description, leave it as "".

• Version : Is the version of the user-created template as it appears in the Global

Templates Explorer or in the Templates Browser pane of the Application

Explorer .

Add a new entry for each user-created template for which you want help to open.

To manage the help for different versions of the same template, refer to the

next topic, page 73 .

NOTE: The </ContextualHelp> element must be the last entry in the file.

Save your changes.

Updating the Help for a New Version of a User-Created Template

The table describes the actions that you need to perform when you create a new version of a template and want help to open for the various versions that exist.

Two versions of a template are used as an example.

MyReactor 1.0.0

is considered the previous version and MyReactor 1.0.1

the new version.

EIO0000001114.15

User Guides folder , page 72

An updated help file is available to document the new version

Action

Yes

1. In the

folder, page 72

to which you have copied your help files, edit the ContextualHelpRepository.xml file.

2. Add a new entry that corresponds to the new version of the template by using the same parameter values as for the previous version; except for Version , which needs to correspond to the version of the new template.

1. Browse to the

located at the path % localappdata%\...

2. Create a copy of the folder in which the help files of MyReactor

1.0.0

and the ContextualHelpRepository.xml file are located.

3. Rename the copy of the folder by using a name that allows you to distinguish the previous and the new version.

For example, <MyReactor 1.0.1 Template Help Files for V2018>.

4. In this folder, edit the entry in the ContextualHelpRepository.xml by modifying the value of Version to be equal to the new version (for example, Version="1.0.1" .

Comment

The same help file opens when you use the context-sensitive help button on MyReactor

1.0.0

or MyReactor 1.0.1

If you remove the entry for template version

1.0.0, help cannot open when you select it.

Clicking either template version when context-sensitive help is enabled opens the help file that is located in the folder, which also contains the XML file with an entry of the same template identifier and version.

NOTE: It is assumed that the help file name and the topic ID are identical for both template versions.

Opening the Help for User-Created Templates

To open the help of a user-created template, proceed as follows.

Step

Action

Click the context-sensitive help button in the

repository for your help, page 72

of the engineering client and select the user-created template.

Result: The software verifies the version of the template and opens the corresponding help file according to your

configuration, page 73 .

NOTE:

• If the value of any parameter in the ContextualHelpRepository.xml file is incorrect (except for description), if the ContextualHelpRepository.xml file is missing or its location incorrect, or if the location of the folder containing the help files and the XML file is incorrect, no help is shown.

• If the template identifier and version appear in more than one

ContextualHelpRepository.xml file contained in different subfolders of the

User Guides folder, the Contextual Help Conflict dialog box opens, which lets you select from which location you want to open the help.

Associating Other HTML Help Files to Schneider Electric Global Templates

By using an example, this topic describes how to associate your own help file in

CHM format to a sample control module template of a Global Templates library for which the EcoStruxure Process Expert help is already available.

The data used for the example is the following:

• Control module template: $Motor version 1.0.0.

• Name of your help file: MyMotorHelp.chm

• ID of the topic that you want to open: mymotor_description.htm

The table describes the steps that you need to perform to implement the help and select, which file to open.

Step

Action

Create a

and copy the MyMotorHelp.chm file to this folder.

Edit the ContextualHelpRepository.xml

file, page 73

located in this folder and add the following entry before the </ContextualHelp> element.

<Item HelpKey="$Motor" FileName="MyMotorHelp" MappingId="mymotor_description.

htm" FileType="CHM" Description="" Version="1.0.0"/>

74 EIO0000001114.15

Step

Action

Click the context-sensitive help button in the

of the engineering client and select the $Motor template version 1.0.0, and instance, or facet of it.

Result: The Contextual Help Conflict dialog box opens and shows the two help files that are associated to the template: The EcoStruxure Process Expert help and your help.

Select the help file that you want to view and click OK .

EIO0000001114.15

Engineering Client User Interface Description..................................................76

What’s in This Chapter

About Dialog Box..........................................................................................78

Engineering Client and Explorer Work Areas ...................................................79

Organizing Work Areas..................................................................................82

Working with Panes.......................................................................................85

Using Menus.................................................................................................89

Software Participant Windows ........................................................................90

Filtering and Sorting Data...............................................................................93

Keyboard Shortcuts .......................................................................................96

Overview

This chapter describes the engineering client user interface, its main components, and the common tools that allow you to engineer and navigate a system.

Engineering Client User Interface Description

Overview

When you start the engineering client, it opens one main work area in which the various explorers and editors are displayed.

The engineering client user interface is composed of five main elements:

• The client toolbar

• The tabs bar of the main work area

• Explorer windows

• The Notification Panel

You can

divide the main work area, page 83

of the engineering client.

The explorer that opens when a client is started depends on the group (see

EcoStruxure ™ Process Expert, Installation and Configuration Guide) that the logged-in user is a member of.

76 EIO0000001114.15

window, page 105 , which lets you create, organize, and

User Interface Description

The following figure shows an example of the engineering client user interface.

Item

Description

Engineering client toolbar

Tabs bar showing the tabs of the explorers and editors that are open

Systems Explorer window

Workspace of the Systems Explorer

Notification Panel

Engineering Client Toolbar Description

The following figure describes the toolbar of the engineering client.

EIO0000001114.15

Item

Description

Opens the Systems Explorer

navigate systems.

From the Systems Explorer you can open the explorers that are needed to create and manage system components:

• Application Explorer

• Project Explorer

• Topology Explorer

Explorer navigation buttons to open or show the explorer of a system.

From left to right:

• Topology Explorer

• Application Explorer

• Project Explorer

Clicking a button opens the corresponding explorer for either:

• The system that is selected in the Systems Explorer when this explorer is active.

Item

Content Repository explorer, page 703

Description

• The system for which an explorer or editor is active. For example, if the

Assignment Editor for System_1 is active, clicking the first button opens/shows the Topology Explorer for System_1 .

If the explorer is already open, it is shown.

NOTE: Navigation does not work from the Global Templates Explorer nor the

Contents Repository by using these buttons.

Opens the

, which contains files related to Global

Templates and the systems that you are engineering.

Opens the

Global Templates Explorer, page 645 , which you can use to browse and

manage templates of the Global Templates library.

NOTE: In this example, the button is shown unavailable because the role of the

logged-in user, page 44

does not have the permission to use this explorer.

Opens the

software Participant, page 69

Opens the About EcoStruxure Process Expert

dialog box, page 78

Opens a dialog box, which lets you access:

• The global software HTML help. It describes how to install, license, and use the software as well as the Global Templates that are included with it.

• The global help of each

• Other help files.

Double-click an entry to open the corresponding help.

Opens the HTML help at the topic describing the system engineering life cycle and the system creation workflow.

It gives you an overview of the various stages of the life cycle and helps you identify what is the next step that you need to complete.

Opens context-sensitive HTML help.

Clicking the button enables context-sensitive help and a question mark appears next to the cursor.

Selecting an item opens the help when available. If no help is available for the selected item, the functionality is disabled.

To disable the functionality while the question mark is shown next to the cursor, press

Esc .

For an overview of UI items for which context-sensitive help is available, refer to the topic describing how to open context-sensitive help.

Full name of the logged-in user and name of the computer running the system server to which the client is connected. If the full name is not defined, the username appears instead.

Opens the User menu, which contains the following commands.

Lock

User

Information

Log Out

Locks, page 46

the components to which you are logged in on the local computer.

Opens the User Information dialog box (see EcoStruxure ™ Process

Expert, Installation and Configuration Guide).

Lets you

of the software.

About Dialog Box

Opening the About Dialog Box

To open the dialog box, click:

• The icon in the

toolbar of the engineering or operation client, page 77

• Help > About in the menu bar of the system server.

78 EIO0000001114.15

instance count by system, page 133

General Tab

The General tab displays information related to:

• Installed EcoStruxure Process Expert and third-party software versions.

• The activated application size license and the total instance count for your database.

• The installation and expiration dates of entity certificates (see EcoStruxure ™

Process Expert, Installation and Configuration Guide) installed on the local computer and of the corresponding root CA.

If no entity certificate is installed, no information is shown.

System Details Tab

The System Details tab displays the

for the mounted database.

Client Details Tab

The Client Details tab displays information about the clients that are currently connected to the system server with a user being logged in. It shows the computer name, user name, and the type of client.

Support Tab

Contains the contact information of the Schneider Electric support.

The Logs Folder link lets you access the

activity log files, page 59

Hotfix Details Tab

The Hotfix Details tab displays information about installed hotfixes.

If no hotfix is installed, the tab is hidden.

Engineering Client and Explorer Work Areas

Overview

By default, in an engineering client only one work area is visible at a time.

The work area is the display area that is below the

tabs bar, page 77

where explorers and certain editors open, such as the Systems Explorer and

Composite Editor .

Certain explorers (for example, the Application Explorer or Project Explorer ) also feature a work area in which various windows and editors open, such as

Properties windows or the Instance Editor .

You can

create additional work areas, page 83

and organize them.

NOTE: When no window opens in the work area, it is called a workspace . This applies to editors and certain explorers (for example, the Global Templates

Explorer ).

EIO0000001114.15

The following figure shows an example of the work area of the Application

Explorer .

Item

Description

Tab of the Application Explorer .

Toolbar of the explorer.

Panes of the explorer, which are open in the work area.

Remaining work area of the explorer in which a window and an editor are open. You can select them by using their tab.

Workspace of the editor.

Tabs Bar Description

For each window, explorer, or editor that you open in a work area, a tab is displayed in the tabs bar, which features:

• An icon representing the type of window, explorer, or editor (for example,

Properties window, Application Explorer , or Links Editor ).

• The identifier of the system that is displayed in the corresponding window

(except for the Contents Repository , Global Templates , and Systems

Explorer ).

• A button to close it.

You can rearrange the order of tabs on the tabs bar by dragging them to a new position.

NOTE:

• Closing the last tab in a tabs bar closes the work area (except if the work area is the last one to be open).

• You cannot close the last tab of the last work area that is open.

• To close all windows except one, right-click the tab of the window that you want to leave open and select Close Other Tabs .

80 EIO0000001114.15

more than one work area, page 82

The following example describes the tabs bars of the engineering client in which two work areas are open.

Item

Description

Main work area.

Additional work area.

Display all Tabs button.

Displays a list of the tabs that are open in this work area.

Inactive tab.

Maximize/Restore Down button.

The button is available when

is open. It maximizes the work area in the window or reverts the display to a multiple work area view.

NOTE: When you maximize a work area, the other open work areas are hidden.

Use the Restore Down button to show them again.

Button to close the work area.

The button is available when

more than one work area, page 82

is open. It allows you to close the other work areas.

You cannot close the main work area.

NOTE: Closing the last tab in a work area closes it.

Scroll left button.

Click the button to view hidden tabs that are to the left of the first tab. The scroll increment is one tab.

Active tab.

Scroll right button.

Click the button to view hidden tabs that are to the right of the last tab. The scroll increment is one tab.

Moving the Workspace (Panning)

In editors (for example, the Links Editor ), click an empty area of the workspace and hold down the left mouse button. The pointer turns into a hand icon. You can now drag the workspace in any direction by moving the pointer. This is useful to view items that are outside the visible workspace.

In certain explorers (for example, the Global Templates Explorer ), you can use the following methods to move the workspace.

Action

Mouse wheel up

Mouse wheel down

Shift + Mouse wheel down

Shift + Mouse wheel up

Direction in which the workspace is moved

Down

Left

Right

EIO0000001114.15

simplified view, page 673

Magnifying and Reducing the Workspace View

To magnify or reduce the workspace view gradually, use the following method.

Ctrl + Mouse wheel up

Ctrl + Mouse wheel down

Zoom in.

The position of the pointer becomes the center of the magnification.

Zoom out.

The position of the pointer becomes the center of the reduction.

NOTE:

• A zoom selection menu may be available at the bottom of some workspaces. You may also be able to use the radar view.

• In some workspaces, starting out from the default zoom level, you can only zoom in.

• Zooming out beyond a certain level may switch the display to

Selecting Multiple Items

The method to select multiple items varies depending on the editor or explorer you are working in:

• In editors (for example, template editors), you can select multiple items in the workspace by using either or a combination of the following methods:

◦ Select an item with the pointer, press and hold Ctrl , and select other items.

◦ Press and hold Ctrl , click the workspace, and hold down the mouse button. Then, drag the pointer to draw a rectangle. Items that overlap with the rectangle are selected when you release the mouse button. Last, release Ctrl .

• In explorers, browsers, and various containers, you can select multiple items by selecting an item with the pointer, pressing and holding Ctrl , and selecting other items. To select contiguous items, select the first one, press and hold

Shift and select the last item. Release Shift .

To unselect an item, press Ctrl and click the item.

NOTE: While you are still holding Ctrl , click a selected item again to unselect it.

Organizing Work Areas

Overview

To work more effectively, you can customize the client UI by

creating additional work areas, page 83

left, right, or below the main one. Inside each work area you can open various explorers and editors.

Each work area has its own

tabs bar, page 80

and toolbar (if available).

NOTE: You can also

divide the work area of explorers, page 84

82 EIO0000001114.15

The following figure shows an example of an engineering client UI that is divided into three work areas.

Viewing Client Windows on Separate Monitors

To open a new window for the same client, so that you can view it on a separate monitor, proceed as follows.

Step

Action

Verify that, at least, two windows are open in the same or separate work areas.

For example, the Systems Explorer and the Project Explorer windows.

Right-click the tab of a window in the tabs bar and select Open in new Window .

Result: The tab opens in a second, separate client window.

Drag any of the two client windows to the other monitor.

NOTE:

• You can repeat the procedure from any tab of either client window given that two tabs are open in the work area. (The functionality is not available for tabs that are open inside the Application Explorer or Project

Explorer .)

• Notifications about actions that you perform in the additional client windows appear in the Notification Panel of the main client window.

Creating Additional Work Areas

You can create a new work area with an already open explorer by using the docking tabs. The new work area opens on the left, right, or at the bottom of the existing one depending on which docking tab you use.

Once you have created several work areas, you can:

• Drag tabs from one work area to the other.

• Reposition work areas by using the docking tabs.

Refer to the topic describing the

tabs bar, page 80

for information on how to manage windows inside a work area.

EIO0000001114.15

work with panes, page 85 .

The following figure illustrates the use of the external docking tabs to create a new work area.

Example of result when you use the bottom docking menu.

To open a new work area, proceed as follows.

Step

Action

Verify that at least two explorers are open in the work area.

Drag a tab from the tabs bar towards the side of the work area where you want to create the new one.

Result: The explorer follows the pointer and the external docking tabs appear.

Keep dragging the pointer over the docking tab where you want the new work area to open and release the mouse button.

Result: A new work area, which contains the explorer opens at the selected location.

NOTE: To cancel the operation, drag the pointer away from the docking tab and release the mouse button.

Creating Additional Work Areas in Explorers

When several windows are open in the work area of the Application Explorer or

Project Explorer , you can create additional work areas by dragging either of the windows to a docking tab.

Refer to the topic describing the

tabs bar, page 80

for information on how to manage windows inside work areas.

NOTE: You cannot create a new work area with the pane of an explorer. Refer to the topic describing how to

84 EIO0000001114.15

The following figure illustrates the use of the external docking tabs to create a new work area inside the Application Explorer .

The following figure shows an example of the Application Explorer with two work areas that are open.

To open a new work area, proceed as follows.

Step

Action

Verify that at least two windows or editors are open in the work area of the explorer.

Drag a tab towards the side of the work area where you want to create the new one.

Result: The item follows the pointer and the external docking tabs appear.

Keep dragging the pointer over the docking tab where you want the work area to open and release the mouse button.

Result: A new work area, which contains the window opens at the selected location.

NOTE: To cancel the operation, drag the pointer away from the docking tab and release the mouse button.

Working with Panes

Overview

The software displays panes in various explorers and editors.

You can minimize them automatically when you do not need to see them, resize, and move them as required.

EIO0000001114.15

Pane Description

The following figure shows a partial view of two panes in the Application

Explorer .

The following figure shows a floating pane. The pin button is not available.

Item

Description

Pane that is pinned and always visible.

Pane that is minimized to a tab.

Extract/retract button. Turns it into a floating pane that you can dock or returns a pane to its previous position (docked or tabbed).

Pin button. Lets you show and hide the pane.

Minimizing, Showing, and Restoring Panes

To minimize, show, and restore a docked or tabbed pane, proceed as follows.

86 EIO0000001114.15

external docking tabs, page 83 .

Step

Action

Click the pin button in the title bar of the pane.

Result: The pin button is displayed in a horizontal position and the pane will be minimized to the edge of the screen as a tab.

Move the pointer over the tab.

Result: The pane is shown entirely while the pointer is inside the pane.

NOTE: Click inside the pane so that it remains visible even you move the pointer away from it. Click outside the pane to minimize it again as a tab.

Click the pin button again.

Result: The pin button is displayed in a vertical position and the pane is restored. If there are several overlapping panes, it may be shown only partially.

Extracting Panes

Docking Panes

To make a pane floating, click the extract button or drag it by the title bar.

When panes are docked on top of each other so that their tabs appear at the bottom, dragging either pane by its title bar extracts the complete group. To extract only one pane, drag it by its tab or use its extract button.

You can move docked panes to another area of the workspace or dock floating panes by using the

When the workspace contains more than one pane and you drag one pane on top of the other, a docking menu appears in the center of the other pane. It lets you position panes in a relative position to each other.

The following figure shows the docking menu.

Item

Description

The up, right, down, and left arrows let you position the pane on top, to the right, below, or to the left of the other one respectively.

The center pad positions the pane on top of the other one as a tabbed pane. The center pad appears when you move the pointer over the square docking menu but outside one of the arrows.

EIO0000001114.15

external docking tabs, page 83

The following figure illustrates the use of the docking menu or external docking tabs to reposition a pane (docked) inside the work area of an explorer.

To dock a pane, proceed as follows.

Step

Action

Drag the pane by its title bar.

If the pane is already docked,

extract it, page 87

first.

Result: The docking menu and/or the

appear.

Keep dragging the pointer over the docking menu or tab where you want the pane to be positioned and release the mouse button.

Result: The pane is docked.

The following figure shows an example of panes that have been tabbed by using the center pad of the docking menu.

The following figure shows an example of a pane that has been docked below another one by using the down arrow of the center pad of the docking menu.

EIO0000001114.15

minimize the pane, page 86

The following figure shows an example of a pane that has been docked to the bottom edge of the engineering client window by using the bottom external docking tab.

Resizing Panes

Typically, panes do not feature a maximize button. Instead, resize them to occupy the entire work area.

To resize a pane, proceed as follows.

Step

Action

Move the pointer over an edge of the pane.

Result: The pointer turns into a double-ended arrow.

Drag the pointer away from the edge.

Result: The pane is resized.

Closing Panes

To close a pane, click the close button in the title bar of the pane (when available).

To open it again, select the corresponding command from the menu of the explorer or editor.

If no close button is available or if it does not allow closing the pane,

to a tab.

Using Menus

Context Menus

For many items of the UI (for example, folders, instances, elements of projects), right-clicking the item opens a context menu containing several commands.

The commands are described in the topic documenting the item.

EIO0000001114.15

keyboard shortcut, page 96

The figure shows an example of the context menu that opens when you right-click a system in the Systems Explorer , which lets you perform actions on the system.

Item

Description

You can execute commands that appear in bold also by pressing Enter when the item is selected or double-clicking the item itself (in this example, the item is System_1 ).

For certain commands, you can also use the

that is indicated to the right of the command when the item is selected.

NOTE: To close a context menu, press Esc .

Software Participant Windows

Floating Software Participant Windows

When you open a Participant window, it opens as a floating window and maximized.

You can resize this window, display it on another monitor, or embed it in the client window.

You can open several floating windows simultaneously.

90 EIO0000001114.15

Copy to the local Clipboard, page 92

The following figure shows an example of a floating Control Participant window.

The window is shown restored down.

EIO0000001114.15

1 Open the HTML help of EcoStruxure Process Expert

2 Embed the floating Participant window in the client

4 Paste from the local Clipboard

5 Save changes that were made in the Participant

6 Minimize the floating window

7 Maximize the floating window (or restore down the floating window when it is maximized)

8 Close the floating Participant window

NOTE: The other buttons of the Participant window toolbar are task-specific and are described in the topic documenting the task.

While the floating Participant window is open:

• The embedded Participant window is not refreshed and displays the view that was shown when you extracted the floating Participant window.

• You cannot work in the embedded Participant window nor close it.

• Use the icon in the taskbar to display the client user interface when the floating Participant window is maximized.

• The Windows ® snap feature is enabled.

Embedded Software Participant Windows

The following figure shows an example of a Control Participant window, which is embedded in the engineering client by using the restore button.

1 Close the Participant window

2 Extract and maximize the Participant window

3 Save changes that were made in the Participant

Showing Software Participant Windows on Separate Monitors

To show a software Participant window on another monitor,

extract it, page 92

and drag it to the other monitor.

If you experience issues viewing the extracted Participant window on an extended monitor (for example, if the window turns black), try disabling hardware acceleration for Windows ® Presentation Foundation (WPF). The required setting may already be present in the registry and you can modify it; otherwise, you need to add it.

To disable hardware acceleration for WPF, proceed as follows. Follow this procedure only if you are experiencing issues viewing an extracted Participant window on an extended monitor.

Step

Action

By using the Windows ® Registry Editor of the computer on which the client is installed, go to HKEY_CURRENT_USER > SOFTWARE > Microsoft > Avalon.Graphics

Add a new registry key by right-clicking the Name column and selecting New

DWORD (32-bit) Value .

NOTE: If the DisableHWAcceleration registry key is already present, proceed to step 4 if necessary.

Enter DisableHWAcceleration as name.

Right-click DisableHWAcceleration , select Modify , and enter 1 as data value.

Restart the computer.

Copy-Paste Functionality

You may not be able to copy-paste data elements (for example, strings or graphic elements in a Supervision page) between the local computer and a software

92 EIO0000001114.15

Participant by using the Ctrl + C and Ctrl + V keyboard shortcuts or the Copy and

Paste commands of contextual menus.

To do so, use the two

buttons, page 90

that are located in the toolbar of the software Participant window, which allow you to perform the following actions:

• Copy to local Clipboard button: Copies strings or graphic elements that are selected in the software Participant to the Clipboard of the local computer.

• Paste from local Clipboard button: Pastes strings or graphic elements that you have copied on the local computer to the software Participant.

NOTE: To copy and paste strings or graphic elements between two instances of the same software Participant (for example, two Refine windows of the

Control Participant) or between two different software Participants (for example, the Control and the Supervision Participant), you can use the Ctrl + C and Ctrl + V keyboard shortcuts.

To copy a data element on the local computer and paste it to the software

Participant, proceed as follows.

Step

Action

On the local computer, select the data element and copy it to the Clipboard ( Ctrl + C or

Copy ).

In the software Participant, position the cursor or pointer at the desired location and click the paste button.

To copy a data element in the software Participant and paste it to the local computer, proceed as follows.

Step

Action

In the software Participant, select the data element and click the copy button.

On the local computer, position the cursor or pointer at the desired location and paste the data element ( Ctrl + V or Paste ).

Filtering and Sorting Data

Overview

For most columns inside folders and panes, you can open a filter menu that lets you refine data that is displayed according to criteria and/or conditions that you define.

In addition, you can sort data in ascending or descending alphanumerical order.

Filters and sorting are reset when you close the pane, window, or editor in which they appear.

NOTE: When a filter is active, commands that you execute at a parent node level may also execute on data that is not displayed. This can be the case, for example, when you execute a command at the folder level in the Application

Explorer while a filter is applied on the Identifier column of the folder and, as a result, not all the instances contained in the folder are displayed.

EIO0000001114.15

Filter Menu Description

The following figure shows an example of the filter menu.

Item

Description

Column filter icon.

Click the icon to open the filter menu.

The icon turns dark to indicate that you have applied a filter on the column.

Data field.

The field displays in a flat list one of each of all the entries that the column contains.

That is, if an entry appears more than once in the column, it is displayed only once in the data field. If the column contains only partial data because, for example, a keyword search has been performed, the data field displays also only the partial data.

Select one or more entries. Only entries that you select will be displayed when you apply the filter.

NOTE: If the column contains a tree view (for example, the Templates Browser pane of the Application Explorer ), the content of the data field depends on the type of lowest-level child elements shown in the column:

• A single type of child elements (for example, only templates): The data field displays only child elements that are not part of the tree structure (for example, only templates but no folders).

• Several types of child elements (for example, the Name column of the Import window in the Projects Explorer for a Control project, which contains services and sections as lowest-level child elements): The data field displays only the parent nodes (for example, the system root folder).

Expression builder.

Lets you build custom filter expressions by selecting one or two conditions and an operator from a list.

The conditions apply to any data contained in the column even if it is not shown in the data field. The list of available conditions varies and is adapted to the data type of the column.

NOTE: If you build an expression and select an entry in the data field, your selection is used as an additional condition in the expression with the AND operator. If you select several entries in the data field, each one is treated as OR condition before the result is used as an additional condition.

Match case button.

Click the button to enable case-sensitive filtering as an additional condition.

The button appears only for columns showing data of String type.

Click the button to apply the filter to the column.

NOTE: When the filtered data is modified (for example, new objects have been created or imported, objects have been renamed), the filters do not apply to the modified data. To apply them, open the filter menu again and click Filter .

Click the button to clear the filter for the column.

NOTE: To clear filters for all columns, right-click any column header and select

Clear Filters .

EIO0000001114.15

Example

The following figure shows a filter example consisting of two items selected in the data field and one expression. It is used to filter the contents of the Identifier column.

The resulting filter expression is:

( Motor_1 OR Motor_2 ) AND Identifier contains 2.

The following figure shows the search result once the filter is applied; instances for which the expression is true.

Using Filters

Sorting Data

EIO0000001114.15

To use filters, proceed as follows.

Step

Action

Click the filter icon of the row that contains the data that you want to filter.

Result: The filter menu opens.

Select entries in the data field or create a filter using the expression builder.

Click Filter .

Result: The column displays data that matches the criteria and the filter icon turns dark.

NOTE: When columns contain tree views, the parent structure of filtered items is shown.

Close the filter menu.

NOTE: You can use filters for several columns simultaneously. Repeat the above procedure on each column.

The sorting feature is represented by a green triangle inside the column header.

Click a column header to enable sorting of the data that the column contains.

Clicking the column header repeatedly toggles between the following states:

• Arrow up: Sorts in ascending alphanumerical order.

Navigation button, page 77 .

• Arrow down: Sorts in descending alphanumerical order.

• No arrow: No sorting. Data is displayed by using the default display order defined for the column.

NOTE:

• Hold Shift to enable sorting of multiple columns.

• To clear sorting on all columns, right-click any column header and select

Clear Sorting .

• If a rule has been defined to display contents of a column, enabling the sorting feature does not override this rule. For example, in the

Application Browser of the Application Explorer folders are shown first, followed by instances. Applying sorting sorts only items within their respective category. It does not change the display order of categories.

Clearing All Filters and Sorting

To clear filters and sorting for all columns, right-click any column header and select Clear All .

Keyboard Shortcuts

Available Keyboard Shortcuts

You can use the following keyboard shortcuts in place of the command in the context menu or the button.

Corresponding command or button Keyboard shortcut

Alt + A

Alt + P

Alt + T

Ctrl + A

Ctrl + C

Ctrl + F

Ctrl + L

Ctrl + V

Del

F12

Shift + F12

Opens or shows the Application Explorer for the system.

Navigation button, page 77 .

Opens or shows the Project Explorer for the system.

Navigation button, page 77 .

Opens or shows the Topology Explorer for the system.

No corresponding command.

Use this keyboard shortcut to select the entire contents of a folder or container, such as instances or facets.

Copy

Find (Global Templates)

Places the cursor in the search field of the Global Templates Explorer.

Edit Links .

Opens the Links Editor of the Application Explorer .

Paste

Delete

Rename

Settings (Global Templates)

Read-only (Global Templates)

Edit (Global Templates)

96 EIO0000001114.15

Quick Reference Guides ................................................................................98

Engineering a System

What’s in This Part

Managing Systems...................................................................................... 105

Instantiation Stage....................................................................................... 115

Project Definition Stage ............................................................................... 199

Assignment Stage ....................................................................................... 256

Generation Stage ........................................................................................ 297

Refinement Stage ....................................................................................... 336

Configuration Stage..................................................................................... 364

Mapping Stage............................................................................................ 420

Build Stage ................................................................................................. 464

Deployment Stage....................................................................................... 481

Execution Stage .......................................................................................... 531

Engineering M580 Safety Systems ............................................................... 577

Managing Communication ........................................................................... 597

Overview

This part describes how to complete the different stages of the system engineering life cycle to engineer a system.

The following figure shows the stages of the system engineering life cycle.

EIO0000001114.15

System Creation Workflow .............................................................................98

What’s in This Chapter

Task Quick Reference.................................................................................. 101

System Creation Workflow

Navigation

This page shows the various stages of the system engineering life cycle and which Explorer is used to complete them.

• Click an Explorer to view the main tasks of the workflow.

• Click a stage for detailed information on how to complete it.

NOTE: In the HTML help, use the Back button in the toolbar of the help window to revert to this page.

System Engineering Life Cycle

Application Explorer Project Explorer Topology Explorer

Instantiation

↓

Project Definition

↓

======================================

↓

Assignment

Configuration

↓

Generation

↓

Refinement

↓ ↓

======================================

↓

Mapping

↓

Build → Deployment

↓

Execution

NOTE: Specific transversal workflows are also provided describing how to

implement communication, page 597 .

System Creation Workflow

The following workflow shows the main tasks that you need to perform to complete the system engineering life cycle. Click a task to navigate to the topic describing how to complete it.

98 EIO0000001114.15

Systems Explorer

Create system

↓

Application Explorer

↓

Create application folder structure

↓

Configure folder properties

↓

Browse templates

↓

Create instances

(process/device/communication)

↓

Configure instances

↓

Link instances

↓

Topology Explorer

For Control (simulation)

Configure NIC properties

↓

Create ControlExpert service

↓

Create topology folder structure (optional)

↓

Create a controller entity

↓

Configure the controller (Participant)

↓

Configure controller properties

↓

Configure station node entities

↓

Create device entities

↓

For Supervision

Configure NIC properties

↓

Create Supervision and/or OFS service

EIO0000001114.15

MODBUS TCP/EtherNet/IP device entity

Select template

↓

Configure device properties

↓

PROFIBUS remote master

(PRM) entity

Create PRM entity

↓

Configure PRM properties

↓

Configure the PRM

(Participant)

↓

Create an Ethernet network

↓

Create physical connections

↓

Project Explorer

↓

Control

Create project

↓

Create sections in task folders

↓

Assign facets to sections

↓

Generate project or sections

↓

Refine project or sections (Participant)

↓

Create executable

↓

Perform service mapping

↓

Perform communication mapping

↓

Perform hardware mapping

↓

Build project

↓

View the built project

Distributed I/O entity

Create STB island entity

↓

Configure the STB island

(Participant)

↓

Configure STB island properties

Supervision

Create project

↓

Assign facets to project container

↓

Create Supervision pages

↓

Edit pages / assign genies (Participant)

↓

Generate project

↓

Refine the project (Participant)

↓

Create executable

↓

Perform service mapping

↓

Perform communication mapping

↓

Build project

↓

Deploy the project

(from the executable)

↓

100 EIO0000001114.15

implement communication, page 597

Topology Explorer

↓

Control

(deployment and execution)

Supervision

(deployment from the station node)

Start the simulator (if applicable)

↓

Select the project and executable

↓

Select the IP address

↓

Select the project and executable

↓

Select the IP address

↓

Deploy the built project Deploy the built project

(deploy changes after first iteration)

↓

Refine online

↓

Update Control project

↓

Supervision software running on the station node)

↓

Start over the life cycle from any point

↓

(Execution is performed by using

NOTE: Specific transversal workflows are also provided describing how to

Task Quick Reference

Overview

The tables in this topic provide an overview of the main tasks that you can perform by using the software at each stage of the

system engineering life cycle, page 26

and where to find information explaining how to complete the task.

Stages are grouped by explorer.

Systems Explorer Task Quick Reference

Task

Creating systems, page 105

(and configuring runtime navigation service (RTNS) parameters)

Creating system backups, page 108

Restoring systems, page 110

Application Explorer Task Quick Reference

System Engineering

Life Cycle Stage

Browsing templates, page 119

Task

Creating instances, page 130

Browsing instances and folders, page 121

Counting instances, page 133

EIO0000001114.15

101

Configuring instances, page 139

System Engineering

Life Cycle Stage

Task

(and associating documents and URLs to instances for use with RTNS)

Linking instances, page 146

Viewing facet assignment, page 294

Managing instances, page 155

(copy/paste, move, update/replace templates)

Exporting and importing application objects, page 168

Project Explorer Task Quick Reference

System Engineering

Life Cycle Stage

Creating projects, page 203

Assignment stage, page

256

Build stage, page 464

Deployment stage, page

481

Control Projects Supervision Projects

and

M580 safety projects, page 577

Managing projects and project sections, page 206

(order, export, import, manage data backup files)

Creating projects, page 226

Creating project components, page 229

Managing Projects, page 238

(export, import)

Creating sections, page 261

(automatic and manual)

Assigning facets, page 279

Creating containers (automatic and manual)

Assigning facets, page 281

Viewing the application structure in projects, page 287

Managing assigned facets, page 292

(view assignments, unassign, move, change order)

Generation stage, page

297

Refinement stage, page

336

Generating for the first time, page 300

–

Generating equipment names, page 329

Generating after changes, page 323

(auto-assign and generate, regenerate)

Managing generated facets, page 332

(unassign, reassign, unlink, move)

Managing versions of types, page 305

–

Refining projects, page 336

(viewing the application structure, viewing code generated by facets, managing device DDTs, creating LL984 segments)

Refining projects, page 361

Checking consistency, page 347

Creating network variables, page 350

Editing Supervision pages, page 361

Editing advanced project settings, adding included projects, attaching user files, page 362

Mapping stage, page 420

Creating Control executables, page 421

Mapping services, page 423

Mapping communication, page 424

Mapping network variables, page 435

Mapping hardware, page 442

Creating executables, page 457

Mapping services, page 459

Mapping communication, page 460

(and connecting

Modbus devices to Supervision)

Exporting/Importing hardware mappings, page 449

Building projects, page 464

(also, generate and build)

Building projects, page 475

(also, generate and build)

Downloading project files, page 478

Viewing the built Participant project, page 469

Refer to the Topology Explorer task quick reference.

Deploying built projects, page 520

and

deploying changes, page 528

(to all the station nodes that are service mapped to the project executable)

102 EIO0000001114.15

Configuration stage, page 364

Topology Explorer Task Quick Reference

System Engineering Life Cycle

Stage

Control Projects

Deployment stage, page 481

Execution stage, page 531

Supervision Projects

Configuring controllers, page 371

and

M580 safety controllers, page 577

Configuring station nodes, page 379

(for Supervision/simulation)

Configuring Modbus TCP and EtherNet/IP devices, page 391

Configuring PROFIBUS PRM Masters and Decentralized Peripherals, page 388

Configuring STB Islands, page 384

Configuring Ethernet networks, page 397

Connecting to Ethernet networks, page 399

Managing the Topology, page 406

(export, import, update templates)

Managing communication, page 597

(Modbus TCP Ethernet implicit (I/O scanning, peer to peer communication)/explicit, EtherNet/IP explicit, Modbus serial)

Using the emulated simulator, page 484

Deploying built projects, page 520

and

deploying changes, page 528

(to specific station nodes)

Managing controller passwords for deployment and execution operations, page 488

Deploying built projects, page 481

Re-deploying projects, page 501

Deploying project changes, page 509

(and undoing online changes)

Deploying controller data, page 505

Starting/stopping controllers, page 536

Synchronizing redundant controllers, page 541

Refining online, page 548

(and importing generated changes, viewing the application structure)

Updating Control projects, page 567

Backing up controller data, page 554

Refer to Executing the Deployed Supervision

Project (see EcoStruxure ™ Process Expert,

Supervision Participant Services, User Guide)

Global Templates Explorer Task Quick Reference

System Engineering Life Cycle

Stage

Global Templates, page 644

Tasks

Managing Global Templates, page 675

(save, copy, export/import, purge)

Updating, duplicating, and replacing Global Templates, page 688

Content Repository Task Quick Reference

Tasks

Creating content containers (see EcoStruxure ™ Process Expert, Runtime Navigation Services ,

User Guide ) (and editing, copying, moving, exporting and importing them to set up runtime navigation services (RTNS))

EIO0000001114.15

103

Opening the help of a Participant, page 69

Virtual Machine and Participant Task Quick Reference

Tasks

Configuring virtual machines (see EcoStruxure ™ Process Expert, Installation and Configuration

Guide) (sharing a folder of the local computer, keyboards, disabling the use of the virtual machine on the local computer)

Installing extensions in Participants (see EcoStruxure ™ Process Expert, Installation and

Configuration Guide) (DTMs, GSD and EDS files, hotfixes)

, OPC Factory Server, and OPC UA Server Expert

104 EIO0000001114.15

Organizing Systems .................................................................................... 105

What’s in This Chapter

Creating Systems........................................................................................ 106

Creating System Backups ............................................................................ 108

Restoring Systems ...................................................................................... 110

Overview

This chapter describes how to manage systems by using the Systems Explorer .

Creating a system is prerequisite to starting the system engineering life cycle.

NOTE: When one or more users work on components of the same system simultaneously (for example, Participant projects, the application, project containers, topological entities), locking mechanisms may restrict certain

concurrent actions, page 52 . In such case, check the

for details.

Organizing Systems

Overview

Systems that you create are stored in the database of the system server.

You can access a system from any client that is connected to the server of this infrastructure.

Accessing the Systems Explorer

To access the Systems Explorer , click the Systems icon in the

toolbar, page 77 .

Systems Explorer Window

The following figure shows the Systems Explorer window.

EIO0000001114.15

1 Systems Explorer root folder

2 System folder

3 Systems

105

restore a system, page 110

Creating System Folders

To organize systems, you can create system folders, which can contain one or more systems.

To create a system folder, proceed as follows.

Step

Action

Right-click the Systems Explorer root folder and select Create Folder .

Result: The software creates a system folder with the default name in edit mode, and displays it in the tree view.

NOTE: To create a subfolder, repeat step 1 at the system folder level.

To change the name, type it; otherwise click outside the folder to accept the default name.

System Folder Actions

Right-click the root folder or any system folder to open a context menu with the following commands.

When you select...

Create Folder

The software...

creates a system folder or subfolder.

Create System creates a system.

Delete

Rename

Restore deletes the folder.

The command is not available from the root folder.

NOTE: The command is not available if the folder is not empty.

allows you to enter a new folder name.

The command is not available from the root folder.

NOTE: You can also click the folder twice to edit its name.

opens the Restore window, which allows you to select a system backup file (.

sbf) to

in the database.

Creating Systems

Creating a System

To create a system, proceed as follows.

Step

Action

Right-click the Systems Explorer root folder or a system folder and select Create

System .

Result: The software creates a new system with the default identifier in edit mode, and displays in the tree view.

To change the identifier, type the new one; otherwise click outside the system to accept the default name.

System Actions

Right-click a system to open a context menu with the following commands.

106 EIO0000001114.15

Command

Open

Application (1)

Open

Topology (1)

Open Projects

(1)

Delete

Rename

Back Up

Description

Opens the Application Explorer , which allows you to start the

Configuration stage, page 364

or access the application of an existing system.

Opens the Topological Explorer , which allows you to start the

or access the topology of an existing system.

Opens the Projects Explorer , which allows you to start the

navigation buttons, page 77

or access the Control and Supervision projects of an existing system.

Deletes the system including all of its contents.

The command is inactive if either an application, topology, or project window of the system is still open.

Allows you to enter a new system identifier.

NOTE: You can also click the system slowly twice to edit its identifier

Opens the Back Up

window, page 108

, which allows you to create a backup file of the system.

Settings Opens the Settings

window, page 107

, which lets you view and configure various system-related settings.

Properties Opens the

Properties, page 107

window of the system.

(1) You can also use the

located in the toolbar of the engineering client.

System Settings Window

The Settings window opens when you select the Settings command in the context menu of a system.

Section

Document

Viewers

Description

Lets you enter the command line that the software executes for a given document type. The command is executed when you open, in the operation client, the document that is associated to an instance by using the HyperLink

service, page

141 .

System Properties

To open the Properties window of the system, right-click the system and select

Properties .

You can view and/or edit the following items.

Item

Identifier

Description

Market

Customer

Site

Description

The identifier must be unique on the system server.

Default value: System_n where n is an incremental number starting at 1.

Optional.

You can enter a description of the system with free form text. The description you enter appears in a tooltip when you move the pointer over the system.

Default value: Blank

Optional.

You can enter a description of the market that the system pertains to with free form text.

Default value: Blank

Optional.

You can enter a description of the customer that the system pertains to with free form text.

Default value: Blank

Optional.

EIO0000001114.15

107

station nodes acting as simulator, page 381

Item Description

You can enter a description of the site that the system pertains to with free form text.

Default value: Blank

Logged-in user who has created the system.

Created By

Creation Date

Time

Modified By

Date and time of the system creation.

Logged-in user who has modified the system properties.

Date and time of the last modification to the system properties.

Modification

Date Time

Change

Description

Optional

Security

Services By

Default

Optional.

You can enter a description of the changes to the system with free form text.

Default value: Blank

The setting has an impact on the default value of the Controller and Simulator password property of

controllers, page 373

and

that you create in the system:

• Enabled : Sets their property to Enabled by default.

• Disabled : Sets their property to Disabled by default.

Default value: Enabled

NOTE: Modifying the setting does not change the value of the password property of existing station nodes and controllers of the system.

NOTE: This setting does not impact the Safety password property of

M580 safety controllers, page 588

Creating System Backups

Overview

You can create a backup file (.sbf) of any system that exists in the Systems

Explorer . This allows you to do the following:

• Save your engineering work on demand so that your data is preserved, for example, in case of a disk problem on the PC on which the system server is installed (refer to the topic describing the contents of a system backup for details).

• Restore your work to an earlier point in time.

• Deliver a system to a site.

You cannot create a backup of a system if a component of the system is open in an engineering or operation client (for example, if the Application Explorer is open or if data of the system is accessed by using runtime navigation services).

Also, while you back up a system, no user can access it from an engineering or operation client.

You can start a new backup while another system is being backed up. You can do this from the same or separate engineering clients.

Version Compatibility

Backup files are version dependent. You cannot use them to restore systems in a different version of the software.

When you back up a system, the version of the software is automatically recorded and is displayed when you restore the system.

108 EIO0000001114.15

Controller data backup files, page 224

System Backup File Contents

A system backup file contains:

• The definition of all topological and application instances used in a system.

• Participant project and executable files with the related mapping information.

•

• Supervision

included projects, page 478

added by users.

•

User files, page 363

added to Supervision projects.

• OPC Factory Server and OPC UA Server Expert

configuration files, page

478 .

•

Password protection properties, page 373

for topological entities and their value.

•

Content containers, page 704

that you have created in the User Contents folder structure of the system.

It does not contain:

• The templates that are used by the instances of the application.

• The default Supervision included project.

•

Password information, page 488 .

NOTE: To be able to

restore a backup file, page 110 , the items listed above

must be present in the database of the system infrastructure where you want to restore it. For example, typically, templates that you have modified or created are not present in the database of a newly installed or different

EcoStruxure Process Expert infrastructure.

System Backup File Name

A system backup consists of a file with the default name <system identifier> <

(time stamp)>.sbf where time stamp is the date and time when the backup file was created, displayed by using the format YYYYMMDDHHMMSS. Time is indicated by using the 24-hour format.

For example, System_1 (20160625144852).

You can edit the file name when creating the backup.

Aborting System Back Up Tasks

After clicking Save in the Back Up window, the abort icon is displayed in the

. Click the icon to cancel the task. The backup file is not created.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are backing up a small system, the task may complete before you are able to click the icon.

Creating a System Backup File

To create a system backup, proceed as follows.

Step

Action

Right-click the a system in the Systems Explorer and select Back Up .

Result: The Back up window opens.

If you want to create the back up in a different location and/or with a different file name, click the browser button; otherwise, proceed to step 6.

Result: A Save As dialog box opens.

Select a location where to create the back up file and edit the file name if needed.

EIO0000001114.15

109

Export templates, page 169

Step

Action

Enter a description (optional).

NOTE: The description appears when you restore the system by using the back up file.

Click Save .

Result: The Save As dialog box closes and the full path to the file is displayed in the

Back up window.

Click Save .

Result: The software creates a backup file of the system and displays information in the notification panel.

NOTE: To cancel the backup task, click the abort icon in the notification panel.

from the root folder of the Global Templates explorer because they are not included in the system backup file but required to restore it.

Restoring Systems

Overview

You can restore a system from a system backup file that you had created by using the Back Up command. This requires that templates that are used by the instances of the application are present in the database of the EcoStruxure

Process Expert infrastructure.

You cannot overwrite an existing system that has the same identifier or merge system data. If a system with the same identifier already exists, the system is restored with a new identifier.

You cannot start a restore task while another system is being restored within the same infrastructure.

Version Compatibility

Backup files are version dependent. You cannot restore system back up files created with another version of the software. The version that was used to create the backup file is displayed when you try to restore a system.

NOTE: Backup files are forward compatible with subsequent releases within the same year ( R• versions) and service packs of a same version of the software only if the Participant version is unchanged. For example, you can restore a backup file created with version 2018 in version 2018 R2. In such case, a dialog box informs you of the version shift and the software makes the restored systems compatible with the installed version.

Detection of Missing Data Before System Restoration

When you restore a system, if the software detects that an item (for example, a template)

is missing in the database, page 109

, it opens the Restore dialog box.

Missing items are reported in the Status column of this dialog box.

To be able to restore the system, first, you need to add the missing item to the database where you want to restore it.

If an include project is missing, you can add it to the content repository by following the steps describing how to add a project file (see EcoStruxure ™

Process Expert, Global Templates Reference Manual). Start from an existing

Supervision genie facet template or create a new one from the Toolbox of the

Global Templates Explorer .

110 EIO0000001114.15

password protection, page 373

Password Management After Restoring a System

After you restore a system that contains a controller and/or a station node acting as simulator for which

has been enabled, you need to do the following to be able to deploy a Control Participant project:

• If no password was set before creating the backup file, you need to set one.

• If a password had been set before creating the backup file, you need to enter this password when prompted.

For more information, refer to the topic describing how to manage

passwords for

Control Participant projects, page 488

Aborting System Restoration

After clicking Restore in the Restore window, the abort icon is displayed in the

. Click the icon to cancel the task. The system is not restored.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are restoring a small system, the task may complete before you are able to click the icon.

Restoring a System

When you restore a system, its name in the database may be different from the name it had when you created the backup. If this occurs and you had already deployed Supervision projects contained in this system when you created the backup file, the system name that was used as reference by runtime navigation services now refers to a different system. As a result, runtime navigation services may not work or display data of another system.

NOTICE

NAVIGATION TO WRONG SYSTEM

Redeploy Supervision Participant projects after restoring a system.

Failure to follow these instructions can display information of an unexpected system.

NOTE: For details on the possible name change, refer to the topic describing the impact of restoration on system names in the

database, page 112

To restore a system from a backup file, proceed as follows.

Step

Action

Right-click the system root folder or any system folder in the Systems Explorer and select Restore .

Result: The Restore window opens.

Browse to the system backup file (.sbf) and click Open .

Result: A confirmation dialog box opens.

Review the information that is displayed and click Restore .

Result: The system is restored. If a system with the same identifier already exists, a dialog box opens, which indicates the new identifier that will be used to restore the system.

NOTE: Click Cancel to close the confirmation dialog box without restoring the system.

EIO0000001114.15

111

Step

Action

Click OK .

Result: The system is restored.

NOTE: To cancel the restore operation, click the abort icon in the notification panel.

If the system that you have restored contains Supervision Participant projects that you had deployed before creating the backup, redeploy each one of them.

Impact of Restoration on System Names in the Database

Each system that you create has an identifier in the Systems Explorer and also a name in the database, which may be different from the system identifier. Names of systems in the database are assigned by the software incrementally and used in the background by software services for system identification purposes, for example, by runtime navigation services provided by the operation client. The name in the database does not change when you rename a system in the

Systems Explorer .

When you restore a system in the same or another EcoStruxure Process Expert infrastructure, if the name that was originally assigned to it is already used, the system is restored with same identifier in the Systems Explorer but with the next available name in the database.

The following example illustrates the scenario where the name of a system in the database changes after restoring it.

The figure shows two systems that exist in the Systems Explorer and their respective name in the database folder.

112

NOTE: The path to the database folder is C:\ProgramData\Schneider Electric

\Process Expert x\Db, where x corresponds to the installled major version (the

R• version suffix does not appear).

EIO0000001114.15

MySystem is backed up and deleted from the Systems Explorer . Its name in the database is also removed and becomes available for assignment to a new system.

Then, a new system ( System_2 ) is created. The software assigns it the next available name in the database. In this case, it corresponds to the name that was originally assigned to MySystem .

Later, MySystem is restored. The software assigns it the next available name in the database ( System_3 ), which is different from the name it originally had.

EIO0000001114.15

As a result, in this example, the name of MySystem in the database:

• Was System_2 before restoration.

113

• Is System_3 after restoration.

114 EIO0000001114.15

Instantiating Templates ................................................................................ 115

What’s in This Chapter

Instance Indicators ...................................................................................... 144

Linking Instances by Using the Asset Workspace Editor ................................. 146

Managing Application Folders and Instances................................................. 155

Exporting and Importing Application Objects to CSV and XML Formats ........... 168

Overview

This chapter provides information to help you model the entire application of the system according to the process and instrumentation diagram (PID).

The following figure shows the position of the instantiation stage within the system engineering life cycle.

Refer to the

Instantiation stage, page 29

for a description of the purpose of this stage.

Instantiating Templates

Overview

This section describes how to use the Application Explorer to:

• Create a folder structure representing the process hierarchy of the application.

• Create and configure instances by instantiating application templates to model the functional components of the application.

• Link instances to each other to propagate data.

concurrent actions, page 52 . In such case, check the

for details.

EIO0000001114.15

115

Browsing Application Templates , page 119

Organizing the System Application

Before Starting

Before creating the folder structure for your system application, define the appropriate segmentation, hierarchy, and naming convention for your process.

The Application Explorer lets you use templates of the Global Templates library to create instances that model typical components and functions of the application of a system. For example:

• Process objects: Represent the functions of process hardware, for example, motors and valves. This includes signals from the field and/or variables.

For example, the $Motor template can model the functions of the electrical motor of a pump.

• Device objects: Provide functions required to communicate with, control, and/ or diagnose a range of electrical devices and instrumentation that are connected to field buses.

For example, the $TesysTEM template can model the functions of a TeSys T variable speed drive communicating through Modbus TCP explicit messaging.

• Communication objects: Provide functions to manage communication with device objects connected to field buses.

For example, the $EMPortQ template can model the management of communication through the port of a Quantum controller through Modbus

TCP explicit messaging.

Refer to

for additional information on templates that you can instantiate.

Creating an Equipment Hierarchy

When you create instances and folders in the Application Explorer , you create a structure, which is defined by:

• The identifier and location of the application folders.

• The identifier and location of the instances.

By default, this structure is used in the Supervision project to create an

equipment hierarchy, page 329

, which allows you to view alarms in the Supervision page in a structure identical to the folder structure of the application.

Therefore,

changes to the structure, page 156

of the application are

reflected on the facets, page 282

of the impacted instances once these facets are assigned to a Supervision project and generated.

Viewing the Application Structure in Control Projects

You can view the folder structure of the application also in relation to Control

Participant project

sections, page 257

once you have instantiated templates and assigned facets to the Control project.

The functionality is available also when you

refine a Control project, page 339

and

make changes online, page 550

Application Explorer

Overview

The

of the Application Explorer features:

• The Templates Browser pane, which lets you search installed libraries and find the application templates that you need to create the instances of your application.

116 EIO0000001114.15

• The Application Browser pane, which lets you view, search, sort, and filter folders and instances of your application. You can also perform other tasks on folders and instances by using this pane.

• The Asset Workspace pane, which lets you create asset workspaces. These are structural elements that let you group instances in order to create links between them.

• In the form of tabs:

◦ The properties of folders.

◦ The Instance Editor , which lets you view and edit properties of instances.

◦ The Asset Workspace Editor , which lets you view, create, and manage links between instances.

Opening the Application Explorer

To open the Application Explorer , double-click the system in the Systems

Explorer .

NOTE: You can also open the Application Explorer in the following ways:

• Drag the system from the Systems Explorer tree view to the

tabs bar, page 77

or to a

docking tab, page 83

• Right-click the system in the Systems Explorer and select Open

Application .

• Select the system and click the Open Application Explorer button in the

Application Explorer Window

The following figure shows an example of the Application Explorer window.

EIO0000001114.15

Item

Description

Templates Browser

pane, page 119

Application Browser

pane, page 121

System root folder

Asset Workspace

pane, page 143

Work area, page 79

of the Application Explorer . It is empty by default.

Properties of a folder

Instance Editor tab

Asset Workspace Editor tab

117

information on instances, page 130

Item

Description

Search field, page 118

for folders and instances

Button to open the folder Settings

pane, page 129

Searching Instances and Folders by Using the Application

Explorer Search Field

The search field of the Application Explorer lets you find instances and folders in the Application Browser by typing the entire or part of their identifier. You do not need to use wildcards. The search is not case-sensitive. Results are displayed as you type in a pane with columns. Your last three matching search keywords are stored and appear in a keyword menu. The stored keyword entries are systemindependent and persist even after the system server is restarted.

For example, to returns instances and folders that contain to in their identifier, such as instance Motor_1 , and folder Reactor .

By default, results are displayed in ascending alphabetical order with folders shown first, instances next.

The results pane provides basic

and remains open until you close it by clicking the close button. A tooltip provides additional information.

The following figure shows an example of the search results that are displayed when you enter mo in the search field.

118

Right-click a search result in the results pane to open a context menu with the following commands.

Command

Navigate

Edit

Description

• For an instance: Expands the containing folder and highlights the instance.

• For a folder: Expands the folder structure and selects the folder.

You can also double-click the item.

If the item is open in a window in a work area, the corresponding tab is also selected.

NOTE: If the instance is hidden because a filter is applied in the

Application Browser , the instance is not shown and a dialog box opens to inform you.

• For an instance: Opens the Instance Editor tab, which lets you view and edit

parameters of the instance, page 134

• For folder: Opens the Properties tab, which lets you view, edit, and create

parameters of the folder, page 126

You can

search results.

NOTE: Search results are not updated automatically if instances or folders were created, modified, or deleted in the meantime. You need to start over the search by clicking the search field and pressing Enter .

EIO0000001114.15

Composite templates, page 23

Browsing Application Templates

Overview

The Templates Browser pane of the Application Explorer lets you find the application templates of the Foundation library and other libraries that are installed in the database of the system server. These templates let you model the application of the system.

The Templates Browser pane also displays templates that you have created and/ or imported.

To be displayed, a template needs to meet the following criteria:

• Template type: Application

• Usability State (see EcoStruxure ™ Process Expert, Global Templates,

Reference Manual) of either:

◦ Approved

◦ Deprecated

By default, quick filters are applied to display only templates that are:

•

• The latest version of the template.

• In the approved state.

You can display additional templates or refine your search by:

• Using the search field.

• Modifying quick filters.

• Using column filters.

NOTE:

• For details on available Schneider Electric application templates, refer to the

Global Templates libraries , page

of the Schneider Electric libraries for EcoStruxure

Process Expert.

• For information on the naming conventions followed by Schneider Electric templates, refer to the topic describing

646

EIO0000001114.15

119

Templates Browser Pane

Pin button, page 86 . Lets you minimize the

120

Quick filters, page 121

(the check mark indicates that the filter is applied).

2 Search results. By default, in tree view, folders are shown first followed by instances. In grid view, instances are shown in a flat list. In both view modes, items are listed in ascending alphanumerical order.

3 Search field.

4 Button to toggle between grid and tree view for the display of search results.

Templates Browser pane to the left edge of the screen. Move the pointer over the Templates Browser tab to display the pane. Click the pin button again to restore the pane.

Filters and sorting, page 93 .

Searching Templates by Using the Search Field

The search field of the Templates Browser pane lets you search templates by typing the entire or part of the template identifier. You do not need to use wildcards or type the $ prefix. The search is not case-sensitive. Your last three matching search keywords are stored and appear in a keyword menu. The stored keyword entries are system-independent and persist even after the system server is restarted.

The search field acts like a filter for the active view mode as soon as you enter a string. Results are displayed as you type. To show the entire content, clear the field by clicking the close button or deleting your entry.

For example, val returns templates that contain val in their identifier, such as

$HandValve_UC , $MValve , and $ControlValve .

The table describes the scope of the search and how results are displayed depending on the view mode that is selected.

EIO0000001114.15

apply additional filters and sort the results, page 93

View mode

Tree view

Grid view

What you can find

• Templates

• Folders

Templates

What is displayed

Templates and folders matching the search criteria with their entire parent folder structure.

Templates matching the search criteria in a flat list.

NOTE: Click the toggle button to switch between display modes. Search keywords and search results are retained.

Searching Templates by Using Quick Filters

The table describes the filters that are available in the Templates Browser pane to refine the template search.

Filter

Composites

Facets

Last Version

Only

Approved

Only

Description

Displays only templates that are composites, which also include control module templates.

Selected by default

Yes

Displays only templates that are facets.

Displays only the latest version of templates.

Yes

Used

Displays only templates that have the approved (see

EcoStruxure ™ Process Expert, Global Templates, Reference

Manual) state.

Displays only the templates that are already used by instances of the application.

Using this filter disables the other filters.

Yes

NOTE:

• When you select multiple filters, only templates that match the selected filters are displayed.

• When you select a filter, the software automatically refreshes the result.

The other way around, when the filtered data is modified, the filters are not applied to the modifications.

• Filters are reset when you close the Application Explorer .

Additional Filters and Sorting

You can

to refine your search.

Using the Application Browser Pane

Overview

The Application Browser pane lets you:

• Create, delete, move, copy-paste, and rename folders and instances.

• Search, sort, and filter folders and instances

• Toggle between tree and grid view mode, the latter showing only instances.

• Customize the display and the order of columns.

• View and edit the properties of folders and instances.

• Add instances to an asset workspace that is open in the Asset Workspace

Editor to create interface links.

• View assignments.

• Export and import application objects.

EIO0000001114.15

121

Filters and sorting, page 93 .

Application Browser Pane

The following figure shows an example of the Application Browser pane.

122

Item

Description

Status filters, page 122

You can

(a check mark indicates that the filter is applied).

Button to toggle between tree and grid view mode.

customize, page 123

which columns appear and in which position.

System root folder. By default, the system root folder is expanded to display its immediate children. Folders are shown first in the order you have arranged them, followed by instances in ascending alphanumerical order.

Pin button, page 86

. Lets you hide the pane and restore it when it is docked.

If the folder has an

alias, page 126 , it is shown in brackets after the folder identifier.

For instances for which the hierarchical naming function is enabled, the alias is shown in front of the

instance name, page 130

(if applicable).

When you edit the identifier of an instance for which the

hierarchical naming function, page

141

is enabled, the alias appears to the left of the identifier in read-only mode (if applicable).

Indicator icons, page 144 .

Search field, page 124

Using Instance Status Filters

The table describes the impact on the search result when you select instance status filters in the Application Browser pane.

Filter

Needs Attention

Link Invalid

Data Invalid

Progress

Description

Shows only instances that satisfy the three subfilter criteria.

Shows only instances whose Link

status, page 150

is invalid.

Shows only instances whose Data

status, page 130

is invalid.

Shows only instance for which a

progress icon, page 144

appears.

EIO0000001114.15

EIO0000001114.15

NOTE:

• When you select multiple filters, only templates that match the selected filters are displayed. You can combine

column filters, page 93

and use the search field to refine your search further.

• When you select a filter, the software automatically refreshes the result.

The other way around, when the filtered data is modified, the filters are not applied to the modifications.

• Filters are reset when you close the Application Explorer .

Toggling Between Tree and Grid View

Tree view is the default view mode. You can switch to grid view any time by clicking the toggle button. The item selection in either view mode is retained when you switch and revert to this mode.

In grid view, when no sorting and filter is applied, all the instances of the application are shown in a flat list sorted in ascending alphanumerical order.

The table describes the impact on various features when switching from one view mode to the other.

Feature that is used

Filtering

Sorting

Impact when switching between view modes

The search criteria is carried over.

Is not applied to the other view.

NOTE: In grid view mode:

• Commands of context menus related to folders are not available.

• You cannot create instances by dragging a template to the Application

Browser pane.

Navigating Inside the Browser Pane

The table describes the various methods that you can use to navigate inside the browser pane.

Key or action

Up/down arrow key

Left/right arrow key (1)

Enter (1)

Double-click (1)

Plus (+)/minus (-) key

Result

Moves the selection to the previous/next item.

Expands/collapses the next level of the selected node.

On a node, expands/collapses the next level of the node.

Expands/collapses the entire hierarchy from/up to the node.

(1) The next time you expand the node by using one of these methods, the display reverts to the last expanded view.

Customizing Column Display and Order

You can choose which columns you want to see by right-clicking a column header and selecting Customize . The Identifier and Template columns are always shown.

The Path column is available only in grid view.

When you hide a column for which a filter is applied, the filter is cleared.

When the Customize dialog box is closed, you can change the order of columns by dragging a column to its new position (except for Identifier ).

123

creation of instances, page 130

You can configure the column display and order independently in tree and grid view.

For a description of each column, refer to the topic describing the

NOTE: The order of columns is reset each time you open the Customize dialog box and click Apply .

Searching Instances and Folders

The search field of the Application Browser pane lets you search folders and instances by typing the entire or part of their identifier. You do not need to use wildcards. The search is not case-sensitive. Your last three matching search keywords are stored and appear in a keyword menu. The stored keyword entries are system-independent and persist even after the system server is restarted.

For example, entering to returns instances that contain to in their identifier, such as folder Torrefier and instance Motor_1 .

The table describes the scope of the search and how results are displayed depending on the view mode that is selected.

View mode

Tree view

Grid view

What you can find

• Instances

• Folders

Instances

What is displayed

Instances and folders matching the search criteria with their entire parent folder structure.

NOTE: When searching for folders, if several folders within the same hierarchical structure match the search criteria, only the highest level parent folder is shown in a collapsed state. You can see whether any child folders match the search criteria by entering the search criteria in the search field of the Application

Explorer . A tooltip indicates the path to folders in the search results.

Templates matching the search criteria in a flat list

Search keywords and search results are retained when you switch between view modes.

By default, results are displayed with folders shown in the order you have arranged them followed by instances in ascending alphanumerical order.

sorting and/or filters, page 93

are applied, they are also applied to the search results.

NOTE: Search results are not updated automatically if instances or folders are created, modified, or deleted. For example, if you have entered va in the search field and create a folder, which has Folder_n as default identifier, it will be shown.

Creating Application Folders

Overview

You can create application folders to structure your application by using the

Application Browser .

The software lets you structure the application according to the ISA-S88.01-1995 standard for batch control. You can create and rename the application folders according to the physical assets that you want to represent and

assign icons to the folders, page 129

to define a hierarchy of equipment.

Folders that you create may inherit properties of their parent folder, such as the

Area .

124 EIO0000001114.15

Assign icons to application folders, page 129 .

EIO0000001114.15

You can also:

• Create folders also by copying and pasting or

import, page 168 .

•

Move folders, page 126

with or without changing the folder hierarchy.

•

Creating Application Folders

To create an application folder, proceed as follows.

Step

Action

Right-click the system root folder and select Create Folder .

Result : An application folder is created at the end of existing folders of the same level.

The identifier is in edit mode.

Application Folder Actions

Right-click the root folder, any application folder, or multiple folders to open a context menu with the following commands.

When you select...

Create

Folder

Open

Topology

Open

Project

Update

Replace

Delete

The software...

creates an application folder or subfolder.

The command is not available when more than one folder is selected.

opens the

Topological Explorer , page 204

, which allows you to start the configuration stage or access the topology of the system.

The command is available from the root folder only.

Opens the Projects Explorer , which allows you to start the

or access the Control and Supervision projects of an existing system.

The command is available from the root folder only.

opens the Update Instance Template window. It lets you update the template that is used by instances inside the folder and any subfolder with the latest version of that template, which is available in the Global Templates library on the system server.

opens the Replace Instance Template window. It lets you select another template to be used by instances contained in the folder and any subfolders. The template needs to be available in the Global Templates library on the system server.

copies folders, their subfolders, and the instances they contain.

The command is not available from the root folder.

pastes the copied items to the selected locations in the system or in another system of the server.

The command is available if the copied content is valid for the selected target locations.

opens an Export dialog box, which allows you to save the parameters and configuration data of application objects to a file in CSV or XML format.

opens an Open dialog box, which allows you to select an export file in CSV or XML format, display its compatible contents, and select instances to be imported into the application.

The command is not available when more than one folder is selected.

deletes any selected folders and their contents including any subfolders and instances.

The command is not available from the root folder.

NOTE: After confirming the command, the abort icon is displayed in the

. Click the icon to cancel the task. Already deleted instances and/or folders are restored.

Only the user who has selected the command is allowed to abort it.

If you are deleting only a few items, the task may complete before you are able to click the icon.

125

Tab

General

Item

Identifier

126

Alias

the equipment hierarchy, page 116

When you select...

Rename

The software...

lets you enter a new folder identifier.

NOTE:

• Renaming a folder may affect

• The command is not available from the root folder and when more than one folder is selected.

• If the folder has an alias, it is not shown while the identifier is in edit mode.

Properties opens the

Properties, page 126

tab, which allows you to edit the properties of the application folder.

The command is not available from the root folder and when more than one folder is selected.

Moving Folders

You can move one or more folders by dragging them to a new position. A tooltip indicates the result of the action, which can have an impact on instances if the folder hierarchy is changed.

The table describes the tooltips that can appear and the corresponding result.

Tooltip

Move X before Y

Result

The folder and its content is repositioned before or after the other folder.

The folder hierarchy is not changed.

The folder that you are moving and its content becomes a child of the other folder.

The

equipment hierarchy, page 329

may be impacted.

The

instance identifier, page 141

and

assignment status, page 320

of generated facets may be impacted.

Where:

X Is the identifier of the folder that you are moving.

Y Is the identifier of another folder of the application.

NOTE: When you move several folders, you cannot reposition them and maintain the same hierarchy.

Application Folder Properties

To open the properties of the application folder, right-click the folder and select

Properties . A tab opens inside the

of the Application

Explorer .

You can also open the properties by dragging the folder to the work area, the tabs bar of a work area, or to a

docking tab, page 84

within the Application Explorer .

You can edit the following items.

Description

Designation of the folder.

The identifier must be unique for each subfolder of the same parent folder and satisfy

the equipment hierarchy, page 116 .

Default value: Folder_n where n is an incremental number starting at 1 for each folder level.

NOTE: Changing the identifier of an application folder may affect

Optional.

You can assign an abbreviated name to the folder.

The alias is shown in brackets next to the folder identifier.

EIO0000001114.15

hierarchical naming function, page 141 .

Tab Item Description

Manage

Parameters

Description

Area

Parameter_1

...

Parameter_n

Identifier

Description

Value

The software uses the alias for the

You cannot create or modify the alias value if it causes any instance identifier to be non-unique.

Default value: Blank

Optional.

You can enter a description of the folder with free form text. The description you enter appears in a tooltip when you move the cursor over the folder.

Default value: Blank

Optional.

You can assign a folder to an area.

Range: 1...255 (integer)

Default value: Blank

The software attempts to propagate the area value to subfolders and any instances contained in the hierarchy to which no area value has been assigned manually.

For details, refer to the topic describing

area value propagation, page 127 .

NOTE: You can also enter a string instead of an integer value. In such case, you must refine the Supervision project after generating it and use the same string as label to name the area; otherwise, the Supervision project does not build successfully. Refer to the help of the Supervision Participant for details.

NOTE: The area value is also propagated to Supervision elements of instances such as genies.

You can use as many folder parameter sets as you require.

Default value: No parameter

NOTE: Click Add Parameter to add a parameter.

Area Parameter Value Propagation

The software automatically propagates the value (including blank (NULL value)) of the Area parameter of a folder to:

• Existing subfolders and instances that the folder and its subfolders contain unless you have assigned an area value to them manually.

• Subfolders and instances that you create afterwards.

• Subfolders and instances that you add afterwards either by copying or moving them unless an area value had been assigned to them either automatically or manually.

If you change an existing area value of a folder, only the area value that was propagated automatically to the next level of subfolders and their instances is updated. The change is propagated down the folder structure, level after level, until a manual folder area entry is detected.

If the software is not able to propagate the value of the Area parameter to any item because the item is locked, it:

• Displays a notification to inform you which item is locked.

• Rolls back any propagated area value.

• Reverts the Area parameter value that you have entered in the folder properties to its previous value.

EIO0000001114.15

127

128

NOTICE

NO CHANGE PROPAGATION

When the Area parameter value of a folder is not propagated:

• Reenter the Area parameter value in the properties of the folder.

• Verify in the Notification Panel that parameter value propagation completed successfully.

Failure to follow these instructions can result in alarms being signaled in the wrong area during operation.

Examples

The following three examples illustrate the area value propagation to existing subfolders and instances in the Application Explorer . The changes described in these examples are performeds in steps inside the same folder structure.

In a first step, starting from a folder structure and instances without area value, if you change Area of Folder_1 to 1, the value is propagated to Instance_1 , subfolders, and their instances.

In a second step, if you change Area of Instance_2 to 2 and then Area of Folder_1 to 3, value 3 is propagated to Instance_1 , subfolders, and their instances except for Instance_2 because the area was entered manually.

EIO0000001114.15

In a third step, if you change Area of Folder_2 to 4, value 4 is propagated to

Instance_21 , the Folder_4 subfolder and its instance.

Instance_2 remains unchanged because the area was entered manually. If you then change Area of

Folder_1 to 5, value 5 is propagated only to Instance_1 , subfolder Folder_3 , and its instance because the area of other subfolders and instances have either been entered manually (for example, Folder_2 ) or are manual entries that have been propagated (for example, Folder_4 ).

Assigning Icons to Application Folders

Overview

By using the Settings pane, you can assign icons to each level of application folders. The icons appear in the tree view of the Application Browser

pane, page

117 .

You can use this feature, for example, to represent graphically the physical hierarchy of equipment used in a batch process according to the ISA-S88.01-1995 standard.

The settings apply to the system for which you configure them, to any user who opens the system in an engineering client, and persist even if you restart the system server.

NOTE: You cannot assign an icon to the system root folder.

Available Icons

You can choose from the following selection of icons.

Icon Description

Default folder icon

Site

Area

Process cell

Unit

Equipment module

NOTE: Control modules are represented by the instances of the application.

EIO0000001114.15

129

folder structure, page 124

Assigning Icons to Folder Levels

To assign an icon to a folder level, proceed as follows.

Step

Action

Click the Explorer Layout Settings

button, page 77 .

Result: The Settings pane opens.

In the Appearance section, select the folder level to which you want to assign an icon.

In the Style menu, click the icon that you want to use.

Result: The icon is assigned to each existing folder of the selected level and to each new folder that you create in the selected level.

Repeat the procedure for other folder levels.

Creating Instances

130

Overview

Instances that you create in the

of the application are created with the default configuration of their template. Basic information on each instance is available at the folder level.

Once you have created an instance by using the Application Browser , you can perform various actions by using the pointer, accessing the context menu of the instance, or using keyboard shortcuts.

Order of Instantiation

The order in which you create instances inside an application folder may affect the order of the referenced Control facets in a section during

assignment, page 280

Instantiating Application Templates

To instantiate a template in the root folder or in any application folder, proceed as follows.

Step

Action

Verify that the folder in which you want to create the instance is displayed in the

Application Browser .

In the Templates Browser , select a template.

Drag the template to the folder.

Result: The folder opens or expands and an instance of the template is created in last position with the default identifier in edit mode.

NOTE: If the folder has an alias, it is shown in a separate cell on the left of the identifier.

To change the identifier, type it; otherwise, press Enter to accept the default name.

NOTE: To keep the default name and create a new instance, you do not need to press Enter ; you can drag another template while the identifier of the instance is still in edit mode.

NOTE: Refer to

Managing Application Folders and Instances , page 155

for information on features that are available when working with many application folders and instances.

Instance Description

The following information of an instance is displayed in the Application Browser when the corresponding

column is shown, page 123 .

EIO0000001114.15

EIO0000001114.15

Header

Icon

Identifier

Template

Version

Data

Link

Assigned

State

Description

Area

Path

Description

Displays the icon corresponding to the type of template that the instance uses.

For instances, displays the instance identifier (see EcoStruxure ™ Process Expert,

Global Templates, Reference Manual), which must be unique for each instance of the same template. The software calculates the identifier by using the parameter $Name of the instance and the applicable naming conventions.

For folders, displays the folder identifier, which you can edit in the Properties tab or by using the Rename command.

NOTE:

• You can edit the $Name parameter of an instance in the

or by using the Rename command. If the resulting identifier is not unique, the $Name field is outlined in red. In such case, clicking outside of the field reverts the name to its previous value.

• The

Asset Workspace Editor, page 146

can modify the identifier of an instance.

• Two instances using two different templates cannot have the same identifier if both instances have an element in their composition in common

(for example, the Logic element, which is created by the $DEVCTL_UL facet). In such case, the identifier of the element that both instances have in common would be the same; this is not allowed.

Indicates the identifier of the template that the instance uses.

The field is not used for folders.

Indicates the version of the template that the instance uses.

The field is not used for folders.

Indicates the status of the instance. Possible values:

• Valid

• Invalid

The value is updated when you save changes in the Instance Editor .

The field is not used for folders.

NOTE: You can obtain information about the

invalid status, page 138

of an instance in the Validity Diagnosis window:

• By clicking Invalid .

• When viewing its

properties, page 134 .

Indicates the status of the application interface link of the instance. Possible values:

• Valid

• Invalid

The value is updated when you make a link by using the

or save changes in the Instance Editor that impact the link requirements of the instance.

The field is not used for folders.

NOTE: You can obtain information about the

invalid status, page 150

of an instance in the Validity Diagnosis window:

• By clicking Invalid .

• In the Asset Workspace Editor .

Indicates the

assignment status, page 282

of the facets of the instance. Values:

Assigned : At least 1 facet of the instance is assigned to any project of the system.

Unassigned : No facet of the instance is assigned to any project of the system.

The field is not used for folders.

Displays the content of the $Description parameter the folder or the instance. You can edit the field in the Properties or the

tab respectively.

Displays the value of the $Area parameter for the folder or the instance. You can edit the field in the Properties tab or the

assigned automatically, page 127

tab respectively.

NOTE: If the value was

by the software, it appears between angle brackets. For example, <5>.

Indicates the path to the instance in the application starting from the system root folder.

NOTE: The column is shown only in grid view mode.

131

132

Instance Actions

Right-click an instance to open the instance context menu with the following commands.

Command Description

Properties (1) Opens the

in the work area, which allows you to view and configure parameters, and select services of the instance.

Navigate to

Workspace

(1)

Opens the Show Workspace window, which lists the asset workspaces that the instance belongs to.

Double-clicking an asset workspace opens it in the Asset Workspace Editor and highlights the instance. This lets you create and manage links between instances.

Edit Links (1)

View

Assignments

Update

Replace

Inspect

Instance (1) , page 155

Opens the

Links Editor, page 712

, which allows you to view the interface links that exist for the instance.

Opens the View Assignments window, which lets you verify if the facets that are referenced by the instance are assigned to Participant projects:

• If a facet is not assigned, you can select an existing project and open the

Assignment Editor to assign it.

• If a facet is assigned, you can access the container to which the facet is assigned.

For Supervision genie facets, you access the Pages node in either case.

NOTE: The command is not available if the Data or Link status of the instance is Invalid .

Opens the Update Instance Template window. It lets you update the template that is used by the instance with the latest version of that template, which is available in the Global Templates library on the system server.

Opens the Replace Instance Template window. It lets you replace the template that the instance is using by another template, which is available in the Global

Templates library on the system server.

Opens the Inspect Instance window, which provides information on the entire instance configuration, including interface links.

Rename (1)

Delete

Copies the selected instances for pasting within the application of the system or any other system on the server.

Opens an Export dialog box, which allows you to save the instance data to a file in

CSV or XML format.

Sets the identifier of a single instance to edit mode. Type the new identifier and press Enter .

NOTE: The instance identifier is split in two and only the instance name

( $Name ) part is editable if the following conditions are satisfied:

• You have defined an alias for the folder containing the instance or any of its parent folders.

• The

notification panel, page 54 . Click the icon to cancel the task. Already deleted

for the instance is enabled.

The concatenated, non-editable aliases are shown on the left of the instance identifier.

Deletes the instance from the application.

You can select multiple instances within the same folder.

Not available while you edit the instance.

If you have assigned facets of the instance to projects, the

assignment state, page

282

of these facets changes to Deleted .

NOTE: After confirming the command, the abort icon is displayed in the

instances are restored.

Only the user who has selected the command is allowed to abort it.

If you are deleting only a few instances, the task may complete before you are able to click the icon.

(1) The command is not available when multiple instances are selected.

EIO0000001114.15

export the instances, page 169

Counting Instances

EIO0000001114.15

Overview

The software includes a mechanism, which counts the instances that exist in the application of any system on the system server and compares their number to the maximum number of instances that the application size license that is activated allows.

At any time during the system engineering life cycle, you can view the instance count for each system, the total count, and the maximum number of instances that is allowed.

The software does not allow actions that cause the maximum number of instances of the application to be exceeded.

Viewing Instance Count Information

Instance count and software license information is displayed in the About

EcoStruxure Process Expert

dialog box, page 78 .

The table describes the information that is displayed in the License Details section of the General tab.

Label

Maximum Instances

Allowed

Current Instance Count

Description

Total number of instances that you can create with the current license.

Total number of instances in the systems that exist on the system server.

The table describes the information that is displayed in the Systems Details tab.

Header

System Name

Instance Count

Description

Identifiers of the systems that exist on the system server.

Total number of instances of the system.

Actions Affecting Instance Count

The following actions that you can perform in the Application Explorer increase and/or reduce the instance count in the application:

• Instantiate

• Paste

• Import

• Delete

The following actions that you can perform in the Systems Explorer increase and/or reduce the instance count in the application:

• Restore

• Delete

Exceeding the Allowed Number of Instances

If one of your actions causes the maximum number of instances that is allowed by the activated license to be exceeded, the software cancels the entire action. It also displays a message to advise you that you have reached the limit of instances allowed by the license.

In such case you have the choice to:

• Delete instances (you can

before deleting them to reuse them later.)

133

back up the system, page 108

• Delete systems (you can

before deleting it to reuse it later.)

• Upgrade the application size license (see EcoStruxure ™ Process Expert,

Licensing Guide).

Accessing Instance Properties

Overview

The Instance Editor tab opens in the inside the

services, page 23 , which are

of the

Application Explorer and provides access to:

• Control, Supervision, and documentation

provided by the template that the instance is using.

• Parameter values of the

elements, page 22

of the instance.

• The number of parameters that have been modified.

• The status of the instance.

NOTE: More information on the instance configuration is available in the

Inspect Instance

window, page 155

in read-only mode.

Read-Only Mode

You can open the Instance Editor for an instance in read-only mode if either of the following is true:

• The instance is being edited, for example, from another client connected to the same system server.

• The instance is displayed in the Links Editor , either as

active or inactive., page 712

The read-only mode allows you to view instance parameters but not to modify them.

Opening the Instance Editor

To open the Instance Editor , double-click the instance that you want to configure in the Application Explorer .

You can also open the Instance Editor in the following ways:

• Right-click the instance and select Properties .

• Drag the instance to either area within the Application Explorer :

◦ The

◦ The tabs bar of a work area.

◦ A

docking tab, page 84

134 EIO0000001114.15

propagate changes, page 282

Instance Editor

The following figure shows an example of instance Motor_1 , which uses template

$Motor open in the Instance Editor .

EIO0000001114.15

Item

Description

Instance identifier. It is prefixed with * if you have made a change and not saved it.

Instance validity status indicator. The status is set to Invalid and details are available by clicking the information button if either the Data or Link

status, page 130

is invalid.

Save button. Click to save parameter values and

Instance pane, which allows you to view the services that the instance provides and to enable/disable optional ones. By default, nodes are shown expanded.

Element displayed in bold indicating that the element contains editable parameters.

Check box for element selection.

Counter indicating the number of modified parameters for a node out of the total number of parameters that exist for that node.

Counter indicating the number of modified parameters for an element.

Elements of optional nodes of the instance that are not selected and that have configurable parameters are displayed on a light gray background. This allows identifying easily which are the optional services of the instance that provide additional customization capabilities. Selecting the node removes the gray background.

Parameters pane, which allows you to configure the parameters of the elements of the instance that you have selected.

Optional

Hierarchical naming function, page 141

selection box. The function is enabled by default.

Parameter Filters section, page 138 .

Grouped by sorting function for parameters.

The table describes the fields of the instance pane.

135

136

Header

Name

Icon

Check box

( x / y )

( z )

Description

Template

Description

Shows the composition of the instance by displaying the identifier of the instance and:

• Its core and optional composite elements (nodes)

• Core and optional elements thereof (facets)

Elements (facets) provide the services of the application template, which depend on the template that the instance uses.

For details on the services that are provided by Schneider Electric application templates, refer to the

of the Schneider Electric libraries for EcoStruxure Process Expert.

An item in bold indicates that you can configure parameters of the element.

Move with pointer over an element to see a description of the element in a tooltip.

Indicates the type of template that is used by the instance and its elements.

Indicates that the element is optional and not mandatory for the control module to function. Typically, optional elements correspond to additional functionalities that are built into the template and that you can select to customize the instance according to your needs.

An optional element may contain optional subelements, which you can select individually.

Selecting an element enables it and creates the corresponding facets. If applicable, it allows you to configure parameters of the service that the element provides.

Selecting an optional Control element automatically selects the corresponding Supervision element if it is available. For example, when you select the Interlocks element of the $Motor template, the InterlockTags

Supervision element is selected.

The other way around, clearing a selected Control element automatically clears the corresponding Supervision element.

The following Supervision elements are selected by default:

• Elements corresponding to core Control elements, which are not optional.

• Elements corresponding to optional Control elements, which are selected by default.

Node counter (7). For the instance and for its composite elements, the first number indicates the number of parameters that you have changed in the node ( x ) compared to the default value and the second, the total number of parameters ( y ) that you can change for this node.

Changes to the Instance Name are not counted.

Counters are updated as soon as you confirm your entry by pressing Enter .

For boolean types, when you select or clear them.

NOTE: The counter turns bold to indicate that you have changed a parameter of the element itself. When you change a parameter of any of its child elements, the counter font style remains regular.

Element counter (8). For child elements, indicates the number of parameters that you have changed compared to the default values.

The counter appears even if the element has no editable parameters.

Counters are updated as soon as you confirm your entry by pressing Enter .

Description of the instance or element displayed in the Name column.

For instances and composite elements, indicates the identifier of the template that the instance or composite element is using.

For facet elements, indicates the identifier of the facet template that encapsulates the constituent provided by the Participant to implement the service.

Version of the template that the instance or element uses.

Version

The table describes the fields of the parameters pane.

EIO0000001114.15

Inspect Instance window, page 155

EIO0000001114.15

Header

Group By

Element Path

Category

Name

Description

Type

Value

Resolved

Value

Description

Allows you to sort parameters that are displayed in the parameters pane by the following criteria:

• Element Path

• Category

• Type

By default, parameters are grouped as follows:

• For instances based on a composite template: By Element Path , then

Category .

• For instances based on a facet template: By Category .

Click the close button of a criteria to remove if from the grouping. The corresponding column is displayed.

Drag a column header to the green bar to group parameters by the corresponding criteria. You can group by multiple criteria simultaneously.

When multiple criteria are selected, swap their order by dragging a criteria left or right.

When you have selected to group by a criteria, the corresponding column is not displayed anymore.

Path to the element, which provides the parameters, as shown in the instance pane.

Not available for instances based on a facet template.

Category of the parameter.

Identifier of the parameter.

The column is hidden by default.

Right-click any column header and select Show Name to display the column.

Right-click any column header and select Hide Name to hide the column.

Description of the parameter.

Indicates the data type of the parameter.

Default value of the parameter or the value that you have entered.

NOTE: For parameters of the enumerated data type, for each enumerator, both the name and the associated integer are shown (for example, Operator

(2) )

Displays the value after formatting according to the data type.

For example, when the check box of a boolean parameter is selected, the value that is displayed is True .

The column is hidden by default.

Right-click any column header and select Show Resolved Value to display the column. Right-click any column header and select Hide Resolved Value to hide the column.

NOTE: Open the

to view the resolved value of additional template parameters, which has been calculated by using the value property and any applicable logic defined in the template definition.

Navigating Inside the Instance Pane

The table describes the various methods that you can use to navigate inside the instance pane.

Key or action Result

Up/down arrow key Moves the selection to the previous/next item.

Left/right arrow key

(1)

Expands/collapses the next level of the selected node.

Enter (1)

Double-click (1)

Plus (+)/minus (-) key

On a node, expands/collapses the next level of the node.

Expands/collapses the entire hierarchy from/up to the node.

137

138

character that is not allowed, page 65

(1) The next time you expand the node by using one of these methods, the display reverts to the last expanded view.

Displaying Instance Parameters Using Filters

The table describes the filters that are available in the Parameter Filters section to customize the display of parameters of the selected instance or element.

Filter

Editable

Modified

Show Child

Parameters

None selected

Description

Displays only parameters of the selected instance or element that you can edit.

A parameter may not be editable because it is optional and you have not selected it.

The filter is applied by default.

Displays only parameters of the selected instance or element whose value you have modified compared to their default value.

Displays parameters of the selected instance or element including those of child elements.

No filter is applied. Displays the parameters of the selected instance or element.

NOTE:

• When you select multiple filters, the software displays only parameters that match the selected filters.

• When you select or clear a filter, the software automatically refreshes the result.

To apply default filters, click the filter icon, then click Default .

To clear any filters, click the filter icon, then click Clear Filter .

Instance Data Status

When any of the following conditions apply, the Data status of the instance in the

Instance Editor changes to Invalid :

• Entering a

in the $Name field.

• Entering a number of characters in the $Name field causing the instance identifier to exceed the

length limit that may be defined, page 65 .

• Selecting an invalid combination of optional elements in the instance pane of the Instance Editor .

• Creating an instance that references an element that has the same identifier as an existing element in the application. For example, if you create two instances with the same identifier from two different templates, which have an element in common, such as Interlocks , which uses the $CONDSUM1_UC facet template.

You cannot assign to projects instances that have a Data status that is Invalid .

Furthermore, when facets of an instance are assigned to a Participant project, and later either status of the instance changes to Invalid , the software propagates the invalid status to facets of Participant projects.

While the Data status is displayed as Invalid , click the validity status information button to display the Validity Diagnosis window, which provides information about the cause of the status.

EIO0000001114.15

instance links, page 150 .

The following figure shows an example of the Parameter tab of the Validity

Diagnosis window that the software displays when it detects an invalid identifier.

NOTE: For information on the other tabs that are related to the Link status of the instance, refer to the topic describing

NOTE: If the status of an instance is Invalid because of a duplicate element identifier, deleting or modifying the other instance that contains the same element does not change the status back to Valid . After you have solved the conflict, edit the invalid instance and save any change (for example, a modification of the description) to set its status to Valid .

Configuring Instances

Overview

The Instance Editor lets you:

• Enable or disable optional Control, Supervision, and documentation services, which are provided by the template that the instance is using.

• View and configure parameters of the instance.

For more information to help you select and configure instances to meet the requirements of your application, refer to the

Date or Deleted , page 320 .

of the Schneider

Electric libraries for EcoStruxure Process Expert.

For information on how to link documents, files, and associate web links to instances for use with runtime navigation services, refer to the topic describing how to add user contents (see EcoStruxure ™ Process Expert, Runtime Navigation

Services , User Guide ).

NOTE: When an instance is being edited by using another client of the same system server, this instance can only be opened with the Instance Editor in read-only mode to preserve

data integrity, page 52

Modifying Instance Parameters After Assignment

When you modify and save properties of an instance whose facets are already assigned to a Participant project, the software may display a message to inform you that your modifications affect the assignment status of these facets.

This is a generic message that does not take into consideration whether the assigned facets are generated or not.

In fact, only the assignment status of generated facets can be changed to

Out Of

If facets are only assigned, upon saving your changes:

• Modifications are propagated without affecting the assignment status. (For example, if you change the instance name, the identifier of assigned facets is updated in the Participant project.)

• Entire facets are removed from the container to which they are assigned. (For example, if you clear an element of an instance, the corresponding facet that was assigned is deleted.)

EIO0000001114.15

139

140

automatic facet assignment, page 284

Changing the Element Selection of Instances with Assigned

Facets

When you change the element selection of an instance, which has at least one facet that is already assigned and this change results in the creation of new facets, the software can assign candidate facets automatically to the same container.

For more information, refer to the topic describing

Validating Parameter Values

When you edit parameters of the instance, the Instance Editor displays and validates values according to the

supported data types, page 63

, helping you configure the values in accordance with the data type format.

You cannot save the instance properties if the software has detected that a parameter value is not valid.

Certain

supported data types, page 63

use language-specific formatting according to the Regional Options that are set for the operating system of the PC. For example, if your regional settings define . (dot) as decimal delimiter and you enter a decimal value in the format 100,5 by using comma instead of the dot, the software processes this value as 1005.0

NOTE: Except for changes to the $Name parameter:

• Changes appear in italics until you save them.

• Values that you enter and that are different from the default value are shown in bold at any time.

WARNING

UNINTENDED EQUIPMENT OPERATION

Verify which Regional Options are configured in the operating system of your computer and follow the applicable formatting rules to enter data in the

Instance Editor .

Failure to follow these instructions can result in death, serious injury, or equipment damage.

In addition, in the Instance Editor the following rules apply when you edit the

$Description parameter and other element parameters of type String of an instance.

Rule

““ returns an empty string.

Conversion of “ into

^” .

To return ^ use ^ .

Example or comment

“ example or example “ is not allowed.

The software converts ” example ” into ^“ example ^“ to return

” example ” .

^ example or example ^ is not allowed.

^^ example ^^ returns ^ example ^ .

Naming Rules for Instance Parameters

When you change instance parameter values, verify that they satisfy the

Participant specific

so that the subsequent generation process can complete successfully.

Further, entering incorrect values may change the Data

status, page 138

of the instance to Invalid when you save the instance configuration.

NOTE: Naming rules may also apply when you use the hierarchical naming function.

EIO0000001114.15

alias of each application folder, page 126

Hierarchical Naming Function

You can use the hierarchical naming function to let the software manage the

identifier, page 130

of an instance. The function is enabled by default.

When you select the hierarchical naming function, the software creates the identifier of an instance automatically through the concatenation of:

• The

in the path of the instance, starting from the system root folder.

• The

$Name , page 141

parameter of the instance.

For example, if the $Name of an instance is Motor_1 and the path to its location is:

System Root Folder\Folder_1\Folder_2 .

Plus, you have assigned the aliases F1 and F2 respectively to each folder.

Then, the identifier of the instance becomes F1F2Motor_1 .

NOTE:

• The length of the instance identifier cannot exceed the

maximum length, page 65 ; otherwise the software displays the status of the instance as

Invalid , page 138

• The software excludes folders without alias from the hierarchical naming

(for example, if you assign no alias to Folder_1 , the identifier of the instance becomes F2Motor_1 ).

• You cannot assign an alias to the system root folder.

To use the hierarchical naming function, proceed as follows.

Step

Action

Right-click the instance and select Properties .

Result: The Instance Editor opens.

Verify that Hierarchical Name is selected, enabling the hierarchical naming function; otherwise select it.

Close the Instance Editor .

Right-click the application folder that is to be considered for the hierarchical naming and select Properties .

Result: The Properties tab of the folder opens.

Assign an alias to the folder in the Alias field.

NOTE: Keep the alias as short as possible to avoid reaching the instance identifier character limit.

Repeat steps 4 and 5 for the other folders that you want to include in the hierarchical naming.

If required, modify the $Name of the instance in the Instance Editor to avoid reaching the instance identifier character limit.

NOTE: The software applies the hierarchical naming when you

move, copy, page 155

, or

import, page 191

instances in the Application Explorer .

Instance Parameters

You can configure the following instance parameters in the parameter pane of the

Instance Editor .

EIO0000001114.15

141

Selection in the instance pane

Instance

Parameter

$Name

Instance

Control node –

Supervision node

–

HyperLink node

NOTE:

Requires using templates of a library that supports this functionality.

–

$Description

$Area

Data type

String

Integer (1)

–

instance identifier, page 130

Description

Default value: Template identifier _ n where n is an incremental number starting at 1. For Schneider Electric templates, the $ suffix and the _xy prefix are omitted.

Within the application of one system, the resulting

must be unique for each instance using the same template; otherwise, the

$Name field is outlined in red. Clicking outside of the field reverts the name to its previous value.

Entering a character that is

not allowed, page 65

changes the instance Status to

Invalid , page 130

NOTE: If you enter the same value for two instances that use a different template and the resulting instance identifiers are identical, the $Name field is outlined in red if the identifiers of Control facets of the two instances are not unique anymore (for example, when both instances contain the Interlocks element, which is created by the same facet).

NOTE: The software changes the $Name parameter of the instance if the value is not unique anymore within the application following a

paste, page

157

import, page 191

operation.

Description of the instance.

Default value: Blank.

Area that the instance is assigned to.

Range: 1...255

Default value: Blank.

NOTE: If you have assigned an

area value to the folder, page 127

containing the instance, the software automatically assigns the same value to the instance unless you assign a value manually.

If the software is not able to propagate the value of the Area parameter to any item because the item is locked, it:

• Displays a notification to inform you which item is locked.

• Rolls back any propagated area value.

• Reverts the Area parameter value that you have entered in the folder properties to its previous value.

NOTE: The area value is also propagated to Supervision elements of instances such as genies. However, the change to blank (NULL) from a non-blank value is not propagated to

genies, page 360

that are already assigned to a Supervision page (for example, changing the area value from 3 to 4 is propagated but not changing it from 3 to blank).

You can configure the values of the parameters of the core and optional

Control services that the instance provides through the selected elements.

The default values are defined in the respective elements of the template that the instance uses.

For details on parameters of Schneider Electric application templates, refer to the

of the Schneider Electric libraries for EcoStruxure Process

Expert.

You can configure the values of the parameters of the optional Supervision services that the instance provides through the selected elements.

The default values are defined in the respective elements of the template that the instance uses.

For details on parameters of Schneider Electric application templates, refer to the

of the Schneider Electric libraries for EcoStruxure Process

Expert.

You can configure the parameters of the optional Documents service that let you link documents to the instance. You can open these documents on computers running the operation client when using runtime navigation services

(see EcoStruxure ™ Process Expert, Runtime Navigation Services , User Guide

You can link up to five documents.

You must add documents that you want to link to the content repository first.

For details, refer to the topic describing how to link documents to instances

(see EcoStruxure ™ Process Expert, Runtime Navigation Services , User Guide

142 EIO0000001114.15

manage links between instances, page 146

Selection in the instance pane

Parameter Data type Description

You can configure the parameters of the optional URL service that let you associate web links and files to the instance. You can open these links on computers running the operation client when using runtime navigation services

(see EcoStruxure ™ Process Expert, Runtime Navigation Services , User Guide

You can link up to five files or URLs.

For details, refer to the topic describing how to associate web links and files to instances (see EcoStruxure ™ Process Expert, Runtime Navigation Services ,

User Guide ).

(1) You can also enter a string instead of an integer value. In such case, you must refine the Supervision project after generating it and use the same string as label to name the area; otherwise, the Supervision project does not build successfully. Refer to the help of the

Supervision Participant for details.

Using the Asset Workspace Pane

This topic describes the Asset Workspace pane. It lets you manage asset workspaces and open them in the Asset Workspace Editor to

Asset Workspace Pane

The following figure shows an example of the Asset Workspace pane, which contains two user-created asset workspaces.

System_1 is the system root node.

EIO0000001114.15

Root Node Actions

The table describes the commands of the context menu of the system root node in an asset workspace.

Command

Create Workspace

Paste

Export

Import

Description

Creates a new empty asset workspace.

This is a structural element that lets you group assets, which are existing instances of the application in order to create links between them.

Lets you create a copy of the asset workspaces and their content that you have added to the Clipboard.

You can paste within the same system only.

Lets you

export, page 168

the data of existing asset workspaces and instances that belong to them to an editable application export file in comma-separated value (CSV) format.

Lets you

import, page 168

the data of workspaces and their instances, which are contained in an application export file (.csv).

143

Opens the asset workspace, page 146

Asset Workspace Actions

The table describes the commands of the context menu of asset workspaces.

Command

Edit Workspace

Show Instances

Copy

Export

Delete

Rename

Description

in the Asset Workspace Editor .

Lets you add and remove instances and edit links between them.

Opens the Show Instances window, which lets you see information about the instances that have been added to this asset workspace.

Double-clicking an instance opens the asset workspace and highlights the instance.

Copies the data of the asset workspace and instances that belong to it to the Clipboard.

Lets you

export, page 168

the data of this asset workspace and instances that belong to it to an editable file in comma-separated value (CSV) format.

Deletes the asset workspace but does not delete the instances from the application nor the links between them.

Lets you rename the asset workspace.

Instance Indicators

Overview

This topic describes the various indicators that appear on folders and instances of the application.

Instance Progress Indicators

Overview

Various icons give an indication of the steps that remain before the instantiation and

assignment, page 256

stages for each instance are completed.

The color of progress icons is used to indicate

instance validity, page 145

A progress icon is not visible while the

checked-out icon, page 254

is shown.

NOTE: The icons are visible to any user who opens the application.

Meaning of Icons

The following progress information is valid only for instances whose facets are not yet generated.

Icon Condition description

The instance is created or has been pasted without further action.

(0% progress)

Either one applies:

• The

instance properties, page 139

have been modified at least once but no assignments have been performed.

• The instance progress is 50% or 75% and existing

assignments, page 256

have been removed.

• The instance has been imported without impact on Participant projects.

Either one applies:

144 EIO0000001114.15

Icon

No icon

(100% progress)

Condition description

• Facets of the instance have been assigned but there is still one type of Participant project to which no facet has been assigned (for example, to a Supervision project).

• At least one facet that is assigned has a

status, page 282

other than Assigned .

• The instance has been imported and has changed the assignment status of at least one facet to Out Of Date or Deleted .

At least one facet of the instance has been assigned to a Control and Supervision

Participant project respectively and each one has the Assigned status.

All the facets of the instance have the Assigned status.

How Icons Appear

The following figure shows an example of the Application Browser displaying several instances with various completion states, which are indicated by progress icons.

Instance Validity Indicator

Overview

A dot or

progress icon, page 144

that appears in red color indicates that the configuration of an instance is invalid.

When the icon appears on at least one instance, it appears automatically on folders in the hierarchy of the instance.

NOTE: The indicator icon is visible to any user who opens the application.

Meaning of the Icon

Level Icon color

Instance Red

(progress icon or dot for objects with 100% progress)

Folder Red

(dot)

Condition description

The instance Data

status, page 130

and/or Link

status, page

150

is invalid.

The icon appears on at least one instance in the child structure.

EIO0000001114.15

145

create, modify, or delete links between instances, page 152

Instance Write-Lock Indicator

Overview

A lock icon lets you see that an instance or folder is being used or modified by another process or user and that you cannot work on it.

Certain objects that are locked can be opened in read-only mode.

NOTE: The indicator icon is visible to any user who opens the application.

Meaning of the Icon

The lock icon is shown, for example, when either operation is performed on an instance or folder:

• Properties are open (instances only)

• Paste

• Rename

• Export/import

• Update/replace template

Linking Instances by Using the Asset Workspace Editor

This topic describes how to add instances to asset workspaces and link them by using their exposed interfaces. It also describes how to manage interface links.

Asset Workspace Editor

Overview

The Asset Workspace Editor lets you link the exposed application interfaces of an instance to the interfaces of other instances that are compatible and respect the cardinality of the roles (for example, 1 to 1, or 1 to n ). The editor lets you

that belong to a same asset workspace.

You can use the editor, for example, to map a signal to an application object such as a limit switch signal to the appropriate input of a pump motor.

Some instances require that you link them to other instances based on the interface rules of their templates; otherwise the status of the

Link , page 130

of the instance remains Invalid and you cannot proceed further in the system engineering life cycle.

NOTE:

• Linking instances by using the Asset Workspace Editor helps avoid having to create such links later by refining the Control Participant project and provides a level of consistency in terms of Control resource names.

• Linking an instance to itself is not allowed. If this is required, edit the template used by the instance or refine the Control project to which facets of the instance are assigned.

Opening the Asset Workspace Editor

To open the Asset Workspace Editor , right-click an asset workspace and select

Edit Workspace .

146 EIO0000001114.15

move the editor background, page 81

Asset Workspace Editor

The following figure shows an example of the Asset Workspace Editor .

EIO0000001114.15

Item

Description

Instances that have been added to the asset workspace by dragging them from the

Application Browser or importing them.

Linked instances that do not belong to the asset workspace are not shown.

An instance can belong to an asset workspace even if it is not linked.

Existing application interface links and new ones.

Only links between instances that belong to the same asset workspace are shown.

Interface link that was converted to a connector by using the link context menu command.

RTNS interfaces, page (runtime navigation services). Appear in blue and are located in the header section of the instance.

RTNS interface links.

Indication of the link status of the instance that is selected and button to open the

Validity Diagnosis window if the status is Invalid .

Zoom tools, page 667 .

Radar View, page 672

Lets you print the visible portion of the asset workspace.

NOTE: You can also

147

148

Opens the instance, page 134

Instance Actions

The table describes the commands of the context menu of instances that appear in the Asset Workspace Editor .

Command Description

Show/Hide Disabled Lets you show or hide interfaces that are disabled (gray) and not available for connection.

Show/Hide Unbound Lets you show or hide interfaces that are not connected to another instance in the same asset workspace.

RTNS interfaces are always shown.

Remove Instance

View Assignments

Removes the instance from this asset workspace but does not delete it from the application.

In addition, if the instance is linked to another instance in the same asset workspace, you can perform either action:

• Delete the links that this instance has with any other instances in the same asset workspace. (Links to instances that are not in this asset workspace are maintained.)

• Remove the instance but maintain its links.

Opens the View Assignments

window, page 294

Properties

in the Instance Editor .

Link Actions

The table describes the commands of the context menu of links that appear in the

Asset Workspace Editor .

Command

Convert to Connector

Convert to Line

Go to

Description

Lets you toggle between .

Delete

Opens a submenu that indicates the following:

• The identifiers of the two instances that are linked.

• For each instance, the name of the element that exposes the linked interface and its path.

Deletes the link.

Impact of Modification of Instance Properties

When you save changes to an instance in the Instance Editor applicable changes are automatically reflected on the instance in the Asset Workspace

Editor . If a change disables an interface that was linked, the link is automatically removed.

This may set the Link

status, page 150

of either linked instances to Invalid .

Viewing Interfaces and Interface Description

Not all interfaces of instances that are displayed in the Asset Workspace Editor are visible by default. You may need to expand nodes of the interface to show enabled (green) or disabled (gray) interfaces.

To enable an interface, edit the instance and select the element that contains the interface, and/or configure the element parameter that enables it.

Move the pointer over any interface in the editor to display a description of the interface in a tooltip.

NOTE: Verify that disabled and unbound interfaces are shown by using the corresponding commands in the context menu of instances.

EIO0000001114.15

Using the Simplified View

Overview

Zooming out to the lowest level in the Asset Workspace Editor switches the display to the simplified view.

This view mode lets you see at a glance the instances and the relation between them without showing the details of links, interfaces, and elements of instances.

Some engineering functionality is not available.

To exit the simplified view, zoom in.

Restrictions of the Simplified View

The table describes the restrictions that are in effect while the simplified view is active.

Actions or object

Actions related to links such as creating and moving

Elements and interfaces

Multiple links to and from an instance

Restrictions

Actions are not allowed

Are not shown

Are shown as a single line

Description

The following figure shows an example of instances as they normally appear in the Asset Workspace Editor .

EIO0000001114.15

149

The following figure shows the same view when simplified view is active (the view is enlarged for better visibility).

• Instances maintain their relative size and position to preserve the aspect of the layout.

• Links between instances are grouped into a single line.

Instance Link Status

Overview

The Link status of an instance can be one of the following:

• Valid : The interface rules and interface element rules that are defined at the template level are satisfied.

• Invalid : At least one of the defined interface rules or interface element rules are not satisfied.

You cannot assign to projects instances that have a Link status that is Invalid .

When the status is displayed as Invalid , click the validity status information button or Invalid in the Application Browser to open the Validity Diagnosis window, which contains information about the cause of the invalid status.

150 EIO0000001114.15

rules of interface elements, page 152

Validity Diagnosis Window - Interface Rules

The following figure shows an example of the Interface Rules tab of the Validity

Diagnosis window.

EIO0000001114.15

Item

Description

Tab displaying information on interface rules of the instance with invalid Link status.

Tab displaying information on

of the instance with invalid Link status.

By default, this section displays only the elements of the instance for which at least one interface rule is not satisfied.

Path to the element whose interface rules are shown. You can view the element by

editing the instance, page 134

Shows for each element, the rules that are defined and their status.

Filter, page 93 .

Select the check box to view elements of the instance for which an interface rule is defined independently if the rule is satisfied or not.

Hover with the pointer over Legend to view an explanation of the statuses displayed in the rule columns.

The table describes the content of the Legend tab of the Validity Diagnosis window.

Item

Description

The link is required to satisfy the rule.

Remove the link; otherwise the Status remains Invalid .

The link is made, which satisfies the rule.

No link is made in accordance with the rule.

The link is optional and a link is made.

The link is optional and no link is made.

151

Validity Diagnosis Window - Interface Element Rules

The figure shows the Interface Element Rules tab, which is available if rules exist for elements of an interface. In this example, interface PVRange , which is one of the interfaces shown in the Interface Rules tab has three elements for which a rule is defined but not satisfied.

Linking Instances

Linking Instances That Are Open for Editing

While an instance is open in the Instance Editor , you can add it to and

remove it from, page 146

the Asset Workspace Editor but you cannot create, modify, nor delete links for it.

Naming Rules for Variable Names

The name of the variable that is created by linking two instances needs to satisfy the

for the subsequent generation process to complete successfully.

152 EIO0000001114.15

EIO0000001114.15

Creating Interface Links

To create an interface link between two or more instances by using the Asset

Workspace Editor , proceed as follows.

Step

Action

Right-click an asset workspace and select Edit Workspace .

Result : The asset workspace opens in the editor.

From the Application Browser pane, drag the instances that you want to link to the editor and position them as needed.

Result : The instances are shown in the editor with their interfaces exposed. If links already exist between these instances, they are shown as well.

From either instance, position the pointer over an interface and when the pointer turns into a hand, click and move the pointer away from it while holding down the left mouse button.

Result : A line appears and follows the pointer. You can release the mouse button.

NOTE: Press ESC to return to the normal pointer function.

Move the pointer over the other instance.

Result : Compatible andenabled interfaces of the instance are automatically highlighted and the line snaps to the nearest matching connector.

Click to confirm the connection or move the pointer to another highlighted interface until the line snaps to it.

Result: A click performs the following actions:

• Links the interfaces of both instances with a line.

• Changes the status of the active instance to Valid if the interface rules are satisfied (if applicable).

NOTE: To delete the link, right-click the line and select Delete .

Verify that the link status of the instances is Valid ; otherwise click Invalid in the Link column of the Application Browser or in the Asset Workspace Editor to open the

Validity Diagnosis window and check which links are required. Create these links for the instance status to become Valid .

Changing the Destination of a Link

A destination interface is represented by a male connector .

It is typically the interface with the REF role.

To change the destination of an interface link, proceed as follows.

Step

Action

Select the link whose destination you want to change.

Result : A black dot appears on the destination connector.

Drag the black dot to a new compatible destination connector of the same or another instance and release the mouse button.

Result : The link is moved to the new destination.

Enabled Interfaces That Cannot Be Connected

The interface of an instance may appear as enabled, unbound, and be compatible but the link does not snap to it. This can be the case if this interface is linked to another instance that is not in the same asset workspace and the interface accepts only one connection at a time.

To view the links that exist for an instance, open it in the Links Editor so that it is the active instance or open the Inspect Instance

window, page 155

153

assignment status, page 320

Using the RTNS Interface

Purpose of the RTNS Interface

When no application link is required between instances, you can use the RTNS interface to link them so that they appear in the Linked Production Assets section of the operation client (see EcoStruxure ™ Process Expert, Runtime

Navigation Services, User Guide ).

The cardinality of the interface is n to n and it can be connected only to another

RTNS interface.

Using the RTNS Interface

You can create a link between any instances that exist in the application by using this interface. The procedure to create an RTNS link is the same as the one to create a regular interface link.

NOTE:

• Creating an RTNS link between two instances that are already linked by an application link has no effect.

• Adding or removing an RTNS link between two instances does not change the

of facets of these instances.

RTNS Interface Identifiers and Roles

Representation Identifier

NullInterfaceRoleA

NullInterfaceRoleB

Role

Example

In the following example, three instances are linked but no link exists between

R1_EMPortM_1 and R1_Motor_1 . To be able to view also information of R1_

EMPortM_1 in the operation client when accessing runtime navigation services from Motor_1 , you can create an RTNS link with R1_EMPortM_1 (shown here as a dotted line for illustration purposes).

154

The following figure shows the result in the EcoStruxure Process Expert operation client after creating the RTNS link when you access runtime navigation services from R1_Motor_1 . Instance R1_EMPortM_1 also appears in the Linked

Production Assets section because of its RTNS link with R1_Motor_1 .

EIO0000001114.15

concurrent actions, page 52 . In such case, check the

Managing Application Folders and Instances

Overview

This section describes the Instance Inspector and the functionalities that are available in the software to manage many application folders and instances.

for details.

Viewing Instance Configuration

Overview

The Inspect Instance command lets you view the entire composition of any instance of the application along with current values of its parameters, elements, functions, and interfaces.

The functionality does not allow you to change values.

Opening the Inspect Instance Window

In the Application Browser , right-click an instance and select Inspect Instance .

EIO0000001114.15

155

resolved value of the parameter, page 135

Inspect Instance Window

The following figure shows an example of the Inspect Instance window for an instance of the application.

The table describes the various components of an instance that you can view in the left-hand pane of the Inspect Instance window.

Component

Instance identifier

Elements

Functions

Interfaces

Description

Identifier of the instance from which you have opened the Inspect

Instance window.

Elements of the instance grouped by Participant (for example,

Control)

Inside each category, you can view the hierarchy of elements as they are visible in the Instance Editor down to the constituent level.

Binding functions (see EcoStruxure ™ Process Expert, Global

Templates, Reference Manual) that are used by the parent element.

For example, it lets you view information related to the location of an instance in the application, which can be provided by the LocationGet function.

Interfaces that are referenced by the parent element.

For each interface, you can view its identifier, role used by the element, its template identifier, parameters, and their current value.

The table describes the parameter information that you can view in the right-hand pane of the Inspect Instance window. The data pertains to the component that is selected in the left-hand pane of the window.

Header

Name

Description

Type

Value

Description

Name of the parameters of the element grouped by category.

Description of the parameter.

Data type of the parameter.

Current

or property.

Changing the Application Hierarchy

Changes Impacting Assigned and Generated Supervision

Facets

When you change the hierarchy of the application, facets of instances that are assigned to a Supervision project and generated are affected when they

generate

156 EIO0000001114.15

equipment based on this hierarchy, page 329

. The table details these changes and their impact.

Change

Moving an application folder to a different parent folder.

Modifying the identifier of a folder.

Moving an instance to a different folder.

Impact

The assignment status of any facets of any instances that the folder and its subfolders contain is set to Out

Of Date .

The assignment status of any facets of the instance is set to Out Of Date .

For information on steps that you need to take to integrate the changes into the system, refer to

Generating Control or Supervision Projects After Changes, page

323 .

Copying and Pasting Application Folders and Instances

Description of the Functionality

You can copy and paste instances and application folders:

• Within the application of a system.

• Between applications of different systems.

The Notification Panel provides detailed information about the result of the paste process.

NOTE: Pasting instances affects the

instance count, page 133 .

The table describes the effects of the copy and paste functionality when applied to application folders and instances.

Item

Folders and instances

Folder identifier and instance name

Interface links

Other user-defined configuration data

Effect

The copied folder and any instances that it contains, including any subfolders and their contents are pasted.

NOTE:

• When you select the Copy command for a folder, this folder, any subfolders, and any instances they contain are copied. This is the case even if you initially selected, in addition to the folder, only one of the instances or subfolders it contains with the intention to copy only the selected items.

• If you delete an instance or a folder after copying it, you cannot paste it. Also, if you copy a folder containing several instances and you delete an instance in this folder, when you paste the folder, the instance that you deleted is not pasted.

If the folder identifier already exists at the same hierarchical level, or the instance identifier already exists in the target location, the software changes the folder identifier or the instance name by adding an incremental numerical value as suffix; otherwise the identifier or instance name is not changed.

For example, Motor_1 becomes Motor_1_1 , and Folder_1 becomes

Folder_1_1 ).

NOTE: If the

propagation of the area parameter value, page 127

is activated for an instance, the software changes the instance identifier according to the new location of the instance and the alias of the folders in its path.

Interface links are maintained between pasted instances like they were defined between the original instances if you copy and paste the instances that are linked at the same time.

Interface links can be copied across systems under the same conditions.

The software does not modify the data during the paste process. Therefore, relative expressions that the software has created at the instantiation stage could produce different results when applied to the new location.

Also, when you paste a folder and/or instance in a folder to which you have assigned an

area value, page 126

, this value is propagated to the pasted items if they do not have an area value yet and if they are not locked. For details refer to the topic describing the

EIO0000001114.15

157

Aborting Paste Tasks

After selecting the Paste command, the abort icon is displayed in the

structure of the application, page 116 . The software

. Click the icon to cancel the task. No instances and folders are pasted.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are pasting only a few items, the task may complete before you are able to click the icon.

Copying and Pasting Instances

To copy and paste instances, proceed as follows.

Step

Action

Expand the folder that contains the instances that you want to copy.

Select the instances.

You can make multiple selections within one folder by holding:

• The Shift key for contiguous instances.

• The Ctrl key if instances are non-contiguous.

Right-click a selected instance and select Copy .

Right-click the destination folder and select Paste .

You can select multiple folders as targets.

NOTE: If the target is not valid for pasting, the command is not available. Also, you cannot paste in the Application Browser in grid view mode.

Copying and Pasting Application Folders

To copy and paste application folders, proceed as follows.

Step

Action

Right-click the folder that you want to copy and select Copy .

You can make multiple selections within the Application Browser by holding the Ctrl key.

Right-click the destination folder and select Paste .

You can select multiple folders as targets.

NOTE: If the target is not valid for pasting, the command is not available. Also, you cannot paste in the Application Browser in grid view mode.

Moving Application Folders and Instances

Overview

You can move instances and application folders:

• Within the application of a system.

• Between the applications of different systems.

Both actions change the

displays a notification informing you of the possible impact on the assignment status of already assigned facets before executing the move operation.

Once the move operation is completed, if the software had to make changes to folder and/or instance identifiers to satisfy naming rules, it displays the Move

Summary

window, page 160

to inform you of the changes.

158 EIO0000001114.15

without modifying the hierarchy of the application, page 161 .

EIO0000001114.15

NOTE:

• You cannot move instances within a folder.

• You can change the position of folders

Moving Folders and Instances

By using the Application Browser pane, you can select a combination of folders and instances to move them at once. This is possible in tree view mode only.

When you move a folder, this folder, any subfolders, and any instances they contain are moved.

This is the case even if you initially selected, in addition to the folder, only one of the instances or subfolders it contains with the intention to move only the selected items.

NOTE:

• You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for non-contiguous items.

• If sorting and/or filters are applied, they are also applied to instances and folders that you have moved.

Effects of the Move Operation

The table describes the effects of the move operation when applied to application folders and instances.

Item

Folders and instances

Folder identifier and instance name

Interface links

Other userconfigured properties

Effect

Moves the folder and any instances that it contains, including any subfolders and their contents.

If the folder identifier already exists at the same hierarchical level, or the instance identifier already exists in the target application, the software changes the folder identifier or the instance name by adding an incremental numerical value as suffix; otherwise the identifier or instance name is not changed.

For example, Motor_1 becomes Motor_1_1 , and Folder_1 becomes Folder_1_

1 ).

NOTE: If the

area value, page 126 , this value is propagated to the moved items

is activated for an instance, the software changes the instance identifier according to the new location of the instance and the alias of the folders in its path.

Interface links are maintained between instances if you move the instances that are linked at the same time.

NOTE: Moving Interface links across systems is supported.

The software does not modify the data during the move process. Therefore, relative expressions that the software has created at the instantiation stage could produce different results when applied to the new location.

Also, when you move a folder and/or instance to a folder to which you have assigned an

if they do not have an area value yet and if they are not locked. For details refer to the topic describing the

propagation of the area parameter value, page 127 .

Moving Instances

To move instances, proceed as follows.

Step

Action

Expand the folder that contains the instances that you want to move.

Select the instances.

You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for non-contiguous instances.

Result : The selected instances are highlighted.

159

two workspaces, page 79 ; one for

Step

Action

NOTE: To move instances across systems, use

each application.

Drag one of the highlighted instances to the target application folder.

Result : The identifiers of the instances you are moving appear in a tooltip.

Release the mouse button.

Result : The software:

• Moves the selected instances to the new location. When no sorting is applied, instances are inserted in ascending alphabetical order among existing instances.

• Displays the Move Summary window if the software has performed a change to comply with applicable naming rules.

Close the Move Summary window.

Moving Application Folders

To move application folders, proceed as follows.

Step

Action

Select the folders that you want to move.

You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for non-contiguous folders.

Result : The selected folders are highlighted.

NOTE: To move folders across systems, use

two workspaces, page 79

; one for each application.

Drag one of the highlighted folders that you want to move to the target.

Result : The identifiers of the folders you are moving appear in a tooltip.

Release the mouse button.

Result : The software:

• Moves the folders and their contents to the new location. When no sorting is applied, folders are added at the end of existing folders.

• Displays the Move Summary window if the software has performed a change to comply with applicable naming rules.

Close the Move Summary window.

Move Summary Window

The following figure shows an example of the Move Summary window.

160

Path Indicates the path to the folder or instance location after the move.

Description Indicates the name change that the software has performed on the folder and/or instance during the move.

EIO0000001114.15

changing the hierarchy of the folder structure, page 158 .

Changing the Position of Folders Without Changing the

Hierarchy

You can change the position of folders inside the structure without modifying the hierarchy of the application. You can do this one folder at a time.

Step

Action

Verify that no sorting is applied in the Application Browser pane of the Application

Explorer and that tree view mode is selected.

In the Identifier column, start dragging a folder along the folder structure until one of the following messages appears in a tooltip:

• Move X before Y .

• Move X after Y

Where:

• X is the identifier of the folder that you are moving.

• Y is the identifier of the target folder.

Release the mouse button.

Result: The software relocates the folder to the selected position.

NOTE: If you release the mouse button while only the identifier of the folder that you are moving appears in the tooltip, you are

Updating and Replacing Templates of Instances

Overview

In the Application Browser , you can perform the following actions on the template that is used by an instance of the application. The working principle of both commands is the same. The difference resides in the choice of templates provided by each command:

Update Template

Replace Template

Lets you update the template that is used by the instance with the latest available version.

When you select the command from a folder, the command applies to any instance that is contained in the folder and any subfolders, and for which a template of a newer version is available.

Lets you replace the template that is used by one or more instances with another version of this template or a different template.

NOTE: The Update Template command is also available in the Topological

Explorer for certain

topological entities, page 407 .

Updating Versus Replacing Templates

The following examples are given to illustrate the difference between the two commands.

Update Template command:

• The following templates are available in the Global Templates library: $Motor

(2.0.0) , $Motor (2.0.1) , and $Motor (2.0.2)

• Instance Motor_1 uses template $Motor (2.0.0)

• The command lets you update the template that is used by Motor_1 with

$Motor (2.0.2) only (latest version).

Replace Template command:

• The following templates are available in the Global Templates library: $Motor

(2.0.0) , $Motor (2.0.1) , and $Valve (3.0.0)

• Instance Motor_1 uses template $Motor (2.0.1)

• The command lets you replace the template that is used by Motor_1 with either:

EIO0000001114.15

161

Importing Templates, page 680

◦ $Motor (2.0.0) : Same template, any available version.

◦ $Valve (3.0.0) : Different template.

Using the Commands on a Folder

When you select the Update Template or Replace Template command at the folder level, the command is performed on this folder, any subfolders, and any instances they contain.

This is the case even if you initially selected, in addition to the folder, only one of the instances or subfolders it contains with the intention to perform the command only the selected items.

Accessing the Commands

Update Template

Replace Template

Right-click one instance, a selection of several instances in the same or in various folders, the root folder, or any application folder, and select the command.

The command executes only if a newer version of the template that is used by the instance is available in the Global Templates library.

Right-click one instance or a selection of several instances in the same folder, and select the command.

Description of the Functionality

The software proceeds with the update or replacement of a template in the following order:

• The template that is associated to the instance is updated or replaced.

• Interface links are processed.

The following conditions need to be satisfied:

• The template or template version that you want to use must be available in the Global Templates library.

• It needs to have the usability state Approved (see EcoStruxure ™ Process

Expert, Global Templates, Reference Manual) or Deprecated .

NOTE: Refer to

The table describes the effects on the various template components when you update or replace the template that is used by an instance.

Identifier in new template (1) Effect Template component

Element The identifier of the element and its path in the composition of the template is the same as in current template.

The identifier of the element does not exist in the current template or the path to the element is different.

• The element is maintained or updated. If updated, the status of the corresponding facet is set to Out Of Date if the facet was generated.

Refinements that you have made are preserved if the element that creates the facet encapsulates the same constituents.

• The element selection that you have made in the current template is applied to the new template.

For example, in the current and the new template, the Interlocks element is at the path Control\Interlocks. If it was selected in the current template, it is selected in the new template.

• If the identifier of the template used by the corresponding facet ( Facet

Template column) is different, the status of the facet is set to Out Of

Date if the facet was generated.

NOTE: If you replace a control module template (highest level template) by one that has a different identifier but an identical composition, no changes are made to the instance, except for the template identifier.

The element is added and the corresponding facet is created.

An optional element that is not part of the current template keeps its default value (selected or cleared).

NOTE: Any element of the current template whose identifier does not exist in the new template or whose path is different is removed.

162 EIO0000001114.15

Template component

Parameter value

Interface link

Identifier in new template

Is not in current template

–

(1)

Is same as in current template

Effect

Explicitly defined parameters of the current template keep their respective value in the new template.

New parameters that are not part of the current template keep their default value.

The software re-establishes interface links that are valid after the template update or replacement in their original configuration.

The software discards interface links that are not valid after the template update or replacement because, for example:

• The cardinality of the interface role is not respected.

• A linked element does not exist anymore.

• An incompatibility of the type and/or role of the interface.

(1) The term new template refers to either a different version of the same template or a different template

This example illustrates the impact of a template update operation on generated

Control facets of an instance. In this scenario, instance Valve_1 uses template

$Valve version 1.3.9. The optional Maintenance service is selected at the instance level.

The following figure shows the composition of the template as it appears in the

Instance Editor . Elements appear in the Name column and the identifier of the template that is used by the corresponding facet in the Template column.

The following figure shows the Control facets ( Facet column) of instance Valve_1 , which are assigned to a section of a Control project. By relating this information to the one shown in the Instance Editor , you can see, for example, that element

LowLimitSwitch creates facet Valve_1_ZSL by using template $DISignal_UL .

This information is also visible at a glance in the View Assignments

window, page 294 .

EIO0000001114.15

163

$Valve 1.3.9 is updated to version 1.3.10 by using the Update Template command.

$Valve 1.3.10 has a modified Interlocks service, which is provided by the modified CONDSUM1_UL template. All other elements are identical.

164

The result of the template update operation shows that one facet has a modified assignment status. All facets remain generated.

1 The facet created by the CONDSUM1_UL template ( Interlocks service) has a status of Out Of Date because the already generated constituents (from $Valve

1.3.9) are not consistent with the constituents of the modified CONDSUM1_UL template anymore. Generating the section injects the constituents coming from the modified CONDSUM1_UL template into the logical Control Participant project.

2 The optional Maintenance service remains selected after the template update because it is also available in the latest version of $Valve .

This example illustrates the impact of a template replacement operation on generated Control facets of an instance. In this scenario, instance Motor_1 uses template $Motor .

$Motor has an Interlocks service provided by the CONDSUM1_

UL template. The optional Maintenance service is selected at the instance level.

EIO0000001114.15

$Motor is replaced with $Valve by using the Replace Template command.

Compared to $Motor , $Valve has a modified Interlocks service, which is provided by the modified CONDSUM1_UL template (located at the same path). The

Maintenance service is identical in both and provided by the same template at the same path. Their other elements are either different (for example, $CONDSUM_

UL) or located at a different path (for example, $DEVCTL_UL) in the composition of the control module template.

EIO0000001114.15

The result of the template replacement operation shows that several facets have a modified assignment status.

1 These two facets are deleted because in $Valve , $DEVCTL_UL is at a different path and $CONDSUM_UL does not exist. Generating the section removes the corresponding constituents from the logical Control Participant project.

2 The facet providing the Interlocks service is set to Out Of Date because Valve contains this service (provided also by $CONDSUM1_UL ) but a modified version of it. Already generated constituents (from $Motor ) are not consistent with the constituents of the modified CONDSUM1_UL template anymore. Generating the section injects the constituents coming from the modified CONDSUM1_UL template into the logical Control Participant project.

3 The optional Maintenance service is not affected because it is identical for both templates. The Instance Template column indicates that the facet is now created by the Valve template.

165

166

assigns them automatically, page 284 .

In the Assignment Editor , you can see the facets that are specific to Valve and that have been created for the Motor_1 instance. You need to assign these to the section as needed. These facets have the Candidate status. By default, the software

NOTE: The same that is described in the above examples for Control facets also applies to Supervision facets of the instance.

Updating or Replacing Templates of Linked Instances

When instances are linked by interface links ( Asset Workspace Editor ),

update the templates of these instances at once, page 167

to maintain the links.

Updating or Replacing Templates Containing a New Version of a Type

When you update or replace the template used by an instance and the Control facets that are referenced by the instance are already generated, if the new template that you have selected contains a version of the type that is different from the one that has been generated, the software requires that you select the version to be used when you generate the Control Participant project. In certain cases, generation may not be able to complete successfully. For details, refer to the topic describing the

selection of type versions during generation, page 305

NOTE: To view the version of a type that is used by a facet, edit the facet encapsulating the type by using the Global Templates explorer, select the element that represents the type, and click Templatizer . The version of the type is indicated in the Global Types section of the Select Variables window

(for example, DEVCTL 0.01.

Validating Instance Identifiers

When you perform a template replacement operation, the software verifies if the result of the operation satisfies the uniqueness requirement for instance identifiers. If it does not, it displays the Replace Template Summary dialog box, which indicates which instance creates a duplicate identifier, and cancels the replace operation.

This can be the case if:

1. Two instances use a different template but have the same identifier.

2. You replace one of the two templates with the same template that the other instance uses.

For example:

• The application contains two instances:

◦ Valve_1 , which uses template $HandValve

◦ Valve_1 , which uses template $Valve

• If you replace template $HandValve by template $Valve (any version), the two instances use the same template and have the same identifier. This is not allowed.

EIO0000001114.15

EIO0000001114.15

NOTE: When replacing a template creates an element with the same identifier as the element of an existing instance, you can still proceed with the template replacement but the Data status of the instance is set to Invalid .

For example:

• The application contains two instances:

◦ Pump_1 , which uses template $Motor

◦ Pump_1 , which uses template $HandValve

• If you replace template $HandValve by template $Valve (any version), although the two instances do not use the same template, they have the element Logic in common, which has the same identifier ( Pump_1_

DEVCTL ) in both instances because both instances have the same identifier. This is not allowed.

Updating the Template of One Instance

To update the template that is used by one instance, proceed as follows.

Step

Action

Right-click the instance that you want to update and select Update Template .

Result: The Update Template dialog box opens. It shows the latest version of the template that is available for the update.

Click OK .

Result: The software:

• Updates the template that is used by the selected instance with the latest version of the same template.

• Displays the version of the template that is used by the instance after the update in the Version column.

• Displays the result of the update process in the Notification Panel .

NOTE: Click Cancel to close the dialog box without updating the template.

NOTE: To revert to an earlier version of a template, use the Replace

Template command.

Updating the Templates of Several Instances

To update the templates of several instances of the application at once, proceed as follows.

Step

Action

Right-click the root folder of the application and select Update Template .

Result: The Update Template dialog box opens, which:

• Lists the templates, which are used by instances of the application for which a template of a later version is available. It indicates the current version of the template and the latest version that is available for the update.

• Indicates, for each template, the instances that are using the template with an indication of the location of the instances ( Path) .

Select the instances that you want to update:

• Instance by instance.

• By template.

• Through a combination of both.

Click OK .

Result: The software:

• Proceeds with the update of the template that is used by the selected instances.

• Displays the version of the template that is used by each instance after the update in the Version column.

• Displays the result of the update process in the Notification Panel .

NOTE: Click Cancel to close the dialog without updating the templates.

167

asset workspaces (CSV only), page 171

NOTE: If you use a filter in the Name column of the Update Template dialog box and as a result, not all the instances that you had selected are displayed, the update operation is still performed on the entire selection of instances.

Replacing Templates of Instances

To replace the template that is used by one or more instances, proceed as follows.

Step

Action

Select one or more instances and/or one or more folders.

Result: The software highlights the selected items.

Right-click a highlighted item and select Replace Template .

Result: The Replace Template dialog box opens.

Click the Select Template list.

Result: The software displays the list of templates that are available for the replace operation.

Select the template that you want to use by scrolling or entering a keyword in the field of the menu.

To search by entering the first letter of the template identifier, enter also the $ prefix for

Schneider Electric templates (for example, $m ).

Click OK .

Result: If the result of the replacement operation does not satisfy the identifier uniqueness requirement, the software displays the Replace Template Summary dialog box and cancels the replace operation.

If no conflict is detected, the software:

• Closes the dialog box and replaces the template that is used by the instances with the template that you have selected.

• Displays the identifier and the version of the template used by the instances respectively in the Template and Version columns.

• Displays the result of the replace process in the Notification Panel .

NOTE: Click Cancel to close the dialog without replacing the template.

NOTE: If you use a filter in the Instance column of the Replace Template dialog box and as a result, not all the instances that you had selected are displayed, the replace operation is still performed on the entire selection of instances.

Exporting and Importing Application Objects to CSV and XML

Formats

Overview

The export and import functionality lets you create comma-separated value (CSV) or XML files and import them into the application of the same or another system.

This allows you to do the following:

• Move or copy the entire application or a selection of folders,

, and instances to another system.

• Perform bulk processes such as creating, modifying and/or deleting instances, folders, asset workspaces (CSV only), and interface links by editing the exported file.

This topic describes how to export objects, edit the export file to perform the required changes, and import it.

168 EIO0000001114.15

concurrent actions, page 52 . In such case, check the

comma-separated, page 175

for details.

Exporting Folders and Instances to CSV and XML Formats

Overview

You can export application folders, instances, and interface links by using the

Export command of the Application Explorer .

The application objects and their respective configuration parameters are saved to an export file in

value (CSV) or XML format.

For example, you can use the export file to

import, page 191

the application into another system while modifying some parameters, which helps avoid having to create it from scratch. Also, you can use it to restore instances after deleting them or to restore them to an earlier state.

NOTE: You also need to

export templates, page 677

that are used by the instances that you are exporting if the same version of template is not present in the Global Templates library of the target system at the time of import.

Instances whose template is not present cannot be imported.

Good Practices

• If you intend to edit the export file, try to limit your export selection to the objects that you want to modify or delete, for example, by using

filters, page

in the Application Browser . It reduces the steps to manage unwanted objects during import and speeds up the process.

• If you want to create instances, export, at least, one instance that uses the same template. If you want to create interface links, export, at least, two instances that are linked. This lets you use the data as model. For example, you can copy and paste it and modify only necessary location, element, and/ or parameter values.

Export Format Selection

The

CSV, page 171

and

XML, page 184

export files contain similar information and let you perform the same actions.

Data in CSV format can appear more comprehensible and easier to manage by using a spreadsheet editor because of its user-friendly, tabular presentation. Also, it facilitates the integration of existing data, such as an asset list, depending on their format.

Exporting to XML may be preferred by users who are familiar with the use of structured data and more powerful XML editors.

NOTE: You cannot update existing interface links by using the XML format.

Invariant Culture

The software uses the

invariant culture, page 176

to format parameter values independently of the language setting that is used on the computer on which you create the export file.

For example, a decimal value that appears as 5,5 (comma separator) in the

Instance Editor because of your regional settings appears as 5.5 (dot separator) in the export file.

EIO0000001114.15

169

170

Some restrictions apply, page 192

Software Version Compatibility

You can import into a system instances that were exported from an earlier version of the software.

Object Selection

You can select the following objects to export them:

• One or several instances: Exports the data pertaining to the selected instances and their location in the folder structure of the application. You can select individual instances located in various folders and export them at once.

• One or several application folders: Exports the data pertaining to the selected folders, the instances contained in the folders, and in any subfolders.

• The root folder of the application: Exports any application folders and instances of the system.

An interface link is exported only if both linked instances are exported.

NOTE: When you select the Export command for a folder, this folder, any subfolders, and any instances they contain are exported. This is the case even if you initially selected, in addition to the folder, only one of the instances or subfolders it contains with the intention to export only the selected objects.

Aborting Export Tasks

After confirming the export by clicking Save in the Save As dialog box, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the

task. The export file is not created.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are exporting only a few objects, the task may complete before you are able to click the icon.

Creating the Export File in CSV or XML Format

To export application objects, proceed as follows.

Step

Action

In the Application Browser , select the objects that you want to export.

Use

filters and sorting, page 93

to facilitate the selection.

Right-click your selection and select Export .

Result: The Export dialog box opens.

Select the location, file name, and format for the export file.

Click Save .

Result:

• The export file containing the selected objects is created.

• A summary of the exported objects is displayed in the notification pane.

NOTE: If any object that you have selected for export is open in an editor (for example, the Instance Editor ), accessed for an assignment, update, or replace operation, or if its Properties tab is open, you cannot create the export file.

EIO0000001114.15

comma-separated value (CSV), page 175

Exporting Asset Workspaces to CSV Format

Overview

You can export asset workspaces and the instances that belong to them by using the Export command.

The application objects and their respective configuration parameters are saved to an export file in

format.

NOTE: You also need to

export templates, page 677

that are used by the instances that you are exporting if the same version of template is not present in the Global Templates library of the target system at the time of import.

Instances whose template is not present cannot be imported.

Object Selection

You can select the following objects to export asset workspaces:

• The root node of the Asset Workspace pane: Exports the existing asset workspaces and the instances that belong to them.

• One or several asset workspaces: Exports the workspaces and the instances that belong to them.

• The root folder of the application: Exports any application folders, asset workspaces, and instances of the system.

Creating the Export File Containing Asset Workspace Data

For information on how to create the export file, refer to the topic describing the

export of folders and instances, page 169

CSV Application Export File

Export File Description

When you export application objects to

comma-separated, page 175

format

(CSV), two files are created.

File

Application export file

Application interface data supporting file

Default file name

<System identifier>

<System identifier>_Pending

Interfaces where _Pending Interfaces is appended to the file name once the file is created.

Content and purpose

Data of the folders, instances, interface links, and asset workspaces that you have exported.

The data is organized in five types of groups.

You need to

edit the content, page 451

of this file to create, modify, or delete application objects.

Data on application interfaces that the exported instances expose and that are not connected. It includes interfaces that are disabled.

The data is organized by instance name.

It helps you edit data of the

InterfaceLinks group in the application export file by providing the necessary data of each interface that you can connect.

The following table describes the grouping of data in the application export file.

Each group has a group header and a header row, which describes the data of objects.

EIO0000001114.15

171

172

instance data, page 176 .

Group header

Folders

TemplateIdentifier=<Template ID>

Version=<Value> where:

• <Template ID> is the identifier of the template that is used by the instance.

• <Value> is the template version.

Example :

TemplateIdentifier=$Motor Version=

3.1.0

InterfaceLinks

Description

Groups that contain

folder data, page 176

More than one group exists when you export folders that have a different number of parameters as part of the optional folder properties.

The number of columns depends on the folder configuration. A column with its header exists for each system parameter and each configured optional parameter.

NOTE: A group header and its header row appear only if the export file contains folder data.

Groups that contain

There are as many groups as templates and versions used by exported instances.

The number of columns depends on the instance configuration. A column with its header exists for each element and parameter of the instance.

NOTE: A group header and its header row appear only if the export file contains instance data.

Workspaces

Group that contains the

data of interface links, page 176 ,

which link exported instances.

The number of columns and their headers are fixed.

NOTE: The group and its header row are always present.

Group that contains the

data of the exported asset workspaces, page 176

NOTE: The group and its header row are always present.

WorkspaceIdentifier=<Asset workspace identifier>

Example :

WorkspaceIdentifier=AssetWorkspace_

Group that contains the data of instances that belong to an asset workspace.

There are as many groups as exported asset workspaces.

NOTE: The group and its header row are present even if the exported asset workspace contains no instance.

Example of CSV Export Files

The following example shows two instances, which have been linked by an interface link.

EIO0000001114.15

The following figure shows a partial view of the resulting export file when you export folder Cell to CSV format.

Item

Description

Export file information that is added by the software.

Group headers.

Header rows.

Element of the instance and its selection state.

Parameter of the instance and its configured value.

Parameters appear right after their parent element.

Parameter of the instance for which no value is configured.

Data rows of exported objects (one row per object, such as a folder, an instance, or an interface link).

The following example shows two asset workspaces that exist in System_2 .

AssetWorkspace_1 contains two linked instances and AssetWorkspace_2 contains none.

EIO0000001114.15

173

The following figure shows the workspace related portion of the resulting export file when you export System_2 to CSV format either from the root node of the

Application Browser or the Asset Workspace .

Item

Description

Group headers.

Header rows.

Rows containing data of the exported asset workspaces.

Rows containing data of the instances that belong to each exported asset workspace.

NOTE: The data of their interface links and configuration parameters appears in their respective groups in the same export file.

The following figure shows a partial view of a supporting file that is created in addition to the actual export file.

Editing the CSV Application Export File

Overview

By editing the application export file (.csv), you can create, update, and/or delete application objects.

Various rules and requirements apply when you open and edit CSV export files.

They are described in this topic.

You can use the supporting file ( *_PendingInterfaces.csv

) to help with the editing of interface link data.

174 EIO0000001114.15

import the edited CSV file, page 191

The software applies the changes when you

into the application of the system. At that time, you have the possibility to review and modify the list of imported objects (except interface links).

Good Practices

• Before editing an application export file, create a copy of it. If needed, it lets you restore the original application.

• Edit only an up-to-date export file to help avoid data conflicts when importing.

• Carefully remove from the file objects that are not impacted by the import, for example, instances that you are not updating or deleting.

• When you use data from the supporting file to create or update interface links, cut the data rather than copying it to help avoid connecting the same interface several times.

The other way around, add to the supporting file data of interfaces that you are disconnecting.

Step

Opening the CSV File by Using a Spreadsheet Editor

When you open a CSV export file by using a spreadsheet editor, some instance parameter values (for example, durations with millisecond values, certain special characters, or strings starting with - (hyphen)) may get modified by the editor.

So that these values remain unchanged, you first need to import the data into a blank workbook in Unicode (UTF-8) format.

Follow this procedure. Microsoft ® Excel ® is used as an example. Menu items and dialog box names may vary depending on the version.

Action

Open a blank workbook.

In the Data menu, select to import from text or CSV.

In the Import Text File dialog box, select the exported CSV file.

Select the following attribute values for the import of data:

• File origin: 65001 : Unicode (UTF-8)

• List separator (delimiter): Comma

• Format for all columns (data type): Text (1)

• Use First Row as Header (1) (depending on version): Open the menu and select this setting even if it is already selected by default.

Load the values to the blank workbook.

NOTE: After loading is completed, the first row of the CSV file must start with ;Export Version=<Software Version> . You may see additional text in columns E and higher of the first row (for example, Column1 , _1 ). This text is treated as

comment, page 182

and ignored during import.

The following example shows an extract of a CSV export file after selecting Use First Row as Header and loading values to the blank workbook.

6 Save the workbook in CSV UTF-8 (comma delimited) format (keep saving in this format when you edit the file).

(1) You may need to edit the file during the import process to access the attribute.

Setting the List Separator Format

CSV export files use the comma as list separator (delimiter) independently of the setting that is in effect on the computer on which the file is created.

EIO0000001114.15

175

Type

Decimal separator

Time

Date

Date Time

Duration

editing rules, page 182 .

If the format of the list separator on the computer is different from comma, data will not be displayed correctly when you open the export file by using a spreadsheet editor.

To verify the setting and change it to comma if necessary, open the Windows ®

Control Panel and click Clock and Region > Region . In the Formats tab, click

Additional settings...

NOTE: For information on how to use commas in values of string data types in the CSV file, refer to the topic describing

Using the Invariant Culture

Use the invariant culture to modify or add parameter values in the application export file.

If required, during import the software converts the format according to the language setting that is used on the target computer.

The table describes the formats of the invariant culture that are used in the export file.

Format x.y

hh:mm:ss mm/dd/yyyy mm/dd/yyyy hh:mm:ss

DD.hh:mm:ss.ms

Example

2.5

14:30:00

11/20/2014

11/20/2014 14:30:00

10.12:30:10.15 translating into 10 days

12 hours 30 min 10 sec 15 msec

Application Export File Content Requirements

This topic describes the columns that appear in the each type of group and the requirements for each one. Use this information when you edit existing data, add columns, and/or add entire groups. For details on the format of the group headers, refer to the topic describing the

export file, page 171

176 EIO0000001114.15

Header

$Action

$InstanceName

$Identifier(Non_Editable)

$IsHierarchical

EIO0000001114.15

Folders

inherited from a parent folder, page 127 , it does

. The information applies to each group that appears in the file or that you add.

Header

$Action

$Location

Description

Action that is performed on the folder during import.

Path to the folder in the application starting from the system root folder.

Example :

Root\Site\Area\Unit_A

NOTE: The name of the

system root folder, page

117

is replaced by Root .

Requirement

Possible values (not case-sensitive):

• Create (default)

• Update

• Delete

• Blank:

◦ Creates the folder if it does not exist yet.

◦ Updates the folder if it exists.

A column with this header and a valid value in each row are required.

The path must exist in the application or be created by the import.

For folders whose parent is the system root folder, enter Root .

$Identifier

$Alias

Folder identifier.

NOTE: You cannot update the identifier of a folder through import.

Folder

alias, page 126 .

A column with this header and a valid value in each row are required.

Column and value are optional.

If a row contains data, it must be valid.

$Description Folder description.

$Area Folder

area, page 126 .

NOTE: If the value is

not appear in the export file.

Parameter x .$Identifier Identifier of the folder

parameter, page 126 .

Parameter x

$Description

Parameter x

.$Value

Description of the folder parameter.

Value of the folder parameter.

Column and value are optional.

If a row contains data, it must be valid.

NOTE: The numbering of folder parameters (x) corresponds to the order (top to bottom) in which parameters appear in the properties of the folder when no sorting is applied.

TemplateIdentifier

Instance identifier, page 130

for instances. The information applies to each group that appears in the file or that you add.

Description

Action that is performed on the instance during import.

Instance

name, page 141

The value is used to identify the instance or calculated by the software in case of instance creation.

Hierarchical naming function, page 141

Requirement

Possible values (not case-sensitive):

• Create (1) (default)

• Update

• Delete

• Blank:

◦ Creates the instance if it does not exist yet.

◦ Updates the instance if it exists.

A column with this header and a valid value in each row are required.

A column with this header is required and:

• To create an instance, the value can be left blank.

• To update or delete an instance, the value must be valid.

Column and value are optional.

Possible values:

177

Header

$Location

$Description

$Area

<Element path>.Enabled

Parameter.<parameter full path>

Description

Path to the instance in the application.

Example :

Root\Site\Area\Unit_A

NOTE: The name of the

inherited from a parent folder, page 127 , it does not

is replaced by Root .

Instance description.

Instance

area, page 141

NOTE: If the value is

appear in the export file.

A column exists for each service ( page 172

the

The instance identifier is excluded from the

Example :

Control. Running.Enabled

element,

) of the instance as they appear in

Instance Editor element path.

For the Running service that belongs to the

Control element, the column header is:

A column exists for each

parameter, page 172

that is featured by the instance, including parameters of

disabled services (elements), page 182

and not configured parameters.

Example :

For the DISignalName parameter of the

Running service, the column header is:

Parameter.Control. Running.DISignalName

Requirement

• True

• False

• Blank (or not present):

◦ Equals true for an instance that is created.

◦ Keeps the configured value for an existing instance.

A column with this header and a valid value in each row are required.

The path must exist in the application or be created by the import.

Column and value are optional.

If a row contains data, it must be valid.

Column and value are optional.

Possible values (not case-sensitive):

• True: The service is enabled.

• False: The service is disabled.

• Blank:

◦ Equals false for an instance that is created.

◦ Keeps the configured value for an existing instance.

Mandatory elements (whose check box cannot be cleared in the Instance Editor ) are identified with (Non_

Editable) in the header. If you set the value to false, it is not considered during import and the element remains enabled.

Column and value are optional.

If a row contains data, it must be valid.

When you edit a parameter, verify that the

element, page 172

to which it belongs is set to true; otherwise, the parameter value is not applied during import. This rule does not apply to parameter values of mandatory elements, which are applied even if the element is set to false in the CSV file.

NOTE: To view the hierarchy of elements and parameters of an instance, use the Instance Editor or the View Instance

window, page 155

NOTE: For parameters of the

enumerated data type, page 186 , the name is exported as value. For

example, if the parameter

value, page 135

that is configured in the Instance Editor is Operator (2) , the exported value is Operator . To edit the value, you can enter either the name of the enumerator or the associated integer (for example, 3 for an enumerator that is Supervisor (3) ).

(1) Instances with action set to create and that you do not want to import can be unselected during

import, page 195 .

InterfaceLinks

group, page 171 .

178 EIO0000001114.15

Parameter

$Action

Description

Action that is performed on the interface link during import.

$SourceLocation Path to the instance that is the source of the link in the

Application Explorer .

The name of the

is replaced by Root .

Example :

For instance Motor_1 of System_1 that is located in Folder_2 , which is a subfolder of Folder_1 , the value is Root\Folder_1\Folder_2 .

$SourceInstanceName Value of the

of the instance that is the source of the link.

$SourceInstance

TemplateIdentifier

$SourceInterfacePath

Identifier of the template that is used by the instance, which is the source of the link.

Path to the source interface in the composition of the instance.

Example :

In the following sample instance, the value for interface ZSHPOS is

Control\Motor\Logic .

Requirement

Possible values (not casesensitive):

• Create (default)

• Update (1)

• Delete

• Blank:

◦ Creates the link if it does not exist yet.

◦ Updates (1) the link destination if the link exists.

A column with this header and a valid value in each row are required.

NOTE: For RTNS interfaces, the column is optional and does not contain values.

EIO0000001114.15

$SourceInterfaceIdentifier

$DestinationLocation

Identifier of the interface that is the source of the link.

Path to the instance that is the destination of the link in the

Application Explorer .

The name of the

is replaced by Root .

A column with this header and a valid value in each row are required.

NOTE: Refer to the description of RTNS interfaces for information on their specific

identifiers, page

154 .

A column with this header and a valid value in each row are required.

$DestinationInstance

Name

Value of the

of the instance that is the destination of the link.

179

180

change the destination, page 183

Parameter

$DestinationInstance

TemplateIdentifier

$DestinationInterface

Path

Description

Identifier of the template that is used by the instance, which is the destination of the link.

Path to the destination interface in the composition of the instance.

Example :

In the following sample instance, the value for interface BoolVar is empty (blank) because it has no parent element.

Requirement

A column with this header and a valid value in each row are required.

NOTE: For RTNS interfaces, the column is optional and does not contain values.

$DestinationInterface

Identifier

$NewDestinationLocation

$NewDestinationInstance Name

$NewDestinationInstance

TemplateIdentifier

$NewDestinationInterface Path

$NewDestinationInterface Identifier

Identifier of the interface that is the destination of the link.

The description is the same as for the $Destination* parameters but the data applies to the new destination interface of the same or another instance.

The parameters are empty by default.

A column with this header and a valid value in each row are required.

NOTE: Refer to the description of RTNS interfaces for information on their specific

identifiers, page

154

Columns with these headers are required. Rows can be left blank.

The columns must contain a valid value only when you

of an existing link.

(1) You can only

change the destination, page 183

of an existing link by using the Update command.

Workspaces

Header

$Action

$Location

$Identifier

Description Requirement

Action that is performed on the asset workspace during import.

Path to the asset workspace in the Asset Workspace

Root by default.

pane.

Possible values (not case-sensitive):

• Create (default): Creates the asset workspace or updates an existing one based on the information in the

WorkspaceIdentifier=<Asset workspace name> group.

• Delete: Deletes the workspace only. Does not delete from the application the instances that belong to it nor their interface links.

• Blank: Same as Create .

A column with this header and Root as value in each row are required.

Asset workspaces can only be located at the system root node level.

Asset workspace identifier.

NOTE: You cannot update the identifier of an asset workspace through import.

A column with this header and a valid value in each row are required.

EIO0000001114.15

group, page 171 . The information applies to each group that

WorkspaceIdentifier

appears in the file or that you add.

Header

$Action

$InstanceLocation

$InstanceName

$InstanceIdentifier

$TemplateIdentifier

$Position

Description

Action that is performed on the instance in the context of the asset workspace during import.

Path to the instance in the application.

Requirement

Not editable.

To remove an instance from an asset workspace, delete the row.

To add an instance, add a row and enter the required information in each column.

A column with this header and the same value as in the $Location column of the TemplateIdentifier group for this instance are required.

Name of the instance.

Identifier of the instance.

Identifier of the template that is used by the instance.

Position in pixels of the top left corner of the instance representation in the asset workspace .

A column with this header and the same value as in the $InstanceName column of the TemplateIdentifier group for this instance are required.

A column with this header and the same value as in the $Identifier column of the TemplateIdentifier group for this instance are required.

A column with this header and the same template name as in the

TemplateIdentifier group header for this instance are required.

For example, $AnalogInputGP if the header for this instance is :

TemplateIdentifier=$AnalogInputGP

Version=1.0.131

Two comma-sperated values indicating the position on the X and Y axis respectively.

For example, 0,0 positions the instance along the left and top borders of the asset workspace.

EIO0000001114.15

181

182

actions on links, page 183

Editing Rules

The table indicates the rules that apply when you edit a CSV application export file.

Item

Header of a group

First header of a header row

Headers of noneditable data

Rows of object data

Empty rows

Comment rows

Order of columns

Empty columns

Interface links

List separator

Values

Rule

Must start with a colon.

You can remove a group header and its header row if the group contains no data.

You can change the order of groups.

Headers of data that does not need to be edited or that is ignored during import are identified by the software with the Non_Editable suffix.

Refer to the

requirements, page 176 .

You can delete the row of an object if you do not want to import it or modify it through import.

Can be added anywhere.

Can be added anywhere and must start with a semi-colon.

Comments are ignored during import.

Can be changed within a group given the first header of the row starts with a colon.

Can be added after the first column.

For any

, the data of the linked instances must be included in the application export file even if the instances already exist in the target application.

Only

comma, page 175

is accepted.

Use the

invariant culture, page 176 .

To use commas or quotation marks in values of string data types when you edit the file by using a text editor, for example, Notepad, follow these rules:

Expected value after import

Motor, Pump

Motor”Pump

Value to be entered

“Motor, Pump”

“Motor””Pump”

Creating, Updating, and Deleting Folders

To create an instance in a new folder, you must also enter in the CSV file the necessary data to create the folder.

Since each row corresponds to only one folder, to create, for example, the structure Root\Folder_1\Folder_10 , you must configure two rows.

NOTE: It is not possible to rename a folder by using the Update action.

Perform the following steps in the Folders groups of the CSV application export file.

Step

Action

Edit the rows that contain data of folders and/or create rows. Verify that at least the

required columns and data, page 176

are present.

Specify a value for $Action for each row as needed.

EIO0000001114.15

required columns and data, page 176

EIO0000001114.15

Creating, Updating, and Deleting Instances

Perform the following steps in the TemplateIdentifier groups of the CSV application export file.

Step

Action

Edit the rows that contain data of instances and/or create new groups and/or rows.

Verify that at least the

are present.

Verify that the data for $Location is consistent with the target application and/or

$Location in the Folders group.

Specify a value for $Action for each row as needed.

NOTE: If you update data of instances that are already linked and want the link to be maintained, it is not required to update the row of the InterfaceLinks group that pertains to the link as long as the linked interfaces remain enabled.

This applies even if you change the value of $InstanceName or the instance identifier (for example, by configuring an alias for a folder) for either or both instances.

Creating and Deleting Interface Links

Perform the following steps in the CSV application export file.

Step

Action

In the InterfaceLinks group, edit the rows that contain data of the links and/or create new rows. Verify that at least the

required columns and data, page 176

are present.

Verify that the data for $SourceLocation and $DestinationLocation is consistent with the target application and/or $Location in the other groups (if applicable).

Specify a value for $Action for each row as needed.

In the TemplateIdentifier group, verify that the data of the linked instances is entered.

If the linked instances already exist in the target application with the same configuration and you do not want to modify them, change the value of $Action to Update or leave it blank for each instance.

NOTE: If the instances already exist in the target application and you leave the value as Create , the Resolve Uniqueness Conflicts

dialog box, page 197

opens during import and you need to select the Update action for the instances there.

Changing the Destination of An Existing Interface Link

To move the destination of an existing link to a different interface, edit the CSV application export file as follows. The new destination interface must be available for connection during import.

Step

Action

In the InterfaceLinks group, for the row that contains the data of the existing link, change the value of $Action to Update or leave it blank.

Enter the appropriate data in each of the five columns $NewDestinationLocation to

$NewDestinationInterfaceIdentifier .

NOTE: You do not need to edit the data of the existing interface link. If the interface link does not exist in the target application, a link from the specified source to the new destination is created anyway.

In the TemplateIdentifier group, verify that the data of the linked instances is included.

If the instances already exist in the target application with the same configuration and you do not want to modify them, change the value of $Action to Update or leave it blank for each instance.

NOTE: If the instances already exist in the target application and you leave the value as Create , the Resolve Uniqueness Conflicts

dialog box, page 197

opens during import and you need to set the action to Update there.

183

XML Application Export File

Export File Description

The following example shows the structure of an XML application export file

(partial view) that was created by exporting Folder_1 , which contains instance

DISignal_UL_1 .

184

1 Data pertaining to the folder.

2 Data pertaining to the instance.

3 Data of the parameters and elements of the instance.

4 Data of the application

interfaces, page 185

that the instance exposes.

5 Folder identifier.

6 Folder Action parameter

7 $InstanceID parameter of the instance, which is generated by the software. This is the identifier that the software uses to identify the instance for delete and update actions. Do not edit this parameter.

8 $Name parameter of the instance.

9 Instance Action parameter.

EIO0000001114.15

create and delete interface links, page 189

When instances that are linked are exported, the information of the interface links is grouped in the InterfaceLinks element, which appears at the end of the file. The following example shows an extract of an export file, which contains two instances linked by two interface links.

(1) Action parameter plus source and destination information pertaining to the first interface link.

(2) Same information pertaining to the second interface link.

Editing the XML Application Export File to Manage Folders and Instances

Overview

You can edit the XML export file by using any XML editing software to perform one or more of the following actions on application folders and/or instances:

• Create an object by using the parameter values of the export file.

• Update an object that has the same identifier by using the parameter values in the export file.

• Delete an object that has the same identifier as in the export file.

You can also

The software applies the changes when you

import the edited XML file, page 191

into the application of the system. At that time, you have the possibility to review and modify the list of imported objects (except interface links).

NOTE: You cannot update the identifier of a folder through import.

Good Practices

• Before editing an application export file, create a copy of it. If needed, it lets you restore the original application.

• Edit only an up-to-date export file to help avoid data conflicts when importing.

Application Export File Content

The table shows the objects and their respective parameters that are exported to the XML file and that are configurable.

Object

Application folder

Instance

Parameters

For the folder and any subfolders

Action

Identifier

Alias

Description

Area (1)

Location

Parameters

For the instances in the folder and its subfolders

EIO0000001114.15

185

186

enumerated data type, page 186 , the name is

Object

Interface link

Parameters

Action

TemplateIdentifier

Version

IsHierarchical

Location

$Name

$Description

$Area (1)

Elements that are enabled (selected in the Instance Editor )

Parameters of each element

For parameters of the

exported as value. For example, if the parameter

value, page 135

that is configured in the Instance Editor is Operator (2) , the exported value is

Operator . To edit the value, you can enter either the name of the enumerator or the associated integer (for example, 3 for an enumerator that is

Supervisor (3) ).

Identifier of exposed interfaces and their path in the composition of the instance. Includes data of disabled and connected interfaces.

When an alias is configured for an interface, both the alias and the identifier are indicated. The alias is the name that appears in the Asset Workspace

Editor or Links Editor .

Parameters of interface links that exist between exported source and destination instances.

Refer to the topic describing how to

edit the XML file to manage interface links, page 189

(1) If the value is

inherited from a parent folder, page 127 , it does not appear in the export file.

Action Parameter

Configuring the Action parameter is optional.

Possible values (not case-sensitive):

• Create (default)

• Update (except for

interface links, page 189

)

• Delete

• Blank:

◦ Creates the object if it does not exist yet.

◦ Updates the object if it exists (except interface links).

NOTE: Instances with action set to create and that you do not want to import can be removed from the list of imported objects during

import, page 195 .

Using the Invariant Culture

Use the

invariant culture, page 176

to modify or add parameter values in the application export file.

Editing Rules for XML Application Export Files

To maintain the consistency of the folder structure and instances contained in the export file, follow these rules.

EIO0000001114.15

Item

Instance

Parameters

Object hierarchy

Rule

Do not modify Identifier of the instance ( $InstanceID parameter) because it is generated by the software.

Modify only the parameters described in the procedures that appear in this topic.

Do not modify the structure of child elements.

For example, a folder must be the parent of an instance and not the opposite.

However, you can modify the order of Elements or Parameters inside an instance ( ApplicationInstance section).

When the export file contains data of a folder structure, do not change the

<Location> parameter of the highest level folder (the folder from which the export file was created). For subfolders, the hierarchy from the export file prevails.

When the export file contains data of a single instance or single folder, do not modify the <Location> parameter.

The following figure shows an extract of an export file of instance Motor_3 , which was exported from Folder_5 . The instance is located in Folder_1 , a subfolder of

Folder_5 . The Location parameters of these folders are highlighted.

EIO0000001114.15

Creating an Instance

To edit the XML export file to create a new instance in an existing folder, proceed as follows.

Step

Action

Change the value of the $Name parameter to the name of the new instance that you want to create.

NOTE: To create multiple instances during import:

• Copy the entire ApplicationInstance section of the export file that contains the data of the instance.

• Paste it at the end of the section that you have copied, as many times as you want to create instances.

• Change the value of $Name to the new name of each instance.

Verify that Action is set to Create ; otherwise replace the value by Create .

Save your changes.

Updating an Instance

To edit the XML export file format to update an existing instance, proceed as follows.

187

188

Step

Action

For the instance that you want to update, change the value of Action from Create to

Update .

Change the value of the

parameters, page 185

that you want to update.

Save your changes.

NOTE: If you update data of instances that are already linked and want the link to be maintained, it is not required to update the data of the

InterfaceLinks element that pertains to the link as long as the linked interfaces remain enabled. This applies even if you change the value of

$Name or the instance identifier (for example, by configuring an alias for a folder) for either or both instances.

Deleting an Instance And/Or a Folder

To edit the XML export file to delete an existing instance and/or folder, proceed as follows.

Step

Action

If you want to delete:

• The instance and the folder containing the instance, verify that the export file also includes the information pertaining to the folder.

• The instance only, proceed to step 3.

For the folder that you want to delete, change the value of Action from Create to Delete .

For the instance that you want to delete, change the value of Action from Create to

Delete .

Save your changes.

Creating Folders

To edit the XML export file to create one or more folders or a folder hierarchy, proceed as follows.

Step

Action

Verify that Action is set to Create for the folders that you want to import; otherwise replace the value by Create .

Save your changes.

Updating a Folder

To edit the XML export file to update an existing folder, proceed as follows.

EIO0000001114.15

import the edited XML file, page

Step

Action

For the folder that you want to update, change the value of Action from Create to

Update .

Change the value of any of the following folder parameters that you want to update:

• Alias

• Description

• Area

• Parameters

If the value of the parameter that you want to update is blank, enter the new value in the following format <Parameter>Value</Parameter> , where Parameter represents one of the four parameters that you can change and Value the new parameter value.

For example, to modify the blank Area parameter of a folder to 100 , enter <Area>100</

Area> .

NOTE: You must not change the Folder Identifier value.

Save your changes.

Editing the XML File to Manage Interface Links

Overview

You can use any XML editing software to edit the export file. This lets you create and delete interface links.

The software applies the configuration when you

191

into the application of the system.

If you modify the data of a link that is contained in the export file, the existing link is not deleted after import. The new link is created in addition.

Good Practices

• Before editing an application export file, create a copy of it. If needed, it lets you restore the original application.

• Edit only an up-to-date export file to help avoid data conflicts when importing.

• Use the data of

exposed interfaces, page 184

to create interface links.

Linked Instances Data

For any actions on links, the data of the linked instances must

appear in the application export file, page 185

even if the instances already exist in the target application.

If the linked instances already exist in the target application with the same configuration and you do not want to modify them, change the value of $Action to

Update for each instance.

NOTE: If the instances already exist in the target application and you leave the value as Create , the Resolve Uniqueness Conflicts

dialog box, page

197

opens during import and you need to select the Update action for the instances there.

Contents of the InterfaceLinks Element

The table describes the parameters of the InterfaceLinks

element, page 184

that appears at the end of the XML application export file.

EIO0000001114.15

189

190

Parameter

Action

DestinationPath

DestinationInstanceName

DestinationInstanceTemplateIdentifier

DestinationInstanceIdentifier

DestinationInterfacePath

Description

Action that the software performs by using the interface link data. Possible values:

• Create (default): Creates new links in addition to existing links whose data has been exported.

• Delete: Deletes links whose configuration matches the data in the imported file.

NOTE: To create a new link in place of an existing link, you need to explicitly delete the existing link.

NOTE: Entering Update produces the same result as

Create .

Path to the instance that is the destination of the link in the

Application Explorer .

The name of the

is replaced by

Root .

Value of the

of the instance that is the destination of the link.

Identifier of the template that is used by the instance, which is the destination of the link.

Identifier, page 130

of the instance that is the destination of the link.

Path to the destination interface in the composition of the instance.

Example :

In the following sample instance, value for interface BoolVar is “” (blank) because it has no parent element.

DestinationInterfaceIdentifier Identifier of the interface that is the destination of the link.

IsDestinationInstanceHierarchical

SourcePath

SourceInstanceName

SourceInstanceTemplateIdentifier

SourceInstanceIdentifier

SourceInterfacePath

Indicates if the

is enabled for the instance.

Path to the instance that is the source of the link in the

Application Explorer .

The name of the

is replaced by

Root .

Example :

For instance Motor_1 of System_1 that is located in Folder_2 , which is a subfolder of Folder_1 , the value is Root\Folder_1

\Folder_2 .

Value of the

of the instance that is the source of the link.

Identifier of the template that is used by the instance, which is the source of the link.

Identifier, page 130

of the instance that is the source of the link.

Path to the source interface in the composition of the instance.

Example :

In the following sample instance, the value for interface

ZSHPOS is Control\Motor\Logic .

EIO0000001114.15

Parameter Description

SourceInterfaceIdentifier Identifier of the interface that is the source of the link.

IsSourceInstanceHierarchical Indicates if the

is enabled for the instance.

Creating a Link

To edit the XML export file to create a link, proceed as follows.

Step

Action

In the InterfaceLinks element, copy the source and destination data that pertains to an existing interface link and paste it inside the element.

Edit the necessary source and destination data.

Verify that the value of Action is Create .

Save your changes.

Deleting a Link

To edit the XML export file to delete a link, proceed as follows.

Step

Action

In the InterfaceLinks element, locate the source and destination data that pertains to the interface link and change the value of Action to Delete .

Save your changes.

Importing a CSV or XML File Into the Application

Overview

By using the Import command, you can modify the application with the configurations that you have made in the CSV or XML file.

The import process is performed in steps during which the software:

1. Validates the structure of the CSV or XML file.

2. If valid, displays the folders, asset workspaces, and instances contained in the imported file along with the action that you have configured for each one, informs you of detected issues, and lets you select which objects to import.

3. Imports selected objects that satisfy applicable rules (for example, uniqueness of instance identifiers and presence of template).

EIO0000001114.15

191

192

uniqueness conflicts, page

4. For the other objects, informs you of the detected

197

and lets you resolve them so that you can import these objects.

5. Displays a summary of the import operation, which includes information about incorrect configurations and objects that were not imported.

Creating and deleting instances through import affects the

instance count, page

133

NOTE: Verify that the version of the templates that are used by the instances that you are importing exists in the Global Templates library before you proceed with the import; otherwise you will not be able to import these instances. Refer to the topics describing how to:

•

Browse application templates , page 119 .

•

Export/import templates, page 675 .

Software Version Compatibility

You can import into a system instances that were exported to XML format from

Process Expert 4.0 and later.

If the XML export file was created from a version earlier than Process Expert 4.0, you need to import the file into the version from which it was created, migrate the database in steps to version 4.0, and export the instances again from this version.

Instance Import Behavior

The table describes the default import behavior when you configure the export file to create instances in the following scenarios.

Scenario

An instance parameter value is invalid or no value is configured.

An instance element selection value is invalid or no value is configured.

Result

The instance is created and configured with parameters whose value is valid.

For the invalid or not configured parameter, the default value of the template is used.

The instance is created and configured with element selections whose value is valid.

For the invalid or not configured element selection, the value is set to false. The values that are configured for its parameters are not applied.

Folders

No Folders

no data, page 176

in the group.

Instance

Data is valid.

Invalid data for at least one folder in the instance path.

Data is valid.

Result

• If the folders exist in the target application: The instance is created.

• If at least one folder in the instance path does not exist: The instance is not created.

• If the folders exist in the target application: The instance is created.

• If the folders do not exist, only those that have valid data and a parent folder with valid data are created.

The instance is created only if the folder that contains it is created.

EIO0000001114.15

EIO0000001114.15

The table describes the import behavior when you configure the export file to update instances in the following scenarios.

Scenario

An instance parameter value is invalid or no value is configured.

An instance element selection value is invalid or no value is configured.

Result

Only parameters whose value is valid are updated.

For the invalid or not configured parameter, the current value of the instance is retained.

Only element selections whose value is valid are updated.

For the invalid or not configured element selection, the current value of the instance is retained.

Folders

No Folders

no data, page 176

in the group.

Invalid or missing data for at least one folder in instance path.

Instance

Data is valid.

Result

The instance is updated.

NOTE: When you import an XML file, folders whose data is invalid or missing are tagged with a red dot in the Import window.

Folder Import Behavior

The table describes the default import behavior when you configure the export file to create folders in the following scenarios.

Scenario

The parameter Action for all the folders in the export file is set to Create and the parent folder already exists in the target application.

The data of at least one folder in the folder structure is invalid.

Result

Only its subfolders are created if these do not exist yet.

If a subfolder already exists, it is not created but any lower-level folder in the hierarchy is created if it does not exist yet. And so on.

Only folders that have valid data and a parent folder with valid data are created.

The table describes the import behavior when you configure the export file to update folders in the following scenario.

Scenario

The data of at least one folder in the folder structure is invalid.

Result

Only folders that have valid data are updated.

NOTE: If it is not able to propagate the value of the Area parameter to any object because the object is locked, the software:

• Displays a notification to inform you which object is locked.

• Rolls back any propagated area value.

• Reverts the Area parameter value that you have entered in the folder properties to its previous value.

NOTICE

NO CHANGE PROPAGATION

When the Area parameter value of a folder is not propagated:

• Reenter the Area parameter value in the properties of the folder.

• Verify in the Notification Panel that parameter value propagation completed successfully.

Failure to follow these instructions can result in alarms being signaled in the wrong area during operation.

193

The table describes the import behavior when you configure the export file to delete folders in the following scenario.

Scenario

The folder that you are deleting contains subfolders and instances.

Result

The software deletes the subfolders and instances.

Interface Link Import Behavior

When you import two instances that are linked and select the Relative Path

import setting, page 195

, which imports the instances to a location that is different from the one that is specified for the source and destination instance in the interface links data group, the link is maintained.

Aborting Import Tasks

After confirming the import by clicking OK in the Import window, the abort icon is displayed in the

. Click the icon to cancel the task.

Only the user who has selected the command is allowed to abort it.

Folders and instances that already appear in the Application Browser at the moment you abort the task are retained given they belong to a tree structure that starts from the system root folder and that is completely imported at the moment the import task is aborted.

If you click the abort icon after clicking OK in the Resolve Uniqueness Conflicts dialog box, instances and folders that you had selected to be created and/or updated are not imported. Already imported objects (non-conflicting ones) are retained.

In any case, links that exist between instances are not recreated when you abort an import task even if these instances are retained. This is because recreating links is the last step performed before completing an import task.

NOTE: If you are importing only a few objects, the task may complete before you are able to click the abort icon.

The following example illustrates two scenarios. Parent folders Folder_1 and

Folder_2 are exported with their respective subfolders from the system root folder

( System_1 ).

194

When you import the two structures into a system, folders are imported in sequence, structure after structure. If the import task is aborted:

• Before Folder_C and its contents is completely imported (displayed), nothing is retained.

• After Folder_C and its contents is completely imported (displayed), only the complete Folder_1 tree structure and the instances therein are retained.

EIO0000001114.15

The following figure shows the objects that are retained when the import task is aborted after Folder_C and its contents has finished importing.

If a link exists, for example, between an instance in Folder_A and an instance in

Folder_C , it is not recreated.

Opening the Application Import Window

To open the application Import window, proceed as follows.

Step

Action

In the Application Browser , right-click the folder in which you want to import instances or that is to become the parent folder and select Import .

Result: The Open dialog box opens.

Select the application export file and click Open .

Result: The application Import window opens and displays the contents of the file.

NOTE: If you are importing only asset workspaces, you can right-click independently the root node in the Application Browser or Asset

Workspace pane.

Import Window Description

The following figure shows an example of the application Import window. This example illustrates a scenario where three instances and one folder cannot be imported. Details are provided in the legend.

EIO0000001114.15

195

196

Item

Description

Full path of the file that you are importing.

You can

may not be created, page 192

data.

Identifier of the folders and asset workspaces and name ( $Name ) of the instances contained in the imported file.

A selected check box indicates that the object is imported if possible.

A colored dot next to each object indicates the import status. Details are shown in a tooltip.

NOTE:

• Instances whose data is invalid are not shown.

• Instances whose data is valid are shown but

Refer to the Details section.

Color Colored dot description

Green For instances: The template that is used by the instance (same identifier and version) is available in the Global Templates library.

For folders: Subfolders and instances inside the folder and its subfolders are marked with a green dot.

Red For instances: The template that is used by the instance (same identifier and version) is not available in the Global Templates library. If you proceed, the instance is not imported.

For folders, may appear in these situations:

• Subfolders and instances inside the folder and its subfolders are marked with a red dot.

• The folder data in the CSV file is invalid.

• The folder contains an instance whose data is invalid.

If the location of the instance is not specified, the red dot appears on the system root folder.

Yellow

For asset workspaces, appears if the asset workspace identifier in the

CSV file is invalid.

For folders only: The folder or its subfolders contains at least one subfolder or instance that are marked with a red dot while at least one instance or subfolder is marked with a green dot.

Identifier of the template that instance is using.

Version of the template that the instance is using.

Indicates the action that the software performs on the selected object according to the value of the Action parameter in the imported file.

NOTE: When you create an instance, in the import summary that is shown in the notification panel, the action appears as Create for the instance but as Update for its elements and parameters.

Contents of the $Description parameter of the object.

Import setting. The view is updated to show the impact of your selection.

Absolute

Path

During import, the software maintains the folder structure of the imported file independently from where you select the import command given the required folder data is present in the imported file or the folders exist in the target application.

The system root folder appears as Root .

Relative

Path

During import, the folder from which you select the import command becomes the parent folder of the imported folder structure.

However, folders that do not exist in the target application and whose data is missing in the import file are not imported. This may change the location of instances.

NOTE: To be able to import an asset workspace when you are importing at the folder level, you need to select Absolute Path .

Notification area, which contains information about detected issues.

The message indicates that the instance cannot be imported because its template is not available in the Global Templates library. As a result, the instance is tagged with a red dot.

EIO0000001114.15

name or identifier, page 141

Item

Description

The message indicates that the instance that is located in folder Unit_2 cannot be imported. As a result, the folder is tagged with a red dot and the instance is not shown in the window.

Folder Cell_3 cannot be imported because of missing data in the imported file. As a result, the folder is tagged with a red dot and no action appears for it. Also, instance

MyValve_2 will not be created. It is tagged with a green dot because its template is available in the Global Templates library.

Resolving Conflicts During Import

You can resolve the object-uniqueness conflicts that the software detects during import, for example, if you are importing an instance or asset workspace and one with the same

already exists in the application.

The Resolve Uniqueness Conflicts dialog box opens once non-conflicting objects have been imported. The following figure shows an example for an instance.

EIO0000001114.15

Item Description

1 $Name parameter of the instance as it appears in the imported file.

The column can also show the identifier of an asset workspace.

Identifier of the instance based on the data of the imported file.

Identifier of the template that the instance uses.

New value for the $Name parameter of the instance that the software will use to satisfy applicable naming rules if you select to create the instance.

The column can also show the new identifier of an asset workspace.

Identifier of the object after import if you select to create it.

Buttons that let you select an action for individual objects:

• Skip : The existing instance and its links are not modified or the asset workspace is not imported.

• Update : Default action. Modifies the existing object with the imported parameter and link configuration. The name of the object is not modified.

• Create : Creates a new object with New Instance Name and the imported folder, parameter, and link configuration.

NOTE: Update is disabled if you have selected the Relative Path import setting and, as a result, the instance is imported in a different folder.

Buttons that let you select an action for the conflicting objects as a whole.

The actions are the same as when you select the action for objects individually.

NOTE: Clicking these buttons overrides the selection you have made for individual objects.

197

198

Importing Objects into the Application

To import the content of an application export file into the application of a system, proceed as follows.

Step

Action

In the application Import window:

• Review information that is shown in the Details pane (if applicable).

• Select the objects that you want to import.

• Select the import settings that you want to apply.

Click OK .

Result: If you select to import with relative path, a confirmation dialog box opens.

NOTE: Click Cancel to close the Import window without importing any object.

Click OK .

Result: If it does not detect conflicting objects, the software:

• Imports the contents of the file and applies the import settings that you have selected.

• Displays the imported objects in the Application Browser .

• Displays a summary of the import process in the notification pane.

If it detects conflicts, the software:

• Imports the objects that satisfy import rules and applies the import settings that you have selected.

• For conflicting objects, opens the Resolve Uniqueness Conflicts dialog box; proceed to step 4.

In the Resolve Uniqueness Conflicts dialog box, select the actions that you want to perform for conflicting objects.

NOTE: Click Cancel to close the Resolve Uniqueness Conflicts dialog box without importing objects for which the software has detected a conflict. Objects that satisfied import rules remain imported.

Click OK .

Result: The software:

• Imports the remainder of the objects with the import settings that you have selected.

• Displays the entirety of the imported objects in the Application Browser .

• Displays a summary of the entire import process in the notification pane.

EIO0000001114.15

Project Explorer and Project Browser ........................................................ 199

What’s in This Chapter

Control Project Definition Stage.................................................................... 203

Managing Control Projects ........................................................................... 206

Supervision Project Definition Stage ............................................................. 226

Creating Supervision Project Components .................................................... 229

Managing Supervision Projects .................................................................... 238

Participant Project Indicators........................................................................ 251

Overview

This chapter contains information to help you define the Control and Supervision projects of the system.

The following figure shows the position of the Project Definition stage within the system engineering life cycle.

Refer to the

Project Definition stage, page 32

for a description of the purpose of this stage.

Project Explorer and Project Browser

Overview

This section describes the Project Explorer , which features the various editors that let you manage Control and Supervision Participant project components. It also describes the Control Project Browser and Supervision Project Browser , which let you create these projects and open their respective editors.

concurrent actions, page 52 . In such case, check the

for details.

EIO0000001114.15

199

Project Explorer

Opening the Project Explorer

To open the Project Explorer for a system, verify that the system is selected in the Systems Explorer or that at least one explorer/editor is already open for this system. Then, click the Open Project Explorer button in the engineering client toolbar.

Otherwise, right-click the system in the Systems Explorer and select Open

Project .

Project Explorer Window

The following figure shows an example of the Project Explorer for a system in which two Participant projects exist. The Control Project Browser is selected.

The following figure shows an example of the Project Explorer for a system in which two Participant projects exist. The Supervision Project Browser is selected.

200 EIO0000001114.15

Project Browser

Item

Description

Tabs to show the Control Project Browser or Supervision Project Browser

pane, page 201

System root folder.

Remaining

Executable management, page 420

of the Project Explorer when the project browser pane is pinned. The data that is shown depends on the project browser tab that is selected. The work area is empty by default.

Assignment Editor

tab, page 256

. It shows the containers of the Participant projects and lets you assign facets to them.

tab, which lets you view and edit executable properties and perform the various mappings by selecting the corresponding subtabs:

• Service Mapping

• Communication Mapping

• Hardware Mapping (Control only)

Properties

tab, page 204

for the Participant projects and their components other than executables.

Description

The project browsers let you see, create, and interact with the Control and

Supervision Participant projects that exist in a system.

The following figure shows an example of the Control Project Browser in which two projects have been created.

The following figure shows an example of the Supervision Project Browser in which one project has been created.

EIO0000001114.15

201

202

Item

Pin button, page 86 . Lets you hide the pane and restore it when it is docked.

Description

You can

customize, page 202

which columns appear.

System root folder.

Node giving access to project-level context menu commands.

Node giving access to container-level context menu commands.

Node giving access to cluster-specific context menu commands.

User-created

executable, page 420 .

Indicator icons, page 251 .

Project type selection tabs.

Navigating Inside the Project Browser

The keys to navigate are the same as in the Application Browser

pane, page

123

Customizing Column Display

You can choose which columns you want to see by right-clicking a column header and selecting Customize . Certain columns are always shown.

For a description of the columns, refer to the topic describing properties of

Control executables, page 422

and

Supervision executables, page 458 .

System Root Folder Actions

Right-click the system root folder to open a context menu with the following commands. The availability of commands depends on the tab of the Project

Browser that is selected.

Command

Create Control

Description

Creates a new Control project that is associated to one of the supported controller families and displays it in the tree view of the Project Explorer .

Opens an Open dialog box, which allows you to create a Control project by importing data of a project that was created with Control Expert. Export files in .

stu or .xef format are supported.

Open

Application

Creates a new Supervision project, and displays it in the tree view of the

Project Explorer .

Open Topology Opens the

Topological Explorer , page 204

, which allows you to start the configuration stage or access the topology of the system.

Export

Opens the

Application Explorer , page 116

, which allows you to start the instantiation stage or access the application of the system.

Import

Opens a Save As dialog box, which allows you to create an export file containing the information of the

Control projects, page 207

and

Supervision projects, page 238

that exist in the system.

Opens an Import dialog box, which allows you to display the compatible contents of an export file (.sbk) in the Import window. You can import entire

Control projects, page 211

and/or

Supervision projects, page 242

, or parts of them into the system.

EIO0000001114.15

concurrent actions, page 52 . In such case, check the

Control Project Definition Stage

Overview

This section describes how to create Control projects of a system and their sections.

family of controllers, page 371

for details.

Creating Control Projects

Before Creating a Control Project

At this stage of the system engineering life cycle, you need to know:

• Which

you will be using to run the Control project.

• How you will organize the function block diagram (FBD) sections of the project.

NOTE: For information on working withControl projects of M580 safety controllers, refer to the topic describing the

engineering of M580 safety systems, page 577 .

Creating Control Projects

To create a Control project, proceed as follows.

Step

Action

In the Control Project Browser , right-click the system root folder, select Create

Control Project and the

controller platform, page 204

that is associated to the project.

Result: The Control project is shown in the tree view.

NOTE: In each system, you can create as many Control projects as needed.

For example, you can create a project, which is engineered for a Modicon

M580 controller in the plant and a project, which is engineered for an M340 controller for test purposes in the laboratory.

Control Project Actions

The table describes the Control project context menu commands.

Command

Assign

Facets

Generate , page 321

Refine

Description

Opens the Assignment Editor , which lets you create and manage sections and assign facets to them.

Applies to

Assignment

Stage, page 256

Starts a process to create or update the logic at the project level.

Generation stage

Manage

Network

Variables , page 357

Manage

Data

Backup

Files , page

224

Opens the Control Participant, which allows you to make changes to the logic of the project.

Opens the Manage Network Variables dialog box, which allows creating, modifying, and deleting network variables.

These are variables that are used to share data by using peer to peer communication.

Opens the Manage Data Backup Files dialog box, which lets you view and delete data backup files that exist for Control

Participant project.

Refinement stage, page 336

Project Definition stage

EIO0000001114.15

203

204

window, page 205 , which lets you configure

Command Description

ReGenerate , page

323

Starts a process to recreate the logic from the beginning at the project level.

NOTE: Certain changes that you have made during refinement may be discarded.

Last

Action

Summary , page 254

Export , page 207

Settings

Opens a dialog box that indicates the last action that was performed and a summary of the result.

Opens a Save As dialog box, which allows you to create an export file containing the Control project information.

Opens the Settings

various project-related settings.

Delete , page 205

Rename

Deletes the Control project including:

• Sections

• Assignments

•

Executables, page 421

Allows you to enter a new

identifier, page 204

for the project.

Properties Opens the Properties window, which allows you to view and/or edit the properties of the Control project.

–

Applies to

Generation stage

Project Definition stage

Assignment stage

–

Containers Node Actions

The table describes the Containers node context menu commands.

Command

Assign

Facets

Create FBD

Section

Generate

ReGenerate

Description

Opens the Assignment Editor , which lets you create and manage sections and assign facets to them.

Lets you

create an FBD section, page 261

in the task folder that you select.

The Assignment Editor opens in the background.

Starts a process to create or update the logic at the section level.

Starts a process to recreate the logic from the beginning at the section level.

NOTE: Certain changes that you have made during refinement may be discarded.

Applies to

Executables Node Actions

The table describes the Executables node context menu commands.

Command

Create

Executable

Description

Creates one or more

Control executables, page 421

, which let you associate one or more controllers to the Control project, map project facets to hardware, and create communication channels by using the I/O scanner service of the controller.

Applies to

Mapping Stage, page 420

Control Project Properties

Right-click the Control project and select Properties .

You can view and/or edit the following items.

Item

General Identifier

Description

The identifier must be unique within the system.

EIO0000001114.15

expressions, page 268 , which define how sections are

EIO0000001114.15

Item

Controller

Family

Description

Description Optional.

Value

You can enter a description of the project with free text.

Indicates the controller platform that you have associated to the project at the time of creation.

Possible values:

• M580

• M580 Safety

• M340

• Quantum

Read-only.

NOTE: When you associate a Control project with a controller family, the software limits the assignment of facets to the project to those that have the corresponding attribute (see EcoStruxure ™

Process Expert, Global Templates, Reference Manual) defined.

Deleting a Control Project

When you select the command to delete a Control project, the software displays a confirmation dialog box. Once you have confirmed the deletion, the software executes the following actions in relation to the project that you are deleting:

• Deletes any components of the project and their contents, including any assignments and mappings.

• Deletes any associated files (for example, data backup files and

expressions, page 268

for container naming rules).

NOTE: You cannot delete a Control project if any executable of the project is

deployed, page 481 .

Project Settings Window

The Settings window opens when you select the Settings command in the context menu of a Control or Supervision project.

Section

Container

Naming Rules

Description

Lets you configure

created and how Control facets are assigned to the project.

The section appears only for Control projects.

Assignment Lets you set the functionality, which can

automatically assign remaining candidate facets, page 284

of instances.

Possible values:

• Enabled

• Disabled

Project Analysis Lets you enable or disable the automatic analysis of the Control project, which is performed when you generate the project/sections or save refinement changes.

When the analysis is disabled:

• The Control

project validity indicators, page 252

are not functional.

• The time required to generate and save refinement changes is reduced.

You can perform an analysis of the Control project manually at any time by refining it offline and clicking Build

Analyze on the menu bar. After you click the save button, the project validity indicators indicate the status of the project.

Possible values:

• Enabled

• Disabled: Default value.

The section appears only for Control projects.

NOTE: For M580 safety Control projects, the setting also impacts the

configuration, page 587

of the associated M580 safety controller.

205

online, page 548 , creating the

NOTE: The OK and Cancel buttons apply to all the sections of the Settings window.

Creating Control Project Sections

Overview

In the Project Explorer , you can create only FBD sections in a Control Participant project by using context menu commands.

Creating FBD Sections

To create FBD sections in task folders, open the Assignment Editor by selecting

Assign Facets from the context menu of the Containers node in the Control

Project Browser .

For a description of sections and actions that you can perform, refer to the topic describing the

editor, page 257 .

NOTE: You can create FBD sections also by refining the Control Participant project or importing them.

Creating Non-FBD Sections

You can create non-FBD sections by:

•

Refining, page 336

the Control Participant project and creating the sections.

• Refining the Control Participant project

sections, and

updating, page 567

the Control project.

•

Importing, page 211

the sections.

Non-FBD sections are sections in any of the following languages: IL, LD, LL984,

SFC, and ST. They appear also in the Containers pane of the Assignment

Editor .

NOTE: In the following cases, existing non-FBD sections may be displayed only after you make a change by using the Refine

command, page 336

at the project level and save it:

• The Control project is contained in a database of an earlier version of the software that you have migrated.

• The Control project is contained in a system that you have restored by using a backup file created with an

earlier version, page 108

of the software.

Managing Control Projects

Overview

This section describes how to use the Project Explorer to manage entire Control projects or sections of such projects.

concurrent actions, page 52 . In such case, check the

for details.

206 EIO0000001114.15

pane, page 257 . The values appear in the

Control Project Section Order

Overview

The software assigns an order to sections, starting at 0, and displays it in the

Containers

Order column.

It indicates the order in which the software generates the sections of the Control project and thereafter the execution order of the sections by the Control

Participant.

You can change the order of sections inside the Containers pane.

The software applies changes to the order of sections in the logical Control

Participant project when you perform either action:

• Select the Refine command at the project level (it is not required to make a change or save).

•

Generate, page 323

the entire project or a section of the project.

•

Regenerate, page 327

the entire project or a section of the project.

You then need to propagate the change downward in the system engineering life cycle.

NOTE: You can also change the order of sections by

refining, page 336

the

Control Participant project or by refining the deployed Control project

online, page 548

and updating the Control Participant project.

Moving Sections

In the Assignment Editor , you can move sections only within the MAST or FAST task folder.

To move sections from the MAST to the FAST task folder or the other way around, refine the Control Participant project.

Changing the Order of Sections

To change the order of sections of a Control project, proceed as follows.

Step

Action

In the Containers pane of the Assignment Editor ,

clear filters, page 96

Drag one section up or down to a new position.

Result: A tooltip indicates the position that the section will occupy.

NOTE: In the Assignment Editor , you can select multiple, contiguous or noncontiguous sections that belong to the same task folder.

Release the mouse button.

Result: The section is inserted at the selected position and the values of the Order column are updated.

Apply the new order to the logical Control project by performing the necessary action.

NOTE: To change the order of the facets inside an FBD section, refer to

Changing the Facet Order , page 295 .

Exporting Control Projects

Overview

The export functionality lets you create a non-editable export file (.sbk), which contains selected Control project information.

EIO0000001114.15

207

208

communication channel, page 424

You can use this data by using the Control project

import, page 211

functionality to transfer project information to a different system or to merge information from different Control projects.

However, you cannot merge data related to communication mapping during import. You need to import either the complete

and/or peer to peer

communication data, page 435

that is contained in the export file for selected Control projects or nothing.

NOTE: To export the Control and Supervision projects of a system at once in one export file, right-click the system root folder in either Project Browser , select Export , and follow the project export procedure described in this section. Refer also to the topic describing the export and import of

Supervision projects, page 238 .

Exporting M580 Safety Control Projects

For specific information about exporting M580 safety Control projects, refer to the topic describing how to

engineer systems with M580 safety controllers, page 581 .

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the export file must be the same as the version that you used to create the export file (a service pack is considered the same version); otherwise you cannot proceed with the import.

Project Related Data

To be able to use the export file to import a project into a different system, verify that the instances, their templates, and topological entities related to the project exist in the target system

before importing the project, page 213 .

NOTE: The parameter values of instances that reference the exported facets are not contained in the export file. However, the export file contains information that allows the software to verify during import if the configuration of an instance is different from when its facets were exported.

Project Export Window

The Control window lets you select, which project information the export file will contain.

EIO0000001114.15

The following figure shows an example of the Export window where the check box for FBDSection_2 has been cleared. To indicate that at least one item of the

Control project is not selected, the check box of parent nodes are filled with a square.

EIO0000001114.15

The table indicates the meaning of the colored dots that appear in the Export window next to items of a Control project.

Color code

Green

Red

Yellow

Description

You can export the item.

You cannot export the item because it contains at least one facet with the following state:

• Deleted

• Unassigned

• Out of Date

• Moved

Generate sections that contain facets with such states in order to export the

Control project.

NOTE: You cannot export items that are tagged with a red dot.

Indicates that the item contains at least one subitem that is tagged with a red dot.

The item can be exported partially only.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter .

Export Settings

The table describes which Control project information you can export.

Item

System_n

ControlProject_n

Tasks folder

Selected for export

By default

Description

By default

Unselecting the item excludes any Control project and disables the creation of the export file.

Unselect the item to exclude the entire project from the export file.

You cannot unselect the item.

209

210

M580 safety Control projects, page 577

Item Selected for export

By default

Description

You cannot unselect the item.

MAST and FAST task folders

Sections By default

Safe Program

Container Naming Rules

Executables

ControlExecutable_n

Service

Mappings

Hardware

Mappings

Communication

Mappings

Built Participant

Project

Backups

By default

You can unselect sections individually.

Selecting an FBD section automatically selects any facets that are assigned to it.

The item is available only for

You cannot unselect the item.

Represents the

expressions, page 268

that are configured.

You cannot unselect expressions.

You cannot unselect the item.

You can unselect each executable and its contents individually.

Selecting an executable automatically selects any associated mapping.

Selecting the item exports any data related to the service mapping including any required contents in the contents repository.

Unselecting the item also unselects both the associated hardware and communication mapping.

You cannot select hardware mappings individually.

Selecting the item also selects the associated control executable and service mapping.

You cannot select communication mappings individually.

Selecting the item also selects the associated executable and exports the complete communication mapping data.

NOTE: If the project contains peer to peer communication data, refer to the topic describing

peer to peer communication export settings, page

210 .

Represents the built Control Participant file (.stu).

You can select data backup files individually.

The time stamp and description of each

backup file, page 554

are shown. The format of the time stamp is

YYYYMMDDHHMMSS.

Peer to Peer Communication Export Settings

To be able to recreate peer to peer communication channels and existing variable mappings at the time of import if the necessary conditions are fulfilled, you need to export all of the following:

• The owner project and its Control executable.

• The consumer project and its communication mappings.

NOTE: Including communication mappings in the export file may also include communication channels other than those for peer to peer communication (for example, communication channels for I/O devices).

Aborting Export Tasks

After confirming the export by clicking Save in the Export window, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the task.

The export file is not created.

EIO0000001114.15

Only the user who has selected the command is allowed to abort it.

NOTE: If you are exporting a small project, the task may complete before you are able to click the icon.

Exporting a Control Project

To export a Control project to file, proceed as follows.

Step

Action

In the Control Project Browser , right-click the Control project that you want to export and select Export .

Result: The Export window opens and displays the Control project that you have selected.

NOTE: To be able to export two or more Control projects, for example, to export peer to peer communication data, right-click the system root folder.

Select the project components that you want to export.

NOTE: If you had right-clicked the system root folder, you can select which projects you want to export.

Click OK .

Result: The Export window closes and the Export dialog box opens.

Select a location where you want to save the export file, enter a file name, and click

Save .

Result: The software creates the export file containing the selected Control project information.

NOTE: If you click Cancel , the Export dialog box closes without creating the export file and the selection you have made in the Export window is discarded.

Importing Control Projects

Overview

The Import command lets you import data of a Control project from an export file

(.sbk), which was created by using the

export, page 207

functionality of the

Project Explorer .

If the system into which you are importing a Control project already contains a

Control project with the same identifier, the software compares the data of both projects. It then proceeds with the partial import, according to the import settings that you select and the import rules that are described in this topic.

However, you cannot do a partial import of data related to

communication data, page 435

. You need to import either the complete communication channel and/or peer to peer

that is contained in the export file for selected Control projects or nothing. Importing it overrides any existing communication mapping and variable mappings. Specific conditions apply and are described in this topic.

If the software detects conflicts related to communication mapping before import, you have the choice to import the Control without communication mapping or to cancel the operation. If it detects conflicts during the import process, the entire import operation is canceled and rolled back.

NOTE: If the export file also contains information of a Supervision project, you can see the data that is related to the Supervision project, and have the choice to

import it, page 242

as well.

Importing M580 Safety Control Projects

For specific information about importing M580 safety Control projects, refer to the topic describing how to

engineer systems with M580 safety controllers, page 581 .

EIO0000001114.15

211

Software Version Compatibility

Naming Rules for Variable Names and Section Identifiers

Names of variables and identifiers of sections that you import into a system need to satisfy the

Consistency Management, page 347

for the generation process to complete successfully.

Checking Consistency After Import

After importing a Control project, perform a consistency check. This allows the software to identify if the constituents of the project into which you have imported are not consistent with the facets that are assigned to the project.

For more information on the process, refer to the topic

Item

System_n

ControlProject_n

Tasks folder

MAST and FAST task folders

Sections

Safe Program

Import Settings

The table describes which Control project information you can import into a system.

Selected for import (1)

By default

Description

Constituent File (FBD sections only)

Container Naming Rules

Executables

ControlExecutable_n

By default

Project dependent

By default

Unselecting the item excludes any Control project and disables the import of the export file.

Unselect the item to exclude the entire project from the import process.

You cannot unselect the item.

You can select sections individually.

Displays the identifier and path of the facets that are assigned to the section.

A Constituent File is associated to each FBD section.

Selecting an FBD section imports any facets that are assigned to this section.

NOTE: A section can be selected only if it is

tagged with a green dot, page 220 .

If the identifier of the imported FBD section already exists in the target project, the selection of the constituent file has an impact on the

import behavior, page 214 .

NOTE: The Constituent File check box is selected and disabled if the identifier of the imported FBD section does not exist in the target project.

The item is available only for

M580 safety Control projects, page 577 .

Unselect the item to exclude the entire safety program from the import process.

Expressions, page 268

are imported only if a Control project with the same identifier does not exist in the target system.

You cannot unselect the item.

You can select each Control executable and its contents individually.

Selecting the Control executable automatically selects any existing mapping.

212 EIO0000001114.15

can be imported, page 220

Item Selected for import (1)

By default

Description

Service Mappings

Hardware Mappings By default

Any data related to the service mapping including any required contents in the Contents Repository.

Selecting the item automatically selects the associated executable.

You cannot select hardware mappings individually.

Selecting the item automatically selects the associated executable and service mapping.

Communication

Mappings

Built Participant Project

By default

The complete data related to the communication mapping.

Selecting the item automatically selects the associated executable and service mapping.

Represents the Control Participant file (.stu).

It appears and is selected only if the built Participant project was selected at the time of export.

Backups By default You can select data backup files individually

The time stamp and description of the

backup file, page 554

are shown. The format of the time stamp is YYYYMMDDHHMMSS.

Importing a data backup file makes it available in the Manage Data

Backup File

dialog box, page 224

and Deploy Data

dialog box, page

505

(1) The information needs to be contained in the export file to be selected.

Import Rules for Project-Related Objects

Facets assigned to Control projects are related to instances of the application and mappings of project executables are related to entities of the topology. For the

Control project import to complete entirely, these project-related objects need to be present in the system in which you want to import the project.

The table describes the impact on the import operation when project-related objects are not present or have a different configuration. It also describes the corrective action.

Project-related object that is not present or different

An instance whose facets are assigned to the

Control project that you are importing (same identifier, template identifier, template version, and status Valid ) is not present.

Impact if not present in the target system Required action

An element of the instance creating a facet that is being imported is not selected.

You can import the project but not the sections to which such facets are assigned. This requires that the project contains at least one section that

, even empty.

A dialog box opens, page 221

asking you to confirm the partial import.

NOTE: Performing a partial import may cancel the entire import operation if

import rules for peer to peer communication variables, page 218

are not satisfied.

The facet that is normally created by this element is not imported.

The notification panel provides information about the facet that is not imported.

For example, you import a Control project to which the facet created by the Maintenance element of an instance is assigned but in the application of the target system, the

Maintenance element of the same instance is not selected.

Do either of the following first to create missing instances:

• Use the

export/import functionality, page 168

of the

Application Explorer to import missing instances.

• Create instances. This may require importing templates first.

You can obtain information about the missing instances and their templates in the tooltip of the container that is tagged with a red dot.

Edit the instance in the Application

Explorer and select the corresponding element.

EIO0000001114.15

213

Project-related object that is not present or different

The properties of an instance are different from the instance configuration at the time of export.

The difference lies in the

element selection

(services) and/or the parameter values, page

134

A topological entity to which you have mapped the executable of the project (service and/or communication) that you are importing (same identifier, same devices, and same services).

Impact if not present in the target system

The assignment status of facets that are imported is set to Out Of Date .

You can import the project but not the Control project executable and any of its associated mappings.

export-import functionality, page 408

Required action

Generate the project o section to apply the changes.

Use the

of the Topology

Explorer first to create the missing topological entities.

Import Rules for Sections

The table describes the import rules that apply to FBD and non-FBD sections with respect to the section order when a Control project with the same identifier already exists in the target system.

Result in Control project of target system after import

Contents of export file selected for import

Section1, order 0

Section2, order 1

Section4, order 2

Section in Control project of target system

Section3, order 0

Section1, order 1

Section3, order 0

Section1, order 1

Section2, order 2

Section4, order 3

The order of existing sections is maintained and imported sections are added at the end.

NOTE: If a section already exists in the target system, its order is maintained even if the order of the section in the export file is different.

The table describes the import rules that apply to non-FBD sections when a

Control project with the same identifier already exists in the target system.

Contents of export file selected for import

Section1

Section in

Control project of target system

Section1

Result in Control project of target system after import

Section1 Section2

Section1 from export file replaces Section1 in the Control project of target of the target system.

Section1 and Section2 exist in the Control project of target of the target system.

214

Import Rules for Facets

The software applies import rules to facets if the system into which you are importing a Control project already contains a Control project with the same identifier.

The following are the general import rules that the software applies if facets with the same identifier contained in FBD sections with the same identifier exist in both the target project and the export file that you are importing:

• If you select the constituent file of the section:

◦ Facets from the export file overwrite facets of the target system and maintain the state they have in the export file.

◦ Facets that exist only in the export file are imported into the target system and maintain the state they have in the export file.

◦ Facets that exist only in the target system become Assigned and Non

Generated . If the status of the facet is deleted, unassigned, or unlinked, the software removes the facet from the section after import.

EIO0000001114.15

property of an instance, page 134

EIO0000001114.15

• If you unselect the constituent file of the section:

◦ Facets with the same identifier maintain the state they have in the target system.

◦ Facets that exist only in the export file are imported into the target system and become Assigned and Non Generated unless the generation status of the facet is Unlinked .

◦ Facets that exist only in the target system maintain their state.

NOTE: The software changes the assignment status of any facet of an instance to Out Of Date if a

is different from what it was at the time of export. The notification panel provides information about the change of the assignment status after import is complete.

The following tables illustrate these import rules based on the different use cases.

The section and facet names are examples, and represent sections and facets in the MAST or FAST task folders of the projects.

If you select the FBD section Constituent File check box.

Contents of export file selected for import

Item in Control project of target system

Section identifier is identical

Section1 Facet1 Section1 –

Section1

Facet1

Section1

Facet1

Facet2

Result in Control project of target system after import

Facet1 from export file with status from export file.

Facet2 with status non-generated.

The software adds imported facets at the end of existing facets in the target section.

If the status of Facet2 is deleted, unassigned or unlinked, the facet is removed from the section after import.

Section identifier does not exist in target project

Section2 Facet3 – – Section2 with Facet3 from export file with status of export file.

The software adds imported sections at the end of existing sections in the target task folder.

– The item does not exist

If you unselect the FBD section Constituent File check box.

Contents of export file selected for import

Item in Control project of target system

Section identifier is identical

Section1 Facet1 Section1 –

Result in Control project of target system after import

Section1

Facet1 Section1 Facet1

Facet1 Section1 Facet2

Facet1 from export file with status non-generated unless generation status of Facet1 is Unlinked .

Facet1 from target system with same status.

Facet1 from target system with status nongenerated.

Facet2 from target system with same status.

The software adds imported facets at the end of existing facets in the target section.

– The item does not exist

Import Rules for Executables and Mappings

Communication mapping is created with the mapping information from the export file if the following conditions are fulfilled:

215

216

import rules for peer to peer communication variables, page 218 .

• For peer to peer communication: The export file contains

necessary data, page 210

of both the consumer and the owner projects and the corresponding elements are selected for import.

• The I/O scanner service of the client controller that is mapped to the imported executable is enabled.

• Sufficient free memory is available in the client and/or server memory length property of the controllers to fit the communication channels that exist in the export file.

• The client and server controllers that are mapped to the imported executables are connected to the same Ethernet network.

• For I/O device communication channels, in addition:

◦ The I/O scanner service that is imported needs to match with the service of the topological I/O device entity with which communication is to be implemented. Refer to the description of the Service column in the Device

IO section of the Communication Mapping Editor

window, page 425 .

◦ The topological I/O device entity with which communication is to be implemented needs to be connected to the same Ethernet network as the controller.

If the export file contains mapped peer to peer variables, refer to the topic describing

If the software is not able to import communication mappings, a

dialog box opens, page 222

indicating the reason.

The software updates the

Build State , page 470

of a Built executable after import depending on the scenario.

NOTE: if the system into which you are importing a Control project already contains a Control project and an executable with the same identifier, the software applies import rules to executables and service, hardware, and communication mappings. These rules are described in the following tables.

The table describes the import rules that apply to Built executables based on different scenarios.

Resulting built state in Control project of target system after import

Contents of export file selected for import

Item in Control project of target system

Executable1

Does not exist

Executable1

Executable2

Out Of Date

Executable1: Out Of Date.

Executable2: Out Of Date.

The table describes the import rules that apply to mappings based on different scenarios.

Contents of export file selected for import

Service mapping

Hardware mapping

Item in Control project of target system

Result in Control project of target system after import

Exists

Does not exist

Exists

Does not exist

Service mapping of target system is not changed.

Service mapping is created with the mapping information from the export file.

Hardware mapping of the target project is updated with the mapping information from the export file in the following way:

• Existing mappings of the target project are overwritten.

• New mappings are created.

• Mappings of the target project that are not affected by the import process are maintained.

NOTE: Any new mapping for which the required mapping interface from the topological instance of the target project is not present is rejected.

Hardware mapping is created with the mapping information from the export file.

EIO0000001114.15

import rules for peer to peer communication variables, page 218 .

Contents of export file selected for import

Item in Control project of target system

Result in Control project of target system after import

Communication mapping

Exists

Does not exist

NOTE: Any mapping for which the required mapping interface from the topological instance of the target project is not present is rejected.

Communication mapping is overwritten as a whole if the following conditions are fulfilled:

• For peer to peer communication: The export file contains

necessary data, page 210

of both the consumer and the owner projects and the corresponding elements are selected for import.

• Sufficient free memory is available in the client and/or server memory length property of the controllers to fit the communication channels that exist in the export file.

• For I/O device communication channels, in addition:

◦ The I/O scanner service that is imported needs to match with the service of the topological I/O device entity with which communication is to be implemented. Refer to the description of the

Service column in the Device IO section of the

Communication Mapping Editor

window, page

425

◦ The topological I/O device entity with which communication is to be implemented needs to be connected to the same Ethernet network as the controller.

• If a service mapping exists, it needs to be identical to the service mapping contained in the export file for the

Control project that you want to import.

NOTE: If the export file contains mapped peer to peer variables, refer to the topic describing

Communication mapping is created with the mapping information from the export file if the following conditions are fulfilled:

• For peer to peer communication: The export file contains

necessary data, page 210

of both the consumer and the owner projects and the corresponding elements are selected for import.

• The I/O scanner service of the client controller that is mapped to the imported executable is enabled.

• Sufficient free memory is available in the client and/or server memory length property of the controllers to fit the communication channels that exist in the export file.

• The client and server controllers that are mapped to the imported executables are connected to the same

Ethernet network.

• For I/O device communication channels, in addition:

◦ The I/O scanner service that is imported needs to match with the service of the topological I/O device entity with which communication is to be implemented. Refer to the description of the

Service column in the Device IO section of the

Communication Mapping Editor

window, page

425

◦ The topological I/O device entity with which communication is to be implemented needs to be connected to the same Ethernet network as the controller.

• If a service mapping exists, it needs to be identical to the service mapping contained in the export file for the

Control project that you want to import.

NOTE: If the export file contains mapped peer to peer variables, refer to the topic describing

import rules for peer to peer communication variables, page 218 .

EIO0000001114.15

217

218

selecting the constituent file, page

Import Rules for Peer to Peer Communication Variables

To be able to import communication mappings as a whole, the software also needs to be able to create variable mappings that exist in the export file.

If none of the imported Control projects exist in the target system, the necessary variables are created, given that import rules for project-related items are satisfied.

If either Control project that you are importing already exists in the target system but a variable that is mapped to a peer to peer communication channel present in the export file has been modified or deleted, two scenarios are possible:

• The variable was created by refining the Control project. In such case, when you import communication mappings, the software is not able to recreate the variable. Therefore, it cannot create variables mappings and the entire import process is canceled and rolled back. The software displays a dialog box to inform you.

You need to recreate the variable manually to be able to import communication mapping.

• The variable was created by a facet assigned to the Control project. In such case, if you select the constituent file of the section to which the facet is assigned, the import process is able to recreate the required variable and the import succeeds, given that other necessary conditions are fulfilled.

The following example illustrates the second scenario: You have created two

Control projects, Owner and Consumer between which a peer to peer communication channel exists.

Var_1 is mapped to this communication channel.

The variable exists as network variable in Consumer (with P2P as custom attribute) and as variable in Owner .

You have exported both projects with their complete contents and have kept on working on both projects, which altered the communication mapping . After a while, you realize that you are not satisfied with some changes you made and therefore, you want to recover the original projects and communication mapping while keeping some of your changes (for example, you want to keep an FDB section that you have added to Consumer after exporting).

You import the export file in the Projects Explorer where Owner and Consumer

Control exist. However, you have renamed Var_1 in the Owner project.

Because you want to import communication mappings, you have selected both

Control projects in the Import window.

Because Var_1 had been created by a facet that is assigned, for example, to

FBDSection_1 in the Owner Control project, by

214

of FBDSection_1 in the Import window, you are able to recreate the variable and import communication mappings.

NOTE: A network variable can be used only once per project, independently of the number of Control executables that exist in the project.

EIO0000001114.15

identification information, page 554

The following figure illustrates the import example by using a target system in which the Owner and Consumer projects exist and showing the objects that are selected for import.

EIO0000001114.15

1 FBDSection_1 of Owner Control project showing the facet that creates Var_1

2 Consumer Control project

3 Communication mappings of Consumer

4 Owner Control project

5 Constituent file of FBDSection_1 to which facet that creates Var_1 is assigned

Import Rules for Data Backup Files

When you import a Control project and a Control project with the same identifier already exists in the target system, if you have selected to import the data backup file and a file with the following identical

already exists, the file is not imported:

• Time stamp.

• Identifier of the executable.

• Identifier of the controller and role.

• Description.

• Type of data that is backed up.

NOTE: The notification panel displays information about the not imported data backup file.

Opening the Project Import Window

To open the Import window, proceed as follows.

219

abort the command, page 222 .

Step

Action

Right-click the system root folder in a Project Browser of the Project Explorer and select Import .

Result: The Import dialog box opens.

Browse to the export file (.sbk) that contains the Control project information that you want to import and click Open .

Result: The Import window opens and displays the contents of the file that you have selected once it has read the data contained in the file. This can take time depending on the number and size of projects contained in the file.

NOTE: You can

Project Import Window

The Import window lets you select Control project information that is contained in an export file and that you can import into an existing system. You can select one or more entire Control Participant project and/or parts of them.

The following figure shows an example of the Import window displaying the contents of a Control project export file. In this example, the check box for FBDSection_2 is cleared because the section cannot be imported. To indicate that at least one item of the Control project is not selected, the check box of parent nodes are filled with a square.

220 EIO0000001114.15

not present in the application, page

The table indicates the meaning of the colored dots that appear in the Import window next to items of a Control project.

Color code

Green

Red

Yellow

Description

You can import the item.

• At the section level: The section contains at least one facet that is referenced by an instance, which is

213

• At the executable level: A

is not present in the target system.

A tooltip provides additional information about the issue.

NOTE: You cannot import items that are tagged with a red dot.

The item contains at least one subitem that is tagged with a red dot.

The item can be imported partially only.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter .

Confirmation Dialog Box For Sections That Cannot Be Imported

The following figure shows an example of the dialog box that opens when a section of a Control project selected for import is tagged with a red dot and you click OK in the Import window.

If you are importing also Supervision projects, containers are grouped by

Participant then by project.

EIO0000001114.15

Button

Yes

Description

Closes the dialog box, the Import window, and imports the selected projects without sections tagged with a red dot.

Closes the dialog box and reverts to the Import window without importing projects. You can modify the selection of projects or cancel the import operation.

221

Confirmation Dialog Box For Communication Mappings That

Cannot Be Imported

The following figure shows an example of the dialog box that opens when you click OK in the Import window and the software detects that communication mappings selected for import cannot be imported. It indicates the identifier of the project and the corresponding executable, and the reason. The Import window is closed before the dialog box opens.

222

Button

Yes

Description

Closes the dialog box and imports the selected projects without communication mappings.

NOTE: This may result in variable mappings being present in the target system while the required variables do not exist.

Closes the dialog box and cancels the import operation.

Aborting Import Tasks

The abort icon is displayed in the

select the export file, page 219 . Clicking the

at two different stages of the import process:

• After clicking Open when you

icon cancels the operation to read the contents of the export file. The Import window does not open.

• After confirming the import by clicking OK in the Import window, the abort icon is displayed. Clicking the icon cancels the task. The project is not imported.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are importing a small project, each task may complete before you are able to click the icon.

Importing a Control Project

To import data of a Control project into an existing system, proceed as follows.

EIO0000001114.15

consistency check button, page 349

Step Action

1 In the Import

window, page 219

, select the items that you want to import.

2 Click OK .

Result

If applicable rules are satisfied, the software:

• Applies the import rules based on your import selection.

• Proceeds with the import.

• Replaces existing communication mapping if you had selected to import them.

• Displays an import summary dialog box.

The Control Participant window opens.

In the Project Browser , right-click the Control project into which you have made the import and select

Refine .

Click the

Take the necessary

actions, page 349

corrective

The software proceeds with a consistency check and displays a notification to report findings once the check is completed.

NOTE: If the software detects incompatibilities during the import process, it cancels and rolls back the import operation, and displays a dialog box to inform you. In such case, take the necessary corrective actions and start the import over. For example, if the incompatibility is related to variable mappings, you can clear the check box next to CommunicationMappings to import

Control project data but no communication mapping.

Importing a Control Expert Project

Overview

The Import Control Project command allows you to create a Control project in the Project Explorer by importing data of a project that was created by using

Control Expert and which is contained in a compatible project file (.stu or .xef

format).

After import, you will have access to the same commands from the project node as if you had created the project in the Project Browser .

Project Compatibility

To be able to import a project created with Control Expert, the following requirements need to be met:

• The version of Control Expert with which the export file was created needs to be identical to the version of the Control Participant. To determine the version of the Control Participant, open it (for example, by refining a Control project) and open the About dialog box from the Help menu.

• The version of the EcoStruxure Control Expert DTM Library that is installed in

Control Expert needs to be the same as the one installed in the Control

Participant. For information on the installed version, refer to the platform release notes.

EIO0000001114.15

223

data backup files, page 554

Imported Data

Project data contained in the file (stu or .xef)

FBD sections

Sections in the following programming languages:

• Ladder Diagram (LD)

• Instruction List (IL)

• Structured Text (ST)

• Sequential Function

Chart (SFC)

• Ladder Logic 984

(LL984)

Constituents of any section

Configuration

Other global project information (for example, variables, types, project settings...)

Project platform

Contained in the

Control

Participant project after import

Yes

Visible in the Project Explorer after import

Yes

Sections are created in their respective

MAST and FAST task folders in the

Assignment Editor .

Yes

Refine the imported project to view the information.

NOTE: Only data related to the program becomes part of the logical

Control project. Other data (for example, data related to the configuration) is ignored during build although it is visible when you refine the logical project.

Yes

Controller Family

attribute, page 204

NOTE: The name of the file containing the project data becomes the identifier of the Control project that the software creates during the import process.

Importing a Control Expert Project

To import a Control Expert project into an existing system, proceed as follows.

Step

Action

Right-click the system root folder in the Control Project Browser of the Project

Explorer and select Import Control Project .

Result: The Open dialog box opens.

Select the file format that you want to import.

Browse to the location of the Control Expert project file that you want to import and click

Open .

Result: The software creates a Control project and displays it in the Control Project

Browser .

Managing Data Backup Files

Overview

The Manage Data Backup Files dialog box lets you view and delete

that exist for all the executables of a Control Participant project.

The dialog box shows the information that was associated to each backup file at the time of creation, including the type of data that was selected.

By default, backup files are listed in descending order of time stamp (most recent one on top). You can

the information that is displayed.

224 EIO0000001114.15

Opening the Manage Data Backup Files Dialog Box

To open the Manage Data Backup Files dialog box, right-click a Control

Participant project in the Project Browser and select Manage Data Backup

Files .

If no data backup file exists, the command is not available.

Manage Data Backup Files Dialog Box

The following figure shows an example of the Manage Data Backup Files dialog box, which shows the data backup files that have been created for executables of

ControlProject_1 .

EIO0000001114.15

Column header

Description

Time Stamp Date and time of the backup file creation.

Description Description that was entered when the backup file was created.

User Name of the user who was logged on when the backup file was created.

Executable

Controller

%MW

Identifier of the Control executable whose data is contained in the backup file.

Identifier of the controller that was running the executable whose data was backed up.

For redundant controllers, it also indicates the role of the controller that was selected when the backup file was created.

Indicates the memory range of located variables of boolean data type that are contained in the backup file.

If no such data was selected during data backup, the value shown is N/A .

Indicates the memory range of located variables of WORD data type that are contained in the backup file.

If no such data was selected during data backup, the value shown is N/A .

Unlocated

Variables

Unlocated

FBs

True indicates that this type of data was selected during data backup.

Possible values:

• True

• False

Deleting Data Backup Files

To delete a data backup file, select the corresponding row and click Delete . The backup file is deleted after you confirm the command.

You can select more than one backup file at a time.

NOTE: When you delete a Control Participant project or the controller to which it is deployed, the corresponding data backup files are deleted as well.

225

concurrent actions, page 52 . In such case, check the

Supervision Project Definition Stage

Overview

This section describes how to create Supervision projects of a system.

for details.

Internal Supervision Architecture

Task Description

As a reminder, the following figure describes the internal Supervision architecture for the execution of tasks:

1 Report scheduling and execution

2 Alarm acquisition and processing

3 Trend acquisition and storage

4 I/O communications

5 Graphical interface, events, local I/O, and client services

NOTE: Report, alarm, and trend servers also act as clients of the I/O server.

Creating Supervision Projects

To create a Supervision project, proceed as follows.

Step

Action

In the Supervision Project Browser , right-click the system root folder and select

Create Supervision Project .

Result: The Supervision is shown in the tree view.

NOTE: For each system, you can create as many Supervision projects as needed to meet the requirements of the system.

Supervision Project Actions

The table describes the Supervision project context menu commands.

226 EIO0000001114.15

Assignment Stage, page 256

EIO0000001114.15

Command

Create

Cluster , page 229

Last

Action

Summary , page

254

Assign

Facets

Description

Creates a new cluster with its default contents and displays it in the tree view.

Opens a dialog box that indicates the last action that was performed and a summary of the result.

Applies to

Project Definition stage

Opens the Assignment Editor , which lets you create and manage tag containers and Supervision pages of the

Supervision project and assign facets to them.

Generate

Refine

Starts a process that creates and/or updates in the

Supervision Participant project the data of the entire

Supervision project.

Opens the Supervision Participant, which allows you to modify the project.

Opens the Supervision Participant, which allows you to change advanced project settings that will be activated in the station nodes where you deploy the Supervision project.

Generation stage, page

297

Refinement stage, page 360

Refinement stage

Advanced

Settings , page 362

Include

Projects page 362

Attach

User

Files , page 363

Opens a dialog box, which allows you to:

• Add external included projects to be deployed to the

Supervision nodes.

• To remove included projects that are attached to the

Supervision and stored in the contents repository.

NOTE: You cannot add an included project if the software has already added to the Participant project an included project with the same name.

Opens a dialog box, which allows you to:

• Attach external files to be deployed to the Supervision nodes.

• To remove files that are attached to the Supervision project and stored in the contents repository.

Export , page 238

Opens a Save As dialog box, which allows you to create an export file containing the Supervision project information.

Settings Opens the Settings

window, page 205 , which lets you

configure various project-related settings.

Delete Deletes the Supervision project including components, assignments, and mappings.

Project Definition stage

Assignment stage

–

Rename

Properties

Allows you to enter a new identifier for the project.

Opens the Properties window, which allows you to edit the properties of the Supervision project.

–

Containers Node Actions

The table describes the Containers node context menu commands.

Command

Assign

Facets

Create Tag

Container

Create Page

Generate

Description

Opens the Assignment Editor , which lets you create and manage tag containers and Supervision pages of all clusters and assign facets to them.

Lets you

create a tag container, page 263

in an existing cluster.

The Assignment Editor opens in the background.

Opens the Assignment Editor and

creates a Supervision page, page 267

in the project.

Starts a process to create and/or update in the Supervision

Participant project the data for the containers of all clusters that exist in the project.

Applies to

227

228

create clusters, page 229 .

Pages Node Actions

The table describes the Pages node context menu commands.

Command

Assign

Facets

Create Page

Generate

Description

Opens the Assignment Editor , which lets you create and manage tag containers and Supervision pages of all clusters and assign facets to them.

Opens the Assignment Editor and creates a Supervision page in the project.

Starts a process to create and/or update in the Supervision

Participant project the data for the pages that exist in the project.

Applies to

Cluster Node Actions

For a description of the context menu commands, refer to the topic describing how to

Tags Node Actions

The table describes the Tags node context menu commands.

Command

Assign

Facets

Generate

Description

Opens the Assignment Editor , which lets you create and manage tag containers and Supervision pages of the parent cluster and assign facets to them.

Starts the generation process of tag containers and pages that exist in the parent cluster to populate new tags, update out-of-date tags, and/or remove deleted tags in the

Supervision Participant project.

Applies to

Services Node Actions

The table describes some of the Services node context menu commands. For a description of the other commands, refer to the topic describing how to

create

Supervision servers and clients, page 230

Command

Open

Generate

Description

Opens the Services window, which lets you view and edit properties of the Alarm, report, and trend servers as well as clients that exist in the parent cluster.

Starts a process to create and/or update in the Supervision

Participant project the data related to services.

Applies to

ClientEvents and ServerEvents Node Actions

The table describes the ClientEvents and ServerEvents nodes context menu commands.

Command

Open

Generate

Description

Opens the corresponding window, which lets you view the

Supervision facets that are assigned to client or server events in the parent cluster.

Starts a process to create and/or update in the Supervision

Participant project the data related to services in the parent cluster.

Applies to

EIO0000001114.15

Supervision executables, page 457

Executables Node Actions

The table describes the Executables node context menu commands.

Command

Create

Executable

Description

Creates one or more

, which let you associate the Supervision project infrastructure to stations nodes and the I/O devices to controllers.

Applies to

Mapping Stage

Supervision Project Properties

Right-click the Supervision project and select Properties .

You can edit the following items.

Item

General Identifier

Description

The identifier of the Supervision project, which must be unique within the system.

Description Optional.

You can enter a description of the project with free form text.

Creating Supervision Project Components

Overview

This section describes how to use the Project Explorer to create the components of Supervision projects.

During build, one or more OPC Factory Server and/or OPC UA Server Expert configuration files (.xml) are automatically

generated, page 476

based on the configuration of properties of the Supervision project components.

For information on how to create tag containers and Supervision pages, refer to the topic describing the

creation of containers, page 256

in the Assignment stage.

concurrent actions, page 52 . In such case, check the

for details.

Creating Clusters

To create a cluster, proceed as follows.

Step

Action

Right-click the Supervision project and select Create Cluster .

Result: The software creates a new cluster node and its child nodes.

Cluster Actions

The table describes the cluster context menu commands.

EIO0000001114.15

229

Command

Description

Generate Starts the generation process to populate the database of the Supervision Participant project for this cluster.

Delete Deletes the cluster including its contents and unassigns the assigned Supervision data facets.

Lets you enter a new identifier for the cluster.

Rename

Properties

Opens the Properties window, which allows you to edit the properties of the cluster.

Cluster Properties

To open the Properties window of the cluster, right-click the cluster and select

Properties .

You can edit the following items,

Item

General

Description

Identifier The identifier must be unique within the Supervision project and satisfy applicable

station node, page 379 , which acts as an engine to run the Supervision project.

NOTE: Changing the identifier of the cluster changes the assignment status of facets that are assigned to a tag container of the cluster to Out Of Date .

Description Optional.

You can enter a description of the cluster with free form text.

Creating Supervision Servers and Clients

Overview

You can create Supervision servers in the Services node of a cluster.

The I/O server instance represents a server that is set up on an operation server

(see EcoStruxure ™ Process Expert, Installation and Configuration Guide), on which Supervision and OPC Factory Server or OPC UA Server Expert software is installed. The operation server is represented in the topology of the system by a

The alarm, trend, and report server instances represent servers that are set up on a single or distinct operation servers, on which Supervision software is installed.

You can create up to two alarm, report, and trend servers per cluster.

NOTE: Generate the Supervision project after you make changes related to components described in this topic.

Creating Supervision Servers

To create I/O, alarm, trend, and report servers in the cluster, proceed as follows.

Step

Action

Right-click the Services node and select the corresponding command.

Result: The new server is created.

NOTE: Only I/O servers are shown in the project browser. To view other servers, open the Services node.

NOTE: The software may automatically create servers during the assignment stage if you have not created them already. For more information, refer to the

Supervision project

Assignment stage, page 281

230 EIO0000001114.15

Supervision I/O Server Properties

To open the Properties window of an I/O server, right-click the server and select

Properties .

You can edit the following items.

Item

General Identifier

Description

Attributes

Port

Legacy Port

Description

The identifier must be unique within the Supervision project.

Optional.

You can enter a description of the server with free form text.

Communication port the server listens on.

Default value: 2082.

Communication port that is used for legacy connections to the server.

Default value: 2078.

Supervision Servers Common Properties

To view the alarm, trend, and report servers that exist in the cluster and their properties, right-click the Services node and select Open .

You can view and/or edit the following items.

Item

General

Attributes

Identifier

Description

The identifier must be unique within the Supervision project.

Default value: Server_n_P where:

• Server is the name of the service provided by the server (for example, Alarm ).

• n is an incremental number starting at 1.

• P stands for primary. The suffix of the second server instance that you create is _S for standby, even if you rename the first instance.

Optional.

You can enter a description of the server with free form text.

Port Communication port the server listens on.

Default value:

• Alarm server: 2080

• Report server: 2084

• Trend server: 2085

Edit the value if you are running more than one server on the station node.

Communication port that is used for legacy connections to the server.

Legacy Port

Default value:

• Alarm server: 2076

• Report server: 2075

• Trend server: 2077

Database Port The attribute is available for alarm servers only.

Communication port the server database listens on.

Default value: 5482

Edit the value if you are running more than one alarm server on the station node.

EIO0000001114.15

231

Item

Mode

Extended

Memory

additional I/O devices, page 234

Description

You can select one of the following values from the menu:

• None

• Primary : Defines the server as the primary server. Default value for the server with _P suffix.

• Standby : Defines the server as the standby server. Default value for the server with _S suffix.

The attribute is available for alarm servers only.

Possible values:

• False : Default value.

• True : The alarm server operates in 64-bit extended memory mode. This allows the alarm server process to utilize memory beyond the 4GB limit.

For more information on this mode of operation, refer to Alarm Server

Process in the help of the Supervision Participant.

Creating Supervision Clients

You can create Supervision Clients in the Services node of a cluster.

The client instance can represent a Supervision client (runtime) that runs:

• On the operation server.

• On an operator station.

To create a client for the Supervision project, proceed as follows.

Step

Action

Right-click the Services node and select Create Client .

Result: The client is created but not shown in the project browser.

Supervision Client Properties

To view the clients that exist in the cluster and their properties, right-click the

Services node and select Open .

You can edit the following items.

Item

General Identifier

Description

The identifier must be unique within the Supervision project.

Optional.

You can enter a description of the client with free form text.

Creating I/O Devices

Overview

Typically, an I/O device is created for one controller. If the data is present in two controllers, create an additional I/O device for the second controller manually.

Create a second

tag container, page 263

for data of the second controller and associate this tag container to the second I/O device.

The software creates

when you create calculated or disk variable tags.

NOTE:

Monitoring data of a device, page 639

communicating by using the

Modbus TCP protocol (or Modbus through an Ethernet gateway) from the

Supervision infrastructure also requires a dedicated I/O device per Modbus device.

232 EIO0000001114.15

Assignment stage, page 281

Item

General

Attributes

Prerequisites

An I/O server must exist in the cluster.

Creating I/O Devices

To create an I/O device in the cluster, proceed as follows.

Step

Action

Expand the Services node and the I/O server, right-click the IODevices node, and select Create IO Device .

Result: The I/O device is created but not shown in the project browser.

NOTE: The software automatically creates the I/O device during the assignment stage if you have not created it already. For more information, refer to the Supervision project

Identifier

Description

Address

StartupMode

Priority

Memory

I/O Device Properties

To view the I/O devices that exist in the cluster and their properties, right-click the

IODevices node and select Open .

You can edit the following items.

Description

The identifier must be unique within the Supervision project.

NOTE: Changing the identifier of the I/O device changes the assignment status of facets that are assigned to the tag container that is associated with the I/O device to

Out Of Date if they were generated.

Optional.

You can enter a description of the I/O device with free form text.

The value needs to be compatible with the protocol that is selected for the associated tag container.

The default value is the alias name for OPC Factory Server: Alias_<IODevice_n> where

<IODevice_n> corresponds to the value of Identifier .

NOTE: The attribute is disabled and cleared when Protocol of the associated tag container is set to OPCUA or OPCUA Embedded .

For these two protocols, the following temporary address is created for the I/O device when you generate the Supervision project or the cluster:

• For OPCUA : opc.tcp://127.0.0.x:49152/OPCUAServerExpert

• For OPCUA Embedded : opc.tcp://127.0.0.x:4840

During

build, page 475

, the IP address placeholder (127.0.0.x) and the port value are updated based on the mapping.

Select the role of the I/O device in terms of communication with the controller:

• Primary (default value)

• Standby

• StandbyWrite

• None

You can assign the order in which the I/O device attempts to communicate with the tag container that it is associated with in case more than one I/O device is associated with the container.

Set the values as follows depending on the role of the I/O device:

• Primary: 1 or blank (default value)

• Secondary: 2 or higher

NOTE: If you associate two I/O devices configured as primary to one tag container, verify that Priority is configured with a different value for each.

Select one of the following values depending on how you want the I/O device to communicate with the controller:

False : Default value. The I/O device is online with the controller

EIO0000001114.15

233

Item

Relationships TagContainer

Ports

automatically created, page 281

Description

True : The I/O device is not connected to the controller. Select this setting for testing purposes, for example.

Select the tag container that is associated with the I/O device.

NOTE:

• By default, the software associates the I/O device with the tag container for which the I/O device has been

during the assignment of Supervision data facets.

• Changing the relationship of the I/O device to the tag container changes the assignment status of facets assigned to the tag containers affected by this change to Out Of Date .

Select the

communication port, page 234

that is associated to the I/O device.

NOTE: By default, the software associates the I/O device with either the communication port that has been

automatically created, page 281

during the assignment of Supervision data facets or with the one that you have created manually.

I/O Devices Created for Calculated and Disk Variable Tags

When you generate a Supervision data facet that references a non-disabled

Calculated Variable Tag or Disk Variable Tag element (see EcoStruxure ™

Process Expert, Global Templates, Reference Manual), one specific I/O device is automatically created per I/O server with the same properties as the default I/O device except for the following. These specific I/O devices are only visible when you refine the Supervision project.

Property

Identifier

Address

Ports

Memory

Persist

For a calculated variable tag

CicodeIODevice_n where is an integer starting at 1 so that the identifier remains unique within the I/

O sever.

Blank

Same value as default I/O device

For a disk variable tag

Disk_IODeviceID_n where:

• IODeviceID is the identifier of the I/O device that is associated to the tag container to which the data facet is assigned.

• n is an optional integer starting at 1 that is added so that the identifier remains unique within the I/O sever.

Blank

True

Creating Communication Ports

Overview

Before you can create a communication port, you need to create a communication board unless one already exists.

You need to create a communication board for each communication driver that you are using. For example, if you are using both OFSOPC and OPCUA, create one board for each and configure them accordingly.

To view the communication ports that exist, right-click a board and select Open .

Prerequisites

An I/O server must exist in the cluster.

234 EIO0000001114.15

Assignment stage, page 281

EIO0000001114.15

Creating a Communication Board

To create a communication board, proceed as follows:

Step

Action

Expand the Services node and the I/O server, right-click the Communications node, and select Create Board .

Result: The board is created.

NOTE:

• The software automatically creates one communication board and port during the assignment stage if you have not created it already. For more information, refer to the Supervision

• Deleting a communication board deletes the associated communication ports.

Communication Board Properties

To open the Properties window of the communication board, right-click it, and select Properties .

You can edit the following items. For details, refer to Board Properties in the help of the Supervision Participant.

Item

General Identifier

Attributes

Description

Protocol

Address

Description

The identifier must be unique within the I/O server.

16 characters maximum.

Optional.

You can enter a description of the board with free form text.

Indicates the protocol for communicating with the I/O device and that is to be used for configuring the I/O device.

When the protocol for the tag container is set to OPCUA Embedded , select OPCUA .

When you configure a

user-defined protocol for a tag container, page

264

, enter a protocol for the board that is compatible and installed in the Supervision Participant. To verify which ones are installed, refine the Supervision Participant project and expand an entry in the Board

Type column of Components & Mapping in the Topology activity.

Default value:

• Same as Protocol (that is, OFSOPC or OPCUA ) if the value of

Protocol for all the tag containers that are associated to an I/O device whose communication port is associated to the board is the same; otherwise, OFSOPC .

• OFSOPC when you create the board manually.

Default value: 0 when the board is created by the software.

NOTE: The OFSOPC driver configuration implements an automatic and adaptive strategy, creating and deleting OPC groups and OPC items dynamically to maximize throughput. For information on other parameters affecting performance when using this driver configuration, refer to

Performance Considerations (see EcoStruxure ™ Process Expert, Supervision

Participant Services, User Guide).

NOTE: For the OPCUA driver, the software adds driver-specific parameters to the citect.ini file (see EcoStruxure ™ Process Expert, Supervision Participant

Services, User Guide) (for example, subscription and connection parameters), which are configured with default values and apply to a given I/O device. For details, refer to OPCUA Driver in the Driver Reference Help of the Supervision

Participant.

235

automatically created, page 281

Creating Communication Ports

For each communication board, you can create several communication ports.

To create a communication port, proceed as follows.

Step

Action

Expand the Services node, right-click the board, and select Create Port .

Result: The port is created but not shown in the project browser.

Communication Port Properties

To view the ports that exist for a board and their properties, right-click the board and select Open .

You can edit the following items.

Item

General

Attributes

Relationships

Identifier

Description

Port Number

Special Opt

IoDevice

Description

The identifier must be unique within the I/O server.

Optional.

You can enter a description of the port with free text.

Interrupt number of the port.

Leave it blank if you are using the COM port of the computer.

Lets you enter any special options that are supported by the board.

32 characters maximum.

For details, refer to Hardware Arrangements in the help of the

Supervision Participant.

Select the I/O devices that are associated with the communication port from the menu.

The

I/O device, page 232

must exist in the Supervision project cluster to be available for selection.

NOTE: By default, the software associates the port with the I/

O device that has been

during the assignment of Supervision data facets. If you have created the I/O device manually, associate it with the port.

Implementing Redundancy

Overview

The Supervision Participant allows you to build redundancy into the system at different levels to help increase the degree of protection and/or reliability. The common ways to implement redundancy are:

• I/O server redundancy

• Alarm, trend, and report server redundancy

• Network redundancy

The following topics describe the additional steps that you need to complete in order to implement such redundancy by starting from a typical Supervision project, which consists of one of each:

• Cluster

• Tag container

• I/O server with its client

• I/O device

• Communication board

236 EIO0000001114.15

Supervision Participant help, page

EIO0000001114.15

• Communication port

For more information, refer to the topic of the

, which describes how to build redundancy into a system.

I/O Server Redundancy

To implement I/O server redundancy, proceed as follows.

Step Action

From the Services node of the Supervision project, create a second I/O server.

From the Services node, create a client for this second I/O server.

From the Communications node of the second I/O server, create a communication board.

From this board, create a communication port.

From the IODevices node of the second I/O server, create an I/O device.

In the properties of the second I/O device, associate the I/O device with the tag container of the Supervision project, which is already associated to the first I/O device.

Result: The software automatically configures the StartupMode of the second I/O device as Standby with Priority 2 (or the next available value).

Refer to

Project definition stage

In the same window, configure the Ports property as Port_2 , which is the port of the communication board that you have created in step 4.

In the properties of the communication port of the second I/O server, verify that the port is associated to the standby I/O device under IODevice .

In the properties of the communication board of the second I/O server, configure Protocol with the same values as for the tag container, which is associated to the first I/O device.

From the system root folder, create a station node entity representing the second I/O server.

In the properties of the NIC of this station node, configure the IP address of the NIC.

On this station node, create one Supervision and one OFS service instances.

Connect this station node to the Ethernet network.

Once you have generated the complete Supervision project, from the project executable, perform the service mapping of the second I/O server to the station node that you have created in step 10.

From the project executable, map the standby I/O device to the same controller to which you have mapped the primary I/O device

(communication mapping).

Configuration stage

Mapping stage

Configure the physical computers according to the topology of the system, build, and deploy the Supervision project.

Build and

Deployment stage

Alarm, Trend, or Report Server Redundancy

To implement alarm, trend and/or report server redundancy, proceed as follows.

Step Action

1 From the Services node of the Supervision project, create a second alarm, trend and/or report server.

Result: The software:

• Creates the server with the _s suffix in its identifier.

• Configures its Mode as Standby .

2 From the system root folder, create a station node entity representing each redundant alarm, trend and/or report server.

Refer to

Project definition stage

Configuration stage

237

Step Action

3 In the Properties window of the NIC of each redundant station node, configure the IP address of each NIC.

On each redundant station node, create one Supervision service instance.

Connect each redundant station node to the Ethernet network.

Once you have generated the complete Supervision project, from the project executable, map each standby server to the corresponding redundant station node (service mapping).

Configure the physical computers according to the topology of the system, build, and deploy the Supervision project.

concurrent actions, page 52 . In such case, check the

Refer to

Mapping stage

Build and

Deployment stage

Network Redundancy

Network redundancy can be implemented for any Supervision station.

To implement network redundancy, for example, on the operation server, proceed as follows.

Step Action

In the station node entity representing the operation server (I/O server), create a second NIC.

In the Properties window of the second NIC, configure its IP address.

NOTE: It is not required to connect this NIC to an Ethernet network.

Configure the physical computers according to the topology of the system.

Build the Supervision project by using the Build All command.

NOTE: In the service mapping, no additional mapping is required as the engine that is mapped to the IOServer service is the station node.

Deploy the Supervision project either from the executable or from the station node by selecting either NIC.

Result: After restoring the Supervision project on the station node

(operation server), both network addresses are created in the Supervision

Participant and associated to the I/O server.

Refer to

Configuration stage

–

Build and

Mapping stages

Deployment and Execution stages

NOTE: No specific action is required in the Supervision project.

Managing Supervision Projects

Overview

This section describes how to use the Project Explorer to manage Supervision projects and project contents.

for details.

Exporting a Supervision Project

Overview

The export functionality lets you create a non-editable export file (.sbk), which contains selected Supervision project information.

238 EIO0000001114.15

before importing the project, page 244

You can use this data with the Supervision project

import, page 211

functionality to transfer Supervision project information to a different system or merge information from different Supervision projects.

NOTE: To export all the projects (Control and Supervision) of a system at once in one export file, right-click the root folder in either Project Browser , select Export , and follow the export procedure described in this section. Refer also to the topic describing the export and import of

Control projects, page

206

Software Version Compatibility

Project Related Data

To be able to use the export file for importing a project into a different system, verify that the instances, their templates, and topological entities related to the project exist in the target system

. Use the

export-import functionality, page 408

of the Topology Explorer first.

Project Export Window

The Supervision project Export window lets you select, which information the export file will contain.

EIO0000001114.15

239

The following figure shows an example of the Export window where the check box for TagContainer_2 has been cleared. To indicate that at least one item of the

Supervision project is not selected, the check box of parent nodes are filled with a square.

240

The table indicates the meaning of the colored dots that appear in the Export window next to items of a Supervision project.

Color code

Green

Red

Yellow

Description

You can export the item.

You cannot export the item because it contains at least one facet with the following state:

• Deleted

• Unassigned

• Out of Date

• Moved

Generate containers that contain facets with such states or clear their check box in the Export window in order to export the Supervision project.

NOTE: You cannot export items that are tagged with a red dot.

Indicates that the item contains at least one subitem that is tagged with a red dot.

The item can be exported partially only.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter .

EIO0000001114.15

equipment hierarchy, page 116

EIO0000001114.15

Export Settings

The table describes which Supervision project information you can export.

Item

SupervisionProject_n

Pages node

Pages

Cluster_n

Tags node

Tag containers

Selected for export

Description

By default Unselect the item to exclude the entire project from the export file.

When you select the project, the associated

is exported.

By default You cannot unselect the item.

By default Selecting a page automatically selects any genie facets that are assigned to it.

Selecting a page automatically selects the logical

Participant project.

By default You cannot unselect the item.

By default You can select tag containers individually.

Selecting a tag container automatically selects any facets that are assigned to it.

Services node

Alarm servers

I/O servers

Communications node

IODevices node

Trend servers

Report servers

Clients

ServerEvents

ClientEvents

Executables

Executable_n

By default You cannot unselect the item.

By default

By default Any associated boards and ports are selected by default.

You cannot unselect the item.

By default Any associated I/O devices are selected by default.

You cannot unselect the item.

By default You cannot unselect the item.

By default

Service

Mappings

By default

By default You can select each executable and its contents individually.

Selecting an executable automatically selects any associated mapping.

By default Contains data related to the service mapping including any required contents in the contents repository.

Communication Mappings

By default Contains data related to the communication mapping.

Built

Participant

Project

By default Represents the Supervision Participant file (.ctz)

(includes the OFS/OPC UA configuration files (.xml)).

It appears and is selected only if its build status is Built or Out Of Date .

Aborting Export Tasks

After confirming the export by clicking Save in the Export dialog box, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the

task. The export file is not created.

241

Only the user who has selected the command is allowed to abort it.

NOTE: If you are exporting a small project, the task may complete before you are able to click the icon.

Exporting a Supervision Project

To export a Supervision project to file, proceed as follows.

Step

Action

In the Supervision Project Browser , right-click the Supervision project that you want to export and select Export .

Result: The Export window opens and displays the Supervision project that you have selected.

Select the project components that you want to export.

Click OK .

Result: The Export window clsoes and the Export dialog box opens.

Select a location where you want to save the export file, enter a file name, and click

Save .

Result: The software creates the export file containing the selected Supervision project information.

NOTE: If you click Cancel , the the Export dialog box closes without creating the export file and the selection you have made in the Export window is discarded.

Importing a Supervision Project

Overview

The Import command lets you import data of a Supervision project from an export file (.sbk), which was created by using the

export, page 207

functionality of the

Project Explorer .

If the system into which you are importing a Supervision project already contains a

Supervision project with the same identifier, the software compares the data of both projects. It then proceeds with the partial import according to the import settings that you select and the import rules that are described in this topic.

NOTE: If the export file also contains information of a Control project, you can see the data that is related to the Control project, and have the choice to

import it, page 211

as well.

Item

SupervisionProject_n

Pages node

Pages

Software Version Compatibility

Import Settings

The table describes which Supervision project information you can import into a system.

Selected for import (1)

By default

Description

Unselect the item to exclude the entire project from the export file.

You cannot unselect the item.

You can select containers (pages) individually (2) .

Selecting a page automatically selects any genie facets that are assigned to it.

242 EIO0000001114.15

import behavior, page 246

Item Selected for import (1)

Description

Cluster_n

Tags node

Tag containers

Tag container Constituent File

By default

Selecting a page automatically selects the logical Participant project.

At least one cluster must be selected.

You cannot unselect a cluster when the export file contains only one cluster.

You cannot unselect the item.

You can select tag containers individually (2) .

Selecting a tag container automatically selects any facets that are assigned to it.

A Constituent File is associated to each tag container.

If the identifier of the imported tag container already exists in the target project, the selection of the constituent file has an impact on the

NOTE: The Constituent File check box is selected and disabled if the identifier of the imported tag container does not exist in the target project.

You cannot unselect the item.

Services node

Alarm servers

IOServer_n

Communications node

By default

IODevices node By default

Any associated boards and ports are selected by default.

You cannot unselect the item.

Any associated I/O devices are selected by default.

You cannot unselect the item.

Trend servers

Report servers

By default

Clients

ClientEvents

ServerEvents

Executables

Executable_n

By default

By default or not selectable

Service Mappings

Communication

Mappings

By default or not selectable

If the target system already contains an executable with the same identifier, you cannot select the executable for import.

Else, you can select each executable and its contents individually.

Selecting an executable automatically selects any associated mapping.

If a service mapping already exists in the target system, you cannot select the service mapping for import.

Contains data related to the service mapping including any required contents in the content repository.

If a communication mapping already exists in the target system, you cannot select the communication mapping for import.

Contains data related to the communication mapping.

Built Participant

Project

By default Represents the built Supervision Participant file (.ctz) (includes the OFS/

OPC UA configuration files (.xml)).

It appears and is selected only if the built Participant project was selected at the time of export.

(1) The information needs to be contained in the export file to be selected

(2) The item is available for selection only if it is tagged with a green dot; otherwise the item cannot be selected.

EIO0000001114.15

243

contained in the export file, page 250

Import Rules for Included Projects

At the time of import, the software checks whether the content repository of the target system contains an included project that has the same identifier as the one contained in the export file.

The following figure shows an example of the Resolve Content Conflict dialog box that opens if the software detects the presence of an included project with the same identifier.

244

Header

Identifier

Conflicts

Version in contents repository

Version in export file

Description

The identifier of the included project for which a conflict exists.

The identifier of the Supervision Participant projects that exist in the target system and use the version of the included project that is in the content repository.

By selecting this check box, you use the version of the included project that is in the content repository.

Selected by default.

By selecting this check box, you use the version of the included project that is

and overwrite the version that is in the repository.

Included projects contain data related to Supervision constituents (for example, genies, tags, and so on), which can be shared by several templates.

Replacing the existing included project has an impact on:

• The templates that use the contents of the included project.

• The Supervision Participant projects to which the included project is associated.

NOTICE

LOSS OF DATA

Resolve an included project conflict that arises during the import of a

Supervision Participant project by selecting the correct version of the included project to be imported.

Failure to follow these instructions can result in unusable Supervision projects.

Import Rules for Project-Related Objects

Facets assigned to Supervision projects are related to instances of the application and mappings of project executables are related to entities of the topology. For the

Supervision project import to complete entirely, these project-related objects need to be present in the system in which you want to import the project.

EIO0000001114.15

A dialog box opens, page 249

The table describes the impact on the import operation when project-related objects are not present or have a different configuration. It also describes the corrective action.

Project-related object that is not present or different

The instances whose facets are assigned to the

Supervision project that you are importing

(same identifier, template identifier, template version, and status Valid ).

An element of the instance creating a facet that is being imported is not selected.

Impact if not present in the target system

You can import the project but not the tag and page containers to which such facets are assigned. This requires that the project contains at least one container that

can be imported, page

248

, even empty.

confirm the partial import.

asking you to

The facet that is normally created by this element is not imported.

The notification panel provides information about the facet that is not imported.

For example, you import a Supervision project to which the data facet created by the

Maintenance element of an instance is assigned but in the application of the target system, the

Maintenance element of the same instance is not selected.

The assignment status of facets that are imported is set to Out Of Date .

Required action

Do either of the following first to create missing instances:

• Use the

export/import functionality, page 168

of the

Application Explorer to import missing instances.

• Create instances. This may require importing templates first.

You can obtain information about the missing instances and their templates in the tooltip of the container that is tagged with a red dot.

Edit the instance in the Application

Explorer and select the corresponding element.

Generate the project or container to apply the changes.

The properties of an instance are different from the instance configuration at the time of export.

The difference lies in the

element selection

(services) and/or the parameter values, page

134

Topological entities to which you have mapped the executable of the project (service and/or communication) that you are importing (same identifier, same devices (for example, NIC for a station node), and services).

You can import the project but not the

Supervision project executable and any of its associated mappings.

Use the

export-import functionality, page 408

Explorer of the Topology first to create the missing topological entities.

Import Rules for Equipment

When you import a Supervision project and a project with the same identifier already exists in the target system, for an instance that exists in the same cluster in both the imported file and the Supervision project, the

equipment, page 329

that is already generated in the Supervision project prevails. This applies independently of the selection of the

Constituent File , page 246

of the tag container.

Example :

Equipment in the Participant project after import

Identifier of instance present in imported file and

Supervision project

MyMotor_1 (1)

Equipment name generated by the imported instance

Folder_1.MyMotor_1

(2)

(1) The instance is located in Folder_1 .

(2) Facets of the instance are assigned to TagContainer_1 in Cluster_1 .

Equipment name generated by the instance in the

Supervision project

Folder_2.MyMotor_1

(2) Folder_2.MyMotor_1

Import Rules for Pages

When you select to import a page that is contained in an export file, and a page with the same identifier exists in the target system, the contents of the existing page is overwritten with the content of the page that is in the export file.

EIO0000001114.15

245

246

property of an instance, page 134

Import Rules for Facets

The software applies import rules to facets if the system into which you are importing a Supervision project already contains a Supervision project with the same identifier.

The following are the general import rules that the software applies if facets with the same identifier contained in tag containers with the same identifier exist in both the target project and the export file that you are importing:

• If you select the constituent file of the tag container:

◦ Facets from the export file overwrite facets of the target system and maintain the state they have in the export file.

◦ Facets that exist only in the export file are imported into the target system and maintain the state they have in the export file.

◦ Facets that exist only in the target system become Assigned and Non

Generated . If the status of the facet is deleted, unassigned, or unlinked, the software removes the facet from the tag container after import.

• If you unselect the constituent file of the tag container:

◦ Facets with the same identifier maintain the state that they have in the target system.

◦ Facets that exist only in the export file are imported into the target system and become Assigned and Non Generated .

◦ Facets that exist only in the target system maintain their state.

NOTE: The software changes the assignment status of any facet of an instance to Out Of Date if a

is different from what it was at the time of export. This includes the location of the instance in the application. The notification panel provides information about the change of the assignment status after import is complete.

The following tables illustrate these import rules based on the different use cases.

The tag container and facet names are examples, and represent tag containers and facets in a cluster of the project.

If you select the tag container Constituent File option.

Contents of export file selected for import

Item in Supervision project of target system

Result in Supervision project of target system after import

Tag container identifier is identical

Tag container1

Facet1 Tag container1

–

Facet1

Facet2

Facet1 from export file with status from export file.

Facet2 with status non-generated.

If the status of Facet2 is deleted, unassigned or unlinked, the facet is removed from the tag container after import.

Tag container identifier does not exist in target project

Tag container2

Facet3 – – Tag container2 with Facet3 from export file with status from export file.

– The item does not exist

If you do not select the tag container Constituent File option.

EIO0000001114.15

EIO0000001114.15

Contents of export file selected for import

Item in Supervision project of target system

Container identifier is identical

Tag container1

Facet1 Tag container1

Tag container1

Facet1 Tag container1

–

Facet1

Facet2

Result in Supervision project of target system after import

Facet1 from export file with status non-generated.

Facet1 from target system with same status.

Facet1 from target system with status nongenerated.

Facet2 from target system with same status.

– The item does not exist

Import Rules for Executables and Mappings

The software updates the

Build State , page 469

of a Built executable after import depending on the scenario.

If the system into which you are importing a Supervision project does not contain a

Supervision project with the same identifier, the state of Built executables that you import changes to Out Of Date .

If the system into which you are importing a Supervision project already contains a

Supervision project and an executable with the same identifier, the software applies import rules to executables, service, and communication mappings. These rules are described in the following tables.

The table illustrates the import rules that apply to a Built executable based on different scenarios.

Contents of export file selected for import

Executable1

Item in Supervision project of target system

Does not exist

Executable1

Executable2

Resulting built state in Supervision project of target system after import

Out Of Date

Executable1: Out Of Date

Executable2: Out Of Date

The table illustrates the import rules that apply to mappings based on different scenarios.

Contents of export file selected for import

Service mapping

Item in Supervision project of target system

Exists

Result in Supervision project of target system after import

Communication mapping

Does not exist

Exists

Does not exist

Service mapping from target system is not changed.

Service mapping is created with the mapping information from the export file.

Communication mapping from target system is not changed.

Communication mapping is created with the mapping information from the export file.

Opening the Project Import Window

To open the Import window, proceed as follows.

247

abort the command, page 250 .

Step

Action

Right-click the system root folder in a Project Browser of the Project Explorer and select Import .

Result: The Import dialog box opens.

Browse to the export file (.sbk) that contains the project information that you want to import and click Open .

Result: The Import window opens and displays the contents of the file that you have selected.

NOTE: You can

Project Import Window

The Import window lets you select the information of a Supervision project that is contained in an export file that you want to import into an existing system.

The following figure shows an example of the Import window displaying the contents of a Supervision project export file. In this example, the check boxes for

TagContainer_2 and relate mappings are cleared because the items cannot be imported. To indicate that at least one item of the Supervision project is not selected, the check box of parent nodes are filled with a square.

248

The table indicates the meaning of the colored dots that appear in the Import window next to items of a Supervision project.

EIO0000001114.15

not present in the application, page 244 .

Color code

Green

Red

Yellow

Description

You can import the item.

• At the container level: The container (for example, the tag container or the page) contains at least one facet that is referenced by an instance, which is

• At the executable level:

◦ An executable with the same identifier already exists in the target project.

◦ A

is not present in the target system.

A tooltip provides additional information about the issue.

NOTE: You cannot import items that are tagged with a red dot.

The item contains at least one subitem that is tagged with a red dot.

The item can be imported partially only.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter .

Confirmation Dialog Box for Containers That Cannot Be

Imported

The following figure shows an example of the dialog box that opens when a container of a Supervision project selected for import is tagged with a red dot and you click OK in the Import window. If you are also importing Control projects, containers are grouped by Participant then by project.

EIO0000001114.15

Button

Yes

Description

Closes the dialog box, the Import window, and imports the selected projects without containers tagged with a red dot.

Closes the dialog box and reverts to the Import window without importing projects. You can modify the selection of projects or cancel the import operation.

249

250

Aborting Import Tasks

After confirming the import by clicking OK in the Import window, the abort icon is displayed in the

window, page 247 , select the items that you want to import.

. Click the icon to cancel the task. The project is not imported.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are importing a small project, the task may complete before you are able to click the icon.

Importing a Supervision Project

Included projects contain data related to Supervision constituents (for example, genies, tags, and so on), which can be shared by several templates.

Replacing the existing included project has an impact on:

• The templates that use the contents of the included project.

• The Supervision Participant projects to which the included project is associated.

NOTICE

LOSS OF DATA

Resolve an included project conflict that arises during the import of a

Supervision Participant project by selecting the correct version of the included project to be imported.

Failure to follow these instructions can result in unusable Supervision projects.

To import data of a Supervision project into an existing system, proceed as follows.

Step

Action

In the Import

Click OK .

Result: The software:

• Applies the import rules based on your import selection.

• If the applicable rules are satisfied, it proceeds with the import; If it detects a conflict with the name of an included project, it displays the Resolve Content

Conflict

dialog box, page 244

• Displays a summary of the completed actions and detected incompatibilities in the

Notification Panel .

NOTE: Click Cancel to close the Import window without importing project information.

If the software displays the Resolve Content Conflict dialog box, do one of the following:

• Select Version in export file to overwrite the existing included project with the one contained in the export file that you are importing.

• Select Version in contents repository to keep the existing included project.

Click OK .

Result: The software proceeds according to your selection.

NOTE: Click Cancel to discard your selection in the Resolve Content Conflict dialog box and revert to the Import window.

EIO0000001114.15

checked-out icon, page 254

Participant Project Indicators

Overview

This topic describes the various indicators that appear on components of Control and Supervision Participant projects.

Participant Project Progress Indicators

Overview

Various icons give an indication of the steps that remain before the system engineering life cycle is completed up to the deployment stage for Control and

Supervision projects.

The progress icon is not visible while the

is shown.

NOTE: The indicator icons are visible to any user who opens the Participant project.

Meaning of Icons

For Control and Supervision projects.

Icon Condition description

Either one applies:

• 0% progress for all project containers.

• At least one facet is

candidate, page 260

for assignment.

(0% progress)

The progress of at least one container is not 100%.

Either one applies:

• The progress of all containers is 100% and no executable exists.

• The project progress is 75% and executables are deleted.

The progress of at least one executable is not 100%.

No icon

(100% progress)

The progress of at least one executable is 100%.

For sections and containers.

Icon Condition description

Either one applies:

• No assignment is done.

• All assignments have been removed.

(0% progress)

At least one facet is Non Generated .

At least one

facet, page 319

is Out Of Date , Deleted , UnAssigned , Moved ,

Inconsistent , or Invalid and no facet is Non Generated .

All facets are Generated but the

analysis detected one or more errors, page 252 .

No icon

(100% progress)

All facets are Generated or Unlinked without detected errors during analysis.

For executables.

EIO0000001114.15

251

service mapping, page 420

Icon

(0% progress)

Condition description

Either one applies:

• The executable is created.

• Executable progress is 100% and

is removed.

• Control: Service mapping is completed.

• Supervision: Service mapping is done for at least one service.

Or, executable progress is 100% and service mapping is modified.

• Control: At least one communication mapping or hardware mapping is done.

• Supervision: Communication mapping is completed.

And the executable state is Not Built .

The executable state is Out Of Date or Built with

alerts, page 254 .

No icon

(100% progress)

The executable state is Built .

How Icons Appear

The following figure shows an example of several Control projects and their components that have various completion states, which are indicated by progress icons.

Participant Project Validity Indicators

Overview

A dot or

progress icon, page 251

that appears in red or yellow color indicates an

alert or detected error, page 254

during the analysis of components of a

Participant project.

When both an alert and the detection of an error occur for the same object, the detected error icon prevails.

When an icon appears on at least one component of a project (for example, a section, a container, an executable), it appears automatically at the project level.

The indicator icons are visible to any user who opens the Participant project.

NOTE: The

last action summary, page 254

can help provide information about issues that are not indicated by validity icons.

252 EIO0000001114.15

Meaning of Icons

Icon color

Yellow

(progress icon or dot for objects with 100% progress)

Example :

Level

Project

Section

Red

(progress icon or dot for objects with 100% progress)

Example :

Tag container or page

Page

Executable

Project

Section

Tag container or page

Page

Executable

Condition description

• Control projects: The

of the project or

generated an alert indicating that the build operation may not complete successfully.

• Supervision projects: Saving changes generated an alert.

• All projects: At least one alert was generated for a project component.

The

of the section or

generated an alert indicating that the build operation may not complete successfully.

Generation completed with at least one alert.

Saving changes generated at least one alert.

Build completed with at least one alert.

• Control projects: The

of the project or

detected an error, which prevents the build operation from completing successfully.

• Supervision projects: Saving changes detected an error.

• All projects: There is at least one detected error for a project component.

The

of the section or

detected an error, which prevents the build operation from completing successfully.

Generation completed with at least one detected error.

Saving changes detected at least one error.

Build did not complete successfully.

How Icons Appear

The following figure shows an example of several Control projects and their components that have various validity states, which are indicated by the color of the progress icons.

EIO0000001114.15

Valid project with 50% progress.

Project with 25% progress and at least one alert.

The detected error at the section level is also shown at the project level.

253

Participant Project Write-Lock Indicator

Overview

A lock icon lets you see which Participant project components are being used or modified by other processes or users and that you cannot work on them.

Certain components that are locked can be opened in read-only mode.

NOTE: The indicator icon is visible to any user who opens the Participant project.

Meaning of the Icon

The icon indicates that the project or a component is locked because an operation is in progress, such as:

• Assignment (1)

• Generation

• Refinement

• Editing

• Mapping (1)

• Export/import

• Build

(1) The lock icon appears very briefly while an performed is performed.

Where the Icon Appears

The lock icon can appear at the following levels:

• The Participant project

• Sections

• Containers (such as Supervision pages or tag containers)

• Clusters

• Services node and any of its subcomponents (such as servers, I/O devices)

• ClientEvents and ServerEvents nodes

• Executables

Viewing the Last Action Summary

Overview

The Last Action Summary command lets you view the last action that was performed on a given Participant project component and a summary of the result.

The command is available in the context menu of projects and their components.

For actions that had not completed successfully or with alerts, and/or detected errors, it shows again the information that was displayed originally.

Supported Actions

An action summary is available after you perform either action:

• Generation

• Regeneration

• Build

254 EIO0000001114.15

Particular Conditions

Last action performed

Not a supported action.

A supported action was aborted.

An action summary for aborted actions is not available.

The action summary for the previous action remains available

(if applicable).

Import of a Participant project.

Result

The command is unavailable.

The action summary that existed at the time of export is cleared.

NOTE: The last action summary of the target project is preserved when you perform an incremental import. That is, when you import a project into a system in which a project with the same identifier already exists.

EIO0000001114.15

255

Creating and Managing Sections and Containers........................................... 256

What’s in This Chapter

Assigning Facets of Instances ...................................................................... 268

Managing Assigned Facets .......................................................................... 292

Overview

This chapter describes how to create Control and Supervision containers and assign facets of instances of the application to the corresponding projects that you have created during the Projects Definition stage.

The following figure shows the position of the Assignment stage within the system engineering life cycle.

Refer to the

Assignment stage, page 34

for a description of the purpose of this stage.

Creating and Managing Sections and Containers

Overview

This section describes the Assignment Editor and how to use it to create and manage Control sections and Supervision containers. It also describes section and container context menu commands and properties.

concurrent actions, page 52 . In such case, check the

for details.

Assignment Editor

Overview

The Assignment Editor lets you create and manage Control and Supervision containers and assign the facets of instances of the application to them.

256 EIO0000001114.15

extent of the assignment, page 261

Section creation

Automatic, user-defined.

With possibility to:

•

Rename sections, page

277

• Select which sections to create

Manual

You can assign by facet, instance, folder, or entire application depending on the

that you want to perform.

The editor gives you the flexibility to assign manually, automatically, or by combining both methods.

The following table describes the two methods that you can use to

assign facets to

Control projects, page 279 .

Facet assignment

Automatic (1) , user-defined, with possibility to

preview assignments, page 277

Prerequisite

Configure assignment mechanism, page 268 .

Manual

Create sections, page 261

(1) By default, remaining candidate facets are

Supervision projects, page 281 .

during generation

How to use

Assign objects by dragging them to the project.

Assign objects by dragging them to a section.

The following table describes the methods that you can use to

assign facets to

Tag container creation

Automatic

With possibility to:

•

Rename tag containers, page 277

• Select the cluster

Manual

Facet assignment

Automatic (1) with possibility to

preview assignments, page

277

Prerequisite

Create additional clusters, page

229

as needed.

How to use

Assign objects by dragging them to the project.

Manual

Automatic, page 285

Create

tag containers, page 263

in the Assignment Editor and additional

clusters, page 229

(as needed).

You have associated a Control project to the tag container.

Assign objects by dragging them to the tag container.

Assigning instances to the

Control project automatically assigns the corresponding

Supervision facets to the tag container.

(1) By default, remaining candidate facets are

during generation

Opening the Assignment Editor

In a Control or Supervision project browser of the Project Explorer , double-click the Containers

node, page 201

of the project to which you want to assign facets.

NOTE: You can also open the Assignment Editor by using the

View

Assignments , page 294

window.

Assignment Editor

The Assignment Editor for Control and Supervision projects is identical except for the color scheme of the Containers and Assignments pane:

• Blue: Displays facets, containers, and assignments of Control projects.

• Orange: Displays facets, containers, and assignments of Supervision projects.

EIO0000001114.15

257

The following figure shows an example of the Assignment Editor for Control projects.

258

The following figure shows an example of the Assignment Editor for Supervision projects. The Instances and Facets panes are minimized to a tab by unpinning the Instances pane.

Instances pane. Shows the compatible instances of the application that have a valid Data and Link status.

Facets pane. Shows Participant-specific facets, which are referenced by the items that are selected in the Instances pane. The pane is empty by default. Supervision genie facets are not displayed.

Containers pane. Shows the project and its sections or containers. This pane is used to select the target to which you want to assign facets.

Assignments pane. Shows facets that are assigned to the project or container that is selected in the Containers pane. The title bar of the pane is where you drag objects to assign them.

You can select which

columns, page 260

you want to see in each pane.

Button to toggle between grid and tree view in the Instances pane.

Button to show or hide

facets, page 261

in the Facets pane. The

Instances pane must be pinned.

Button to toggle between grid and tree view in the Containers

pane, page

260 .

Button to

show or hide, page 85

the Instances and Facets panes.

Button to extract or retract the Instances pane.

Project node, which gives you access to project-level context menu commands.

The following tables describe the information that appears in the panes of the

Assignment Editor .

Instances pane.

Description Column header

Instance

Template

Version

Identifier of the instance.

Identifier of the template that the instance is using.

Version of the template that the instance is using.

EIO0000001114.15

Assignment Viewer , page 294

EIO0000001114.15

Column header

Assigned

State

Path

Description

• Assigned : At least one Control or Supervision facet of the instance is assigned to a project of the system.

• Unassigned : No facet of the instance is assigned to any project of the system.

Path to the instance in the tree view of the Application Browser .

The column appears only if you have selected the grid view display mode.

Candidate Provides information about the assignment of facets at the instance level:

• Done : The facets of the instance are already assigned to this project.

• Candidate : The instance contains at least one facet that is not yet assigned to this project.

Description

Contents of the $Description parameter of the instance.

Facets pane.

Column header

Instance

Template

Facet

Template

Description

Identifier of the instance that references the facet.

Identifier of the template that the instance that references the facet is using.

Identifier of the facet.

Identifier of the template that the facet is using.

Path

System

Project

Path to the facet as it is shown in the

Indicates the assignment (1) status of the facet at the system level:

• Assigned : The facet is already assigned to a project of the system.

• Not assigned : The facet is not yet assigned to a project of the system.

Indicates the assignment status of the facet at the project level:

• Candidate : You have not yet assigned the facet to this project.

• Done : You have already assigned the facet (1) .

Type Provides information on the subtype of the facet.

(1) Generating the section that contains the facet may change this status depending on the actions that you have executed on the facet (for example, unassigning it after a first generation). The

Assignment column of the Assignments pane provides you with a more detailed information on the assignment status of the facet.

Containers pane.

Column header

Path

Description

Container

Order

For a Control project, indicates whether the section belongs to the MAST or FAST task folder.

For a Supervision project, indicates to which cluster the container belongs.

Shows the identifier of the project and the sections or containers that it contains.

An icon indicates the language of a section or the type of container.

NOTE: Although Supervision pages appear, you cannot

assign genie facets, page 360

to them by using the Assignment Editor .

For Control projects, indicates the order in which the software generates the sections.

You can

change the order of sections, page 207 .

For more detailed information on how the software manages the section order, refer to the

generation process description, page 303 .

NOTE: The order is not shown in tree view mode.

For a description of the Assignments pane, refer to the topic

Assigned Facet

Description , page 282

259

representation of the application structure in Control projects, page 287

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking a column header and selecting Customize . Certain columns are always shown.

When you hide a column for which a filter is applied, the filter is cleared.

If tree and grid view are available, you may be able to configure the column display independently in each view.

Displaying Sections in Tree View Mode

The tree view mode allows you to view sections to which facets are assigned in relation to the folder structure of the application.

For more details, refer to the topic describing the

The figure shows an example of the Containers pane in tree view mode once facets have been assigned to some FBD sections.

260

3 item

Description

System root folder and subfolders representing the folder structure of the application.

NOTE:

Predefined folder icons, page 129

that you may have assigned in the application to various folder levels are not represented.

Section identifier.

Special root folders.

Viewing Instances with Facets That Can Be Assigned

To view the instances of the entire application, which have facets that can be assigned to the project, proceed as follows.

Step

Action

Switch to grid view mode by clicking the button in the Instances pane.

Click the button to show the candidate column in the Instances pane.

Result: The Instances pane displays the instances of the entire application.

Those that have a status of Candidate in the Candidate column have facets that can be assigned to this project.

EIO0000001114.15

instance progress icons, page 144

NOTE: Use the

to see which instances have facets that need to be assigned.

Viewing Facets That Can Be Assigned

To view the facets of the entire application that can be assigned to the project, proceed as follows.

Step

Action

Switch to tree view mode by clicking the button in the Instances pane.

In the Instances pane, select the system root folder.

Click the button to show facets in the Instances pane.

Result: The Facets pane displays the facets of the entire application.

Those that have a status of Candidate in the Project column can be assigned to this project.

NOTE:

• To view only the facets with status Candidate , use the filter on the

Project column.

• To narrow the display to part of the application, select an application folder instead of the system root folder.

Object Selection

The following table describes the scope of the assignment depending on the objects that you drag from the Instances or Facets pane of either Assignment

Editor . Each editor assigns only Participant-specific facets.

Object

One or more facets of the same or several instances.

One or more instances.

One or more folders.

Resulting assignment

These facets only.

Remaining facets are

assigned automatically, page 284 .

The facets of all the selected instances.

The facets of all the instances that are contained in the selected folders.

By dragging the system root folder, you can assign facets of the entire application at once.

NOTE: If the facet that you are trying to assign is not compatible with the selected container, you cannot create the assignment and a tooltip indicates it.

If you are trying to assign multiple items at once and some of them are not compatible, the assignment is created for the compatible ones and information about the other ones is displayed in the notification panel.

Creating Control Project Sections

Overview

In the Assignment Editor , you can create only FBD sections in a Control

Participant project.

This topic describes how to create sections manually. Sections can also be

created automatically, page 268

To create non-FBD sections, refer to the topic describing the Project Explorer .

Creating FBD Sections

To create an FBD section in the Assignment Editor , proceed as follows.

EIO0000001114.15

261

262

Step

Creates a new FBD section, page 262

Action

Right-click the identifier of the Control project in the Containers pane and select Create

FBD Section .

Result: The Create FBD Section dialog box opens.

Edit the

identifier, page 262

of the section if required, select the MAST or FAST task folder, and click OK .

Result: A new FBD section is created with the next available

order value, page 207 .

Inserting FBD Sections

To insert an FBD section, proceed as follows.

Step

Action

In the Containers pane of the Assignment Editor , right-click the section where you want to insert the new one and select Insert FBD Section .

Result: The Insert FBD Section dialog box opens.

Edit the

identifier, page 262

of the section and click OK .

Result : The newly created section is inserted and has the

order, page 207

of the section that you had right-clicked. The order of the section that you right-clicked and those that follow is incremented by 1.

Section Actions

The table describes the context menu commands of sections.

Command

Insert FBD

Section

Generate

Description

at the position of this section.

Refine

ReGenerate

Delete

Rename

Properties

Refer to

Generation Stage , page 297 .

The command is only available for FBD sections.

Refer to

Refinement Stage , page 336 .

The command is not available for LL984 sections.

Refer to

Generation Stage , page 327 .

The command is only available for FBD sections.

Deletes the section.

If you have

assigned, page 256

facets to the section, the software:

•

Unassigns, page 293

any facets contained in the FBD section that you are deleting.

• Change the System

status, page 320

of the facets to Not assigned .

NOTE: If the FBD section has been generated, deleting it also removes from the logical Control Participant project the section and constituents that were generated by the facets assigned to the section (for example, variables).

However, derived types that were generated by these facets are not removed

(for example, DFBs and DDTs). To remove these, you can either:

•

Regenerate, page 327

the Control project. This discards refinements.

• Purge the types from the Control Participant during refinement. For details, refer to Purge of Unused Instances in the Control Participant help.

Lets you edit the

identifier, page 262

of the section.

Opens the Properties window of the section.

Section Properties

To open the Properties window of a section, right-click the section and select

Properties .

EIO0000001114.15

assign facets, page 256 .

You can edit the following items.

Item

General Identifier

Description

Depending on how you create the section, the default identifier can be either:

• FBDSection_n if you create the FBD section manually, using the Create FBD Section command, where n is an incremental number starting at 1.

• The concatenation of instance identifier_instance template identifier if the software creates the section automatically during assignment.

NOTE: For identifiers of Schneider Electric templates, the

$ prefix is omitted.

The identifier must be unique within the Control project.

The software allows only the use of identifiers that satisfy the

naming rules, page 66 .

Description Optional.

You can enter a description of the section with free form text.

Generated

Date and time of the last successful generation or regeneration of the section.

The property is read-only and contains information only for FBD sections.

Creating Supervision Tag Containers

Overview

This topic describes how to create tag containers manually by using the

Assignment Editor , their properties, and context menu commands. The software creates tag containers automatically when you

You need to create, at least, one tag container per controller to assign Supervision data facets of instances of the application.

These data facets represent the tags that are managed by Supervision components and assigned to the I/O device variables to be associated to the

Supervision Participant project:

• Variable tags

• Trend tags

• Alarm tags

Monitoring data of a device, page 639

communicating by using the Modbus TCP protocol (or Modbus through an Ethernet gateway) from the Supervision infrastructure requires creating, in addition, one tag container for each device.

Supervision Data facets representing device-specific data are assigned to each container. Also, a specific communication protocol needs to be defined for these tag containers.

Creating Tag Containers

To create a tag container in the Assignment Editor , proceed as follows.

Step

Action

Right-click the identifier of the Supervision project in the Containers pane and select

Create Tag Container .

Result: The Create Tag Container dialog box opens.

Edit the

identifier, page 264

of the tag container if required, select an existing cluster, and click OK .

Result: A new tag container is created.

EIO0000001114.15

263

264

parameter of the tag container, page

Using a User-Defined Protocol

When you enter a protocol in the Protocol

264

instead of selecting a predefined one, verify the following:

• The protocol is supported by the platform of the controller that is the data source of the variable tags; otherwise, the variables cannot be read and/or written to by Supervision software.

• It is supported by the Supervision Participant and installed; otherwise, you cannot build the Supervision executable.

To verify which protocols are installed in the Supervision Participant, refine the Supervision Participant project and expand an entry in the Protocol column of I/O Devices in the Topology activity.

If the protocol is not installed, contact EcoStruxure Process Expert support .

When using a user-defined protocol, some data generated at the template level, such as variable tag addresses may not be in the required protocol-specific format depending on the template configuration. After generating the Supervision

Participant project, refine it and edit the data as needed. No configuration file (.

xml) is generated when you build the Supervision Participant project.

NOTE: For communication with the I/O server, ensure that the

protocol of the communication board, page 235

is correctly configured.

Tag Container Actions

The table describes the tag container context menu commands.

Command

Create

Tag

Container

Generate , page 321

Delete

Rename

Properties

Description

Lets you create a new tag container in an existing cluster.

Starts the generation process to populate new tags, update out-of-date tags, and/or remove deleted tags in the Supervision Participant project.

Deletes the tag container.

If you have assigned facets to the container, the software:

• Unassigns the facets contained in the container that you are deleting.

• Changes the system status of the facets to Not assigned .

NOTE: The software does not delete the servers that it may have created during the assignment of Supervision facets.

NOTE: If the container has been generated, deleting it also deletes the data in the logical Participant project when you generate the project again.

Lets you enter a new identifier for the tag container.

Opens the Properties window, which allows you to edit the properties of the tag container.

Tag Container Properties

To open the Properties window of the tag container, right-click the container and select Properties .

You can edit the following items.

EIO0000001114.15

OFS configuration file, page 475

EIO0000001114.15

Item

General Identifier

Description

The identifier must be unique within the Supervision project.

Generated

Attributes ScanTime

Default value: TagContainer_n where n is an incremental number starting at 1.

NOTE: When Protocol for the tag container is set to OPCUA , the identifier is used as follows:

• During generation, it becomes part of the variable tag address in the Supervision Participant project. The format of the address is ns=2;s=0:<tag container ID>!<variable name> , where ns indicates the namespace and 2 corresponds to the OPC UA server as defined by

Schneider Electric.

For example, ns=2;s=0:Controller1!InputVar1

• During build, it becomes the alias for the device in the

Therefore, it may be useful to rename the tag container with the identifier of the controller that is mapped to the

associated I/O device, page 460

Description Optional.

You can enter a description of the container with free text.

Date and time of the last successful generation of the tag container

(read-only).

Protocol

The acquisition time for the tags that are assigned to the container.

msec

Default value: 0

The protocol that is used for communication with the I/O device.

The menu contains the following values:

• OFSOPC (default)

• OPCUA

NOTE: When using the OPC UA protocol with templates of a Schneider Electric library, clear the Use Native Types checkbox of the Unity/Control Expert symbols parameter (selected by default) so that the correct Control

Participant types are used by the OPC UA server. For details, refer to PLC Software Settings in the OPC UA

Server Expert help.

• OPCUA Embedded : When the OPC UA server is embedded in a module (see EcoStruxure ™ Process Expert, Control

Participant Services, User Guide) of the controller. Sets the protocol of the associated I/O device to OPCUA in the

Supervision Participant project.

•

User-defined protocol, page 264

whose name can be entered by using free-form text. 16 characters maximum. Values entered are added to the menu.

When you instantiate Schneider Electric templates and assign their

Supervision facets to the Supervision project, only OFSOPC .

OPCUA , and OPCUA Embedded are supported. This is because, by default, the facets generate Supervision data (variables and tags) that is specific to these protocols. To use another protocol, you can add the protocol-specific Supervision data to the project either by instantiating and configuring the $VariableTag_CD template or by refining the Supervision project.

NOTE: For each additional tag container that you create to monitor data of a device directly from the Supervision runtime, change the value to OPC .

Attributes Direct TCP

Addressing

Mode (1)

For information on the corresponding driver, refer to the driver help. To locate driver help files, look up Driver Reference Help in the

help of the Supervision Participant, page 69

Sets the addressing mode for the TCP IP driver in the OFS/OPC UA configuration file. Select the mode depending on the Modbus TCP

topological entity, page 460

that is mapped to the associated I/O device in the Communication Mapping tab.

The parameter is disabled when Protocol for the tag container is set to OPCUA Embedded .

Possible values:

265

266

assign Supervision facets to the container, page 281 . If

Item Description

• Unallocated/Allocated Data, PAC Modicon (/U) (default):

Corresponds to selecting UNITY / Control Expert in the PLCs section of the Device address wizard in the OFS/OPC UA configuration tool. Use this setting when mapping a controller or station node.

• Allocated Data, Offset 0 (/T) : Corresponds to selecting PL7 in the PLCs section.

• Allocated Data, Offset 0 with minimum communication

(/NT) : Corresponds to selecting PL7 in the PLCs section and

Minimum communication profile .

• Allocated Data, Offset 1 (/Q) : Corresponds to selecting

CONCEPT in the PLCs section.

• Allocated Data, Offset 1 with 32 bits swapping (/QW) :

Corresponds to selecting CONCEPT in the PLCs section and

Swap 32-bit Values .

• Allocated Data, Offset 1 (/NQ) : Corresponds to selecting

MODBUS Device in the PLCs section.

The value is available only when Protocol is set to OPCUA .

NOTE: The value shown in brackets corresponds to the suffix that is appended to the device address in the configuration file.

For more information, refer to:

• Editing the Device Network Address in the

help of OPC

Factory Server, page 77

• Managing Device Aliases in the help of OPC UA Server

Expert.

Attributes Supports

Optimized

Modbus

Frames (1)

Corresponds to the Modbus Request Optimization parameter of

Communication Settings in the OFS configuration tool.

Possible values:

• Off (default): The check box of the parameter is cleared.

• On : The check box of the parameter is selected.

The parameter is not available for the OPCUA protocol.

NOTE: Because in OFS, this parameter applies to all aliases of the OFS configuration file, if you configure several tag containers in a Supervision project and for one of them you select Off , the check box of the parameter in the OFS configuration file is cleared, overriding the On setting that you may have configured for any other tag container.

Select the I/O device that you want to associate with the container.

Relationships

IoDevices

The I/O device appears in the menu once you have created it or assigned facets.

Default value: IODevice_1

NOTE:

• By default, the software associates the tag container with the I/O device that it automatically creates when you

you

create the I/O device manually, page 232

, associate it with the tag container before or after assigning facets.

• Changing the relationship after assigning facets to the tag container changes their assignment status to Out Of Date .

Associated

Control

Project

Lets you select one existing Control project that will trigger the

automatic assignment, page 285

of Supervision facets to the tag container when you assign Control facets.

You can associate a Control project to several tag containers given they belong to a different Supervision project.

When the associated Control project is renamed, the value is updated. When it is deleted, the value is reset.

Default value: Not Assigned

(1) The parameter becomes read-only when Protocol is different than OFSOPC or OPC UA .

EIO0000001114.15

Creating Supervision Pages

Prerequisites

Generate the Supervision project before creating pages.

Creating Supervision Pages

To create a page in the Assignment Editor , proceed as follows.

Step

Action

Right-click the identifier of the Supervision project in the Containers pane and select

Create Page .

Result: A new page is created.

Supervision Page Actions

The table describes the page context menu commands.

Command

Create

Page

Edit , page

361

Description

Lets you create a new Supervision page.

Opens the Supervision Participant, which allows you to assign to the page animated graphics that are associated with the instances of the Supervision project. It also allows you to add graphic elements to the page to represent process hardware.

Generate , page 321

Delete

Rename

Properties

Starts the generation process to update out-of-date genies, and/or remove deleted genies in the Supervision Participant project.

Deletes the page including assignments of animated graphics.

Lets you enter a new identifier for the page.

Opens the Properties window, which allows you to edit the properties of the page.

Supervision Page Properties

To access the Properties window of the Supervision page, right-click the page and select Properties .

You can edit the following items.

Item

General Identifier

Description

The identifier must be unique within the Supervision project.

The software allows only the use of identifiers that satisfy the

Description Optional.

You can enter a description of the page with free form text.

Generated On Date and time of the last successful generation of the page (readonly).

EIO0000001114.15

267

concurrent actions, page 52 . In such case, check the

Assigning Facets of Instances

Overview

This section describes how to use the Assignment Editor to assign facets of instances to their respective Control and Supervision containers. It also details the information that the software provides on the resulting assignments.

one preconfigured expression, page 271

for details.

Defining the Control Facet Assignment Mechanism

Overview

The Container Naming Rules window allows up to four expressions and lets you use either one to define the assignment mechanism of Control facets, which includes:

• The name of sections that are automatically created when you assign facets.

• Which facets are assigned to which section.

Expressions are project-specific.

By default,

is selected in each project.

The expression is applied when you drag instances or folders containing instances to the Control project in the Assignment Editor .

If the resulting container identifier does not satisfy applicable naming rules, it is

indicated, page 279 .

NOTE: You can

preview and modify, page 277

the result or override the mechanism by assigning facets to an existing section.

Opening the Container Naming Rules Window

To open the Container Naming Rules window, select Settings in the

context menu, page 203

of the Control project.

268 EIO0000001114.15

Preconfigured expression, page 271

Container Naming Rules Window Description

The following example shows the Container Naming Rules window for a new

Control project with its two preconfigured expressions of which the first one is selected.

EIO0000001114.15

Item Description

(read-only). Select the expression to use it to create sections and assign facets.

You can

copy expressions, page 272

and edit the name and description of expressions that you add.

To create the expression, you can configure up to six tokens. To create the section identifiers, the software concatenates the values that it has calculated for each of the configured tokens.

The tokens that you include in the expression have an impact on the

number of sections, page 270

that are created.

The available tokens are:

• Alias Hierarchy : Corresponds to the

alias of the folder, page 126 .

• Folder Hierarchy : Corresponds to the identifiers of folders that make up the path of the instance.

• Free Text : Free-form text that you can enter. It lets you add a fixed value to all sections that are created or insert a separator. Underscore is the only special character that is allowed.

• Instance ID : Corresponds to the

identifier of the instance, page 130

• Template ID : Corresponds to the

identifier of the template, page 130

that is used by the instance.

For Alias Hierarchy and Folder Hierarchy , you can select which levels in the path of the instance to consider.

0 corresponds to the folder that contains the instance. 1 corresponds to its parent folder, and so on.

N corresponds to the highest folder in the structure. The system root folder is excluded

(except for instances that have the system root folder as direct parent).

Maximum value: 99

Example :

For an instance located in System_1\Site_1(S1)\Area_1(A1)\Cell_1(C1)\Unit_1(U1) (where the value in parentheses represents the folder alias):

• 0 = Unit_1 (or its alias, U1 )

• 1 = Cell_1 (or its alias, C1 )

• 2 = Area_1 (or its alias, A1 )

• N = Site_1 (or its alias, S1 )

269

270

preconfigured expression, page 271

Item Description

Configuring the value as 1 to 2 for each token generates the following result:

• For Folder Hierarchy : Cell_1Area_1

• For Alias Hierarchy : C1A1

Optionally, you can define up to two

conditions, page 272

for each token (except for the first and last token, which support only one condition each).

The following conditions are available:

• Condition 1 :

◦ Remove if previous token resolved value is empty

◦ Remove if all previous tokens resolved value is empty

◦ Remove if previous token resolved value is NOT empty

◦ Remove if all previous tokens resolved value is NOT empty

• Condition 2 :

◦ Remove if next token resolved value is empty

◦ Remove if all next tokens resolved value is empty

◦ Remove if next token resolved value is NOT empty

◦ Remove if all next tokens resolved value is NOT empty

Buttons to add and remove tokens in an expression.

Lets you simulate the resulting section identifier by using the expression that is configured based on a sample folder structure and instance identifier if you were to assign any part of this sample hierarchy to the Control project in the Assignment Editor .

To refresh the result after modifying the expression, click the button again.

Pane showing the sample folder structure and the resulting section identifier.

Values in bracket represent the alias of the folder and the identifier of the template.

Lets you add a custom expression.

You can add up to two expressions but only one expression can be selected at a time.

You can delete expressions that you have added.

When selected, opens the Assignment Viewer

window, page 277

only if the assignment creates at least one new section based on the selected expression.

Additional

(read-only).

User-created expression that can be configured and selected.

Container Creation Principle

The table describes the

number of sections, page 274

that are created depending on the token that the expression contains. When several tokens are included, the one with the lowest granularity determines the number of sections. Tokens are listed in increasing order of granularity.

Token

Instance ID

Folder Hierarchy (1) As many sections as there are folders containing instances in the object that you are dragging (when Value = 0 to N).

This token lets you assign facets of instances located in

several folders of a same level, page 275

to one section.

Alias Hierarchy (1)

Number of sections created

As many sections as there are instances in the object that you are dragging.

As many sections as there are folders that have an alias and that contain instances (instances of subfolders included) in the object that you are dragging.

This token lets you assign facets of instances located in

several folders of different levels, page 276

to one section.

EIO0000001114.15

use the same template, page 274

Token

Template ID

Number of sections created

As many sections as there are templates used by instances in the object that you are dragging.

This token lets you assign facets of several instances that

to one section.

(1) The value that you configure impacts the number of sections that are created and the section identifier

NOTE: The

conditions, page 272

that are configured may impact the results.

Preconfigured Expressions

The following preconfigured expressions exist and are read-only. The section identifier that they create is composed of three parts where each part is the result of a calculated token.

To use a different expression, create one and select it.

For new Control projects:

The expression creates a section for each folder containing instances.

Example:

Alias1Alias2Alias3_Folder3Folder4

The table describes how the tokens of the expression are used to calculate the different parts of the section identifier.

Token

Alias Hierarchy

Free Text

Folder Hierarchy

Value

From 1 to N

_ (underscore)

From 0 to 1

Result

Concatenation of the folder aliases from the highest level folder down to the level-1 folder in the path of the instance.

An underscore.

NOTE: The condition removes the underscore if no aliases have been configured because a section identifier cannot start with an underscore.

Concatenation of the identifiers of the level-1 and level-0 folders in the path of the instance starting with the level-

1 folder.

For new and migrated Control projects:

The expression creates a section for each instance. The section identifier is the same as the one that was automatically created when assigning facets by using earlier versions of the software.

It is selected by default for migrated projects.

Example:

MyMotor_1_Motor

The table describes how the tokens of the expression are used to calculate the different parts of the section identifier.

Token

Instance ID

Free Text

Template ID

Value n/a

_ (underscore) n/a

Result

The identifier of the instance.

An underscore.

The identifier of the template that is used by the instance

(without $ prefix).

EIO0000001114.15

271

272

Using Conditions in Expressions

You can use conditions to modify container identifiers. Conditions remove a token from an expression based on the value of one or all previous tokens and/or the value of one or all following tokens.

It lets you, for example, show the folder identifier instead of the folder alias in case no alias is defined.

Example of condition based on previous token:

You have configured an expression as < token1 >< token2 >< token3 > and an underscore is defined as free text for token2 .

If the value for token1 is blank, the resulting container identifier starts with an underscore. To avoid that, you can configure the condition Remove if previous token resolved value is empty for token2 . The container identifier is then only token3 .

Example of condition based on next token:

You have configured an expression as < token1 >< token2 >< token3 > and Section_

A is defined as free text for token1 . However, you want this text to appear only when token2 and token3 contain no value.

You can configure the condition Remove if all next tokens resolved value is not empty for token1 to achieve this.

Copying Expressions

You can copy expressions to paste them in the same window or in the window of another project.

Step

Action

Right-click the header of the expression and select Copy .

Right-click the empty space below an expression and select Paste .

Result : The expression is added to the Container Naming Rules window.

NOTE: You can only paste as many expressions as is allowed to remain within the limit of expressions per project.

Sample Application for Examples

The following figure shows the sample application that is used in the following examples. In each one, Area is dragged to the Control project in the Assignment

Editor

EIO0000001114.15

previous example, page 273 , the number of sections remains the

Example With Instance ID Token

Only Instance ID is configured as token without conditions.

After dragging Area , one section for each instance is proposed. The section identifier is the instance identifier.

Example With Folder Hierarchy and instance ID Tokens

Folder Hierarchy is added to Instance ID as tokens with an underscore as separator. No conditions.

Compared to the

same. Only the identifier of the sections is changed by adding the identifier of the folder containing the instance (level 0) and its parent (level 1) as prefix.

EIO0000001114.15

273

Example With Template ID Token

Instance Motor_1 that is using template $Motor is added to the application so that two instances of the same template exist.

Only Template ID is configured as token without conditions.

One section for each template that is used in the application is proposed. The section identifier is the template identifier (without $ character).

274

Example With Template ID and Alias Hierarchy Tokens

Alias Hierarchy is added to Template ID as tokens with an underscore as separator. No conditions.

EIO0000001114.15

previous example, page 274 , one section has been added

Compared to the

because the two instances of template $Motor are located in folders that have a different alias. The section identifier is the template identifier with the aliases of

Cell1 and Area added as prefix.

NOTE: The same number of folders would have been created if Folder

Hierarchy had been selected as token instead of Alias Hierarchy .

Example to Group Facets of Instances Located in Several

Folders of Same Level

This example illustrates how to use the Folder Hierarchy token to assign to one section the facets of instances located in folders of a same level in the application

( Cell1 and Cell2 ). The following figure shows the sample application that is used.

EIO0000001114.15

Folder Hierarchy is configured as token with value 1 to 1. Because the value represents the parent folder, it creates a section for each folder that contains instances by using the identifier of its parent. When two folders have the same parent, only one section is created. No conditions.

275

After dragging Area to the Control project, two sections are proposed. Section

Area contains the facets of A1HandValve_1 and A1Motor_1 because it is the parent of Cell1 and Cell2 .

NOTE: If the section identifier is not satisfactory, you can

edit it in-place, page

279

or add a Free Text token to the expression.

Example to Group Facets of Instances Located in Several

Folders of Different Levels

This example illustrates how to use the Alias Hierarchy token to assign to one section the facets of instances located in folders of different levels in the application ( Area and Cell1 ). The following figure shows the sample application that is used.

276

Alias Hierarchy is configured as token with value 0 to 1. This creates a section for each folder that has an alias and contains instances. No conditions.

EIO0000001114.15

expression that you have selected, page 268

After dragging Area to the Control project, one section is proposed, which contains the facets of the three instances of the application.

Cell1 contains instances but has no alias.

Area contains an instance and has an alias. Thus, its alias is used to create the section identifier to which facets of A1Valve_1 are assigned. Facets of any instances contained in subfolders ( Cell1 ) are assigned there as well.

NOTE: If the section identifier is not satisfactory, you can

edit it in-place, page

279

or add a Free Text token to the expression.

Previewing Facets Assignments

Overview

The Assignment Viewer opens when you drag one or more facets to a project in the Assignment Editor .

It does not open if you drag facets to a container that you have created manually.

The window lets you:

• For Control projects, preview the identifier of newly created sections, which is the result of the

• Preview which facets will be assigned to which container.

•

Edit the identifier, page 279

of containers in-place.

• Select in which task folder or cluster to create new containers.

• Select which assignments to perform.

NOTE: For Control projects, you can

configure it, page 269

to open only if the facets that you are assigning create a new section.

EIO0000001114.15

277

default expression, page 271

Assignment Viewer Description

The following figure shows an example of the Assignment Viewer when you drag the top level folder of a folder structure containing two instances (1) to a Control project while the

for a new project is selected.

The following figure shows an example of the Assignment Viewer when you drag the top level folder of a folder structure containing two instances (1) to a

Supervision project.

278

Item

Shows the identifier of the containers to which the facets of the instances that you have dragged will be assigned. For each container, shows the identifier of the instances whose facets will be assigned.

By default, the order of containers and instances corresponds to the hierarchy of the application.

For Control projects, the number of sections and their identifier depends on the

expression that is selected, page 268

and the object that you have dragged (for example, an instance, a folder, or a folder structure).

For Supervision projects, one tag container is created each time you drag an object to the project independently of the number of instances inside the object.

You can edit the identifier of new sections.

Identifiers of the facets that will be assigned to the container.

Indicates whether the container already exists in the project or if it will be created.

Indicates or, for new containers, lets you select:

• For Control projects: The task folder of the section.

• For Supervision projects: The cluster of the container.

Check box to select all the containers that appear in the window.

Select the check box to create the container (if new) and assign the facets.

Containers whose check box is cleared are ignored.

For Control projects, indicates the name of the

expression, page 269

that is selected.

EIO0000001114.15

(1) The following figure shows the application that was used for the two

Assignment Viewer examples.

Editing Container Identifiers

You can edit the identifier of new containers only.

By editing the identifier of a container so that it is the same as an existing container or another container that is proposed in the Assignment Viewer , you can assign the facets of both to a single container.

Container Identifier Validation

Either of the following dots can appear on the container icon:

• A red dot to indicate that the container identifier that is the result of the expression is blank.

• A yellow dot to indicate that the container identifier has been modified to satisfy applicable

(for example, maximum length or allowed characters).

Modifying the Application While the Assignment Viewer is

Open

If the application is modified while the Assignment Viewer is open and the changes impact any result of the expression that is selected, the information in the window is not updated. Also, when you proceed with the assignments, they are performed based on the information that is displayed in the window.

Assigning Control Facets of Instances

Before Starting

To assign Control facets of instances, you must have completed:

• The

Control Project Definition stage, page 203

• The

You can only assign facets of instances that have a valid

Data and Link status, page 130 .

You can assign facets only to FBD sections.

You cannot assign the same facet to more than one FBD section in the same project but you can assign the same facet to several Control Participant projects of the system.

NOTE: You can associate a Control project to a tag container to assign the corresponding Supervision facets

automatically, page 285

EIO0000001114.15

279

280

change the order of facets, page 295

Facet Assignment Order

Depending on the method that you use to select instances for assignment, the order of the referenced facets varies. The following applies when you assign all facets to the same FBD section.

Assignment method

Instance by instance

Multiple instances at once

By folder

Multiple folders at once

Facet order

The order in which you drag instances to assign them defines the order of the referenced facets. Instances selected first for assignment have facets with the lowest order.

The order in which you select instances defines the order of the referenced facets. Instances selected first have facets with the lowest order.

The order of instantiation defines the order of the referenced facets.

Instances created first have facets with the lowest order.

The order in which you select folders defines the order of the referenced facets. Folders selected first have facets with the lowest order.

If the folders contain multiple instances, the order in which instances where created is not relevant anymore.

NOTE: You can

Assigning Facets

This procedure describes how to assign facets of instances to sections of the

Control project by using an

expression, page 268

Step Action

1 Verify that the instances are displayed in tree view mode in the

Instances pane, else click the

toggle button, page 257

NOTE: Alternatively, you can assign instances using the grid view mode. The assignment principle remains unchanged.

You can switch between views at any time during assignment by clicking the toggle button.

Configure the expression depending on the assignment mechanism that you want to use and select it.

In the Containers pane, select the

Control project.

Result

The Assignment Editor displays the

valid, page

130

instances of the application in tree view mode.

–

From the Instances pane, drag one or more

objects, page 261

to the title bar of the Assignments pane.

NOTE: Alternatively, you can drag objects directly to project in the Containers pane.

• The name of the project appears in the title bar of the Assignments pane.

• Any existing sections and the facets already assigned to them are displayed.

The Assignment Viewer

window, page 277

opens.

EIO0000001114.15

Step Action

Review the information that is displayed, edit section identifiers as needed, and select the task folder for each section.

Click OK .

Result

–

• Sections that do not exist yet are created after existing sections.

• The Control facets that have a status of

Candidate are assigned to the respective FBD sections and displayed in the Assignments pane.

• The software assigns an

order, page 282

to each assigned facet.

• The status of the assigned facets in the

System column of the Facets pane changes to Assigned if the status was Not assigned .

• The status in the Project column of the Facets pane changes from Candidate to Done .

NOTE: By default, remaining facets will be

when you generate the project or a section.

Assigning Supervision Facets of Instances

Before Starting

To assign Supervision data facets of instances, you must have completed:

• The

Supervision Project Definition stage, page 226

• The

You can only assign facets of instances that have a valid

Data and Link status, page 130 .

You cannot assign the same facet to more than one tag container in the same project but you can assign the same facet to several Supervision projects of the system.

NOTE: To assign Supervision genies facets to a

page, page 267 , refine the

Supervision project.

Automatic Supervision Project Component Creation

Each time you drag an object from the Instances pane to the Supervision project, one tag

container is created, page 277

In addition, depending on the facets that you assign to the tag container, the software may automatically create and configure the following components under the Services

node, page 228

of the Supervision project cluster:

• One I/O server including:

◦ One I/O device

◦ One communication board and its port

• One alarm and/or one trend server (if facets that create alarm and/or trend tags have been assigned).

NOTE: The I/O server and its components are created only for the first tag container of a cluster whether you create the tag container manually or if the software creates it automatically during the assignment. The other servers are created also when you assign corresponding facets to additional tag containers.

Assigning Facets

This procedure describes how to assign data facets of instances to a Supervision project.

EIO0000001114.15

281

toggle button, page 257 .

Step Action

1 Verify that the instances are displayed in tree view mode in the

Instances pane, else click the

NOTE: Alternatively, you can assign instances using the grid view mode. The assignment principle remains unchanged.

You can switch between views at any time during assignment by clicking the toggle button.

2 In the Containers pane, select the

Supervision.

Result

The Assignment Editor displays the

valid, page

130

instances of the application in tree view mode.

• The name of the project appears in the title bar of the Assignments pane.

• Any existing containers and the facets already assigned to them are displayed.

The Assignment Viewer

window, page 277

opens.

From the Instances pane, drag one or more

objects, page 261

to the title bar of the Assignments pane.

NOTE: Alternatively, you can drag objects directly to the project in the Containers pane.

Review the information that is displayed, edit the container identifier as needed, and select the cluster.

Click OK .

–

• Containers that do not exist yet are created.

• Supervision data facets that have a status of

Candidate are assigned to the respective container and displayed in the Assignments pane.

• The status of the assigned facets in the

System column of the Facets pane changes to Assigned if the status was Not assigned .

• The status in the Project column of the

Facets pane changes from Candidate to

Done .

NOTE: If an instance contains a facet of type ClientEvent or ServerEvent , the software assigns the facet to the ClientEvents and ServerEvents

container, page 228

respectively.

NOTE: By default, remaining facets will be

when you generate the project or a section.

Assigned Facet Description

Facet Description

The Assignments

of the Assignment Editor provides information on the facets that are assigned to an FBD section or tag container.

To see a list of facets that are assigned to a project, select the project in the

Containers pane.

The following information is displayed in the Assignments pane.

Column header

Description

Container Identifier of the section/container to which the facet is assigned.

Instance

Template

Identifier of the instance that references the facet.

Identifier of the template that the instance is using.

State State of the facet in the context of the instance.

Possible values:

• Valid

282 EIO0000001114.15

composition of the instance, page 134 .

EIO0000001114.15

Column header

Description

Facet

Template

Path

Order

•

Invalid , page 138

• Deleted : The section is

generated, page 297

and you have unselected the corresponding element of the instance in the Instance Editor or deleted the instance itself.

Unique identifier of the facet.

Identifier of the template that the facet is using.

Assignment

Generation

Path to the facet in the

This column applies to Control projects only.

Indicates the order in which the software generates constituents of the facets inside the section and as such, the order in which the Control Participant executes the constituents inside the section.

You can

change the order of facets, page 295

inside a section.

The software applies the order only during:

• A

first generation, page 300

• A

regeneration, page 327

For more detailed information on how the software manages the facet order, refer to the

description of the generation functionality, page 303 .

Indicates the status of the facet in relation to the instance that references the facet.

Possible values:

• Assigned

• Unassigned

• Out Of Date

• Deleted

Refer to

Assignment Status of Generated Facets , page 320

for a description of the assignment status.

Indicates the status of the facet in relation to the generation of its constituents in the logical Participant project.

Possible values:

• Non Generated

• Generated

• Moved

• Inconsistent

• Unlinked

Refer to

Generation Status of Facets , page 319

for a description of the generation status.

Changing the Element Selection of Instances After Assignment

If you change the Control or Supervision element selection of an instance in the

Instance Editor window after assigning facets of the instance (before generating), the changes are reflected in the respective Assignment Editor .

The table describes how the changes to the element selection of an instance are reflected in the Assignment Editor .

When you...

Select a new element of an instance

Unselect an element of an instance

Then...

The corresponding facets are added to the existing facets of the instance and you can display them in the Facets pane of the Assignment Editor . Proceed with the assignment as described in the assignment procedure.

The corresponding facets are removed from the list of facets in the Facets pane of the Assignment Editor .

If you had already assigned the facets, then they are also removed from the corresponding container.

283

Assignment Status of Generated Facets , page

NOTE: Changes impacting the assignment status of facets that you have generated are described in

320 .

Automatic Assignment of Remaining Facets

Overview

The Project Explorer features a functionality that allows you to assign remaining

Control and Supervision candidate facets of instances, which have at least one facet that is already assigned to a Participant project. The assignment is done automatically by the software when you select a

generation command, page 299

The container to which these facets are assigned depends on where the other facets of the instance are already assigned.

There can be candidate facets remaining because you have:

• Not assigned all the facets to a Participant project yet.

• Unassigned facets.

• Changed the

element selection of the instance, page 139

after assignment, which has created new facets.

Information on facets that the software has assigned automatically is displayed in the notification panel.

NOTE: Automatic assignment does not apply to Supervision genie facets.

Using and Disabling the Functionality

The functionality is enabled by default and remains enabled until you disable it in the settings of a

Control project, page 205

Supervision project, page 226 .

Assignment is triggered, page 299

when you use any generation command at the project or project container level.

NOTE: You can still assign facets manually while the functionality is enabled.

Automatic Assignment Criteria

The table describes how the software assigns remaining candidate facets of an instance, depending on where other facets of the instance are already assigned.

Candidate facet type

Control facet

Facets of same instance are already assigned to one container

Candidate facets are assigned to the same FBD section.

Facets of same instance are already assigned to several containers

Supervision facet Candidate facets are assigned to the same tag container.

Candidate facets are assigned to the FBD section to which other facets of the instance are already assigned and that has the lowest Order number.

• Supervision project with one cluster:

Candidate facets are assigned to the tag container that was created first.

• Supervision project with several clusters: Candidate facets are assigned to each cluster. In each cluster, candidate facets are assigned to the tag container that was created first.

NOTE: Only facets that are available are assigned. If a facet is locked, for example, because the instance referencing it is open in the Instance Editor , it remains unassigned.

Viewing Assignments

To verify to which container facets of an instance are assigned, use the

View

Assignments , page 294

window.

284 EIO0000001114.15

property of the tag container, page 263 .

Examples

In this example, three facets of instance Motor_1 are already assigned to section

FBDSection_1 . A modification of the element selection of Motor_1 has created facet Motor_1_DEVMNT , which is candidate to be assigned. The software assigns

Motor_1_DEVMNT automatically to section FBDSection_1 when you generate the project. (Information has been highlighted in yellow for this example.)

In this example, three facets of instance Motor_1 have been assigned to section

FBDSection_1 . The section was generated and the three facets unassigned.

Thereafter, modification of the element selection of Motor_1 has created facet

Motor_1_DEVMNT , which is candidate to be assigned. The software assigns

Motor_1_DEVMNT automatically to section FBDSection_1 when you generate the project again while the three unassigned facets are removed from it. (Information has been highlighted in yellow for this example.)

Automatic Assignment of Supervision Facets

Overview

This topic describes the functionality that is enabled when you associate a Control project to a tag container by using the Associated Control Project

Working Principle

When you associate a tag container to a Control project, whenever you drag instances (or a folder) to the Containers pane in the Assignment Editor to assign their Control facets to this Control project, the Supervision data facets of these instances are automatically assigned to the associated tag container.

You can see the details of the Supervision facet assignment in the notification panel.

EIO0000001114.15

285

automatically assigned by the software, page 285

The automatic assignment of Supervision facets is not performed in the following cases:

• When you drag Control facets from the Facets pane.

• When remaining candidate Control facets are

• When Control facet assignments are created by means of import.

• The instance has no Supervision data facets. In such case, an entry for unsuccessful facet assignment appears in the notification panel.

Visual Indicator

The following partial view of the Assignment Editor shows two tag containers where only TagContainer_1 is associated to a Control project. It is indicated by a blue icon.

286

Further, when you hover with the pointer over the tag container, a tooltip indicates the identifier of the Control project.

Locked Supervision Projects

If the Supervision project that contains the tag container is locked (for example, because it is open for refinement) when the software attempts to assign the

Supervision facets, a dialog box opens. It gives you the following choices:

• Yes : The dialog box closes and the software will attempt to assign both the

Control and the Supervision facets again after waiting for approximately 1 min.

◦ If, at that moment, the Supervision project is still locked, the dialog box opens again.

◦ If the lock has been released, both facets types are assigned without further notification. You can see the details of the facet assignment in the notification panel.

During the wait time, certain actions that you or other users perform on the

Control and the Supervision projects are queued without further notification.

The software will perform these actions automatically once the initial facet assignment is completed. You can see the details of these actions in the notification panel once they are completed. Such actions can be, for example, assigning additional facets to existing tag containers.

Other actions may be forbidden and a dialog box opens to inform you. For example, refining either project or creating new containers.

• No : Only the Control facets are assigned and you can resume working normally. You need to assign the corresponding Supervision facets manually.

If you click No the second time the dialog box opens, actions that are queued will be performed in sequence.

• Cancel : No assignment is performed.

NOTE: If the instance whose Control facets you are assigning has no

Supervision data facets to be assigned and the Supervision project is locked, the dialog box still opens. In this case, click No .

EIO0000001114.15

NOTE: If the dialog box opens and the Supervision project has already been released when you click Yes , the wait time still needs to elapse before the software performs the assignment of facets.

Unassigning Control Facets

When you unassign Control facets, the corresponding Supervision facets that were assigned automatically remain assigned.

Impact on Supervision Project Export and Import

The value that is selected for the Associated Control Project property is exported.

When you import into a system a Supervision project, which has a tag container that is associated to a Control project, the value of the Associated Control Project property after import is as follows:

• If the system contains no Control project with the same identifier, the value is reset.

• If the system contains a Control project with the same identifier, the value is kept and automatic assignment of Supervision facets is enabled.

Viewing the Application Structure in Control Projects

Overview

Switching to tree view mode in the Containers

Participant projects, page 339

of the

Assignment Editor allows you to view FBD sections based on the location of instances whose Control facets are assigned to these sections.

It shows the relationship between the folder structure of the application and the sections of a Control Participant project. This is useful, for example, when you want to view the logic related to a specific area or subdivision of the application or verify that the Control facets of a group of instances are assigned to the right sections of a project.

Any FBD section to which a Control facet is assigned appears in the tree view. A section can appear several times depending on the facets it contains.

Independently of where and how many times an FBD section appears, its contents, which is visible in the Assignments pane, is the same.

Changing the application folder structure, the location of instances, facet assignments, and/or the status of facets has an impact on the position of sections in the tree view.

Empty FBD sections and non-FBD sections are shown as well.

NOTE: You can view the application structure also when

refining Control

and

making changes online, page 550

Root Folder Description

In tree view mode, up to three root folders can appear in the Containers pane.

EIO0000001114.15

287

288

Root folder identifier Description

<system identifier> (for example, System_1

EmptyContainers

)

The <system identifier> (for example, System_1 ) root folder is the parent folder for the application structure. This structure contains sections to which facets with the following status are assigned:

• Assigned

• Out Of Date

• UnAssigned

• Non Generated

• Generated

• Moved

• Inconsistent

Parent folder for sections to which no facet is assigned because you have performed one or more actions such as:

• Created the section manually.

• Unassigned all non-generated facets from the section. If the facets were already generated, you have unassigned all facets and generated the section.

• Disabled a service, which removed the corresponding nongenerated facet. If the facet was already generated, you have disabled the service and generated the section.

• Deleted any instance referencing a non-generated facet assigned to the section. If the facets were already generated, you have deleted the instances and generated the section.

• Moved all facets to another section.

• The section is a non-FBD section.

DeletedFacetContainers Parent folder for sections to which at least one facet is assigned with the status Deleted .

If the section contains at least one facet with another status, the section also appears under the <system identifier> root folder.

Once you generate the section and the Deleted facet is removed from the section, the section appears only under either of the two other root folders depending on the facets that are assigned to it.

No application folders are shown under this root folder.

NOTE: A root folder appears only if there is a section in its folder structure. For example, if there is no empty section, the EmptyContainers root folder is not shown.

Relation Between Folder Structure and FBD Sections

A folder structure can contain several sections if facets referenced by instances in that folder structure are assigned to multiple sections.

A section can be shown multiple times under different folder structures if the facets assigned to this section are referenced from instances located in various folders.

EIO0000001114.15

In this example, the application contains three folders. The Control facets referenced by each instance are assigned to separate FBD sections.

Folder_2 is empty.

The following is an extract of the Assignment Editor , which shows the corresponding FBD sections in the Containers pane of the Control project in grid view mode . The project node is not shown.

The following figures show how the FBD sections are displayed in relation to the folder structure of the application in the Containers pane in tree view mode .

EIO0000001114.15

289

290

If during assignment, you had assigned one facet of instance Valve_1 also to section Motor_20_Motor , this section would appear twice. Under Folder_20 because of facets of instance Motor_20 and under Folder_1 because of the facet of Valve_1 . The following figure shows this.

Impact of Changes in the Application on the Tree View

In tree view mode, changes to the application are reflected.

Changes that you make to the folder structure of the application are reflected in folder structure shown in the Containers pane.

Changes that you make to the location of instances whose facets are assigned to sections are reflected in the position of these sections in the Containers pane.

Based on the application of the previous example, if you create Folder_3 and move instance AnalogInput_1 to this folder, the tree view is modified as shown in the figure.

EIO0000001114.15

If you delete instance AnalogInput_1 and its facets were generated, the status of the facets changes to deleted. When this happens, section AnalogInput_1_

AnalogInput appears under the DeletedFacetContainers root folder as shown in the figure.

NOTE: Folder_3 is empty and therefore it does not appear in the Containers pane.

Impact of Changes to Assignments on the Tree View

Changes that you make to the assignment of facets are reflected in the position of sections in the Containers pane.

If without changing the application, you move a facet of the Valve_1 instance to the Motor_20_Motor section, the section appears also under Folder_1 because the instance is located in Folder_1 .

EIO0000001114.15

291

concurrent actions, page 52 . In such case, check the

If you had generated section AnalogInput_1_AnalogInput , delete the instance, and generate the section again, the Deleted facets are removed from the section and the empty section now appears under the EmptyContainers root folder. The result is shown in the following figure.

Managing Assigned Facets

Overview

This section describes the actions that you can perform on assigned facets by using the Project Explorer and the Application Explorer .

It also describes how to access containers to which facets are assigned and how to open the Assignment Editor from facets that you have not yet assigned to a project.

management of generated facets, page 332 .

for details.

Facet Actions After Assignment

Overview

This topic applies to facets that are assigned but not yet generated.

For information on facets that are generated, refer to the topic describing

Commands and Actions

Once you have assigned Control or Supervision data facets of instances to the respective project, you can execute the following commands and actions on these facets from the Assignments pane of the Assignment Editor .

292 EIO0000001114.15

Unassigning Facets , page 293 .

EIO0000001114.15

Command/Action

Unassign

Go To Instance

Move the facet

Description

Removes the facet from the section or container.

You cannot unassign facets that have the Assignment status of deleted .

Refer to

NOTE: The actions that the software executes when you select the Unassign command for a non-generated facet is different than if you execute the command on a

generated facet , page

334 .

Shows the instance that references the facet in the Application

Explorer .

The navigation feature is not available if the Assignment status of the facet is deleted .

Refer to the topic describing how to

navigate from facets to the instance , page 296 .

Changes the assignment of a facet to another FBD section or tag container. Does not apply to

genie facets, page 361

Refer to

Moving Facets , page 293 .

NOTE: The

Reassign , page 334

and

Unlink , page 334

commands that you can access from the facet context menu become available only once you have completed the generation stage.

Unassigning Facets

To unassign a non-generated facet from a section or container, proceed as follows.

Step Action

1 In the Assignments pane of the Assignment

Editor , right-click the facet and select Unassign .

NOTE: You can select multiple facets to unassign them at once.

Result

The facet is removed from the Assignments pane and:

• The status of the unassigned facet displayed in the

System column in the Facets pane changes from

Assigned to Not assigned if the facet is not assigned to any other project of the system.

• The status of the Project column changes from Done to Candidate .

Moving Facets

To move a non-generated facet from one FBD section/tag container to another, proceed as follows.

Step Action

1 In the Assignments pane of the

Assignment Editor , right-click any one of the column headers to

clear filters and sorting, page 93 .

2 Drag the facet to another FBD section of the same task folder or tag container that is shown in the

Containers pane.

NOTE: You can select multiple facets to move them at once.

Result

•

The facet is removed from its original container and assigned to the target one.

The assignment status of the facet is unchanged.

NOTE: Control facets that you move are assigned to the new section with the highest order value in the

Order column of the Assignments pane, page 257 .

When you move several facets at once, the facet that you have selected first gets the lowest order out of the ones that are moved.

293

Open the corresponding Assignment Editor , page 257

Viewing Facet Assignments

Overview

By opening the View Assignments window for any instance of the application, you can verify if Control facets and Supervision (data and genie) facets are assigned to a project of the system.

For each facet, you can:

• If the facet is not yet assigned:

for existing projects of the system. For genie facets, you can open the Pages container of existing Supervision projects.

• If the facet is already assigned: Open each container to which it is assigned and locate the facet.

Opening the View Assignments Window

In the Application Browser

pane, page 117

, right-click an instance and select

View Assignments .

NOTE: You cannot open the View Assignments window if both conditions are true for the instance:

• Assigned status is Unassigned .

• Data or Link status is Invalid .

View Assignments Window

The following figure shows an example of the View Assignments window for instance MyMotor_1 , whose Control and Supervision data facets are assigned but not its genie facets.

294

Item

Description

Displays the elements of the selected instance grouped by Participant.

For each Participant, elements are grouped by one or more levels of categories. For example, category Control and subcategory Interlocks contain element Logic .

Indicates the subtype of the facet.

Identifier of the facet that corresponds to the element.

Identifier of the template that the facet is using.

Facet assignment status.

Possible values:

• Unassigned : The facet is not yet assigned to any project of the system.

• Assigned : The facet is assigned to, at least, one project of the system.

EIO0000001114.15

inspect the instance, page 155 .

Item

Description

For Control facets, the following information is displayed:

• For unassigned facets: A list of existing Control projects in the system to which you can assign the facet.

Click a project in the list to open its Assignment Editor .

• For assigned facets: The list of sections to which the facet is assigned.

Section identifiers are shown in the format: ProjectIdentifier .

SectionIdentifier .

Click a section to show or open the Assignment Editor . The section and facet are highlighted.

NOTE: For unassigned facets, if no Control project exists in the system, the column is empty.

For Supervision data and genie facets, the following information is displayed:

• For unassigned facets: A list of existing Supervision projects in the system to which you can assign the facet.

Click a project in the list to open its Assignment Editor .

• For assigned facets: The list of containers to which the facet is assigned.

Container identifiers are shown in the following format format:

◦ For data facets: ProjectIdentifier .

ClusterIdentifier .

ContainerIdentifier .

◦ For genie facets: ProjectIdentifier .

PageIdentifier .

Click a container to show or open the Assignment Editor . The container and facet are highlighted.

NOTE: For unassigned facets, if no Supervision project exists in the system, the column is empty.

Elements of the instance, which generate a facet and that are shown when you open the Instance Editor .

Elements of the instance, which generate a facet and that are shown when you

NOTE: The View Assignments window is closed automatically when you navigate to the Assignment Editor .

Order of Control Facets

Overview

The software assigns an

order, page 282

to facets that you assign to an FBD section, starting at 0, and displays it in the Assignments pane. The values appear in the Order column.

The order corresponds to the execution order of the constituents of the facet by the Control Participant inside the section after you generate the section.

You can change the order of facets inside an FBD section.

The software applies the default order or changes to this order only until the

first generation, page 303

of the section. After you have generated the section a first time, you can still change the order of facets inside the section. However, the change has no effect on the order of already generated facet constituents if you generate the section again. You need to

regenerate, page 327

the section for the software to apply the new facet order.

Changing the Facet Order

To change the order of Control facets inside an FBD section, proceed as follows.

EIO0000001114.15

295

clear filters and sorting, page 93

Step

Action

In the Containers pane, select the FBD section that contains the facets that you want to rank.

Result: The facets that are assigned to the selected FBD section appear in the

Assignments pane.

In the Assignments pane, right-click any one of the column headers and

Result: The facets are displayed in increasing order from top to bottom.

Drag a facet up or down to a new position until you see a tooltip, which indicates the position that the facet will occupy when you release the mouse button.

Result: The facet appears in the selected position with a new order value.

NOTE: To change the execution order of the FBD sections, refer to the topic describing how to

change the order of sections , page 207 .

Navigating from Facets to the Instance

Overview

From a facet that is shown in the Assignments pane of the Assignment Editor , you can open the Application Explorer to show the instance that references this facet.

The navigation feature is available for:

• Control facets.

• Supervision data and genie facets.

Conditions Impacting Navigation to the Instance

The table describes the scenarios where navigation to the instance is limited or not possible.

Condition

The Assignment status of its facet is

Deleted .

The instance is not shown in the

Application Browser because a

filter, page 93

is applied.

The Application Browser pane is minimized or in the background (if tabbed).

Result

The Go To Instance command is not available.

The Application Explorer opens or is shown but a dialog box informs you that the instance is not visible.

The Application Browser pane remains minimized or in the background.

If the instance is open in the Instance Editor , the corresponding tab is shown.

Navigating to the Instance

To navigate from a facet assigned to a project container to the instance that references this facet, proceed as follows.

Step

Action

Rick-click the facet and select Go To Instance .

Result: The software:

• Opens the Application Explorer window if it is not yet open. If it is, the window is shown.

• Expands the application folder containing the instance.

• Selects the instance that references the facet.

296 EIO0000001114.15

General Description..................................................................................... 297

What’s in This Chapter

Generating a Project for the First Time .......................................................... 321

Generating Projects After Changes............................................................... 323

Generating Equipment in Supervision Projects .............................................. 329

Generation Diagnostic Messages ................................................................. 331

Managing Generated Facets ........................................................................ 332

Overview

This chapter describes how to create the logical Control and Supervision

Participant projects of the system.

The following figure shows the position of the Generation stage within the system engineering life cycle.

Refer to the

Generation stage, page 35

for a description of the purpose of this stage.

General Description

Overview

This section gives a general description of the generation process of Control and

Supervision Participant projects.

concurrent actions, page 52 . In such case, check the

for details.

Generation Process Description

Overview

Once you have assigned Control and/or Supervision facets to the containers of their respective projects, you need to generate these projects.

EIO0000001114.15

297

298

first-time generation, page 321

During the system engineering life cycle, the generation process of Participant projects can encompass up to three steps:

• A

• A

generation after changes, page 323 .

• A Control Participant project

regeneration, page 327

You can generate the entire projects or parts of it.

The generation process creates the logical Participant project.

For Control projects the generation process:

• Creates the derived function blocks (DFBs) and variables based on the constituents that are encapsulated inside the facets according to the assignment of the facets in the structure of the project and their

properties, page 134 .

• Creates links between function blocks generated from different facets, which are assigned to the

same FBD section, page 301 . In addition to links that are

defined at the template level, links created in an editor of the Application

Explorer are processed.

For Supervision projects, the generation process populates the native Supervision

Participant database files for:

• Tags from Supervision data facets.

• Report events from Supervision server event facets.

• Events from Supervision client event facets.

• Supervision project components.

• User interface messages.

•

Equipment, page 329

NOTE: You can abort the generation of

projects, page 321

and their

containers, page 322

as well as the

regeneration, page 328 .

Data Validation Before Generating

When you select the Generate or ReGenerate command for a project or a container, the software first verifies if the constituents of the assigned facets satisfy the applicable

impact of detected errors on generation, page 301 .

The software behaves as follows when it detects that the applicable naming rules are not satisfied:

• For Control facets, it does not generate containers nor constituents in the logical Participant project even those that satisfy the naming rules.

Refer also to the topic describing the

• For Supervision facets, it generates only the constituents that satisfy the applicable naming rules.

• For both facet types, it displays a diagnostic message, which contains the identifiers of the containers, assigned facets, and their parameter values that do not satisfy a naming rule.

Generating Facets of the Same Instance Assigned to Several

Projects

You can generate several projects simultaneously even when facets of the same instance are assigned to these project.

The projects can be Control and/or Supervision projects.

EIO0000001114.15

assigns candidate facets automatically, page 284

EIO0000001114.15

Generating Automatically Assigned Facets

By default, the software

when you select any generation command at the project or project container level.

If among the instances whose facets are already assigned to the Participant project, at least one facet remains with the status Candidate , the software opens a dialog box to remind you that the functionality is enabled before executing the command. You have the possibility to cancel generation and disable the automatic assignment of these facets.

If the software is not able to proceed with the automatic assignment of a facet, generation of assigned facets completes but the notification panel displays information on the facets that it could not assign and generate.

If generation does not complete successfully, facets that the software has assigned automatically are unassigned.

NOTE: Generation takes a little longer to complete when the functionality is enabled.

Generating During Build Stage

To save time or if you have made minor changes to a logical Participant project, instead of using the Generate command, you can use the Generate and Build command from the

Control executable, page 421

Supervision executable, page

457

context menu. This performs a generation followed by a build. You need to have completed the system engineering life cycle up to the build stage.

If you generate a complete Participant project and

generation of any section, page

301

or generation of any container does not complete, build is not started.

Information about the sections/containers that were not generated is displayed in the notification panel.

If build is not started or does not complete successfully, the result of the generation process is the same as if you had selected the Generate command for the Participant project. This means, for example, that for a Control Participant project, sections that were successfully generated remain generated.

The Generate and Build command:

• Cannot be used to perform a

regeneration, page 327

• Can be used together with the

automatic facet assignment functionality, page

284 .

• Automatically performs a Build or Build All

command, page 464

depending on the type of change that you have made to the Participant project.

NOTE: After selecting the command, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the task. Only the user

who has selected the command is allowed to abort it.

If you cancel the task:

• Before generation completes, the entire generation task is canceled and no sections are generated. Build does not start.

• After generation completes, only the build task is canceled and the software displays a notification to inform you.

If you are generating and building a small project, the whole task may complete before you are able to click the icon.

Generating Facets with State Invalid

If the

State of a facet, page 282

has become Invalid after you have assigned it, generating the container or Participant project removes the facet from the container.

This can be the case, for example, when you link instances A and B (where instance A needs to be linked to be valid), assign their facets to a Control project,

299

refine the project, page 341

and then delete the link between the two instances. The facet of instance A becomes invalid because the instance is not linked anymore.

Generating the section to which the invalid facet is assigned removes it from the section.

Skipping Facets During Generation

If a facet is locked, the constituents that it encapsulates cannot be generated. In such case, the locked facets are skipped but generation of the section or the

Participant project completes for the other facets. This may happen, for example, when an instance is open in the Instance Editor .

The generation status of a facet that is skipped does not change.

The notification panel contains information about locked facets that the software could not generate.

Control Project Specifics

Overview

This topic describes the default behavior when generating Control Participant projects and the settings that you can configure to customize the generation process.

Identifying Code Generated by Control Facets

Constituents that are generated from facets assigned to Control projects are locked in the Control Participant project. The locked code is color coded in the

DFB editor of the Control Participant when you

Validity Indicators

When you execute any generation command on a logical Control Participant project or any of its containers (including the Generate and Build command) and

project analysis is enabled, page 205 , the software performs an analysis.

If the result of the analysis raises and alert or detects an error, the software displays a

validity icon, page 252 .

In such case,

refine, page 336

the Control Participant project, identify, and fix the issue. When you save your refinement changes, the software performs a new analysis. The result is shown in the Analyze Project tab of the Control Participant window.

300 EIO0000001114.15

M580 safety Control projects, page 579

EIO0000001114.15

NOTE: It is possible that the software detects inconsistencies that are linked to the default configuration in the Control Participant, which is part of every logical Control project but that is not relevant in the context of the Project

Explorer (except for

). These detected errors do not affect the capability to build the project successfully if you configure the topological entities correctly in the Topological Explorer .

This can be the case, for example, when the application contains an instance of a communication port template, which requires that you enter a %MW holding register starting address. During generation, this address is checked against the default address in the CPU of the default configuration . If both addresses are not consistent, a validity icon is displayed. But when you build the logical Control Participant project, this address is checked against the address that you configure in the CPU of the entity in the Topological

Explorer , which needs to be consistent.

It can also happen because the logical Control Participant project is missing

IODDT variables (for example, when the configuration contains HART

modules, page 396 ) or

Device DDT variables, page 547 , which exist only in

the configuration project until you perform the build or

you create them, page

343

If fixing the inconsistency requires that you change a value in the CPU of the default configuration , you still have to verify that the value in the CPU is configured correctly in the Topological Explorer by using the Configure command for the entity to which the Control Participant project will be mapped.

Generating Graphical Links

Inside the same FBD section, the software generates graphical links between function blocks that use the same variable and that are encapsulated inside different facets only if the following conditions are satisfied:

• The variable is created by a facet (not created manually by the user).

• The resulting link:

◦ Links the output pin and input pin of separate function blocks.

◦ Is not a circular link.

The software breaks any graphical circular link and creates it as variable link.

Impact of Detected Errors or User Action During Generation

When you select the Generate or Generate and Build command for a project containing several sections and the software detects an error, the impact on the generation process depends on the detected error or the user action that is performed.

NOTE: The behavior is the same when you

regenerate, page 327

a Control

Participant project.

Detected error or user action

Variable name conflict (1)

Type version conflict (1)

Naming rule conflict, page 65

Clicking Cancel in the Type Version

Conflict

dialog box, page 305 .

Operation in the Control Participant did not succeed (for example, injecting data in a section through import).

.NET exception occurred (for example, an

Object reference not set diagnostic message is shown).

Impact on the generation process

Generation stops. Code of sections that have been successfully generated remains in the logical Control

Participant project.

The section which contains the detected error and any subsequent sections are not generated.

A summary dialog box indicates the identifier of the section where generation stopped as well as the reason.

301

diagnostic messages, page 331 .

Detected error or user action

Section overcrowded (1)

Impact on the generation process

Generation completes but any overcrowded section is not generated.

Details are provided in the summary dialog box.

(1) Refer to the topic describing

In the following example, ControlProject_2 , which consists of four sections is being generated for the first time but the software stops the generation process because of a variable name conflict in FBDSection_3 (the section name is highlighted for the purpose of the example). As a result, FBDSection_1 and

FBDSection_2 are generated in the logical Control Participant project.

FBDSection_3 is not generated because it contains the conflicting variable and

FBDSection_4 is not either because it is generated only once generation of

FBDSection_3 completes

302

NOTE: If you had selected the Generate and Build command, build would not start because at least one section did not generate.

Control Project Section Size

During generation, FBD sections are created in the Control Participant project with a maximum initial size of 360 rows x 240 columns. You can

modify this size, page

304

If additional space is required to fit the function blocks that are generated from the facets assigned to a section, the software adapts the section size by:

• Deleting empty columns on the outer right of the section to add rows at the bottom of the section.

• Deleting empty rows at the bottom of the section to add columns on the outer right of the section.

The software displays a message to inform you of the change in section size.

If you want to reserve some space in the section, you can insert a comment box on the right-hand side of the section and/or at the bottom of the section so that the software does not delete the rows that are left and/or above the comment box when resizing the section.

When the space requirements of the function blocks exceed the maximum section size, the software displays a

diagnostic message, page 331 .

NOTE: The section resizing process applies to a first generation, subsequent generations, and regenerations.

EIO0000001114.15

order of sections, page 207

EIO0000001114.15

Execution Order and Function Block Layout

When you generate a Control project for the first time, the software processes the facets that you have assigned to the project and that have an Assignment

status, page 282

of Assigned . It takes into consideration the

at the project level and the

order of facets, page 282

at the section level.

Refer also to the topic giving an example of section layout management (see

EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

The table describes the process that the software applies during a first generation to manage the order of sections and facets, and the position of function blocks inside a section.

Stage

Description

The software detects the

order, page 257

of the project sections and processes the sections starting with the one ranked 0; then the section ranked 1; and so on, until it has processed the sections of the entire project.

For each section, the software detects the

order, page 282

of the first facet of each instance that is assigned to the section.

The software generates the function blocks encapsulated in the facets according to the order that it has detected in stage 2, starting with the facet ranked 0. However, the software groups the function blocks according to the

layout, page 645

of the composite referencing the facets.

For example, if a section contains two instances, Instance1 and Instance2, referencing three and one facets respectively, and ordered as follows:

Facet1_Instance1 - Order 0

Facet1_Instance2 - Order 1

Facet2_Instance1 - Order 2

Facet3_Instance1 - Order 3

The software generates Facet1_Instance1 before Facet1_Instance2 but groups function blocks of facets 1, 2 and 3 of Instance1 at the top of the section to respect the layout of the composite template used by Instance1.

Therefore, function blocks of Facet1_Instance2 are placed at the end in spite of the order of the facet, which is 1.

If a function block is generated in a position that is already occupied by another function block, creating an overlap, the function block generated last is moved to the end of the section content.

The block keeps its horizontal position (X axis) as defined by the layout of them template referencing it.

In such case, the software displays a message advising you about the change in position and a possible change in the execution order.

Facet Status After Unsuccessful Generation

The table describes the effect on the status of Control facets when the generation of a section or any facet is not successful.

Generated component

Entire Control project

Control project section

Facet status

The generation status of facets assigned to the entire project reverts to the value it was before generating.

The generation status of facets assigned to the section reverts to the value it was before generating.

Removing Types from the Logical Control Participant Project

Types generated from Control facets remain in the logical Control Participant project even when you

unassign generated facets, page 332

encapsulating them,

303

system server restart, page

delete, page 320

the facets by deleting the instance, or

delete the section, page

262

to which these facets were assigned.

To remove these types, you can either:

•

Regenerate, page 327

the Control Participant project. This discards refinements you have made.

• Purge the types from the Control Participant during refinement. For details, refer to Purge of Unused Instances in the Control Participant help.

Parameter name

ReGenerateNonFbdSections

UnityProIgnoreFbdComments

UnityProMinSpaceTop

UnityProMinSpaceLeft

UnityProMinDistanceX

UnityProMinDistanceY

UnityProUseEffectiveSize

UnityProInsertToEnd

CheckConsistency

True

SaveAfterNumberSectionGenerated

Configurable Generation Settings

By editing the GenerationSettings.xml file, you can customize the behavior of the generation process of Control Participant projects.

The file is located on the computer on which the system server is installed at the path C:\Program Files\Schneider Electric\EcoStruxure\Process Expert\System

Server.

You need to have administrator rights to be able to edit this file.

NOTE: Changes to the file are applied only after a

You can configure the following parameters.

Default value

True

False

True

Description

True = The behavior during a regeneration is the following:

• Non-FBD sections that were created during refinement and their contents are retained.

• Refinements that are made in FBD sections to which facets are assigned are discarded.

• Refinements made in FBD sections that were created in the Projects

Explorer are retained if no facets have been assigned to these sections.

False = The behavior during a regeneration is the following:

• Non-FBD sections that were created during refinement and their contents are discarded.

• Refinements that are made in FBD sections are discarded whether facets have been assigned to them or not.

NOTE: The value of this parameter has no impact on the regeneration of data and logic of the safety program of

M580 safety Control projects, page 585

projects.

True = Comments of FBD sections are not generated.

Minimum space that the software leaves above function blocks that are positioned at the top of the section.

Minimum space that the software leaves at the left of any function block that it generates.

Minimum space that the software leaves between two consecutive function blocks along the x axis.

Minimum space that the software leaves between two consecutive function blocks along the y axis.

True = The minimum space around function blocks is decreased to help utilize the space of the section more effectively.

• True = The software puts function blocks that are generated after a first generation at the end of sections independently of the position that they would normally occupy.

• False = The software lays out function blocks according to the default behavior when

generating Control Participant projects after changes, page 326

This is not a user-configurable parameter.

Changing the value affects the behavior of the software.

Number of FBD sections that need to generate successfully to trigger a save command in the Control Participant.

304 EIO0000001114.15

impact of detected errors during generation, page 301 .

Parameter name Default value Description

NumberOfUnitySectionRows

NumberOfUnitySectionColumns

(1)

If you are generating a number of sections lower than the value, a save command is executed once generation completed successfully.

NOTE: Reducing this number may increase generation time because the number of save operations is higher. The setting does not alter the

Number of rows/columns that the section contains when it is created by generating the Control Participant project or section for the first time or regenerating it.

NumberOfUnitySectionRows allowed range: 24 to 144

NumberOfUnitySectionColumns allowed range: 6 to 36

NOTE: If you modify the default section size or if the Control Participant creates a section that is different from your settings, generation or regeneration may not complete successfully because constituents cannot be

positioned, page 303

as required.

(1) NumberOfUnitySectionRows x NumberOfUnitySectionColumns =< 864. If this value is exceeded, either 24 or 144 is retained for the number of rows (the value that comes closest to NumberOfUnitySectionRows ) and the number of columns adjusted in consequence, independently of the setting of NumberOfUnitySectionColumns . For example, if you enter 200 and 7 respectively, a section of size 1440 x

60 is created because 200 exceeds the allowed number of rows and is closer to 144 than to 24.

Selecting Versions of Types in Control Facets During Generation

Overview

Because in a logical Control Participant project, only one version of a given type can exist, either of the following situations require that you select which version is generated:

• You are assigning to a Control Participant project facets that encapsulate the same type but different versions of it.

• You have

updated or replaced the template, page 161

that is used by an instance whose facets are already assigned to a Control Participant project and generated. The new template contains the same type (DFBs and/or

DDTs) but of a different version. The assignment status of one or more of these facets has been set to Out Of Date .

If such a case occurs, when you generate the logical Control Participant project to apply the changes, the software detects the presence of several versions for a same type.

As a result, the software opens the Global Constituent Type Version Conflicts dialog box in which you can select either command to select the version that you want to use in the logical Control Participant project:

• Update

• Skip

• Cancel

The software maintains a list of the various versions of a type that it detects during each generation cycle and applies your initial selection when it detects a version again. If the software detects a new version of the same type when it generates the next section, it opens the Global Constituent Type Version Conflicts dialog box again.

The detection of the version change is performed at the facet level and it is irrelevant to which instance a facet belongs.

However, if two or more versions of the same type are detected in the same section, generation stops. In this case, the software informs you about the facets, the type, and the versions that create the conflict. You need to resolve the version conflict at the instance or facet level manually.

This topic contains several examples illustrating the main scenarios that you may encounter.

EIO0000001114.15

305

306

different signature, page 308 .

NOTE: Although you select the version at the section level, updating the version of a type impacts all its instances across all sections of the Control

Participant project. Also, the last action that you select for a given type is the one that is applied.

NOTE: The Global Constituent Type Version Conflicts dialog box also opens if the software detects the same version of a type but with a

Relation Between Type Versions in the Application and in

Control Projects

The version of the type that you select to use in the logical Control Participant project is not necessarily the same as the version that is encapsulated in the template used by instances of the application. Indeed, in the application, instances can use several versions of a same template encapsulating different versions of a type. The version of the type that is used in the logical Control Participant project can only be one of these versions.

This example shows the different versions of a template that are used by three instances of the application. Each template encapsulating a different version of a

DFB. It also shows the single type version that is generated in the Control project.

Template version and encapsulated type version in the application

Template_A [1.0.0], type version 1.2

Template_A [1.0.1], type version 1.3

Template_A [1.0.2], type version 2.0

Type version used in the logical Control project

Type version 1.3

This second example shows that different versions of a type can be used in different Control projects, each project using only a single version.

Template version and encapsulated type version in the application

Type version used in logical Control project 1

Template_A [1.0.0], type version 1.2

Type version 1.3

Template_A [1.0.1], type version 1.3

Template_A [1.0.2], type version 2.0

Type version used in logical Control project 2

Type version 2.0

Impact of Type Version Selection on Links

Selecting Update or Skip for a facet removes links with any instance of the encapsulated type if a pin for which a link exists is impacted in either way:

• The pin is removed.

• The pin is renamed.

The software displays a message informing you of the links that have been removed after generation completes.

EIO0000001114.15

Global Constituent Type Version Conflicts Dialog Box

The following figure shows an example scenario where several DFB and DDT types create a version conflict in FBDSection_1 .

Item

Description

Identifier of an instance referencing a facet that is assigned to this section and that encapsulates the type. If other facets encapsulating the type and assigned to the section are referenced by different instances, the number of instances is indicated.

Expand the row to view a list of these instances with the template identifier and version each one uses. A tooltip displays the same information when the row is not expanded.

Name of the type encapsulated in the facets for which a version conflict is detected.

Version of the type that is currently used in the logical Control Participant project.

Version of the type that is encapsulated in the facets being generated.

Button that lets you select the Skip action for individual types.

Does not update the type (1) that is currently used in the logical Control project (version X ) to version Y , which is the version encapsulated in the facet. Also, it does not generate the facet.

For each generation cycle, the software maintains a list of the various versions of a same type that it has detected. Based on this list, if other facets encapsulate version X or y of the same type, no dialog box opens and version X is maintained automatically.

If, in another section, the software detects a facet that encapsulates the same type but of a version that is different from version

X and version Y (for example, version Z ), the Global Constituent Type Version Conflicts dialog box opens again. Version Z is added to the list of versions already detected.

The generation status of facets may be set to inconsistent. In such case, when generation completes, the software provides a summary with the name of the facets that are affected and the name of the section they are assigned to.

NOTE: Skip only skips the generation of the facet that encapsulates the type. Other facets belonging to the same instance are generated if their

status, page 324

requires it (for example, if it is Out Of Date ).

Button that lets you select the Update action for individual types.

Generates the facet and updates the type (1) currently used in the logical Control project (version X ) to the version that is encapsulated in the facet (version Y ). The status of the facet becomes Generated .

If, in another section, the software again detects a facet that encapsulates version X of the same type and the facet is not generated, it remains non-generated.

If, in another section, the software detects a facet that encapsulates the same type but of a version that is different from version

X and version Y (for example, version Z ), the Global Constituent Type Version Conflicts dialog box opens again. This allows you to update the current version of the type (for example, version Y ) to version Z . Version Z is added to the list of versions already detected.

NOTE: version Y can be a version later or earlier than version X . The same applies to version Z compared to the other versions.

Copies the content of the dialog box to the Clipboard.

Buttons that let you select an action for the conflicting type versions as a whole.

EIO0000001114.15

307

Item Description

The actions are the same as when you select the action for types individually.

NOTE: Clicking these buttons overrides the selection you have made for individual types.

Generation of the Control Participant project stops. Code of sections that have been generated successfully remains in the logical Control Participant project. The type (1) version that was used after the generation of the previous section is maintained.

The section in which the version conflicts have been detected and any subsequent sections are not generated.

10 Generates the section by applying your selection of actions for conflicting types.

(1) Includes all the types encapsulated in the facet if more than one, for example the DFB and its DDT. You cannot select to update or skip one and not the other.

NOTE: The status of facets is updated only after the entire generation process is completed.

Setting the Status of Facets to Inconsistent

Updating or skipping the version of a type may set the generation status of a facet to Inconsistent . The assignment status does not change.

The table describes under which conditions the generation status is changed.

Status of the type version

The version has already been detected during this generation cycle but is different from the one currently used in the

Control project.

Required facet status

Assignment: Out Of Date

The version has not yet been detected during this generation cycle.

Assignment: Out Of Date

Required user action

Because the version has already been detected, the Global

Constituent Type Version

Conflicts dialog box does not open; therefore, no action is required.

Refer to

example 3, page 313 .

You are selecting Skip for the proposed version change after having already selected Update for the same type in another section during the same generation cycle.

Refer to

example_7, page 317 .

NOTE: If the status of the facet is Non Generated , it does not change.

Detecting Types of Same Version But With Different Signature

The Global Constituent Type Version Conflicts dialog box also opens if the software detects in a facet assigned to the Control project and which needs to be generated, the same version of a type as it is already used in the logical Control project but with a different signature.

The following figure shows an example of detection of a type of the same version but with a different signature. A tooltip indicates the nature of the conflict when you position the pointer over the version of the type.

308 EIO0000001114.15

EIO0000001114.15

• Update : The type in the logical Control project is updated with the type and signature that is encapsulated in the facet.

• Skip : The type that is used in the logical Control project continues to be used; no update is performed. The generation status of facets may be set to

inconsistent, page 308

Independently of the action that you select, the Global Constituent Type Version

Conflicts dialog box opens again if in another section of the same Control project another facet is detected, which encapsulates the same version of the same type and with a signature that is the same as in the previous facet or with yet another signature.

If two or more facets encapsulating the same version of a type but each with a different signature are detected in the same section,

consistency check, page 347

Performing a Consistency Check After Version Conflict

Detection

It is recommended to perform a

when the software detects several versions of the same type or the same version with different signature during generation of a Control Participant project.

A consistency check detects which generated facets encapsulate a type whose version or signature is different from the version/signature of the type used in the

Control Participant project. The status of such facets is set to Inconsistent .

The following example illustrates a scenario where a consistency check allows identifying a facet that contains a version of a type that is different from the version used in the Control project after the software detected a version conflict. In this example, v1.0 of DFB_A type was generated in the Control project by Facet_2. A second facet (Facet_1) containing v2.0 of the same type is assigned to a different section and the project is generated again.

Section Facet DBF_

A type version

Facet assignment/ generation status before generating

Section_1 Facet_

1 v2.0

Section_2 Facet_

2 v1.0

Out Of Date/

Generated

Assigned/

Generated

Facet status after generating and performing a consistency check

Assigned/

Generated

Comment

Assigned/

Inconsistent

The software detects a version conflict and you update the type used in the Control project to v2.0 by selecting

Update .

Because the facet encapsulates v1.0 of the type, the consistency check has set the status of the facet to Inconsistent .

Regenerating a Control Participant Project After Type Version

Changes

When you select the Regenerate command after generating a Control Participant project or section in which version conflicts were detected, the behavior is different depending on what you regenerate.

If you regenerate the entire Control Participant project, the software removes the types from the logical Control project and generates the ones that are encapsulated in facets assigned to the Control Participant project sections. If various versions of a same type are detected again, the Global Constituent Type

Version Conflicts dialog box opens.

If you regenerate a section of a Control Participant project, the software

maintains existing types, page 327

in the logical Control project and starts over the generation process. During regeneration, it compares:

309

310

in the same section, page

• For the first facet of the section that encapsulates a type, the version of the type.

• The version of this type that exists in the logical Control project.

If they are different, it opens the Global Constituent Type Version Conflicts dialog box.

If they are identical, it performs the comparison with the second facet of the section encapsulating a type, and so on.

In case several versions of the same type are detected

310

, generation stops.

Examples

The following examples illustrate various type version conflict scenarios when facets are assigned to the same section.

Description

A facet is assigned to an already generated section.

A section contains two facets that are not generated.

A section contains two facets that are generated and one of them is updated to use a different version of the type.

Command used

–

A generated facet is updated while the same section contains a non-generated facet.

This example illustrates a possible solution to examples 1.

Update and Skip

Refer to

The following examples illustrate various type version conflict scenarios when facets are assigned to different sections.

Description

Two different versions of the same type in different sections of a Control project.

Several different versions of the same type in different sections of a Control project.

Two different versions of the same type in different sections of a Control project.

Several different versions of the same type in different sections of a Control project.

Two different versions of the same type in different sections of a Control project.

Command used

Update

Skip

Refer to

Update and Skip

Cancel and Update

The Regenerate command is also described.

Example 7, page 317

Example 8, page 318

Example 1a: Two Different Versions of the Same Type in the

Same Section

A facet is assigned to an already generated section.

The starting point is the following:

• One facet is assigned to Section_1 and generated.

• The facet encapsulates DFB_A.

EIO0000001114.15

Facet ID

Facet_0

DFB_A version encapsulated in facet v1.0

Facet assignment/ generation status

Assigned/Generated

DFB_A version used in

Control project v1.0

Facet ID (1)

Facet_0

Facet_1 v1.0

v2.0

Then, another facet encapsulating DFB_A but of a different version is assigned to the same section. The section is generated again to apply the changes.

The table explains the behavior during generation of Section_1 and which version of DFB_A is used in the end.

DFB_A version encapsulated in facet

Facet assignment/ generation status after generation

Assigned/Generated

Assigned/Non Generated

DFB_A version used in

Control project after generation v1.0

Comment

The software detects v2.0

while v1.0

is already generated. Because the conflict arises in the same section,

use the same version of DFB_A, page 313 .

and DFB_A version v1.0

is maintained.

The status of facets is unchanged.

To be able to generate the section, you can either:

• Unassign one of the facets from the section.

• Update the template used by one of the instances so that both facets

• Unlink Facet_0, generate the section, select

Update when the Global Constituent Type

Version Conflicts dialog box opens, then relink Facet_0.

(1) The order of facets in the section is not relevant.

(Back to

Example 1b: Two Different Versions of the Same Type in the

Same Section

A section contains two facets that are not generated.

The starting point is the following:

• Two facets of two different instances are assigned to Section_1.

• Both facets encapsulate DFB_A but of a different version.

• DFB_A does not exist in the Control project.

Facet ID

Facet_0

Facet_1

(1) DFB_A version encapsulated in facet v1.0

v2.0

(1) The order of facets in the section is not relevant.

Facet assignment/generation status

Assigned/Non Generated

Then, the section is generated.

The table explains the behavior during generation of Section_1 and which version of DFB_A is used in the end.

EIO0000001114.15

311

Facet ID

Facet_0

Facet_1

(1) DFB_A version encapsulated in facet v1.0

v2.0

Facet assignment/ generation status after generation

Assigned/Non Generated

DFB_A version used in

Control project after generation

None

Comment

The software detects v1.0

and v2.0

in the same section. Because of this,

use the same version of DFB_A, page 313

and no version of DFB_A is generated.

The status of facets is unchanged.

To be able to generate the section, you can either:

• Unassign one of the facets from the section.

• Update the template used by one of the instances so that both facets

(1) The order of facets in the section is not relevant.

(Back to

Example 1c: Two Different Versions of the Same Type in the

Same Section

A section contains two facets that are generated and one of them is updated to use a different version of the type.

The starting point is the following:

• Two facets of two different instances are assigned to Section_1.

• Both facets encapsulate the same version of DFB_A.

Facet ID (1) DFB_A version encapsulated in facet v1.0

Facet assignment/ generation status

Facet_0

Facet_1

Assigned/Generated v1.0

(1) The order of facets in the section is not relevant.

DFB_A version used in

Control project v1.0

Facet ID (1)

Facet_0

Facet_1 v2.0

v1.0

Then, the template used by instance referencing Facet_0 is updated. This results in Facet_0 encapsulating a different version of DFB_A. The section is generated again to apply the change.

The table explains the behavior during generation of Section_1 and which version of DFB_A is used in the end.

DFB_A version encapsulated in facet

Facet assignment/ generation status after generation

Out Of Date/Generated

Assigned/Generated

DFB_A version used in

Control project after generation v1.0

Comment

The software detects v2.0

while v1.0

is already generated. Because the conflict arises in the same section,

use the same version of DFB_A, page 313 .

and DFB_A version v1.0

is maintained.

The status of facets is unchanged.

To be able to generate the section, you can either:

• Unassign one of the facets from the section.

• Update the template used by the instance referencing Facet_1 so that both facets

• Unlink the already assigned and generated facet (Facet_1), generate the section, select

Update when the Global Constituent Type

Version Conflicts dialog box opens, then relink Facet_1.

(1) The order of facets in the section is not relevant.

312 EIO0000001114.15

(Back to

Example 2: Two Different Versions of the Same Type in the

Same Section

A generated facet is updated while the same section contains a non-generated facet.

The starting point is the following:

• Two facets are assigned to Section_1.

• One facet is generated, the other not.

• Both facets encapsulate DFB_A but of a different version.

Facet ID (1) DFB_A version encapsulated in facet v1.0

Facet assignment/generation status

Facet_0

Facet_1

Assigned/Generated

Assigned/Non Generated v2.0

(1) The order of facets in the section is not relevant.

DFB_A version used in

Control project v1.0

Facet ID (1)

Facet_0

Facet_1 v2.0

v2.0

Then, the template used by instance referencing Facet_0 is updated. This results in Facet_0 encapsulating the same version of DFB_A as Facet_1 ( v2.0

). The assignment status of Facet_0 is set to Out Of Date . The section is generated again to apply the change.

The table explains the behavior during generation of Section_1 and which version of DFB_A is used in the end.

DFB_A version encapsulated in facet

Facet assignment/ generation status after generation

Assigned/Generated

DFB_A version used in

Control project after generation v2.0

Comment

The software detects v2.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical Control project is updated from v1.0

to v2.0

(1) The order of facets in the section is not relevant.

NOTE: If you select Skip instead, none of the facets in Section_1 are generated and the version of DFB_A in the logical Control project remains v1.0

(Back to

Example 3: Two Different Versions of the Same Type in Different

Sections of a Control Project

This example illustrates the behavior during generation when facets encapsulating two different versions of the same type are assigned to various sections.

The starting point is the following:

• Four facets of four different instances are assigned to separate sections.

• Each facet encapsulates DFB_A.

• All sections are part of the same Control project and generated.

Facet ID DFB_A version used in Control project v1.0

Facet_0

Facet_1

DFB_A version encapsulated in facet v1.0

v1.0

Section ID (1)

Section_0

Section_1

EIO0000001114.15

313

Facet ID DFB_A version encapsulated in facet

Section ID (1)

Facet_2

Facet_3 v1.0

Section_2

Section_3 v1.0

– No facet assigned Section_4

(1) The order of the sections corresponds to the section number.

DFB_A version used in Control project

Then, the following changes are performed:

• The template used by one instance is updated. As a result, one facet encapsulates DFB_A of a different version and its status is set to Out Of

Date .

• A new facet, Facet_4, is assigned to Section_4. It encapsulates version v1.0

of DFB_A and its statuses are Assigned / Non Generated .

The Control project is generated again to apply the changes.

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

Facet ID DFB_A version encapsulated in facet

Section ID (1) DFB_A version used in Control project after facet generation v1.0

Comment

Facet_0 v1.0

Section_0 No change to be generated for the facet.

Facet_1

Facet_2

Facet_3 v2.0

v1.0

Section_1

Section_2

Section_3 v2.0

(2) The software detects v2.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical Control project is updated from v1.0

to v2.0

Because v1.0

has already been detected, the previously selected Update command is applied automatically and

DFB_A version v2.0

is maintained.

Facet_4 v1.0

Section_4 Facet_4 is not generated; its statuses remain Assigned /

Non Generated .

NOTE: If the assignment status of Facet_2 or Facet_3 is Out Of Date , its generation status is set to

Inconsistent .

(1) The order of the sections corresponds to the section number.

(2) Version of DFB_A that is used in the end after successful generation of the Control project.

(Back to

Example 4: Several Different Versions of the Same Type in

Different Sections of a Control Project

This example illustrates the behavior during generation when facets encapsulating different versions of the same type are assigned to the various sections.

The starting point is the following:

• Four facets of four different instances are assigned to separate sections.

• Each facet encapsulates DFB_A.

• All sections are part of the same Control project and generated.

314 EIO0000001114.15

Facet ID DFB_A version encapsulated in facet

Section ID (1)

Facet_0

Facet_1

Facet_2

Facet_3 v1.0

v1.0

Section_0

Section_1

Section_2

Section_3

(1) The order of the sections corresponds to the section number.

DFB_A version used in Control project v1.0

Then, the template used by some instances is updated with various versions. As a result, the facets encapsulate various versions of DFB_A and their status is set to

Out Of Date . The Control project is generated again to apply the changes.

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

Facet ID

Facet_0

Facet_1

Facet_2

DFB_A version encapsulated in facet v1.0

v3.0

v1.0

Section ID

Section_0

Section_1

Section_2

(1) DFB_A version used in Control project after facet generation v1.0

v3.0

Comment

No change to be generated for the facet.

The software detects v3.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical Control project is updated from v1.0

to v3.0

Because v1.0

has already been detected, the previously selected Update command is applied automatically and

DFB_A version v3.0

is maintained.

NOTE: If the assignment status of the facet is Out Of

Date , its generation status is set to Inconsistent .

Facet_3 v4.0

Section_3 v4.0

(2) The software detects v4.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical Control project is updated from v3.0

to v4.0

(1) The order of the sections corresponds to the section number.

(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: It is possible to update the version of a type to an earlier one. For example, if Facet_3 would encapsulate DFB_A of version v2.0

, the version used in the end would be v2.0

(Back to

Example 5: Two Different Versions of the Same Type in Different

Sections of a Control Project

This example illustrates the behavior during generation when facets encapsulating two different versions of the same type are assigned to various sections and the

Skip command is used.

The starting point is the following:

• Four facets of four different instances are assigned to separate sections.

• Each facet encapsulates DFB_A.

• All sections are part of the same Control project and generated.

Facet ID DFB_A version used in Control project v1.0

Facet_0

Facet_1

Facet_2

DFB_A version encapsulated in facet v1.0

v1.0

Section ID (1)

Section_0

Section_1

Section_2

EIO0000001114.15

315

Facet ID DFB_A version encapsulated in facet

Section ID (1)

Facet_3 v1.0

Section_3

(1) The order of the sections corresponds to the section number.

DFB_A version used in Control project

Then, the template used by two instances is updated. As a result, two facets encapsulate DFB_A of a different version and their status is set to Out Of Date .

The Control project is generated again to apply the changes.

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

Facet ID DFB_A version encapsulated in facet

Section ID (1) DFB_A version used in Control project after facet generation v1.0

(2)

Comment

Facet_0

Facet_1 v1.0

v2.0

Section_0

Section_1

No change to be generated for the facet.

The software detects v2.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Skip is selected. The facet is not generated and the version of

DFB_A used in the logical Control project remains v1.0

Facet_2

Facet_3 v1.0

v2.0

Section_2

Section_3

No change to be generated for the facet.

Because v2.0

has already been detected, the previously selected Skip command is applied automatically. The facet is not generated and DFB_A version v1.0

is maintained.

(1) The order of the sections corresponds to the section number.

(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: The assignment status of Facet_1 and Facet_3 remains Out Of Date .

(Back to

Example 6: Several Different Versions of the Same Type in

Different Sections of a Control Project

This example illustrates the behavior during generation when facets encapsulating different versions of the same type are assigned to the various sections and the

Skip command is used.

The starting point is the following:

• Four facets of four different instances are assigned to separate sections.

• Each facet encapsulates DFB_A.

• All sections are part of the same Control project and generated.

Facet ID

Facet_0

Facet_1

Facet_2

Facet_3

DFB_A version encapsulated in facet v1.0

v1.0

Section ID

Section_0

Section_1

Section_2

Section_3

(1)

(1) The order of the sections corresponds to the section number.

DFB_A version used in Control project v1.0

Then, the template used by some instances is updated with various versions. As a result, the facets encapsulate various versions of DFB_A and their status is set to

Out Of Date . The Control project is generated again to apply the changes.

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

316 EIO0000001114.15

Facet ID DFB_A version encapsulated in facet

Section ID (1) DFB_A version used in Control project after facet generation v1.0

(2)

Comment

Facet_0

Facet_1

Facet_2 v1.0

v2.0

v4.0

Section_0

Section_1

Section_2

No change to be generated for the facet.

The software detects v2.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Skip is selected. The facet is not generated and the version of

DFB_A used in the logical Control project remains v1.0

The software detects v4.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Skip is selected. The facet is not generated and the version of

DFB_A used in the logical Control project remains v1.0

Facet_3 v2.0

Section_3 Because version v2.0

has already been detected (for

Facet_1), the previously selected Skip command is applied automatically. The facet is not generated and the version of

DFB_A used in the logical Control project remains v1.0

(1) The order of the sections corresponds to the section number.

(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: The assignment status of Facet_1, Facet_2, and Facet_3 remains Out

Of Date .

(Back to

Example 7: Several Different Versions of the Same Type in

Different Sections of a Control Project

This example illustrates the behavior during generation when facets encapsulating different versions of the same type are assigned to the various sections and the

Update and Skip commands are used.

The starting point is the following:

• Six facets of six different instances are assigned to separate sections.

• Each facet encapsulates DFB_A.

• All sections are part of the same Control project and generated.

Facet ID

Facet_0

Facet_1

Facet_2

Facet_3

DFB_A version encapsulated in facet v1.0

v1.0

Section ID

Section_0

Section_1

Section_2

Section_3

(1)

Facet_4

Facet_5 v1.0

v1.0

Section_4

Section_5

(1) The order of the sections corresponds to the section number.

DFB_A version used in Control project v1.0

Then, the template used by the instances is updated with various versions. As a result, the facets encapsulate various versions of DFB_A and their status is set to

Out Of Date . The Control project is generated again to apply the changes.

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

EIO0000001114.15

317

Facet ID DFB_A version encapsulated in facet

Section ID (1) DFB_A version used in Control project after facet generation v4.0

Comment

Facet_0

Facet_1

Facet_2

Facet_3

Facet_4 v4.0

v2.0

v1.0

v4.0

v2.0

Section_0

Section_1

Section_2

Section_3

Section_4 v4.0

(2)

The software detects v4.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical Control project is updated from v1.0

to v4.0

The software detects v2.0

and opens the Global

Constituent Type Version Conflicts dialog box.

Skip is selected. The facet is not generated and version v4.0

DFB_A is maintained.

NOTE: The generation status of the facet is set to

Inconsistent because the version of DFB_A has been previously updated when generating Facet_0.

Because version v1.0

has already been detected when generating Facet_0, the previously selected Update command is applied automatically and DFB_A version v4.0

is maintained.

NOTE: If the assignment status of the facet is Out Of

Date , its generation status is set to Inconsistent .

The facet is generated but without the detection of a version change because the version of DFB_A used in the Control project is already v4.0

due to the update when generating

Facet_0.

The previously selected Skip command (for Facet_1) is applied automatically. The facet is not generated and DFB_

A version v4.0

is maintained.

NOTE: The generation status of the facet is set to

Inconsistent because the version of DFB_A has been previously updated when generating Facet_0.

Facet_5 v3.0

Section_5 The software detects v3.0

for the first time and therefore opens the Global Constituent Type Version Conflicts dialog box.

Skip is selected. The facet is not generated and the version of DFB_A used in the logical Control project remains v4.0

NOTE: The generation status of the facet is set to

Inconsistent because the version of DFB_A has been previously updated when generating Facet_0.

(1) The order of the sections corresponds to the section number.

(2) Version of DFB_A that is used in the end after successful generation of the Control project.

(Back to

Example 8: Two Different Versions of the Same Type in Different

Sections

This example illustrates the behavior during generation when facets encapsulating different versions of the same type are assigned to the different sections and the

Cancel and Update commands are used.

The starting point is the following:

• Two facets of two different instances are assigned to one section each.

• Each facet encapsulates DFB_A.

• Facets are not yet generated.

Facet ID (1) DFB_A version encapsulated in facet

Section ID

Facet_0

Facet_1 v1.0

v2.0

Section_1

Section_2

(1) The order of the facet in the section corresponds to the facet number.

DFB_A version used in Control project

None

Then, the Control project is generated.

318 EIO0000001114.15

The table explains the behavior during generation of the Control project and which version of DFB_A is used in the end.

Facet ID DFB_A version encapsulated in facet

Section ID DFB_A version used in

Control project after generation

1.0

Comment

Facet_0 v1.0

Section_1 Version v1.0

of DFB_A is generated in the logical Control project.

Facet_1 v2.0

Section_2 1.0

(1) The software detects v2.0

and opens the Global Constituent Type Version

Conflicts dialog box.

Cancel is selected. Generation stops. The facet is not generated and the version of DFB_A used in the logical Control project remains v1.0

(1) Version of DFB_A that is used in the end after successful generation of the section.

Then, the Control project is generated a second time.

Facet ID DFB_A version encapsulated in facet

Section ID DFB_A version used in

Control project after generation

1.0

Comment

Facet_0 v1.0

Section_1 No change to be generated for the facet.

Facet_1 v2.0

Section_2 2.0

(1) The software detects v2.0

and opens the Global Constituent Type Version

Conflicts dialog box.

Update is selected. The facet is generated and the version of DFB_A used in the logical

Control project is updated from v1.0

to v2.0

(1) Version of DFB_A that is used in the end after successful generation of the section.

NOTE: After the second generation, if you regenerate:

• The entire Control project: A version conflict is detected in Section_2 like during a first generation because type DFB_A is removed from the

Control before regenerating.

• Section_1: A version conflict is detected because the version of DFB_A in the Control project ( v2.0

) is different from the version encapsulated in

Facet_0 ( v1.0

• Section_2: No version conflict is detected.

(Back to

generation of facets after changes, page 323

Statuses of Facets

EIO0000001114.15

Overview

After the generation process, the generation and assignment statuses of facets provide information on the facet state.

NOTE: For information on the behavior when generating such facets again, refer to the topic describing the

Generation Status of Facets

The generation status indicates the status of the facet in relation to the generation of its constituents in the logical Participant project.

319

320

You can see the generation status in the Generation column of the Assignments

consistency check, page 347 :

in the Assignment Editor .

The table describes the possible generation statuses of facets following a generation.

Status Description

Non

Generated

You have assigned the facet to the FBD section or container after generating that section/container.

Generate, page 323

the section/container again to create the constituents of the facet in the logical Participant project.

It can also indicate that the generation process of a facet or its container was unsuccessful.

Generated The software has successfully generated the constituents of the facet into the logical participant project.

NOTE: The software automatically sets the status of Supervision genie facets that you assign to a page during page edit to Generated .

Moved

Inconsistent

Unlinked

You have

moved, page 293

the facet to another FBD section of the Control project or another container of the Supervision.

NOTE:

• If you move the facet back to its original FBD section or container, it keeps the status Moved .

• The status does not apply to genie facets.

You have refined, updated, or imported the logical Control Participant project, or relinked a facet, which was unlinked and the software has detected an inconsistency in the facet during the

• You have not yet generated the section containing the facet again in order for the software to

resolve the inconsistency, page 325

and change the status, or

• The software could not solve the inconsistency during a subsequent generation and the status of the facet remains Inconsistent .

NOTE: By default, the status of Supervision genie and data facets changes to

Inconsistent when you

reassign or relink, page 332

them.

NOTE: This status can also be the result of a type version conflict that the software detected during

generation of Control facets, page 305

You have unlinked the facet from its already generated constituents in the logical

Participant project:

• By using the

Unlink , page 334

command.

• By unlinking the facet through the Check Consistency dialog box:

◦ After

refining a Control Participant project, page 336 .

◦ Before

updating a Control Participant project, page 573

By unlinking a facet, the software does not change already generated constituents when you generate it again if the status the facet is such that a generation would change its status (for example, if the status of the facet is out of date or inconsistent, generating it would change its status to generated). This allows you to preserve changes that you have made in the logical Participant project to constituents of the facet through refinement or refinement online.

Assignment Status of Generated Facets

The assignment status indicates the status of the facet in relation to the instance that references the facet.

The software may update the Assignment status of the facet when you change the properties of the instance that references the facet.

You can see the assignment status in the Assignment column of the

Assignments

in the Assignment Editor .

The table describes the possible assignment statuses of a facet following a generation.

Status Description

Assigned The facet is assigned to the container.

Unassigned

You have

unassigned, page 332

had assigned it.

a generated facet from the container to which you

NOTE: The facet can still be assigned to other projects of the system.

EIO0000001114.15

The application structure, page 156

Status

Out Of

Date

Deleted

Description

You have changed at least 1 of the following parameter configurations of the instance that references the facet:

• $System parameters (see EcoStruxure ™ Process Expert, Global Templates,

Reference Manual) that affect the facet.

• Element selections and their parameters.

• Instance identifier (including changes made by the software in relation to the hierarchical naming function).

• Links.

• Updated or replaced the template that is used by the instance.

• Other changes made within the application to an instance and that affect its facet.

Furthermore, for Supervision data facets only, you have changed any of the following in the Supervision project:

• The identifier of the cluster or I/O device.

• The identifier of the tag container if Protocol is set to OPCUA .

• The relationship between the tag container and the I/O device.

• The protocol of the tag container.

•

(in the Application Explorer ).

You have unselected the corresponding element in the Instance Editor or deleted the instance that references the facet.

Generating a Project for the First Time

Overview

This section describes how to use the Project Explorer to create a logical Control or Supervision Participant project or part of a project for the first time.

concurrent actions, page 52 . In such case, check the

for details.

Generating Entire Projects

Overview

The generation of the entire project for the first time encompasses:

• For a Control project: The FBD sections of the project and the facets that are assigned to these sections.

• For a Supervision project: The various containers of the clusters of the project to which facets are assigned and any associated components of the Services node.

The status of facets is updated only after the entire generation process is completed.

NOTE: You can generate a project while the generation of another project is still ongoing.

Aborting Project Generation Tasks

After selecting the Generate command, the abort icon is displayed in the

. Click the icon to cancel the task. The project is not generated; what the software had already generated at the time you canceled the task is reverted.

Refer to the notification panel for details.

Only the user who has selected the command is allowed to abort it.

EIO0000001114.15

321

generation status, page 319

NOTE: If you are generating a small project, the task may complete before you are able to click the icon.

Generating an Entire Project

To generate an entire Participant project, proceed as follows.

Step

Action

In the project browser or the Containers pane of the Assignment Editor , right-click the project that you want to generate and select Generate .

Result:

• The software creates the corresponding logical Participant project. Generation is complete when Completed is displayed for the process in the notification panel.

• The status of the Generation column in the Assignments pane changes to

Generated for facets that are assigned to the project.

NOTE: If you are generating the project again, the

of facets that were Unlinked remains unchanged and those that were Inconsistent may remain unchanged.

NOTE: For Control projects, you can configure certain

generation settings, page 304 .

Generating Sections, Containers, and Nodes

Overview

The generation of parts of a project for the first time encompasses:

• For an FBD section of a Control project: The facets that are assigned to the section and the order of the section.

• For a Supervision project:

◦ For the Containers node: The containers of all the clusters of the project.

◦ For tag containers, pages, client and sever event containers: The facets that are assigned to the respective container.

◦ For the Tags containers: The facets that are assigned to the containers of the corresponding cluster.

◦ For a cluster: The containers of the Tags , ClientEvents , and

ServerEvents nodes of the cluster and any components of the Services node.

◦ For the Services node: The components of the node.

NOTE: You can generate several sections or containers of the same project at the same time but the generation process will occur in sequence. If the sections/containers belong to different projects, they are generated in parallel.

Aborting Generation Tasks

After selecting the Generate command, the abort icon is displayed in the

. Click the icon to cancel the task. The container of the

Participant project is not generated; what the software had already generated at the time you canceled the task is reverted.

Refer to the notification panel for details.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are generating a container to which only few facets are assigned, the task may complete before you are able to click the icon.

Generating Part of a Project

To generate part of a project, proceed as follows.

322 EIO0000001114.15

generation status, page 319

Step

Action

In the project browser or in the Containers pane of the Assignment Editor , right-click the item that you want to generate and select Generate .

Result:

• The software generates the contents of the selected item. Generation is complete when Completed is displayed for the process in the notification panel.

• The status of the Generation column in the Assignments pane changes to

Generated for the facets that are assigned to the selected containers.

NOTE: If you are generating this part of the project again, the

of facets that were Unlinked remains unchanged and those that were

Inconsistent may remain unchanged.

NOTE: For Control projects, you can configure certain

generation settings, page 304

Generating Projects After Changes

Overview

This section describes how to use the Project Explorer to perform a subsequent generation or to regenerate entire logical Control or Supervision Participant projects, or parts of such projects.

You may be able to

import into the deployed Control Participant project, page 558

sections that you have generated or regenerated after modifying them.

concurrent actions, page 52 . In such case, check the

for details.

Generating Participant Projects After Changes

Overview

You need to generate the logical Participant project that you have created with the first-time generation when you make changes that result in facets having one of the following statuses:

• Assignment status:

◦ Unassigned

◦ Out Of Date

◦ Deleted

• Generation status:

◦ Non Generated

◦ Moved

◦ Inconsistent

You also need to generate it when you perform the following actions on sections of a Control project in the Project Explorer :

• Rename a section.

• Create an FBD section.

• Change the order of sections.

To update the logical Participant project, use one of the following commands:

EIO0000001114.15

323

324

Control projects only, page 327 . Re-creates the logical

Generate

Regenerate

Only changes that you made to the application and the project since the last generation are generated incrementally into the logical Participant project. Already generated data remains unchanged. However, certain changes that you made during refinement may be discarded.

Applies to

Participant project from the beginning based on the current application and Control project settings. Certain changes that you made during refinement are discarded. You can configure certain

generation settings, page 304

The software proceeds with the

validation of data, page 298

like it does when generating.

NOTE: To apply to the logical Control project changes that you have made to sections, you can also select the Refine

command, page 336

at the project level.

Generation Function Description

The table indicates the actions that the software executes on facets when you perform a subsequent generation of a project or parts of it, based on the

Assignment and Generation status of the facet.

Facet generation status

Facet assignment status

Assigned

Non

Generated

Generated Moved Inconsistent

Out Of Date

Unassigned

–

O (1)

Del

–

Deleted – Del –

X Creates the constituent of the facet in the logical Participant project

Del

Unlinked

–

O No action

Del Removes the facet and its already generated constituents (for example, variables and FB instances) but not derived types (DFBs and DDTs)

– Combination not applicable

(1) Some exceptions apply. Refer to the topic describing the generation of Control projects after refining

NOTE: When you change the order of a facet inside a section that you had generated a first time and generate it again, the software does not propagate the new

order of facets, page 295

to the logical Control Participant project.

Generating Control Projects After Changing the Order of

Sections

When you

change the order, page 207

of already generated sections and generate again either the entire Control project or a section whose order you have changed, the software propagates the new order to the logical Control Participant project.

NOTE: Generating at the project level may take slightly longer to complete compared to generating at the section level.

Generating Control Projects After Refining

If during refinement you have modified code in a section that was already generated by the software from a facet (for example, you have modified the variable or immediate value on a pin of a DFB), the software reverts your change when you generate the section again if any of the following conditions is true; otherwise your modification is preserved:

EIO0000001114.15

• You assign a facet to this section.

• You unassign a facet in this section.

• You move a facet to or from this section.

• You make a modification, which sets the status of any facet assigned to this section to Out Of Date .

• You perform a consistency check, which sets the status of any facet assigned to this section to Inconsistent .

Your modification is reverted to the code that the software had previously generated from the facet.

If your modification consists in replacing a variable or immediate value on the pin of an FFB by a graphical link, such modification is not reverted by a subsequent generation. If the change is detected as an inconsistency, the generation status of the corresponding facet is set to Inconsistent .

In this example, the immediate value of the ZSHEN input parameter of the

DEVCTL DFB is changed to True during refinement and saved. Section Motor_1_

Motor that contains the facet, which generates the DFB ( Motor_1_DEVCTL ) contains only facets with the Assigned and Generated status. No other changes were made in the Control project. Generating section Motor_1_Motor does not undo your refinement; the immediate value of the ZSHEN input parameter remains True .

However, if section Motor_1_Motor contains, for example, a facet with status Out

Of Date , generating the section undoes the refinement change, setting the

ZSHEN input parameter again to False .

EIO0000001114.15

Generating Supervision Projects After Refining

Generating a Supervision project overrides any changes that you have made in refinement to elements pertaining to the

Services , page 230

of the project.

Generating Inconsistent Facets

During generation, the software attempts to restore the generated constituents of facets in the logical Control Participant project that have the Generation status

Inconsistent to be consistent with the related facets of the Control project.

The resulting Generation status of an inconsistent facet can be:

325

326

State of a facet, page 282

• Generated : The software completely restored the generated constituents while preserving the refinement that you have made.

• Inconsistent : The software was not able to restore the generated constituents completely because it would require altering the refinement that you have made. The software may have partially restored the constituents and the refinement that you have made was preserved.

This is the case, for example, if during refinement of an FBD section, you replace a variable by a graphical link and such change is detected as an inconsistency. Indeed, the software retains your refinement if you generate the section. Your refinement is discarded if you regenerate the section.

Generating Facets with State Invalid

If the

has become Invalid after you generated it, generating the container or Participant project again does not remove the facet from the container.

This can be the case, for example, when you link instances A and B (where instance A needs to be linked to be valid), assign their facets to a Control project, generate the section, and then delete the link between the two instances. The facet of instance A becomes invalid because the instance is not linked anymore.

You need to either

regenerate, page 327

the section to which the invalid facet is assigned or unassign the facet and generate to remove it from the section.

Function Block Layout

When you generate Control projects or sections again, the software positions function blocks that are encapsulated in facets depending on their status:

• Facets that you had already generated and that have the following status:

◦ Out Of Date : Facets creating a new function block after a change in their properties. The function block is positioned according to the layout defined by the template referencing the facet.

◦ Inconsistent : Function blocks encapsulated in the facet are recreated and positioned in their previously generated position.

For both facets, if the position of the function block is already occupied, the block is moved to the end of the section content (Y axis), keeping its horizontal position (X axis) as defined by the layout of the template referencing the facet.

• Non Generated facets:

◦ Single facets created through an element selection and that you have assigned to the section after generating it: Function blocks encapsulated in the facet are positioned at the end of the section content, on the outer left.

◦ Facets referenced by an instance of which no facets were previously assigned: Function blocks encapsulated in the facets are positioned at the end of the section content while respecting the layout as defined by the template that the instance uses.

This requires that the generation of the corresponding facets completes successfully and that the resulting facet status is Generated .

The software manages

the section size, page 302

as needed.

For more information, refer to Section Layout Management Example (see

EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

NOTE: To keep the constituents that are generated for an instance grouped, assign all its facets at once.

NOTE: Certain

configurable generation settings, page 304

can affect the position of function blocks.

EIO0000001114.15

Part of a project, page 322

Generating a Project Again

Refer to the procedure describing how to generate:

• The

entire project, page 321

•

Regenerating a Control Project

Control Project Regeneration Description

This process recreates the logical Control Participant project from the beginning based on the current settings:

• Section execution order.

• Facet execution order inside the section.

• Properties of assigned facets.

The following changes made during

refinement, page 336

are discarded by the regeneration process:

• Any changes to the contents of sections to which facets are assigned.

• Any contents added to such sections.

• If you set the ReGenerateNonFbdSections parameter to false :

◦ Non-FBD sections that you have added during refinement and their contents.

◦ Name changes of FBD sections that are created by the generation process.

◦ FBD sections that you have added during refinement, their contents and any facets that you have assigned to these sections.

You can regenerate the entire Control project or FBD sections individually.

If the software was not able to regenerate a Control project or FBD sections of it, the

status of facets, page 329

can vary.

Types Removed When Regenerating

The following derived types (DFBs and DDTs) are removed from the logical

Control project when you regenerate it:

• Types that were generated from facets that you have unassigned from a project section or whose instance has been deleted.

• Types that remained after deleting the section that contained the facet that generated them.

NOTE: In both cases, such types are not removed when you:

• Regenerate only a section of a Control project.

• Generate the Control project.

Actions on Facets

The table indicates the actions that the software performs on facets when you regenerate a Control project or FBD section, based on the Assignment and

Generation status of the facet.

Facet generation status

Non Generated Generated Moved Inconsistent Unlinked Facet assignment status

Assigned

Out Of Date

–

EIO0000001114.15

327

328

the section size, page 302

Facet generation status

– Del Unassigned –

Deleted – Del –

X Creates the constituent of the facet in the Participant project

Del Deletes the facet and its already generated constituents

– Combination not applicable

Del

–

Control Project Section Size

The software manages

Execution Order and Function Block Layout

The process to regenerate the section order and section layout is the same as for a

first-time generation, page 303 , independently of the facet status.

Regenerating Control Projects Containing Non-FBD Sections

When you regenerate a Control project that contains non-FBD sections, a message appears in the notification panel for each one of them informing you that the section was generated because of an order change. This message, which is related to an internal process, appears even if the position of these sections has not changed.

An exception applies to non-FBD sections that have rank 0 ( Order column) when the Regenerate command is used. For these sections, the message does not appear whether their position has changed or not.

Aborting Regeneration of Projects And Sections

After confirming the ReGenerate command, the abort icon is displayed in the

Configure generation settings, page 304

. Click the icon to cancel the task. The Control project or section is not regenerated; what the software had already regenerated at the moment you canceled the task is reverted.

Refer to the notification panel for details.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are regenerating a small project or section, the task may complete before you are able to click the icon.

Regenerating the Entire Control Project

To recreate the entire logical Control Participant project, proceed as follows.

Step

Action

as needed.

In the project browser or the Containers pane of the Assignment Editor , right-click the

Control project that you want to regenerate and select ReGenerate .

Result:

• The software re-creates the logical Control Participant project. Regeneration is complete when Completed is displayed for the process in the notification panel.

• The status of the Generation column in the Assignments pane changes to

Generated for the facets that are assigned to the project.

EIO0000001114.15

sections that are not regenerated, page 301

Regenerating an FBD Section Only

The regeneration at the FBD section level allows you to recreate the Control

Participant logic for the facets contained in the selected FBD section only.

To regenerate the logic of an FBD section, proceed as follows.

Step

Action

In the Containers pane of the Assignment Editor , right-click the section that you want to regenerate and select ReGenerate .

Result:

• The software re-creates the Control Participant logic of the selected section only.

Regeneration is complete when Completed is displayed for the process in the notification panel.

• The status of the Generation column in the Assignments pane changes to

Generated for the facets that are assigned to the selected FBD section.

Facet Status After Unsuccessful Regeneration

The table describes the effect on the status of Control facets when the regeneration of a section is not successful.

Regenerated project component

Entire Control project

Control project section

Facet status

The generation status of facets assigned to

reverts to the value it was before regenerating.

The generation status of facets assigned to this section reverts to the value it was before regenerating.

Generating Equipment in Supervision Projects

Generating Equipment Based on the Application

Overview

By default, generating a Supervision project populates the equipment table of the

Supervision project based on the

structure of the application, page 116

. Each instance of the application creates one equipment instance. This allows you to view alarms during runtime in a structure identical to the hierarchy of the application.

To create equipment names, the software may truncate the identifier of folders and instances to comply with the format of the name field of the equipment database file.

Changes to the structure, page 156

of the application are reflected on generated facets of the project allowing you to update the equipment database file by generating the project again.

NOTE: To view the equipment name that is generated, refine the Supervision project and open the equipment table.

Properties of the Equipment Table

The generation process populates the following properties of the equipment table of the Supervision project.

EIO0000001114.15

329

330

Field

Name

Description

Instance identifier with its path in the application, satisfying the equipment naming rules for the name field (1) . The folder and instance identifiers are dot-separated.

NOTE: The system root folder identifier is not included in the name.

Cluster Identifier of the cluster of the Supervision project to which facets of the instance are associated.

$Description parameter of the instance.

Comment

Area $Area parameter of the instance.

(1) The Supervision Participant does not accept the use of certain reserved words for item names

(for example, DO ). While the software allows using these reserved words as identifiers of instances in the application, doing so prevents the Supervision project from generating successfully because the reserved word becomes the equipment name when the instance is created in the system root folder. For details on the reserved words, look up Reserved Words in the

help of the Supervision

Participant, page 69

NOTE: You can use the Equipment element (see EcoStruxure ™ Process

Expert, Global Templates, Reference Manual) to populate additional properties of equipment instances without impacting the way the equipment name is generated.

Rules Applying to the Creation of Equipment Names

The software may modify and/or truncate the identifier of folders and instances according to the following rules to populate the Name property of the equipment table of the Supervision project.

Item

Folder levels

Instance path

Rule

7 folders maximum not including the system root folder

125 characters maximum including the instance identifier and dot separators

Folder identifier length

12 characters maximum (1)

Instance identifier length

18 characters maximum (1)

Comment

–

Identifiers of folders

Can only begin with a letter.

Can only contain alphanumerical characters and underscores ( _ ).

No spaces.

By default, the identifiers of instances of

Schneider Electric templates are limited to 18 characters.

Examples :

$Folder1 and Folder$1 are modified to

Folder1 (or Folder100 if Folder1 already exists)

Folder 2 is modified to Folder2

(1) The software may add an indexer consisting of two digits at the end of identifiers so that the name of each folder having the same parent folder and the name of each instance inside a folder remain unique.

For more information on not allowed characters, refer to the topic describing

naming rules, page 65 .

NOTE: If the software truncates the instance identifier or path to satisfy the equipment name creation rules, it displays a notification once the generation process is completed.

NOTE: The software does not change the identifier of folders and instances in the application.

Example 1 - Folder Identifier Exceeds Length

If in the Application Explorer , the following instance exists:

• Conveyor_Motor_1

• At path (folder identifiers): System_1\PlantNorthFace\Unit 20

EIO0000001114.15

generate inside it, page 302

The generated equipment name is: PlantNorthFa.Unit20.Conveyor_Motor_1

Example 2 - Indexing the Truncated Folder Identifier

If in the Application Explorer , the following two instances exist in two distinct folders:

• Instance_1 at the path System_1\Folder_12345_1 (the application folder name has 14 characters)

• Instance_2 at the path System_1\Folder_12345

The generated equipment names are:

• Folder_1234500.Instance_1

• Folder_12345.Instance_2

Example 3 - Number of Folders Exceeds Limit

If in the Application Explorer , the following instance exists:

• Motor_1

• At path (folder identifiers): System_1\F1\F2\F3\F4\F5\F6\F7\F8\F9

The generated equipment name is: F1.F2.F3.F4.F5.F6.F7.Motor_1

Generation Diagnostic Messages

Overview

The following tables describe some of the messages that the software displays when applicable rules are not satisfied during the generation of Control and

Supervision projects and propose corrective actions.

In these messages and others,

notifications, page 254

that are generated by the

Control Participant may be displayed. These notifications provide more detailed information about the reason for which the generation process did not complete successfully.

For Control Projects

Message details

Section is overcrowded

Variable name conflict

Cause

The section cannot accept as many function blocks as the software is trying to

Also, you may have changed the position of DFBs during refinement so that the software cannot adapt the size of the section to accommodate the function blocks.

A facet is generating a variable that has the same name as an already existing variable in the project.

Corrective action

Do the following to free up space:

• Move or unassign facets from the FBD section.

• Change the layout of the function blocks inside the section.

• Verify whether a comment box is preventing the software from

adapting the size of the section, page 302

Then, generate the project/section again

NOTE: When you move DFBs inside a section, use either method:

• Position DFBs tightly together to use the full width of the grid effectively, leaving empty rows at the bottom of the section.

• Position DFBs to use the entire height of the grid, leaving empty columns on the right side of the section.

• You can

change the section size, page 304

by regenerating it.

You can do either of the following:

• Change the instance

$Name parameter, page 134

so that the facet creates a variable with a different name. Then, generate the project again.

• If you had already generated the project, refine the project and rename or remove the existing variable. Then, generate the project again.

EIO0000001114.15

331

updated the template used by an instance, page 166 .

Message details

Version conflict in the same section

Invalid characters

Cause

The software is trying to generate, within the same section, a version of a DDT and/or DFB that is different from the version that already exists in the Control project.

You may have

The name of a generated constituent contains a character that is invalid for use with the Control Participant.

Corrective action

•

Regenerate the Control project, page 327

in order to remove the existing variable (for example, if you had created the variable during refinement).

You can do either of the following:

• Update the template used by instances whose facets are assigned to the section so that only one version of the same type is generated.

• Remove the type from the project if it is not used anymore.

• Assign the facet that is generating the new version of the type to another section.

Generate the project again.

For details, refer to the topic describing the

management of type versions in Control facets during generation, page 305 .

Edit the properties of the instance referencing the facet that is mentioned in the message details so that resulting variable names and section identifiers satisfy the

concurrent actions, page 52 . In such case, check the

, and generate the project again.

For Supervision Projects

Detected error

Unique equipment name cannot be generated.

Indexer used for uniqueness has reached 99

(maximum limit).

Cause

The number of non-unique truncated folder and instance identifiers during generation exceeds 99.

Corrective action

Change the folder structure of the application or instance identifiers to reduce the number of non-unique identifiers that the software creates through

truncation, page 330 .

Managing Generated Facets

Overview

Following the generation of the Control or Supervision project, or parts of it, you can execute commands and actions on generated facets from the Assignments pane of the Assignment Editor .

for details.

Generated Facets Actions

The table outlines the commands and actions that you can execute on generated facets.

332 EIO0000001114.15

variable name conflict, page 331

EIO0000001114.15

Command or action

Unassign

Unlink

Reassign

Relink

Go To Instance

Move

Description

You can unassign facets that have the following Assignment status:

• Assigned

• Out Of Date

If you unassign a Control facet that has the generation status of Unlinked , the facet is removed from the section but the generated constituents pertaining to the facet are not deleted from the logical Control Participant project. If you assign this facet again to the same project, you may receive a notification about a

The status UnAssigned is described in

Assignment Status of Generated

Facets, page 320

Refer to

Unassigning Generated Facets, page 334 .

NOTE: The actions that the software executes when you select the

Unassign command for a generated facet or a

facet that is not yet generated, page 293

are different.

Refer to

Unlinking Generated Facets, page 334

NOTE: The status Unlinked is described in

Generation Status of Facets, page 319 .

You can reassign generated facets that have the status UnAssigned .

The Reassign command assigns a facet to the container in which it is located, allowing you to:

• Apply to the facet changes to the instance that references it.

• Generate its constituents into the logical Participant project.

The software performs a

consistency check, page 347

when available.

When the consistency check is not available, the generation status of facets changes to Inconsistent . This is the case, for example, for Supervision genie and data facets.

Reassigning a facet changes its status to Assigned .

Refer to

Reassigning Facets, page 334

You can relink generated facets that have the status Unlinked .

The Relink command links a facet again to its already generated constituents, allowing you to:

• Apply to the logical Participant project changes of the facet using the

Generate command.

• Detect inconsistencies by performing a consistency check.

When you relink a facet, the software performs a consistency check if the functionality is available for the facet. Depending on the result, it changes the generation status of the facet to either:

• Generated if it detects no inconsistency.

• Inconsistent if it detects an inconsistency.

When the consistency check is not available, the generation status of facets changes to Inconsistent . This is the case, for example, for Supervision genie and data facets.

Refer to

Relinking Facets, page 334 .

Allows you to go to the instance that references the facet.

The navigation feature is not available if the Assignment status of the facet is

Deleted .

Refer to

Navigating From Facets to Instance, page 296

Refer to

Moving Generated Facets, page 335 .

NOTE: The status Moved is described in

Generation Status of Facets, page 319 .

NOTE: For a description of the effect of a subsequent generation process on the facets that you have acted upon, refer to

Generating Projects After

Changes, page 323

333

334

derived data types, page 327

Unassigning Generated Facets

To unassign a generated facet from the container to which it is assigned, proceed as follows.

Step Action

1 In the Assignments pane, right-click the facet and select Unassign .

Result :

• The software unassigns the facet from the selected container.

• Its already generated constituents (for example, variables and FB instances for

Control facets and database entries for Supervision facets) are removed from the logical Participant project (except

for Control facets).

• The status of the facet displayed in the Assignment column changes to

UnAssigned .

NOTE: You can select several facets in the same container.

Unlinking Generated Facets

To unlink a facet, proceed as follows.

Step Action

1 In the Assignments pane, right-click the facet and select Unlink .

Result :

• The software unlinks the facet from its already generated constituents.

• The status of the facet displayed in the Generation column changes to Unlinked .

NOTE: You can select several facets in the same container.

Reassigning Facets

To reassign a facet, proceed as follows.

Step Action

1 In the Assignments pane, right-click the facet and select Reassign .

Result :

• The software reassigns the facet to the same container and performs a consistency check.

• The status of the facet displayed in the Assignment column changes to Assigned or Out Of Date .

• The status of the facet displayed in the Generation column changes to

Generated or Inconsistent , page 319

NOTE: You can select several facets in the same container.

Relinking Facets

To relink a facet, proceed as follows.

Step Action

1 In the Assignments pane, right-click the facet and select Relink .

Result :

• The software links the facet again to its generated constituents in the logical

Participant project.

• The status of the facet displayed in the Generation column changes to

Generated or Inconsistent , page 319

NOTE: You can select several facets in the same container.

EIO0000001114.15

clear filters and sorting, page 93 .

Moving Generated Facets

To move a facet from one container to another, proceed as follows.

Step Action

1 In the Assignments pane, right-click any one of the column headers and select the appropriate command to

2 In the Assignments pane, drag the facet to another container in the Containers pane.

Result :

• The software removes the facet from its original location and assigns it to the target container.

• The status of the facet displayed in the Generation column changes to Moved .

NOTE: You can select several facets in the same container.

NOTE: Control facets that you move are assigned to the new section with the highest order value in the

Order column of the Assignments pane, page 282 .

If you move several facets at once, the facet that you have selected first gets the lowest order out of the ones that are moved.

NOTE: After you have moved a generated facet from one container to another,

generate, page 323

the target container again to update the associated logical Participant project.

EIO0000001114.15

335

Control Project Refinement Stage................................................................. 336

What’s in This Chapter

Supervision Project Refinement Stage .......................................................... 360

Overview

This chapter describes how to modify the logical Participant projects that the software has created during the generation stage to fulfill the requirements of the system.

The refinement stage is not mandatory to be able to proceed to the next stage.

The following figure shows the position of the Refinement stage within the system engineering life cycle.

Refer to

Refinement Stage, page 36

for a description of the purpose of this stage.

Control Project Refinement Stage

Refining the Logical Control Project

Overview

You can refine at the project level, which allows you to view and modify the entire logical Control project with the help of the Control Participant.

You can also refine specific sections only by launching the refinement process from a section (except for LL984 sections). The section does not need to be generated to be refined.

You can import LL984 sections (see EcoStruxure ™ Process Expert, Control

Participant Services, User Guide).

FBD and non-FBD sections that you add during refinement are displayed in the

Control project ( Assignment Editor ) in the order they appear in the Control

Participant. The contents of these sections is not displayed there however.

Once refinement is complete, you can request the software to perform a

consistency check, page 347 .

336 EIO0000001114.15

manage network variables, page

At the refinement stage, you can also create and

350 , which are used for peer to peer communication.

concurrent actions, page 52 . In such case, check the

CCOTF for offline controller configuration, page 369

for details.

Refining Offline With CCOTF Enabled

For M580 and M580 safety Control projects created in the Project Explorer , the configuration change on the fly (CCOTF) functionality of the Control Participant is enabled by default. That is, the Online modification in RUN or STOP CPU parameter of the default configuration of the Control project is selected.

To complement

, when you refine a Control project offline, the software informs you ahead of time if a modification that you are about to make will require stopping the controller when you

deploy changes, page 509

to the controller later on. This information is available again in the Impact on Engine column of the Deploy Changes / Undo

Online Changes window where modifications that can be deployed are listed.

The working principle is the same as for CCOTF when configuring a controller except for the following:

• If you have performed a CCOTF-incompatible modification, save, and close the Control Participant window, the next time you refine the same project offline, you continue receiving notifications about CCOTF-incompatible modifications. This, even if you have not yet deployed the last CCOTFincompatible modification.

• Performing a CCOTF-incompatible modification does not disable the Build nor the Deploy Changes / Undo Online Changes command.

Before performing a CCOTF-compatible modification, refer to the topics describing the CCOTF functionality in the help of the Control Participant for your specific controller platform and follow the recommendations that are given.

NOTE: CCOTF is not supported for Control projects the M340 and Quantum controller families.

NOTE: CCOTF notifications are shown even if you have not yet deployed the

Control project.

Project Refinement Window

The figure shows the Refine Offline window embedding the Control Participant, which opens when you select the Refine command at the Control Participant project level. The window is shown restored.

EIO0000001114.15

337

Item

Description

Tab of the pane in which you can see the project sections in relation to the structure of the application

Manage network variables button

Access device DDTs of unmapped hardware button

Check consistency button

Save button

Section Refinement Window

The figure shows the Refine Offline window embedding the Control Participant, which opens when you select the Refine command at the section level. The window is shown restored.

338

Item

Description

Tab of the Control Participant window.

Tab of the section refinement window.

Tab of another refinement window (for example, a DFB refinement window), which you have opened from the section that is being refined.

Tab of another window that is open in the Project Explorer .

NOTE:

• To switch between open refinement windows, use the tabs at the bottom of the Participant window.

• To close a refinement window, right-click its tab and select Close

Window .

EIO0000001114.15

application structure view, page 287

EIO0000001114.15

Viewing the Application Structure When Refining Control

Participant Projects

While you refine a Control Participant project, the Application Browser pane displays FBD sections based on the location of instances whose Control facets are assigned to these sections.

It shows the relationship between the folder structure of the application and the sections of the Control Participant project. This is useful, for example, when you want to view the logic related to a specific area or subdivision of the application.

You can open sections from the pane.

The pane only shows FBD and non-FBD sections that exist in the logical Control

Participant project at the moment you select the Refine command.

For a general description of the contents of the pane, refer to the topic describing the

For information on how to use the pane, refer to the topic describing the refinement of Control Participant projects (see EcoStruxure ™ Process Expert,

Control Participant Services, User Guide).

For general information on how to work with panes, refer to the topic describing the

engineering client workspace, page 85 .

Applying Changes to Generated Control Participant Projects

Selecting the Refine command applies to the logical Control Participant project the following changes that you have made in the Project Explorer to an already generated Control project:

• Renaming a section.

• Creating an FBD section.

• Changing the order of sections.

If the status of the executable of the Control project is Built , it is set to Out Of

Date .

NOTE: You do not need to click the save button in the Control Participant window to apply the above mentioned changes.

Validity Indicators

When you save the logical Control Participant project during refinement and

project analysis is enabled, page 205 , the project is

analyzed, page 300 . The

status of the project is indicated by the

validity icons, page 252

Details of the analysis are shown in the Analyze Project tab of the Control

Participant window while it is still open.

If the logical Control project is not open in the Participant and the validity icon is displayed, you need to refine the Control project and analyze it. This allows you to identify the cause of the invalid status. The Control Participant features tools that help you identify validity issues, which

result in an unsuccessful build, page 467 .

For information on troubleshooting Control projects and/or analyzing them, refer to the help of the Control Participant.

NOTE: This verification is performed also when you

generate a logical Control project, page 300

Deleting Sections During Project Refinement

The table describes the result when you delete sections during refinement and the action that you need to perform to complete the deletion process depending on the type of section.

339

340

generate the section or project, page 300 , DFBs that you have added are not moved, and DFBs coming

Type of section

Non-generated FBD section that was created in the Project

Explorer .

Non-generated FBD section that was created during refinement.

Result after saving changes and closing the Control Participant window

The section still appears in the

Containers pane but below other existing sections (higher order value) (1) .

Required action

Right-click the section in the Containers pane and select

Delete .

Any non-FBD section.

(1) LL984 segments deleted during refinement appear in last position (highest order value)

Refining Non-Generated Sections

When you refine an FBD section to which facets are assigned but that is not generated yet, you do not see the constituents of these facets in the Control

Participant.

If you add logic to this section during refinement, when you

from assigned facets are laid out around them.

Refining at the Control Project Level

To refine the logical Control project, proceed as follows.

Step

Action

In the Project Explorer , right-click the Control project you want to refine and select

Refine .

Result: The Control Participant opens

consistency check, page 349

and maximized.

Proceed with the refinement.

For more information on the refinement process, refer to Refining the Logical Control

Participant Project (see EcoStruxure ™ Process Expert, Control Participant Services,

User Guide).

Click the save button in the toolbar of the Participant window to save the changes in the logical Control Participant project.

Perform a

if required.

Click the close button in the Control Participant window.

NOTE: If you have unsaved changes and click the close button in the Participant window, the software displays the Save Refinement dialog box where you have the following choices:

• Yes : Saves changes in the logical Control Participant project and closes the

Participant window.

• No : Discards changes and closes the Participant window.

• Cancel : Does not save changes and leaves the Participant window open.

Refining at the Section Level

To refine a section of the Control project (except for LL984 sections), proceed as follows.

Step

Action

In the Containers pane of the Assignment Editor , right-click the section that you want to refine and select Refine .

Result: The Control Participant opens

and maximized and displays only the contents of the selected section.

Proceed with the refinement of the section.

EIO0000001114.15

consistency check, page 349

Step Action

For more information on the refinement process, refer to Refining the Logical Control

Participant Project (see EcoStruxure ™ Process Expert, Control Participant Services,

User Guide).

Click the save button in the toolbar of the Participant window to save the changes in the logical Control project.

Perform a

if required.

Click the close button in the tab of the Control Participant window.

NOTE: If you have unsaved changes and click the close button in the Participant window, the software displays the Save Refinement dialog box where you have the following choices:

• Yes : Saves changes in the logical Control Participant project and closes the

Participant window.

• No : Discards changes and closes the Participant window.

• Cancel : Does not save changes and leaves the Participant window open.

Identifying Code Generated by the Software

Overview

Constituents that are generated from facets assigned to Control projects are locked in the Control Participant project. The locked code is color coded in the

DFB editor of the Control Participant.

This feature helps you with the following:

• Distinguish code generated by the software from code that you modify and/or add during refinement.

• Avoid modifying code generated by the software inadvertently and maintain consistency. This is achieved by requiring a confirmation before unlocking code and providing the possibility to lock code again.

Locking of code is managed by the software throughout the system engineering life cycle.

Viewing Locked Code

The following figure shows an example of a Control Participant refinement window showing an FBD section, which contains code that was generated by some sample facets assigned to the section.

EIO0000001114.15

341

342

Item

consistency check, page 347

Description

Code that is generated from the facet is locked and shown in purple.

Variable that was added by the user during refinement to code generated by the software. The code is not locked and shown in black.

Literal, previously shown in purple that was unlocked and changed by the user and now shown in black.

Link, previously shown in purple that was unlocked by the user and now shown in black.

Code that Is Locked

The following data is locked when generated from facets assigned to a Control project:

• DFBs and the pins to which an effective parameter is assigned.

• Effective parameters.

• Links (including links created by using an editor of the Application Explorer ).

• EFB and DFB instances.

NOTE: FBD sections that you have generated are also locked but without visual indication.

Code that Is not Locked

The following data is not locked:

• Non-FBD sections.

• Pins of DFBs to which no effective parameter is assigned or that are not connected.

• Formal parameters of DFBs.

• Variables shown in the Data Editor of the Control Participant.

• Any code added by the user during refinement offline and online.

• FBD sections that are generated but to which no facets are assigned.

Modifying Locked Code During Refinement

To modify locked code during refinement offline and online, you need to unlock it first (see EcoStruxure ™ Process Expert, Control Participant Services, User

Guide).

For example, changing the parameter that is assigned to the pin of a generated

DFB.

However, adding code that does not modify generated code can be done without unlocking. For example, assigning a parameter to an empty pin of a generated

DFB or adding an EFB in a section containing generated code.

NOTE: You cannot delete FBD sections that are locked.

Management of Locked Code in the System Engineering Life

Cycle

The fact that code is locked is part of its attributes and managed by the software during the system engineering life cycle.

As such, unlocking code is detected as an inconsistency during a

even if the code itself is unchanged. The status of the facet that generated the code is set to Inconsistent .

Code that was originally locked and that you have unlocked is:

• Locked again when the facet is generated and either condition applies:

EIO0000001114.15

concurrent actions, page 52 . In such case, check the

◦ The status of the facet is Inconsistent .

◦ No consistency check was performed but the contents of the section

was modified, page 324

• Detected when you use the following commands:

◦ Deploy Changes / Undo Online Changes

◦ Update Project

Considerations when Migrating Databases

When you refine a Control project of a database that was migrated from a previous version of the software, code generated by the software may not be locked.

However, you can enable the code locking feature for such code in a migrated database if you perform a consistency check and generate the Control project.

Code generated from facets that are assigned to Control projects after the migration is locked.

The table describes the impact on code that is generated by the software and contained in a migrated database depending on the action that you perform and the status of facets.

Actions performed after migration

Result after generating the Control projects

No consistency check was performed.

Status of facets assigned to Control projects in the migrated database

Generated or Unlinked .

Non Generated , Out Of

Date , or Inconsistent .

A consistency check is performed.

All facets are set to

Inconsistent .

No change.

The code of facets that were successfully generated is locked.

FBD sections containing at least one such facet are locked.

The code of facets that were successfully generated is locked.

FBD sections containing at least one such facet are locked.

NOTE: If you use the Regenerate command on the Control project after migrating the database, code that was generated by the software before the migration is locked even if you have not performed a consistency check.

Creating and Updating Device DDT Variables in Logical Control Projects

Overview

In the system engineering life cycle, the software lets you engineer Control projects independently of the hardware that exists in the topology up to the build stage. As a result, device DDT variables, which are associated to hardware modules and managed by the Control Participant are not readily available when you refine a logical Control project offline.

This functionality lets you create in the logical Control project device DDT variables that are associated to the hardware present in the topology of the system. This makes it possible to use device DDT variables in the program during refinement offline, for example, to manage special modules or access hardware diagnostic data.

Using device DDT variables does not replace hardware mapping. Device DDT variables do not appear in the Hardware Mapping Editor .

for details.

EIO0000001114.15

343

Device DDT Variables Present in the Control Project by Default

When you create a Control project of the M580 platform in the Project Explorer , it contains a default configuration with only a controller (although it is not to be used from the Project Explorer at this stage of the system engineering life cycle).

Therefore, by default, the logical Control Participant project already contains the device DDT variable that is mapped to the M580 CPU module (a lock icon appears next to the DDDT variable). You can use it by refining the logical Control project.

Prerequisites

The topological entities whose device DDT variables you want to create must exist in the topology of the system.

Accessing the Device DDT Variable Wizard

To open the wizard, refine the Control project and click the device DDT wizard

button, page 337

Device DDT Variable Wizard - Controller Selection

344

Item

Description

Box to select the controller whose device DDT variables you want to create in the logical

Control project.

When the check box is selected, the menu shows only the controllers that are service mapped to an executable of the Control project. Otherwise, it shows the controllers that exist in the topology of the system.

Proceeds to the next screen and locks the controller in the Topology Explorer so that no other user can change its configuration or delete it.

EIO0000001114.15

Device DDT Variable Wizard - Device DDT Variable Selection

EIO0000001114.15

Item

Description

Candidate pane that shows device DDT variables of the controller that you have selected and that you can create in the logical Control project. The following can be shown:

• Variables that do not exist in the logical Control project yet.

• Variables and types that already exist but which have been modified in the controller.

NOTE: The following variables do not appear in the candidate pane:

• Device DDT variables of the M580

CPU, page 344 .

• Device DDT variables that already exist in the logical Control project with the same name but with a different type. This can be the case, for example, if after having created the device DDT variable for hardware module 1, you remove this module in the topology, add hardware module 2, which creates a device DDT variable of a different type, and rename this device DDT variable to have the same name as the variable that was associated to hardware module 1.

Selected variables panes that shows the device DDT variables that you have selected.

Filter icon, page 93 .

Name of the device DDT variable.

Data type of the device DDT variable.

Either action appears for each device DDT variable:

• Create :

Creates, page 345

the data type and the variable in the logical Control project.

• Update :

Updates, page 346

the data type in the logical Control project.

Notification area.

Expand the area to view alerts on device DDT variables of the selected controller.

Reverts to the previous screen.

To be able to select device DDT variables from another controller, you need to complete the process for your current selection first. Any selection that you have not applied is discarded.

Impact of the Create Action on the Logical Control Project

The table describes the impact when you create in the Logical Control Project a device DDT variable that appears in the candidate pane with the Create action.

The impact varies depending on the scenario.

345

346

Scenario

The variable and the type are not yet present in the logical Control project.

A type of the same name already exists in the logical Control project but not the variable.

Impact of the Create Action

Both are created in the logical Control project.

The variable is created.

If the structure of the type of the selected variable is different, it overwrites the type that is present in the

Control project. This may impact other existing variables of that type.

Impact of the Update Action on the Logical Control Project

The table describes the impact when you update in the Logical Control Project a device DDT variable that appears in the candidate pane with the Update action.

The impact varies depending on the scenario.

Scenario

The variable and the type already exist in the logical Control project but the structure of the selected type is different.

The variable and the type already exist in the logical Control project but the version of the selected type is different.

Impact of the Update Action

The structure of the type is updated in the logical

Control project. This may impact other existing variables of that type.

The version of the type is updated in the logical

Control project. This may impact other existing variables of that type.

Creating or Updating Device DDT Variables

To create or update device DDT variables in the logical Control project, proceed as follows.

Step

Action

In the device DDT variable wizard, select the controller whose device DDT variables you want to create or update and click Next .

Expand the notification area to view alert messages.

In the candidate pane, select one or more device DDT variables that you want to create/update and click OK .

Result : The selected device DDT variables are processed by applying the corresponding action for each and the wizard is closed.

Save changes by clicking the

save button, page 337

in the toolbar of the Control

Participant window frame.

Modifying Device DDT Variables

Device DDT variables that you create in the logical Control project are not locked and you must not modify their structure or name. If you do, the software cannot treat them anymore as device DDT variables associated to the device from which they were created originally.

Deleting Device DDT Variables

You cannot remove a device DDT variable and/or its data type from the logical

Control project by using the device DDT variable wizard.

To remove the variable, select it in the Control Participant window while refining the logical Control project and select Delete . Then, purge the type by using the

Types Library manager

EIO0000001114.15

the stages of the system engineering life cycle described in this manual ( build, page 466 ,

Considerations When Removing Modules in the Topology

Explorer and Deploying Changes

When the topology of the system contains entities and you had created the corresponding device DDT variables in the logical Control project, built the project, and deployed it, if you delete the source of the device DDT variable from the topology (for example, a module or DTM), verify that the corresponding device

DDT variable is removed in the configuration of the Topology Explorer . If not (for example, when you delete an analog input module), you need to purge the corresponding device DDT variable.

Otherwise, if you build the logical Control project after removing the source of the device DDT variable from the topology, it remains in the built Control project as unmapped variable (while it is present in the deployed Participant project as mapped variable). If you deploy changes, the software proposes to add the unmapped device DDT variable.

Integrating Device DDT Variables in the System Engineering

Life Cycle

To use device DDT variables that you have created logical Control project, follow

build changes, page 471

, deployment,

deployment of changes, page

515 , refinement online, and so on).

Using Device DDT Variables in the Supervision Runtime

Device DDT variables do not have the HMI attribute enabled. To use such a variable in Supervision, you need to connect it to the input pin of a DFB encapsulated in a template that features Supervision services.

Managing Consistency

Overview

Consistency management is a process that encompasses the following steps:

• Launching the consistency check of a logical Control Participant project or

FBD section of such project.

• Indicating if the constituents of facets that the software has generated in such project or FBD section are not consistent with the related facets that are assigned to the Control project or section. In such case, a message informs you of the detected inconsistencies and the Generation status of the related facets is changed to Inconsistent . Otherwise, the software informs you that it did not detect an inconsistency.

• Attempting to fix the detected inconsistencies by restoring the constituents inside the logical Control Participant project or FBD section to a state that is consistent with the related facets of the Control project or section.

The purpose of consistency management is to provide means for you to know whether changes that you have made during refinement affect the logical Control

Participant project that was created during generation and, if desired, to fix inconsistencies when it is possible without modifying the refinements you made.

The software performs a consistency check in the following way when you:

• Generate again an already generated Control project or FBD section:

Depending on the

changes you have made, page 324 .

•

Reassign, page 332

a facet with the status UnAssigned : Automatically (if available).

•

Relink, page 332

a facet with the status Unlinked : Automatically (if available).

•

Update the logical Control Participant project, page 567

: On request.

NOTE: The software does not perform consistency checks on facets that have the Unlinked

status, page 319

EIO0000001114.15

347

348

Rules for Consistency Checks

The table indicates in which cases the software detects and reports an inconsistency when performing a consistency check on constituents that the software has generated in a logical Control Participant project. It also indicates the resulting status of the facet encapsulating the constituent.

Type Change made through refinement

Any change resulting in a new version of the type (1) .

Change causing no version change but resulting in a new type or code signature (1) .

Generation status of the facet

Changes to Inconsistent .

Derived data

(DDT) and function block (DFB) types

Variables Changing an attribute of a variable.

Removing markers created by the software (for example P2P ).

FBD sections

Changing function calls (EFs, EFBs, or DFBs) in an

FBD section.

Changing the relative execution order of function blocks (EFs, EFBs, or DFBs).

No change.

Changing links. Includes changing immediate values and links between variables.

Unlocking

locked data, page 341

Changes to Inconsistent

– Changes to Inconsistent .

(1) The change may also have been made by encapsulating a modified type in a Control facet and updating the template with this facet. However, starting with Process Expert 4.2 SP2, the software does not allow you anymore to save modifications to the type encapsulated in a Control facet if the version of the type is still the same but its type or code signature different.

Check Consistency Dialog Box

The figure shows an example of the Check Consistency dialog box.

EIO0000001114.15

changes that you made through refinement are discarded, page

EIO0000001114.15

Check box to select all FBD sections and facets that appear in the two categories of the dialog box. By default no section or facet is selected.

Category listing FBD sections containing facets for which inconsistencies related to their DDT and DFB types have been detected. Select the check box to select all sections and facets that appear in this category.

Category listing FBD sections in which inconsistent facets have been detected. Select the check box to select all sections and facets that appear in this category.

Name of a type for which an inconsistency has been detected. Expand the node to view the facets generating this type and the sections to which these facets are assigned.

Identifier of a section to which facets are assigned, which are inconsistent.

Expand the node to view the facets.

Description of the detected inconsistency.

Unlinks the selected facets so that no consistency check is performed on them.

Copies the content of the dialog box to the Clipboard in text format. The status of check boxes is not copied.

Cancels your selection and closes the dialog box.

NOTE: When a section or facet appears in both categories, selecting it in one category automatically selects it in the other, and the other way around, clearing its selection in one category automatically clears it in the other.

Performing a Consistency Check

To perform a consistency check on generated constituents, proceed as follows.

Step

Action

In the Project Explorer , right-click the Control project or FBD section that you want to check for consistency and select refine .

Result: The Control Participant opens in a reduced window.

In the toolbar of the window, click the check consistency button .

Result: The software:

• Performs a consistency check.

• Opens the Check Consistency dialog box.

• Changes the Generation status of facets referencing inconsistent constituents to

Inconsistent .

NOTE: The check consistency button is not available when you refine a non-FBD section.

In the Check Consistency dialog box, select inconsistent sections and/or facets that you want to unlink.

Click Unlink to unlink the selected facets.

NOTE: Click Cancel to close the Check Consistency dialog box without unlinking facets. The status of facets that the software has detected as inconsistent remains

Inconsistent .

Managing Inconsistencies

Even though a logical Control Participant project contains inconsistent facets, you can proceed further in the system engineering life cycle.

Regenerate the FBD section or project containing inconsistent facets to revert to a consistent state, which is indicated by the generation status Generated of the facet but certain

327 .

For information on managing inconsistencies without affecting changes made through refinement, refer to

Generating Inconsistent Facets, page 325

349

communication channels, page 424 .

About Variables for Peer to Peer Communication

Overview

The software facilitates the creation of variables to exchange scattered data or sets of data between two or more Control Participant projects by using peer to peer communication. Such variables are called network variables .

You can create network variables in the following ways:

• By assigning facets of instances to different projects.

• By refining both logical Control Participant projects. Refer to Refining the

Logical Control Participant project (see EcoStruxure ™ Process Expert,

Control Participant Services, User Guide).

• By using peer to peer communication templates of the EcoStruxure Process

Expert Foundation Library.

• By using a mix of the above.

Depending on the way that you use to create them, network variables have the candidate status until they are explicitly created for use as network variables by using the Manage Network Variables

dialog box, page 357

You can create network variables before proceeding with the service mapping and the creation of

Variables used for peer to peer communication are allocated during

build, page

468

based on the

network variable mapping, page 435

NOTE: For more information on the steps to implement peer to peer communication by using the I/O scanner function, refer to the topic describing

peer to peer communication by modbus TCP Ethernet implicit messaging, page 597 .

Control Participant Functionality

Peer to peer communication can also be implemented by using the specialized functions of the Control Participant instead of or in addition to using the templates of the EcoStruxure Process Expert Foundation Library.

To do so, refine the client Control project and add the necessary logic.

For details, refer to the topics describing the READ_REMOTE and WRITE_

REMOTE functions in the help of the Communication Library of the Control

Participant.

NOTE: The functions are available for Control projects of the M580 and M340 platforms with compatible CPU firmware version.

Owner/Consumer Project Principle

To help you understand the way peer to peer communication is implemented in the software, this manual uses a particular naming convention to refer to the

Control Participant projects that exchange data.

The logical Control Participant project producing the variables to be shared is the owner project, and the one receiving the variables is the consumer project.

The controller that is mapped to the owner project acts as the server. The one mapped to the consumer project acts as the client.

A network variable allows you to read data from the server by mapping it to a communication channel that exists client-side.

NOTE: You can write data to the server by using a network variable that exists in the owner project and the corresponding variable of same name and type in the consumer project.

350 EIO0000001114.15

Other ways to create network variables exist, page 355 .

The following example illustrates the owner/consumer principle in a system where sample variables DISignal_UL_1V and Valve_1_VALVE_OPV are used for peer to peer communication to read from and write to the server respectively. The variables are generated by facets of the DISignal_UL_1 and Valve_1 sample instances respectively. The specific attributes of the variables of reference data type are shown. The two instances are linked and their facets are assigned to the

Owner_Project and Consumer_Project Control Participant projects. The executable of each project is mapped to the corresponding topological entity. The read from server and write to server actions are performed from the consumer

(client) project.

EIO0000001114.15

Ways to Create Network Variables to Share Scattered Data Oneto-One

The first two scenarios that are shown in the following figure illustrate two common ways to create a network variable to share scattered data between an owner and a consumer project.

351

352

Scenario Description

1 When the instance in the owner project creates a variable (for example, an instance of a hardware abstraction layer (HAL) template), it can be linked directly to the input pin of a DFB (created, for example, by an instance of an application template) in the consumer project.

2 When the instance in the owner project does not create a variable (for example, an instance of an application template), the output pin needs to be linked first to an instance of a peer to peer communication template (for example, Data Out) in the owner project.

The Data Out instance creates a variable, which can be linked directly to the input pin of a DFB (created, for example, by an instance of an application template) in the consumer project.

3 In the first two scenarios, only a network variable candidate is created. You need to create the network variable manually by using the Manage Network Variables

command, page 357 .

This third scenario shows how to create the network variable automatically by using two peer to peer communication templates (Data Out and Data In).

The following example shows how to implement the first scenario by using sample instances and linking them in the Asset Workspace Editor . Facets of each instance are then assigned to the owner and consumer projects.

The following example shows how to implement the second scenario by using sample instances and linking them in the Asset Workspace Editor . Facets of each instance are then assigned to the owner and consumer projects.

EIO0000001114.15

The following example shows how to implement the third scenario by using two peer to peer communication templates to create the network variable automatically. Instances are linked in the Asset Workspace Editor .

Ways to Create Network Variables to Share Scattered Data Oneto-Many

The following figure illustrates the use of Data In and/or Data Out application templates to share one variable exposed by one owner project with three different consumer projects of the same system.

This example illustrates the scenario by using sample instances and linking them in the Asset Workspace Editor . Facets of each instance are then assigned to the owner and the three consumer projects.

EIO0000001114.15

Ways to Create Network Variables to Share Sets of Data

The following figure illustrates the use of owner and consumer application templates to share physical signals:

• Without signal conditioning.

• With signal conditioning by using a HAL template.

353

write to the server, page 350 .

354

NOTE: In both cases, the physical signals are linked to the owner template and the HAL templates respectively by using mapping interfaces (dotted lines) during the hardware mapping.

For more information on owner/consumer templates and a usage example, refer to the topic describing these templates (see EcoStruxure ™

Expert , Foundation Application Templates, User Guide).

Process

Properties of Variables for Peer to Peer Communication

Certain attributes of variables that you create through refinement to be mapped to peer to peer communication channels require a specific configuration.

The configuration varies depending on:

• Whether the variable is used to read from the server or

• The platform or the communication module that is used by the topological entity acting as client.

The table describes required variable attribute values in the Control Participant when the topological entity acting as client communicates by using a Quantum

CPU module or an NOE communication module (with Quantum or M340 platform).

Usage

Reading data from the server

Writing data to the server

Variable attribute

Designation of the variable in the context of

EcoStruxure Process

Expert

Owner project/Server

Variable

Name

Type

Custom

Any valid name

Any, including the

Reference data type (REF_

TO).

Some

restrictions apply, page 357 .

Custom

Constant (1)

R/W Rights of

Referenced Variable (1)

Designation of the variable in the context of

EcoStruxure Process

Expert

Blank

True (selected)

Network variable

Name

Type

Any valid name

Any, including the

Reference data type (REF_

TO).

Some

restrictions apply, page 357 .

P2P

Consumer project/Client

Network variable

Same name

Same type

P2P

True (selected)

False (cleared)

Variable

Same name

Same type

Blank

EIO0000001114.15

Create the network variable, page 357

Usage Variable attribute Owner project/Server

Constant (1) True (selected)

R/W Rights of

Referenced Variable (1)

True (selected)

(1) For variables of the Reference data type (REF_TO) only

Consumer project/Client

True (selected)

The table describes required variable attribute values in the Control Participant when the topological entity acting as client communicates by using an M580 CPU module with or without NOC communication module, or a Quantum controller with

NOC communication module.

Usage

Reading data from the server

Variable attribute

Designation of the variable in the context of

EcoStruxure Process

Expert

Name

Type

Owner project/Server

Variable

Consumer project/Client

Network variable

Writing data to the server

Custom

Constant

R/W Rights of

Referenced Variable

Designation of the variable in the context of

EcoStruxure Process

Expert

Name

Type

Any valid name

Reference data type (REF_

TO) only

Blank

True (selected)

Same name

Same type

P2P

True (selected)

False (cleared)

Network variable Variable

Custom

Constant

R/W Rights of

Referenced Variable

Any valid name

Reference data type (REF_

TO) only

P2P

True (selected)

Same name

Same type

Blank

True (selected)

NOTE: For more information on the REF_TO data type, refer to the topic describing the refinement of Control projects (see EcoStruxure ™ Process

Expert, Control Participant Services, User Guide).

Overview of Ways to Create Network Variables

The table provides an overview of the different ways to create network variables in the consumer project to read data from the controller of the owner project, acting as server. It also indicates the status of the variable for each method.

Action in owner project

Instantiate a Data Out template corresponding to the data type to be shared

(for example,

$DOUTBool_UL to share a boolean variable of the

REF_TO ANY_BOOL data type).

Instantiate a peer to peer owner template corresponding to the data

Action in consumer project

Instantiate a Data In template corresponding to the data type of the Data Out template (for example, $DINBool_UL ).

Instantiate a peer to peer consumer template matching the peer to peer owner template (for

Status of variable

Once you generate both projects, the Manage Network

Variables dialog box detects the variable as a network variable candidate in the consumer project, with the name of the Data Out template instance.

The generation process creates a network variable in the consumer project with the name of the Data Out template instance.

NOTE: The Manage Network Variables dialog box shows the variable in the Existing Network Variables pane.

The generation process creates a network variable in the consumer project with the name of the owner template instance.

EIO0000001114.15

355

Create the network variable, page 357

Action in owner project type to be shared (for example, $Bool16INO to share up to 16 boolean input signals of the REF_

TO data type).

Instantiate a template, which creates a variable during the generation process (for example, a variable of type REF_TO

ANY_BOOL (1) ).

Create a variable shared by using the

Refine

(1) command.

to be

Action in consumer project example, $Bool16INC to receive up to 16 boolean input signals).

Reference a variable of the same name and data type as the one created by the instance in the owner project without declaring it by using the Refine type, and enter command.

Instantiate a template that receives the variable exposed by the instance in the owner project by creating a link between both templates in the Asset Workspace Editor .

Create a variable of the same name and data type as the one created by the instance in the owner project, and enter P2P as Custom attribute by using the Refine command.

Reference a variable of the same name and data type without declaring it, using the

Refine command.

Create a variable of the same name and data

P2P as Custom using the Refine command.

attribute by

Status of variable

NOTE: The Manage Network Variables dialog box shows the variable in the Existing Network Variables pane.

The Manage Network Variables dialog box detects the variable as a network variable candidate in the consumer project.

The Manage Network Variables dialog box shows the variable in the Existing Network Variables pane.

The Manage Network Variables dialog box detects the variable as a network variable candidate in the consumer project.

Create the network variable, page 357

The Manage Network Variables dialog box shows the variable in the Existing Network Variables pane.

(1) Verify that the data type of the variable that is created meets the

requirements to be used for peer to peer communication, page 354 .

NOTE:

• The table does not detail each step required to implement peer to peer communication. For more information, refer to

Peer to Peer

Communication Through Modbus TCP Implicit Messaging, page 603

• To be detected and/or created as network variables by the Manage

Network Variables dialog box, variables need to satisfy the

network variable management rules, page 357 .

Overview of Peer to Peer Templates

The following templates are available from the Global Templates library to create network variables:

• Data IN/Data OUT: Application facet templates that create a network variable in the consumer project. The library contains templates for sharing various variable sizes and data types. Use these templates to share scattered data.

For a detailed description of the templates and how to use them, refer to Data

In/Data Out Templates (see EcoStruxure ™ Process Expert , Foundation

Application Templates, User Guide).

NOTE: To find these templates by using the template browser of the

Application Explorer , select the Facets

filter, page 121

, and enter either din or dout in the search field.

• Owner/Consumer: Application composite templates that create a network variable in the consumer project. The library contains templates for sharing up to 16 digital and 8 analog inputs/outputs. Use these templates to share sets of data. Typically, such templates allow you to manage I/O objects exchanged between a Modicon BMX PRA module and a master controller.

For a detailed description of the templates and how to use them, refer to

Owner/Consumer Templates (see EcoStruxure ™ Process Expert , Foundation

Application Templates, User Guide).

NOTE: Network variables created by using peer to peer templates have the

Custom attribute set to P2P by default in the variable properties window of the

Control Participant.

356 EIO0000001114.15

peer to peer template, page 351 .

Managing Network Variables

Overview

This topic describes how to use the Manage Network Variables dialog box to manage network variables, which exist or have the candidate status.

Network variable management includes the creation, modification, and deletion of network variables.

General Network Variable Management Rules

The software applies either of the following rules to identify candidate network variables when you open the Manage Network Variables dialog box:

• The variable needs to be referenced from, at least, 1 FBD section but not be declared.

• The variable is created by using a

In addition, the following are not considered network variable candidates:

• Variables referencing an element of a data structure (for example,

DigitalInput_DINPUT_ST.STW

where STW is a word of the DINPUT_ST structure).

• Function block instances (for example, DigitalInput_DINPUT.PV

where PV is a formal parameter of the DINPUT DFB).

• Types ANY_X where X represents the type (except for the ANY_BOOL data type).

• Inconsistent types (for example, a.b where a and b are variables and one of them is undefined).

• 32-bit data types.

NOTE: In the Manage Network Variables dialog box, it is not taken into account whether the data type of the variable is

compatible with the communication module client-side, page 354

Network Variable Properties

Network variables that the software creates by using the Manage Network

Variables dialog box have the following properties:

• They are of the same type as shown in the Type field of the Network

Variables Candidates section.

• They have P2P as Custom attribute in the variable properties window of the

Control Participant.

NOTE: The software does not set the R/W Rights of Referenced Variable attribute for REF_TO type network variables that it creates. If it needs to be enabled, you need to refine the consumer project and set the attribute manually (see EcoStruxure ™ Process Expert, Control Participant Services,

User Guide) in the variable properties window of the Control Participant.

Opening the Manage Network Variables Dialog Box

You can open the Manage Network Variables dialog box either way:

• From the context menu of the Control Participant project in the Project

Explorer by selecting Manage Network Variables .

• From within the Control Participant by clicking the button (see

EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

When you refine at the section level, the button is available only for FBD sections.

Both commands open the Manage Network Variables dialog box. The difference lies in the way you save changes.

EIO0000001114.15

357

Manage Network Variables Dialog Box

The following figure shows an example of the Manage Network Variables dialog box in which several sample variables appear.

358

1 Network Variables section showing existing network variables.

2 Network Variable Candidates section showing the candidate variables that the software has detected in the selected project. These variables satisfy the applicable rules and you can them use as network variables. Certain restrictions apply depending on the communication module used by the topological entity acting as client.

Fields of the Network Variables section.

Header

Action

Name

Type

Comment

Description

• Left/right arrow icon: Existing network variable.

• Minus icon: The variable will be removed from the project.

• Plus icon: The variable will be added to the project.

• Pencil icon: The variable will be modified in the project.

• Lock icon: The variable is already mapped to a peer to peer communication channel in the

Identifier of the variable.

The field is

editable, page 360 .

Data type of the variable

You can enter a comment for the variable using free form text.

Fields of the Network Variable Candidates section.

Header

Name

Type

Description

Identifier of the variable.

When you use HAL or peer to peer templates, the name of the variable is the identifier of the template instance.

Data type of the variable.

NOTE: You can select multiple variables in either sections by selecting the first variable, pressing and holding Ctrl , and selecting the other variables by using the pointer.

EIO0000001114.15

Save your changes, page 359

EIO0000001114.15

Saving Changes in the Manage Network Variables Dialog Box

Depending from where you have opened the Manage Network Variables dialog box, the procedure to apply and save your changes varies.

If you have opened the Manage Network Variables dialog box from the context menu of the Control project, proceed as follows to apply and save your changes.

Step

Action

In the Manage Network Variables dialog box, click OK .

Result : A confirmation dialog box opens.

Click Yes to save your changes.

NOTE:

• Click No to close the Manage Network Variables dialog box without saving changes.

• Click Cancel to leave the Manage Network Variables dialog box open without saving changes.

If you have opened the Manage Network Variables dialog box from within the

Control Participant during refinement, proceed as follows to apply and save your changes.

Step

Action

In the Manage Network Variables dialog box, click OK to apply the changes to the logical Control project.

Result : The Manage Network Variables dialog box closes.

NOTE: If you open the Manage Network Variables dialog box again before closing the Control Participant, your changes are preserved but are not saved yet.

Click the save button in the toolbar of the Control Participant window to save your changes.

NOTE: Closing the Control Participant without saving does not apply your changes.

Creating Network Variables

To create a network variable by using the Manage Network Variables command from the context menu of the Control project, proceed as follows.

Step

Action

In the Projects Explorer , right-click the logical Control project in which you want the software to identify network variable candidates and select Manage Network

Variables .

Result: The Manage Network Variables dialog box opens. If the software did not detect any candidate or network variables, the corresponding dialog box fields are empty.

In the Network Variable Candidates section, select the candidate variables that you want to create as network variables and drag them to the Network Variables section.

Result: The network variables are shown in the New Network Variables section.

NOTE: Right-click a network variable to open a context menu, which allows you to make

changes, page 360 .

Result: The software closes the dialog box, creates the network variables, and displays a summary of the actions in the notification panel.

NOTE: You can see the variable by refining the Control Participant project and double-clicking Elementary Variables in the Variables & FB Instances section of the Project Browser .

359

removes the mapping, page 442

Modifying Network Variables

NOTE: Depending from where you have opened the Manage Network

Variables dialog box, there are different ways to

save your changes, page

359 .

You can perform the following modifications on network variables displayed in the

Network Variables section:

Action

Adding a comment

Changing the name of the variable

Description

Double-click the Comment field of the variable and enter a description with free form text.

Double-click the Name of the variable and enter a new name with free form text.

NOTE: You can only change the name of existing network variables that are not yet mapped to a communication channel.

Undoing changes

Deleting a network variable

Right-click a variable and select Undo to discard the changes that you have made.

You can also press Ctrl + Z .

NOTE: You cannot undo changes that you have applied by clicking

OK if you have opened the Manage Network Variables dialog box from within the Control Participant.

Right-click a variable and select Remove to:

• Display the variable again in the Network Variable Candidates section if it has not been created yet.

• Mark the network variable for deletion in the Control Participant project.

If the variable is mapped to a communication channel, the software

You can also select a variable and press Del .

Supervision Project Refinement Stage

Refining the Supervision Project

Overview

The refinement process of Supervision Participant projects allows you to:

• View and modify Participant project data by using the Refine command.

Limitations apply to the modification of project data that is managed by the software.

• Add animated graphics to

pages, page 267

of the project, using the Edit command.

• Edit Participant project settings by using the Advanced Settings command.

• Add included projects and attach user files.

For each Supervision Participant project, you can use only one of the aforementioned commands at a time. However, you can edit several Supervision pages at the same time. Each command uses one instance of the virtual machine

(see EcoStruxure ™ Process Expert, Installation and Configuration Guide).

NOTE: While you refine the Supervision Participant project or edit advanced settings, commands such as Generate or Delete are not available for pages or containers.

concurrent actions, page 52 . In such case, check the

for details.

360 EIO0000001114.15

Refining the Supervision Project

To refine the Supervision project, proceed as follows.

Step

Action

In the Project Explorer , right-click the Supervision project you want to refine and select

Refine .

Result: The Supervision Participant opens

download included projects, page 478

and maximized.

Proceed with the refinement.

For more information on the refinement process and restrictions that apply, refer to the topic describing the refinement of the Supervision project (see EcoStruxure ™ Process

Expert, Supervision Participant Services, User Guide).

Close the Participant window.

Result: The Save Refinement dialog box opens.

Click the appropriate button in the dialog box.

Result:

• Yes : Closes the Supervision Participant window and keeps only changes that you have saved in the Supervision Participant.

• No : Closes the Supervision Participant window and discards all changes, including those that you have saved in the Supervision Participant.

• Cancel : Closes the Save Refinement dialog box and keeps the Supervision

Participant window open.

Editing Supervision Project Pages

The number of pages that you can edit at the same time is limited by the number of virtual machine instances that can run simultaneously (see EcoStruxure ™

Process Expert, Installation and Configuration Guide) for the client and/or system server (for the system server in case the client is installed on the system server computer).

You can save changes to several Supervision pages at the same time by clicking the save button on each Supervision Participant window.

When you add an animated graphic to a page, the software adds the required included project to the Supervision Participant project if it is not yet present. You can

as soon as the software has added them.

To edit a Supervision page, proceed as follows.

Step

Action

In the Containers pane of the Assignment Editor , right-click the

page, page 267

that you want to edit and select Edit .

Result: The Supervision opens

and maximized with the Instances browser pane next to it.

Edit the page as required.

For more information on adding animated graphics, refer to Editing Supervision Pages

(see EcoStruxure ™ Process Expert, Supervision Participant Services, User Guide).

EIO0000001114.15

361

362

Step

Action

Click the save button in the toolbar of the Participant window to save the changes.

Result: The facets that encapsulate the animated graphics that you have added to a page appear in the Assignments pane when you select the page. The Assignment and Generation statuses of these facets are Assigned and Generated respectively.

If you have deleted an animated graphic that had already been added to a page, the corresponding facet is removed from the Assignments pane.

Close the Supervision Participant window.

NOTE:

If you have unsaved changes and click the close button on the outer frame of the

Participant window, the software displays the Save Refinement dialog box where you have the following choices:

• Yes : Saves changes you made to the page and closes the Participant window.

• No : Discards changes and closes the Participant window.

• Cancel : Does not save changes and leaves the Participant window open.

Editing Advanced Supervision Project Settings

To edit advanced project settings, proceed as follows.

Step

Action

In the Project Explorer , right-click the Supervision project and select Advanced

Settings .

Result: The Supervision Participant opens

add an animated graphic, page 361

and maximized.

Proceed with changes to the advanced project settings.

For more information, refer to Editing Advanced Project Settings (see EcoStruxure ™

Process Expert, Supervision Participant Services, User Guide).

Click the save button in the toolbar of the Participant window to save the changes.

4 Close the Supervision Participant window.

NOTE:

If you have unsaved changes and you click the close button in the Participant window, the software displays the Save Advanced Settings dialog box where you have the following choices:

• Yes : Saves changes you made to the advanced settings and closes the

Participant window.

• No : Discards changes and closes the Participant window.

• Cancel : Does not save changes and leaves the Participant window open.

NOTE: You need to

deploy, page 521

the Supervision project to apply changes to advanced project settings.

Adding Included Projects

When you

to a Supervision page, the software automatically adds the required included project to the Supervision Participant project.

You can add additional included projects. However, you cannot add an included project if the software has already added to the Participant project an included project with the same name.

To add additional included projects to a Supervision Participant project, proceed as follows.

EIO0000001114.15

re-deploy the Supervision project, page 523

Step

Action

In the Project Explorer , right-click the Supervision project to which you want to add an included project and select Include Projects .

Result: The Include Projects window opens.

Click Add .

Result: The Open dialog box opens.

Browse to the location where the included project file (.ctz) is stored, select it, and click

Open .

Result:

• If an included project with the same name already exists in the Participant project, the software displays a notification:

◦ Click OK to acknowledge.

◦ Close the Include Projects window.

• If an included project with the same name already exists in the Global

Constituents folder of the contents repository, the software displays a notification:

◦ Click OK to add the included project that exists in the contents repository.

◦ Click Cancel to cancel the process without adding the included project.

• If no included project with the same name already exists, the software:

◦ Stores the selected file in the contents repository.

◦ Displays the selected file in the window.

NOTE: The software lets you

deploy, page 520

included project that you add.

Close the Include Projects window.

NOTE: To remove an included project from the Supervision project, select the file in the Include Projects window and click Remove . After you acknowledge the command, the software removes the file and deletes it from the contents repository.

Attaching External Files

To add external files to a Supervision project, proceed as follows.

Step

Action

In the Project Explorer , right-click the Supervision project to which you want to add files and select Attach User Files .

Result: The Attach User Files window opens.

Click Add .

Result: The Open dialog box opens.

Browse to the location where the file is stored, select it, and click Open .

Result: The software:

• Stores the selected file in the contents repository.

• Displays the selected file in the window.

NOTE: The software includes files that you attach into the Supervision project, which it deploys during deployment.

Close the Attach User Files window.

NOTE: To remove a file from the Supervision project, select the file and click

Remove . The software removes the file and deletes it from the contents repository . If user files had already been deployed, they are not removed from the location they were deployed to when you

EIO0000001114.15

363

Creating the Topology of the System............................................................. 364

What’s in This Chapter

Managing the Topology................................................................................ 406

Overview

This chapter provides information to help you model the entire topology of the system, which consists of the hardware and software infrastructure.

The following figure shows the position of the Configuration stage within the system engineering life cycle.

Refer to the

Configuration stage, page 37

for a description of the purpose of this stage.

Creating the Topology of the System

Overview

This section describes how to use the Topology Explorer to create and configure topological entities modeling the topology of the system.

The software includes templates that allow you to model the following infrastructure components:

• Ethernet networks

• Station nodes

• Controllers

• Ethernet STB islands and devices connected through CANopen extension

• Modbus TCP and EtherNet/IP I/O devices

• PROFIBUS remote masters (PRMs) and their decentralized peripherals

(DPs)

Controllers and station nodes act as engines to which you can deploy Control or

Supervision projects.

364 EIO0000001114.15

concurrent actions, page 52 . In such case, check the

For more information on supported architectures, refer to the topic describing integrated architectures (see EcoStruxure ™ Process Expert, Control Participant

Services, User Guide).

topological entities, page 24

for details.

Organizing the System Topology

Before Starting

The topology of the system is defined through

, which consist of instances of topological templates, called devices. You can organize these entities in the form of a folder structure, which is displayed in the tree view of the Topology Explorer .

Before creating the folder structure for the topology, define the appropriate segmentation and naming convention for the hardware infrastructure of the system.

NOTE: Before selecting another command for an entity, wait for the current task to complete. However, the same command can be executed on distinct entities by one or more clients simultaneously.

Opening the Topology Explorer

To open the Topology Explorer , right-click the system from the Systems

Explorer tree view and select Open Topology .

Topology Explorer Window

The following figure shows an example of the Topology Explorer window.

EIO0000001114.15

1 System root folder

2 Topology folder tree view

3 Station node entity (expanded view to display contents)

4 Ethernet networks

5 Controller entity (collapsed view)

365

366

Topological Entity Description

The following figure shows an example of topological entity.

update the associated logical Control

Item

Description

Identifier of the entity.

Icon indicating the type of entity.

Show/hide devices button.

Mapping indicator.

The entity is mapped when a check mark is displayed. It is not mapped when a cross is displayed.

Hover with the pointer over the indicator to display in a tooltip the mapping status.

Online refinement indicator.

The icon indicates that you have made changes online to the Control Participant project that is deployed to the engine. These changes need to be applied to the associated logical Control Participant project and controller configuration to make them consistent with the one that is deployed to the engine.

The icon is removed once you successfully

Participant project, page 567

with all the changes that the software has detected in the following sections of the Update Project dialog box:

• Derived Data & FB Types

• Variables & FB Instances

• Sections

If you update the project only partially with these three categories, the icon remains visible.

Hover with the pointer over the indicator to display a tooltip.

NOTE: If you have also made changes pertaining to the Animation Tables and/or

Operator Screens category, it is not relevant whether you select or not any of these two categories as long as you select all the changes in the three aforementioned categories to remove the refinement indicator.

If you have made a change online pertaining only to the Animation Tables and/or

Operator Screens category, you need to select such change to remove the indicator.

Creating Topology Folders

The Topology Explorer allows you to organize the system infrastructure in the form of a folder structure.

To create a topology folder, proceed as follows.

Step

Action

Right-click the system root folder in the Topology Explorer and select Create Folder .

Result : A topology folder is created and displayed it in the tree view.

NOTE: To create a subfolder, repeat this step at the topology folder level.

Topology Folder Actions

Right-click the system root folder or a topology folder to open a context menu with the following commands.

EIO0000001114.15

Application Explorer , page 115

EIO0000001114.15

Command Description

Expand The first time you click Expand , expands the next level in the folder structure or opens the folder/window.

The next time you click Expand , displays the folder structure or contents in its last expanded state.

If the folder is empty, the command has no effect.

Collapse Collapses the folder structure up to the folder or closes the folder/window.

The command is available only if the folder/window is already expanded.

Creates a topology folder or subfolder and displays it in the tree view.

Create

Folder

Open

Application

Opens the

, which allows you to start the instantiation stage or access the application of the system.

The command is available from the root folder only.

Open

Project

Opens the Projects Explorer , which allows you to start the

manage communication, page 597

or access the Control and Supervision projects of an existing system.

The command is available from the root folder only.

Creates an Ethernet network entity and displays it in the folder. The entity represents an Ethernet based network of the system.

Create

Ethernet

Network, page 397

Create

Station

Node , page 379

Create

Controller , page 371

Creates a station node entity and displays it in the tree view.

For example, a station node can represent a Supervision I/O server or a PC emulating simulator software.

Create

STB

Island , page 384

Displays a submenu, which allows you to create a controller entity of the supported platforms (see EcoStruxure ™ Process Expert, Control Participant Services, User

Guide).

The topological entity allows you to configure devices, which represent the CPU, power supply, communication, I/O modules, extended and remote racks, and so on.

Creates an STB island entity and displays it in the tree view.

The topological entity represents the segments, communicator, STB island modules, and devices connected through the CANopen bus of the island once you have configured them.

Create

PRM

PROFI-

BUS DP , page 388

Create

Device IO , page 391

Creates a PROFIBUS remote master (PRM) entity and displays it in the tree view.

The topological entity allows you to configure the decentralized devices (DPs) connected to the PRM by using device type managers (DTMs) and generic station description (GSD) files.

Opens a submenu containing the following commands:

• Modbus TCP

• EtherNet/IP

Selecting either command opens the Select Template dialog box, which lets you select and instantiate a topological template to create an I/O device entity. The topological entity is used to

between such device and the controller by using Modbus TCP (I/O scanning and explicit) or EtherNet/IP

(explicit) messaging.

Update

Template , page 407

Import , page 411

Delete

Updates the template that is used by entities inside the folder and any subfolder with the latest version of that template, which is available in the Global Templates library on the system server.

Opens the Export window, which allows you to select the topological entities that you want to export in the form of a topology export file (.sbk).

You can select entities contained in the folder and any subfolders along with their folder hierarchy.

The command is not available from empty topological folders.

Opens the Import window, which allows you to select an export file (.sbk). In a second step, you can select which compatible content of the export file you import in the topology.

Deletes the folder and its contents, including subfolders, their contents, and associated configurations.

The command is not available from the root folder.

367

Command Description

Rename Allows you to type a new folder name.

Properties

The command is not available from the root folder.

Opens the folder Properties window, which allows you to view and edit information of the folder.

The command is not available from the root folder.

Topology Folder Properties

To access the Properties window of the topology folder, right-click the folder and select Properties .

You can edit the following items.

Item

General Identifier

Description

Area

Description

Designation of the folder.

The identifier must be unique for each subfolder of the same parent folder and satisfy

Update Templates command, page 407

Default value: Folder_n where n is an incremental number starting at 1.

Optional.

You can enter a description of the folder with free form text. The description you enter appears in a tooltip when you move the pointer over the folder.

Default value: Blank

Optional.

You can assign an access control number to the folder.

Value: 1...255 (integer).

Default value: Blank

Selecting Topological Templates

Overview

When you create a topological entity, the software displays the Select Template dialog box if more than 1 topological template is available to model a hardware module:

• When you first create the entity: For any module that you add in the Control

Participant.

• When you modify the entity: For modules that you have added or moved since you last configured the entity.

The Select Template dialog box allows you to select the topological template and version that you want to use among the compatible ones that are available.

NOTE: The

is available from the context menu of entities after you create them.

Default Selection

By default, the software selects the topological template in the Global Templates library that has the highest version number with the usability state (see

EcoStruxure ™ Process Expert, Global Templates, Reference Manual) of

Approved or Deprecated among those that have a matching Hardware

Reference as attribute.

368 EIO0000001114.15

help of the Control Participant, page 69

Selection for Redundant Controllers

When you select a topological template for a module of the primary controller of a redundant configuration, the software applies your selection automatically to the counterpart module of the standby controller.

Select Template Dialog Box

The table describes the fields of the Select Template dialog box and how to select templates.

Column Header Description

Hardware References Module hardware references and network type (see EcoStruxure ™

Process Expert, Global Templates, Reference Manual) for which a choice of topological templates is available.

Templates For each displayed hardware reference, indicates the identifier and version of the default topological template that the software will use to create the device.

• To select a different template: Click the default template to display the other available templates, select the template that you want to use, and click OK to confirm your selection.

• To cancel the configuration process and return to the Control

Participant window, click Cancel .

Using Configuration Change on the Fly (CCOTF)

Before Performing CCOTF Modifications

The CCOTF functionality of the Control Participant is enabled by default when you create a controller of the M580 or M580 safety platform in the Topology Explorer .

That is, the Online modification in RUN or STOP parameter of the CPU is selected.

It allows you to deploy compatible hardware configuration and parameter changes to the controller while it is running without impacting other modules or ongoing tasks.

Before performing a CCOTF-compatible modification, refer to the topics describing the CCOTF functionality in the

for your specific controller platform and follow the recommendations that are given.

CCOTF with EcoStruxure Process Expert

In EcoStruxure Process Expert, CCOTF already comes into play when you configure a controller (offline) of the M580 or M580 safety platform in the

Topology Explorer to which you have already deployed a built Control project.

When CCOTF is enabled, the software informs you if a configuration or parameter change that you are about to make will require stopping the controller when you deploy changes to the controller later on during the deployment stage. That is, it must be built offline.

NOTE: If you configure drops of the S908 architecture or make changes to an existing drop of this architecture during configuration of the controller (offline), you must use the

Build All , page 470

and Deploy Built Project commands thereafter, which requires stopping the controller. To perform CCOTFcompatible configurations of drops of the S908 architecture, use the Refine

Online command instead.

NOTE: CCOTF is not supported for controllers of the M340 and Quantum platforms.

EIO0000001114.15

369

370

Enabling and Disabling CCOTF

By configuring the controller, you can disable or enable the Online modification in

RUN or STOP parameter in the Control Participant Configuration section of the

CPU.

If you have already deployed a built Control project to the controller, enabling or disabling the parameter will require that you deploy once to the controller by using the Deploy Built Project command. This requires stopping the controller.

Configuration Changes not Compatible With CCOTF

The following types of changes can be incompatible with CCOTF and require stopping the controller:

• A single change that is saved during controller configuration.

For example, adding a NOC communication module in the local rack of an

M580 controller.

• A series of changes of the same type, which exceeds the number of allowed consecutive changes in a same transaction.

For example, adding five digital input modules to the local rack of an M580 controller (the limit for CCOTF is four modules).

For details on the CCOTF limitations, refer to the Control Participant help on

CCOTF for each controller platform.

Working Principle

When you perform a series of CCOTF compatible changes, you can build the executable of the associated Control project in the Project Explorer between changes. The changes are still part of the same transaction. A transaction is executed and the CCOTF counter is reset when you use the Deploy Changes/

Undo Online Changes or Deploy Built Project command on the controller.

When the software detects that a configuration change will require stopping the controller, a dialog box opens. It gives you the choice to proceed with the change or cancel it. The following table describes the impact of either choice.

Action selected by the user

Yes

Impact on CCOTF

Cancel

Impact on future configuration changes

The configuration change is performed.

If you save the change when closing the

Participant configuration window, the

Deploy Changes/Undo Online

Changes command is disabled and deploying the change by using the

Deploy Built Project command requires stopping the controller.

NOTE: Closing the Participant configuration window without saving discards the change and CCOTF is still available.

NOTE: Undoing the CCOTFincompatible configuration change does not revoke the controller stop if you save your changes.

The configuration change is discarded and you can continue with the configuration of the controller.

You are not informed anymore if you make CCOTF-incompatible configuration changes until you deploy to the controller.

The Build command in the context menu of the executable is disabled. Only Build

All can be used.

You continue to be informed when you make a CCOTF-incompatible configuration change.

NOTE: Using the Deploy Built Project command also resets the CCOTF counter.

EIO0000001114.15

change in the Control project, page 336

CCOTF in the System Engineering Life Cycle

The following table summarizes the main impact of the CCOTF functionality on the other stages of the system engineering life cycle. For details, refer to the description of each stage.

Stage

Refinement (offline)

Build

Deployment

Execution

Impact of CCOTF

When you perform a

that is not

CCOTF-compatible, the software informs you ahead of time that it will require stopping the controller when you deploy changes later on.

Changes related to the topology that are CCOTF-compatible can be

built, page 470

by using the Build command.

Changes related to the topology that are CCOTF-compatible can be

deployed, page 509

by using the Deploy Changes/Undo Online

Changes command without stopping the controller.

If you have made a CCOTF-incompatible change, only the Deploy Built

Project command is available, which requires stopping the controller.

It is required to

update the project, page 567

with configuration changes that you have made online to be able to use the Deploy Changes/Undo

Online Changes command.

Configuring a Controller

Overview

Controller entities act as engines for executing Control projects that are defined in the Projects Explorer .

You proceed with the configuration of controller entities from within the Control

Participant, which then transfers the defined configuration to the controller entity of the Topology Explorer by using the appropriate topological templates.

If the software cannot find the corresponding template for a hardware module, it uses the $UnknownModule template. Hardware modules that are modeled with this template do not appear in the Hardware Mapping editor.

NOTE: For additional information on configuring M580 safety controllers, refer to the topic describing the

engineering of M580 safety systems, page 577

Virtual Machine Usage

The configuration of one controller entity uses up one session of the Control

Participant of the virtual machine (see EcoStruxure ™ Process Expert, Installation and Configuration Guide).

Device DDTs of Topological Entities

When you add a module to a controller entity, which uses a device type manager

(DTM) (for example, an M580 CPU, a NOC communication module, or a HART analog I/O module), the software automatically creates the corresponding device

DDT. Such variables exist only in the configuration that you can access from the

Topology Explorer and are integrated to the Control Participant project during build.

However, you can

create certain device DDTs, page 343

in a Control Participant project during refinement.

Redundant Controllers

Typically, for redundant controllers that are configured in the topology, only the entity identifier or the identifier of the primary engine is used at the platform level to identify them (for example, in the Physical Connections dialog box when you connect the controller to an Ethernet network). The standby engine is implicitly

EIO0000001114.15

371

372

Update Project , page 531

included. If the standby engine needs to be dealt with explicitly (for example, for deployment tasks), it is identified separately.

Creating a Controller Entity

To create the controller entity, which will contain the controller configuration

(devices), proceed as follows.

Step

Action

Right-click the system root folder or a topology folder in the Topology Explorer , select

Create Controller , and select a controller platform.

Result: The controller

entity, page 366

is created and displayed in the tree view.

Controller Actions

Right-click the controller entity to open a context menu with the following commands.

Command

Configure , page

375

Physical

Connections , page 401

Update

Template

Deploy Built

Deploy Changes

/ Undo Online

Re-Deploy Last

Description

Opens the Control Participant, which allows you to configure the controller hardware, in-rack modules, drops, and communication services.

Opens the Physical Connections window, which allows you to connect or disconnect communication modules of the controller that support Ethernet to existing Ethernet networks to represent physical connections to such networks.

Opens the Update Template dialog box, which allows you to update the templates that are used by controller entities with the highest available version of the Global Templates library on the system server.

Opens the Deploy Built Project dialog box, which lets you select a built

Control Participant project and deploy it entirely to the controller.

It can also be used to remove refinements made online.

Deploys to the controller the differences between the deployed Control

Participant project and the corresponding built Control Participant project.

Deploy Data page 505

Start

, page 531

Stop , page 531

Refine Online , page 531

Sync (Primary→

Standby) , page

541

Back Up Data page 554

Lets you deploy once again the entire built Control Participant project that you had deployed to the controller last.

The command is available only if you had executed the Deploy Built Project command previously on the controller.

Opens the Deploy Data dialog box in which you can select a controller data backup file that has been created by using the Back Up Data command. It lets you deploy the data contained in the file to the controller.

The command available only if you have deployed a built Control Participant project to the controller.

Starts the execution of the participant project by the controller.

Stops the execution of the participant project by the controller.

Lets you modify the deployed Control Participant project online.

Lets you synchronize the standby controller with the primary one.

The command is available only for redundant controllers.

Updates the logical Control Participant project that is associated to the deployed Control Participant project with the changes that you have made to the deployed project online by using the Refine Online command.

It also requires that you update the controller configuration with hardware changes that you have made during online refinement.

Opens the Back Up Data dialog box, which lets you configure the data that you want to back up and create a controller data backup file.

The command available only if you have deployed a built Control Participant project to the controller.

EIO0000001114.15

Controller password, page 493

EIO0000001114.15

Command

Manage

Password

Clear Password

Description

Opens the Manage Password dialog box, which lets you set and modify the

Controller, page 491

and/or the

Safety, page 588

password.

Each command is available only if the corresponding property is enabled in the properties of the controller.

Opens the Clear Password dialog box, which lets you remove the

of the deployed Control Participant project and/or the

Safety, page 588

password.

Each command is available only if you have set the corresponding password.

Forgot

Password

Opens the Forgot Password dialog box, which contains an authentication code that you need to reset the forgotten

password.

Deletes the controller entity including controller devices and related configurations.

NOTE: For M580 safety controllers, deletes also the

associated M580 safety Control project, page 579 .

Rename Lets you change the identifier of the controller entity.

Controller Representation, page 377

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Properties Opens the Properties window in which you can view and edit properties of the controller entity.

NOTE: To view properties of the controller devices representing the hardware modules, refer to

Controller Properties

Right-click the controller entity and select Properties to open the Properties window in which you can view and edit its properties.

Item

General Identifier

Description

Area

Hot Standby

(1)

ControllerExist

Description

The identifier must be unique within the system and satisfy

peer to peer communication, page

The entity identifier becomes part of the name of the devices that the software creates inside in the entity:

• Folders ( identifier field)

• Devices ( $Name parameter)

The identifier (or part of it) is also used to create the name of the DTM if it is added during build when the controller is acting as server for

466

Optional.

You can enter a description of the controller with free form text. The description you enter appears in a tooltip when you move the cursor over the entity.

Default value: Blank

Optional.

You can assign an access control number to the controller entity.

Range: 1...255 (integer)

Default value: Blank

• PrimaryAndStandby : Select this value when both the primary and the standby controllers are physically present and connected by a Hot Standby cable link (default value).

• Primary : Select this value when either of the following applies:

◦ Only the primary controller is physically present.

◦ Both the primary and the standby controllers are physically present but not connected by a

Hot Standby cable link.

373

374

deployment and execution, page 481

Item

Controller

Family

CpuVersion

$Name of communication module (2)

Password

Protection

Value

CpuVersion

Controller

Description

The value has an impact on the behavior during

Indicates the hardware platform that the controller belongs to.

Read-only.

Indicates the firmware version of the CPU module that is configured.

The read-only property is displayed only after you save the controller configuration.

ServerMemoryStart Holding register address (%MW) for peer to peer data.

(Integer)

Default value: Blank

You can only enter an

odd address, page 468

for this parameter (for example, 1, 5, 11).

For more information, refer to

32-bit alignment, page 468

ServerMemory-

Length

Holding register size for peer to peer data.

(Integer)

Default value: Blank.

NOTE: The available memory length is

ServerMemoryLength - 1 because 1 word is reserved to move the channel address for managing the

for peer to peer communication across Modicon M340, M580, and

Quantum platforms.

For more information, refer to

ClientMemoryStart

(3)

Holding register address (%MW) for I/O scanning.

(Integer)

Default value: Blank.

For more information, refer to

ClientMemory-

Length (3)

Holding register size in words for I/O scanning

(Integer)

Default value: Blank.

For more information, refer to

manage password protection, page 488

Lets you

for deployment and execution operations performed on the controller.

• Enabled : Enables password protection.

• Disabled : Disables password protection after you confirm the selection.

By default, the value is set according to the value of the

Optional Security Services By Default

property, page

107

, which is set at the system level.

Default value: Enabled once you configure the controller.

NOTE: To disable the property once you have deployed a Control Participant project with the property set to Enabled , you need to enter the current password, which also clears it.

On the other hand, if you had already deployed a

Control Participant project while the property was set to Disabled , you can enable it and set a password for the already deployed Control project.

EIO0000001114.15

manage safe area password protection, page 588 .

EIO0000001114.15

Item

Safety

Description

The property is available only for M580 safety controllers and lets you

• Enabled (default): Makes the use of a password mandatory when performing operations on the safety configuration and/or safety program of the controller.

• Disabled : Disables password protection after you confirm the selection.

To disable password protection when a password is set, you must enter it. This also clears the password.

(1) The section is displayed only for redundant controller configurations.

(2) The section is displayed when the software has completed the configuration process. A section is displayed for each communication module that you have configured with an IP address in the Control Participant by using the Configure command. The server properties are displayed for CPU modules only.

(3) The client properties are displayed for communication modules, including the

CPU module when the I/O scanner service is enabled. They are not displayed for controllers of the Modicon M580 platform and NOC communication modules.

NOTE: To view properties of the controller devices representing the hardware modules, refer to

Controller Representation, page 377

Configuring the Controller

To configure the controller, proceed as follows.

Step

Action

Right-click the controller entity in the Topology Explorer and select Configure .

Result: The Control Participant opens

and maximized.

Proceed with the configuration of the controller inside the Control Participant.

For more information about configuring the controller and working inside the Control

Participant, refer to the Control Participant Services User Guide (see EcoStruxure ™

Process Expert, Control Participant Services, User Guide).

Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration to the Topology Explorer . It may display the

dialog box.

NOTE: If the software detects a configuration issue, it displays a notification, which allows you to change the configuration until you are able to save it.

Close the Control Participant window.

NOTE:

If you change the configuration and you click the close button on the outer frame of the Participant window without saving your changes first, the software displays the

Save Configuration dialog box where you can click the following:

Yes , to save the changes in the configuration file and close the Participant window.

No , to discard your changes and close the Participant window.

Cancel , to leave the Participant open without saving your changes.

Changing the Controller Configuration

To change the configuration of a controller, follow the procedure to configure a controller, and proceed with the changes inside the Control Participant.

375

376

If the controller is mapped to at least 1 executable, saving changes to communication functions that you made from within the Control Participant may delete the existing

and

communication mapping, page 424 .

of this executable.

In such case, the software displays a notification asking you to confirm the change. Make either selection:

• OK : To save the change to the configuration file of the controller and delete the associated communication and hardware mappings.

• Cancel : To keep the Control Participant window open. Unsaved changes are not discarded

For more information, refer to Configuring the Controller (see EcoStruxure ™

Process Expert, Control Participant Services, User Guide).

Configuring the Controller I/O Scanner Parameters

To use the I/O scanner of the controller and define communication channels between the CPU and/or communication modules and devices connected to the same Ethernet network, configure the read/write zones once the software has completed the configuration process to transfer the controller configuration to the

Topology Explorer .

The software configures the related parameters of the devices representing the

CPU/communication modules and exposes the data in the Communication

Mapping Editor window during the

If you configure overlapping client and server memory areas for a controller and map variables to these overlapping addresses, build does not complete successfully and the software displays a message to inform you.

These settings are an example of values entered in the Properties window of a controller that result in overlapping memory areas:

• ServerMemoryStart : 1

• ServerMemoryLength : 100

• ClientMemoryStart : 51

• ClientMemoryLength : 150

For more information on configuring parameters for I/O scanning, refer to the

Control Participant help.

NOTE: If you reduce the value of the

size, page 428

that is reserved in the client and/or server memory while peer to peer communication channels exist in the controller and you have already built the associated logical Control

Participant project, verify that the new register size meets the requirements of the project. You cannot build the project if the free memory value becomes negative.

NOTE: When you modify a parameter of the client and/or server memory reserved for communication channels and you have already deployed the associated built Control Participant project, you can only apply the change to the engine by using the

command, which requires stopping the controller. You cannot use the Deploy changes command.

To configure the I/O scanner parameters of the controller, proceed as follows.

Step

Action

In the Topology Explorer , right-click the controller folder and select Properties .

Enter a value in the appropriate fields of the

memory section, page 373

of the CPU and/ or communication module that you want to use for I/O scanning.

Click the close button to close the Properties window.

EIO0000001114.15

NOTE: For controllers of the Quantum platform configured with a NOC communication module and acting as client, configure the memory size of the

NOC (see EcoStruxure ™ Process Expert, Control Participant Services, User

Guide) by using the Control Participant.

Controller Representation

The Topology Explorer allows you to view the topological devices representing the following hardware components of the controller entity once you have configured it:

• Racks

• Buses

• Power supplies

• CPUs

• Communication modules

• I/O modules

It lets you also view and configure their

properties, page 378

The following figure shows the representation of a controller entity based on the

Modicon M580 platform with a local rack and one Ethernet RIO drop.

EIO0000001114.15

1 Controller folder representing the controller

entity, page 366

2 Controller local bus folder

3 Controller local rack folder

4 Controller local rack module folder

5 Devices modeling the rack, power supply, CPU, communication modules, and I/

O modules of the local rack

6 EIO bus folder

7 EthRIO rack folder

8 EthRIO drop folder

9 Devices modeling the rack, CRA module, and I/O modules of the EthRIO drop

Devices are identified by the $Name parameter, which uses the format <Entity identifier> <Bus number>:<Designation> <Drop number>:D <Rack number>:R

<Position on rack>:<Commercial reference>.

<Designation> is either:

• Local for the local bus of controller platforms that do not support a redundant configuration.

• PriLocal or SecLocal for the local bus of controller platforms that support a redundant configuration. If a standalone controller is configured, the local bus designation is PriLocal .

• EthRIO for the EIO bus of any controller platform supporting remote drops.

377

In this example, the highlighted row in the following figure represents a

BMXDDI1603 digital input module located in position 3 of the local rack of

Controller_1.

In this example, the highlighted row in the following figure represents a

BMXAMO0210 analog output module located in position 2 of the second remote drop of Controller_1.

378

NOTE: For CPUs of the Modicon M580 platform that have an embedded RIO scanner service:

• The parent folder with the name <Entity identifier> <Bus number>: EthRIO is created by default. The folder and the device it contains represent the

RIO scanner service. The status of the device remains invalid until you configure at least one RIO drop.

• The <Entity identifier> <Bus number>: EthRIO device appears in the

Physical Connections

dialog box, page 399

even if you have not yet configured a RIO drop. It is associated to IP Address A of the CPU module. In case of a redundant controller, it also implicitly represents the

RIO scanner service of the CPU designated as B and is associated to IP

Address B .

Properties of Modules

Expand the topological entity folder, right-click a device, and select Properties to open the Device Editor , which lets you view some of its parameters without the need to open the Control Participant. For example:

• Its reference

• Its position on the rack

• IP addresses, ports, and other module-specific communication parameters

• Physical interface links with Ethernet networks

• Implicit connections within the entity

Deleting a Controller Entity

When you select the Delete command for a controller entity, the software notifies you if it detects any of the following:

• Any mappings.

• Any physical interface link with an Ethernet network.

EIO0000001114.15

Peer to peer communication channels, page 433

Once you have confirmed the delete command, the software deletes the following components of the controller entity:

• Physical interface links

• The controller entity, subfolders, and devices contained therein

• The corresponding Control Participant configuration project, including:

◦ Any mapping information

◦

◦ Any deployed Control Participant project related to the engine

To delete the controller entity and its contents, proceed as follows.

Step

Action

Right-click the controller entity in the Topology Explorer and select Delete .

Result: A dialog box opens.

Verify the information that is displayed and click OK to proceed.

Result: The software deletes the controller entity and its contents, and displays a confirmation message in the notification panel.

Configuring a Station Node

Overview

The station node is a topological entity, which represents the hardware (for example, network interface cards (NICs)) and software (for example, Supervision servers and clients, OPC Factory Server or OPC UA Server Expert) that is installed on a computer workstation, which is connected to the Ethernet control network.

Station nodes act as engines for executing:

• Deployed Supervision projects.

• Deployed Control projects running in an

emulated simulator, page 484

For example, station nodes represent operator stations and operation servers.

You create station node entities in the Topology Explorer and define their devices from the station node folder representing the entity.

Creating a Station Node Entity

To create a station node entity, proceed as follows.

Step

Action

Right-click the system root folder or the topology folder in the Topology Explorer and select Create Station Node .

Result: The software creates a station node

entity, page 366

and displays it in the tree view.

NOTE: By default, the software creates a Network Interface Card (NIC) device when you create a station node entity. To display the NIC device, open the station node entity folder.

NOTE: The software may display the

dialog box.

Station Node Actions

Right-click the station node folder to open a context menu with the following commands.

EIO0000001114.15

379

380

Command

Create NIC , page

382

Create

Supervision

Service

Create OFS

Create Control

Service

Physical

Connections , page 403

Update

Control

Supervision

Delete

Rename

Description

Creates an NIC device and displays it in the station node folder.

The NIC provides connectivity to the Ethernet network through the

Physical

Connections , page 399

dialog box.

Creates a Supervision service instance and displays it in the station node folder.

It lets you select the station node in the

so that you can deploy a Supervision project to it.

Create the service in the stations nodes on which the I/O (1) , Alarm, Trend, and

Report servers as well as the Supervision clients are installed.

You can create one Supervision service per station node.

Right-click the service and select Properties to access its

parameters, page

384

(1) May also require an OFS service.

Creates a protocol-independent OFS service instance and displays it in the station node folder.

Create the service in the station node on which the I/O server and OPC

Factory Server or OPC UA Server Expert are installed. It is required to map the station node to the IOServer service of the Supervision project in the

configuration files, page

and to deploy the corresponding

476

to the station node.

You can create one OFS service per station node.

Right-click the service and select Properties to access its

parameters, page

384

NOTE: Requires also a Supervision service.

NOTE: The OFS service is not required to perform the service mapping with the IOServer service when the OPCUA Embedded protocol is

selected, page 264

for all the tag containers associated to the same I/O server.

Creates a Control Expert service instance and displays it in the station node folder.

It allows you to:

•

Deploy, page 481

a built Control Participant project to software emulating a simulator that is running on the computer.

• Select the station node to which you have deployed a Control project in the

communication mapping, page 460 . It lets you use it as data source

(I/O device) for simulating Supervision runtime services.

You can create one ControlExpert service per station node.

Right-click the service and select Properties to access its

parameters, page

384

Opens the Physical Connections window, which allows you to connect or disconnect the station node, through its NIC, to existing Ethernet networks to represent physical connections to such networks.

Opens the Update Template dialog box, which allows you to update the templates that are used by station node entities with the highest available version of the Global Templates library on the system server.

Opens a submenu containing deployment and execution commands.

Opens a submenu that contains the following commands:

• Deploy Built Project : Lets you select a built Supervision Participant project and

deploy it to the station node, page 523

The command is available only if you have created the necessary service in the station node, mapped an executable to the station node, and built it.

• Deploy Changes : Lets you

deploy a limited number of changes, page

528

to the station node.

The command is available only if you have already deployed the built

Supervision Participant project to the station node and if the number and type of changes are supported.

Deletes the station node entity including services and related configurations.

Lets you change the identifier of the station node entity.

EIO0000001114.15

Command Description

deploy it to the station node, page 481

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Properties Opens the Properties window in which you can view and edit properties of the station node entity.

The following table describes the commands of the Control submenu. Commands in this submenu are available only if you have created the necessary service in the station node, mapped an executable to the station node, and built it. Additional availability conditions may apply; refer to the description of each command.

Command

Deploy Built

Project

Deploy Changes

/ Undo Online

Changes , page

481

Re-Deploy Last

Project

481

, page

Deploy Data page 505

Start

Stop

, page 531

Description

Opens the Deploy Built Project dialog box, which lets you select a built

Control Participant project and

Lets you deploy to the station node the differences between the deployed

Control Participant project and the corresponding built Control Participant project.

It can also be used to remove changes made online.

Lets you deploy once again the entire built Control Participant project that you had deployed to the station node last.

The command is available only if you had executed the Deploy Built Project command previously on the station node.

The command available only if you have deployed a built Control Participant project to the station node.

Starts the execution of the deployed Control Participant project in the simulator.

Stops the execution of the deployed Control Participant project in the simulator.

Lets you change the deployed Control Participant project online.

Refine Online , page 531

Update Project , page 531

Back Up Data page 554

Manage

Password

Clear Password

Lets you update the logical Control Participant project that is associated to the deployed Control Participant project with the changes that you have made to the deployed project online by using the Refine Online command.

Opens the Back Up Data dialog box, which lets you configure the data that you want to back up and create a controller data backup file.

The command available only if you have deployed a built Control Participant project to the station node.

Opens the Manage Password dialog box, which lets you

set, page 491

a password for deployment and execution operations performed on the simulator and modify it.

The command is available only if the Simulator password property is set to

Enabled .

Opens the Clear Password dialog box, which lets you

remove, page 493

the application password of the deployed Control Participant project.

The command is available only if you have set a password.

Parameter

General Identifier

Description

Station Node Properties

Right-click the station node folder and select Properties to open the Properties window in which you can view and edit the station node properties.

Description

The identifier must be unique within the system and satisfy

naming rules, page

Optional.

EIO0000001114.15

381

Parameter

Control

Expert

Area

Computer Name

Password

Protection

Simulator

Supervision TCP Port

manage password protection, page 488

Description

You can enter a description of the station node with free form text. The description you enter appears in a tooltip when you move the cursor over the entity.

Default value: Blank

Optional.

You can assign an access control number to the station node entity.

Range: 1...255 (integer)

Default value: Blank

Optional.

The value is applied to the Computer property in the Network Addresses table of the Supervision Participant project when you build its executable.

The value is required, for example, when you are using encryption with

Supervision.

Default value: Blank

The property is available only once you create a ControlExpert

service, page

379 .

Lets you

for deployment and execution operations performed on the simulator.

• Enabled : Enables password protection.

• Disabled : Disables password protection after you confirm the selection.

By default, the value is set according to the value of the Optional Security

Services By Default

property, page 107 , which is set at the system level.

Default value: Enabled .

NOTE: To disable the property once you have deployed a Control

Participant project with the property set to Enabled , you need to enter the current password, which also clears it.

On the other hand, if you had already deployed a Control Participant project while the property was set to Disabled , you can enable it and set a password for the already deployed Control project.

Configure the value to be the same as TCP Listening Port of the OPCUA server that is installed on the station node.

The value is used in the

I/O device address, page 475

only when Protocol of the associated tag container is set to OPCUA .

Valid range: 49152 (default) to 65535.

The parameter is available only for station nodes in which an OFS service has been created.

Creating a Network Interface Card (NIC)

To create an NIC device, proceed as follows.

Step

Action

Right-click the station node entity in the Topology Explorer and select Create NIC .

Result: The software opens the station node folder and displays the NIC device.

NOTE: The software may display the

dialog box.

NIC Actions

Right-click the NIC device to open a context menu with the following commands.

382 EIO0000001114.15

EIO0000001114.15

Command

Update

Delete

Rename

Properties

Description

Opens the Update Template dialog box, which allows you to update the template that is used by NIC devices with the highest available version of the

Global Templates library on the system server.

deletes the NIC device including related configurations.

allows you to change the identifier of the NIC.

opens the Properties window in which you can view and edit properties of the

NIC.

NIC Properties

Right-click the NIC device and select Properties to open the Device Editor , which lets you view and edit its parameters.

Parameter

$System

NIC Parameters

PhysicalInterface-

LinkX (1)

$Name

Description

The identifier must be unique within the system and satisfy

Default value: NIC_n where n is an incremental number starting at 1.

$Description Optional.

You can enter a description of the NIC with free form text.

$Area

IPAddress

Default value: Blank

Optional.

You can assign an access control number to the NIC.

Range: 1...255 (integer)

Default value: Blank

IP address of the NIC on the Ethernet network.

The default IP address of the NIC that is created when you create the station node is 127.0.0.1

, which corresponds to the local host. For additional NICs that you create manually, the default value is blank.

NOTE: For station nodes on which you install software emulating a simulator, enter the

IP address, page 487

that is displayed by the simulator software running on the station node.

Subnet Mask Subnet mask that is used to define IP addresses on the

Ethernet network that the NIC belongs to.

Destination

Instance

Role

Interface

Default value: Blank

Indicates to which Ethernet network the NIC is connected.

Indicates the identifier of the role of the interface.

Indicates the identifier of the interface that the NIC device exposes for connection to the Ethernet network.

(1) The section is displayed if you have

connected, page 403

the station node through its NIC to an Ethernet network of the system. The parameters are not editable.

X represents the number of the physical interface link, which is an incremental number starting at 1.

Station Node Service Actions

Right-click an OFS , ControlExpert, or Supervision service instance to open a context menu with the following commands.

383

Command

Update

Delete

Rename

Properties

Description

Opens the Update Template dialog box, which allows you to update the template that is used by the instance with the highest available version of the

Global Templates library on the system server.

Deletes the instance including related configurations.

Lets you change the identifier of the instance.

Opens the Properties window in which you can view and edit properties of the instance.

Station Node Service Properties

Right-click an OFS , ControlExpert, or Supervision service instance and select

Properties to open the Device Editor , which lets you view and edit its parameters.

Parameter

$System $Name

Description

Identifier of the service, which must be unique within the system and satisfy

$Description Optional.

You can enter a description of the instance with free form text.

$Area

Default value: Blank

Optional.

You can assign an access control number to the instance.

Range: 1...255 (integer)

Default value: Blank

Configuring an STB Island

Overview

The topological entity represents an STB island that communicates with the controller through I/O scanning. It contains:

• Modules

• CANopen extensions

• HART devices

The STB island acts as a server.

You configure STB island entities from within the Control Participant, which then transfers the defined configuration to the STB island entity of the Topology

Explorer by using the appropriate topological templates.

Virtual Machine Usage

The configuration of one STB island entity uses up one session of the Advantys

Configuration Software (ACS) Participant of the virtual machine (see

EcoStruxure ™ Process Expert, Installation and Configuration Guide).

384 EIO0000001114.15

EIO0000001114.15

Creating an STB Island Entity

To create the STB island entity, which will contain the STB island configuration

(devices), proceed as follows.

Step

Action

Right-click the system root folder or a topology folder in the Topology Explorer and select Create STB Island .

Result: The software creates an STB island entity and displays it in the tree view.

STB Island Actions

Right-click the STB island entity to open a context menu with the following commands

Command

Configure

Description

Physical

Connections , page 404

Update

Opens the Control Participant, which allows you to configure hardware, such as modules of the STB island, devices connected through the CANopen bus, and communication modules.

Opens the Physical Connections window, which allows you to connect or disconnect the STB island to existing Ethernet networks to represent physical connections to such networks.

Opens the Update Template dialog box, which allows you to update the templates that are used by STB island entities with the highest available version of the Global Templates library on the system server.

STB Island Representation, page 387 .

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Delete , page 387

Deletes the STB island entity including its devices and related configurations.

Rename Allows you to change the identifier of the STB island entity.

Properties Opens the Properties window in which you can view and edit properties of the

STB island.

NOTE: To view the parameters of the devices representing the hardware modules of the STB island, refer to

STB Island Properties

Right-click the STB island entity and select Properties to open the Properties window in which you can view and edit its properties.

Item

General Identifier

Description

Area

Description

The identifier must be unique within the system and satisfy

The folder identifier becomes part of the name of the items that the software creates inside in the entity:

• Subfolders ( identifier field)

• Devices ( $Name parameter)

The identifier (or part of it) is also used to create the name of the DTM if it is added during

build, page 465 .

Optional.

You can enter a description of the STB island with free form text. The description you enter appears in a tooltip when you move the pointer over the entity.

Default value: Blank

Optional.

You can assign an access control number to the STB island entity.

Range: 1...255 (integer)

Default value: Blank

385

386

STB Island Representation, page 387

Item

Identifier

<communication module

ID> (1)

IPAddress

Subnet Mask

Description

IP address of the communication module of the STB island on the Ethernet network.

Default value: Blank

Subnet mask that is used to define IP addresses on the

Ethernet network that the communication module of the STB island belongs to.

Default value: Blank

(1) The section is displayed once you have closed the Participant window and saved changes.

NOTE: To view the parameters of the devices representing the hardware modules of the STB island, refer to

Changing STB Island Properties

Modifying the IP address or subnet mask of an STB island, may delete the

that exists with this STB island.

In such case, the software displays a notification asking you to confirm the change. Make either selection:

• Yes : To save the change to the properties of the STB island and delete the associated communication mapping.

• No : To discard your changes.

Configuring the STB Island

To configure the STB island, proceed as follows.

Step

Action

Right-click the STB island folder in the Topology Explorer and select Configure .

Result: The Control Participant opens

and maximized.

Proceed with the configuration of the STB island.

For more information about configuring the STB island and working inside the Control

Participant, refer to the Control Participant Services User Guide (see EcoStruxure ™

Process Expert, Control Participant Services, User Guide).

Click the close button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file, closes the Control

Participant window, and transfers the configuration to the Topology Explorer . It may display the

dialog box.

NOTE: If the software detects a configuration issue, it displays a notification, which allows you to change the configuration until you are able to save it.

NOTE:

If you click the close button on the outer frame of the Participant window, the software displays the Configuration dialog box where you can click the following:

• Yes to save the changes in the configuration file and close the Participant.

• No to discard your changes and close the Participant.

• Cancel to leave the Participant open without saving your changes.

Right-click the STB island entity and select Properties .

Enter the IP address and the subnet mask of the STB island.

Close the Properties window.

NOTE: To change the configuration of an STB island, follow the procedure to configure the STB island, and make the changes inside the Control

Participant.

EIO0000001114.15

Communicating with STB Islands Through Modbus TCP, page 600

Configuring Communication Between Controller and STB

Island

Refer to

for details about implementing communication by using the I/O scanner of the controller.

STB Island Representation

The Topology Explorer displays the devices representing the following hardware components of the STB island entity once you have configured it:

• Segments

• Bus

• Power supply

• CPU

• Communication modules

• I/O modules

• Devices connected through the CANopen fieldbus

It lets you also view and configure their

properties, page 378

The following figure shows the representation of an STB island entity with a device connected through the CANopen fieldbus:

EIO0000001114.15

1 STB island folder representing the STB island entity

2 STB island bus folder containing the bus device (expanded view)

3 STB island drop folder

4 STB island rack folder containing the devices modeling the STB island modules:

Power supply, I/O modules, NIM, CANopen extension module, termination plate

(expanded view)

5 STB island CANopen fieldbus folder containing the CANopen fieldbus device

(collapsed view)

6 STB island drop folder containing the devices modeling the devices connected to the CANopen fieldbus of the Island (collapsed view)

Deleting an STB Island Entity

When you select the Delete command for an STB island entity, the software notifies you if it detects any physical or mapping interface links with any device that is contained in the STB island folder that you want to delete.

387

configure the PRM entity, page 390 , the software loads the

Once you have confirmed the delete command, the software executes the following actions in relation to the devices that are being deleted:

• Interface links are deleted.

• The STB island folder, subfolders, and device contained therein are deleted

• The associated STB island profile is deleted.

To delete the STB island entity and its contents, proceed as follows.

Step

Action

Right-click the STB island entity in the Topology Explorer and select Delete .

Result: A notification dialog box opens.

Verify the information that is displayed and click OK to proceed.

Result: The software deletes the STB island entity and its contents and displays a confirmation message in the notification panel.

Configuring a PROFIBUS Remote Master and Decentralized Peripherals

Overview

The software allows you to model PROFIBUS remote masters (PRMs) and their decentralized peripherals (DPs), which communicate with supported controller platforms through I/O scanning.

You proceed with the configuration of PRM and DPs from within the Control

Participant by using the default device type managers (DTMs) or generic station description (GSD) files that are installed in the virtual machine. Thereafter, the software transfers the defined configuration to the entity of the Topology

Explorer by using the appropriate topological templates.

If the software cannot find the corresponding topological template for a DP, it uses the $GenericPBSlave template. DPs that are modeled with this template use a generic mapping interface that is available in the Hardware Mapping

editor, page

442

NOTE: You can install additional DTMs and GSD files in the Control

Participant by using the Extensions section (see EcoStruxure ™ Process

Expert, Installation and Configuration Guide) of the System Server

Configuration Wizard .

Virtual Machine Usage

The configuration of one PRM entity uses up one session of the Control

Participant of the virtual machine (see EcoStruxure ™ Process Expert, Installation and Configuration Guide).

Creating a PRM Entity

To create the PRM entity, which will contain the PRM and DP configuration

(devices), proceed as follows.

Step

Action

Right-click the system root folder or a topology folder in the Topology Explorer , select

Create PRM Profibus DP .

Result: The software creates a PRM entity and displays it in the tree view.

Right-click the PRM entity and select Properties .

Result: The Properties window of the PRM entity opens.

Select the controller platform that the PRM is communicating with in the menu of the

ControllerFamily

property, page 389 .

Result: When you

corresponding base configuration.

388 EIO0000001114.15

EIO0000001114.15

PRM Actions

Right-click the PRM entity to open a context menu with the following commands.

Command

Configure , page

390

Physical

Connections , page 401

Description

Opens the Control Participant, which allows you to configure the PRM and DPs by using DTMs and/or GSD files.

Opens the Physical Connections window, which allows you to connect or disconnect the PRM to existing Ethernet networks to represent physical connections to such networks.

Update

Opens the Update Template dialog box, which allows you to update the templates that are used by PRM entities with the highest available version of the Global Templates library on the system server.

PRM Representation, page 390 .

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Delete , page 391

Deletes the PRM entity including DPs and related configurations.

Rename Allows you to change the identifier of the PRM entity.

Properties Opens the Properties window in which you can view and edit properties of the

PRM entity.

NOTE: To view the parameters of the PRM devices representing the hardware modules, refer to

PRM Properties

Right-click the PRM entity and select Properties to open the Properties window in which you can view and edit the properties of the PRM entity.

Item

General

Controller

Family

Identifier

Description

Area

ControllerFamily

Description

The identifier must be unique within the system and satisfy

naming rules, page 65 .

The entity identifier becomes part of the name of the devices that the software creates inside in the entity:

• Folders ( identifier field)

• Devices ( $Name parameter)

The identifier (or part of it) is also used to create the name of the DTM if it is added during

build, page 465

NOTE: The identifier is not propagated to the PRM

DTM ( Alias name ) in the Control Participant.

Optional.

You can enter a description of the PRM with free form text. The description you enter appears in a tooltip when you move the pointer over the entity.

Default value: Blank

Optional.

You can assign an access control number to the PRM entity.

Range: 1...255 (integer)

Default value: Blank

Indicates the hardware platform of the controller that the

PRM communicates with through I/O scanning.

The value needs to correspond to the family of the controller that you select in the

service mapping tab, page

423

of the executable of the Control Participant project.

Possible values:

• M340/M580

• Quantum

Default value: Quantum

389

390

PRM Representation, page 390 .

NOTE: To view the parameters of the PRM devices representing the hardware modules, refer to

Configuring the PRM and its DPs

To configure the PRM and its DPs, proceed as follows.

Step

Action

Right-click the PRM entity in the Topology Explorer and select Configure .

Result: The Control Participant opens

and maximized.

Proceed with the configuration of the PRM and its DPs inside the Control Participant.

For more information, refer to the topic describing the configuration of the PRM and DPs

(see EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration to the Topology Explorer . It may display the

communication mappings, page 424

dialog box.

NOTE: If the software detects a configuration issue, it displays a notification, which allows you to change the configuration until you are able to save it.

Close the Control Participant window.

NOTE:

If you change the configuration and you click the close button on the outer frame of the Participant window without saving your changes first, the software displays the

Save Configuration dialog box where you can click the following:

• Yes to save the changes in the configuration file and close the Participant window.

• No to discard your changes and close the Participant window.

• Cancel to leave the Participant open without saving your changes.

Changing the PRM Configuration

To change the configuration of a PRM, follow the procedure to configure a PRM, and proceed with the changes within the Control Participant.

Saving changes to communication functions that you made within the Control

Participant, may delete existing

of the PRM.

In such case, the software displays a notification asking you to confirm the change. Make either selection:

• OK : To save the change to the configuration file of the PRM and delete the associated communication mapping.

• Cancel : To keep the Control Participant window open. Unsaved changes are not discarded.

For more information, refer to

Configuring the PRM, page 390

PRM and DP Representation

The Topology Explorer allows you to view the topological devices representing the following components of the PRM entity once you have configured it:

• PROFIBUS fieldbus

• PRM master

• PROFIBUS DPs

It lets you also view and configure their

properties, page 378 .

EIO0000001114.15

from the Supervision infrastructure, page 639 .

The following figure shows the representation of a PRM master configuration with one DP communicating with a Quantum controller.

1 PRM folder representing the PRM entity

2 PROFIBUS bus device

3 PRM device

4 DP device

Deleting a PRM Entity

Once you confirm the delete command, the software deletes the following components of the PRM entity:

• Physical interface links

• The PRM entity, subfolders, and devices contained therein

• The corresponding Control Participant configuration project, including:

To delete the PRM entity and its contents, proceed as follows.

Step

Action

Right-click the PRM entity in the Topology Explorer and select Delete .

Result: A notification dialog box opens.

Verify the information that is displayed and click OK to proceed.

Result: The software deletes the PRM entity and its contents, and displays a confirmation message in the notification panel.

Configuring Modbus TCP and EtherNet/IP Devices

Overview

The Topology Explorer lets you select and instantiate the topological template of devices that communicate with the controller by using either:

• Modbus TCP implicit (I/O scanning) or explicit messaging.

• EtherNet/IP explicit messaging.

Each template creates an I/O device topological entity.

There are two types of I/O device templates:

• Templates that are specific to a Schneider Electric device (see EcoStruxure ™

Process Expert, Device Templates User Guide) (for example, $EATV32HW) , which models an Altivar 32 speed drive).

• Generic templates (for example, $EIPGenericDeviceHW ), which let you model devices for which no specific template is available. For generic

Modbus TCP templates, select one that creates the required number of I/O scanner lines.

Alternatively, instances of the $EGenericDeviceHW template can act as gateways when you implement monitoring of Modbus serial device data directly

EIO0000001114.15

391

Filters, page 121 . The check mark indicates that the filter is applied.

Selecting Topological I/O Device Templates

The Select Template dialog box displays templates of the Global Templates library that meet the following criteria:

• Type : Topological

• SubType : Device-I/O

• Usability State (see EcoStruxure ™ Process Expert, Global Templates,

Reference Manual): Approved or Deprecated

The following figure shows an example of the Select Template dialog box for

Modbus TCP I/O device templates in tree view mode.

392

Column header

Template

Search field, page 120

to search for topological I/O device templates.

Button to toggle between grid view and tree view.

Description

Identifier of the template.

In tree view mode, the path to the template in the Global Templates library is also shown.

Version of the template.

Usability state (see EcoStruxure ™ Process Expert, Global Templates,

Reference Manual) of the template.

Description of the template.

Version

State

Description

Creating an I/O Device Entity

To create an I/O device entity, proceed as follows.

Step

Action

In the Topology Explorer , right-click the root or a topological folder and select Create

Device IO > Modbus TCP or EtherNet/IP .

Result: The Select Template dialog box opens displaying the corresponding templates.

Select a template and click OK .

Result: The software creates an instance of the selected template in the folder, which represents the I/O device topological entity.

NOTE: Click Cancel to close the Select Template dialog box without creating the

I/O device entity.

EIO0000001114.15

EIO0000001114.15

Modbus TCP and EtherNet/IP Device Actions

Right-click the I/O device entity to open a context menu with the following commands.

Command

Physical

Connections , page 403

Update

Replace

Description

Opens the Physical Connections window, which allows you to connect or disconnect the device to existing Ethernet networks to represent physical connections to such networks.

Opens the Update Template dialog box, which allows you to update the template that is used by Modbus TCP device entities with the highest available version of the Global Templates library on the system server.

Opens the Replace Device Template dialog box, which allows you to replaces the template that is used by the device with another template that meets the

criteria, page 392

and that is available in the Global Templates library on the system server.

Delete , page 387

Deletes the device entity including related configurations and mappings.

Rename Allows you to change the identifier of the Modbus TCP device entity.

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Properties Opens the Device Editor window in which you can view and edit properties of the device entity.

I/O Device Properties

Right-click the device entity and select Properties to open the Device Editor window in which you can view and edit its parameters.

You can view and/or edit the following parameters.

Parameter

$System $Name

$Description

Description

The identifier must be unique within the system and satisfy

naming rules, page 65 .

The default value: xHW_n where x is the identifier of the corresponding application template of the device and n an incremental number starting at 1.

The identifier (or part of it) is also used to create the name of the DTM if it is added during

build, page 465 .

String.

Optional.

You can enter a description of the device with free form text (string).

$Area Optional.

You can assign an access control number to the device entity.

Range: 1...255 (integer)

Communication IPAddress

Subnet Mask

IP address of the device on the Ethernet network.

Default value: Blank

Subnet mask that is used to define IP addresses on the

Ethernet network that the device belongs to.

Default value: Blank

IOScanningLines (1) You can select the number of I/O scanner lines that are generated during build.

Possible values: 1 to n , where n , is the maximum number of lines that a given template can generate.

Default value: Varies by template.

393

394

Parameter

ID (2)

Communication ReadLength (2)

ReadAddress (2)

WriteLength (2)

WriteAddress (2)

Description (2)

Configuration Privilege

IOSType (3)

EnableDHCP

Description

Modbus unit ID, unique identifier of the device. The parameter is provided by the DeviceID element of the

Modbus TCP server interface ( MBTCPServiceServer ), which is referenced by all Schneider Electric Modbus

TCP I/O device hardware templates.

Default value: 255

Valid range: 0 to 255

(UnsignedInt).

For example, for Altivar variable speed drives, the identifier is 255 .

NOTE: You can configure the parameter also in the Communication Mapping

tab, page 462

Supervision executables.

Number of words to be read (integer).

Enter an appropriate value. The value cannot be null when you implement communication by using I/O scanning with the CPU of an M580 controller or a NOC communication module.

Default value: 0

Remote address (%MW) to be read (integer).

Enter an appropriate value.

Default value: 0

Number of words to be written (integer).

Enter an appropriate value. The value cannot be null when you implement communication by using I/O scanning with the CPU of an M580 controller or a NOC communication module.

Default value: 0

Remote address (%MW) to be written (integer).

Enter an appropriate value.

Default value: 0

Optional.

Enter a description of the device with free form text

(string).

Parameter for access control purposes.

Default value: Blank

(String).

Parameter to select the I/O scanning element to be used:

• TesysTE : To read/write the complete data from/to the device.

• TesysTEFast : To read/write a minimum set of data from/to the device. Default value.

The selection and the device template that is used in the application of the system needs to match; otherwise you cannot proceed with the

For example, if you select TesysTEFast for this parameter, instantiate the $TesysTEFast template in the application.

(Enum).

NOTE: Changing this parameter value when the hardware mapping is done removes the mapping.

When true, the device subscribes to a DHCP server service.

EIO0000001114.15

Parameter

PhysicalInterfaceLink1 (4)

IdentifyByDevice-

Name

MACAddress

DTMDeviceName

Destination

Instance

Role

Interface

Description

When true, the DHCP server identifies the device by using DTMDeviceName ; otherwise, it identifies the device by using MACAddress .

MAC address of the device.

Use a hyphen as separator.

Name of the device.

For example, TeSys064 .

Indicates to which Ethernet network the device is connected.

Indicates the identifier of the role of the interface.

Indicates the identifier of the interface that the device exposes for connection to the Ethernet network.

(1) The parameter is displayed only for entities using a generic topological

Modbus TCP device template, which allows selecting the number of I/O scanner lines that are generated (for example, $EGenDev4IOSHW ).

(2) The parameters are available only for entities using a generic topological

Modbus TCP device template (and also for a few Modbus TCP device-specific templates). For generic templates that reference several Modbus TCP server interfaces (for example, $EGenDev4IOSHW ), the set of parameters appears as many times as there are server interfaces in the template.

(3) The parameter is available only for certain Modbus TCP entities (for example, those using the $ETesysTHW template).

(4) The section is displayed if you have

connected, page 403

the I/O device entity to an Ethernet network of the system. The parameters are not editable.

Changing I/O Device Properties

Modifying the IP address or subnet mask of an I/O device entity, may delete the

manage communication, page 597 .

that exists with this device.

In such case, the software displays a notification asking you to confirm the change.

Make either selection:

• Yes : To save the change to the properties of the I/O device and delete the associated communication mapping.

• No : To discard your changes.

Implementing Communication Between Controllers and I/O

Devices

For details about how to implement communication between controllers and I/O devices by using Modbus TCP or EtherNet/IP, refer to the topic describing how to

Configuring HART Modules

Overview

The HART communication protocol can be addressed by using either of these

Modicon eX80 modules:

• BMEAHI0812 HART analog input module.

• BMEAHO0412 HART analog output module.

You can add these HART analog I/O modules to local racks and/or remote drops of controllers of the Quantum and M580 platform. With the Quantum platform, a

NOC communication module is required.

EIO0000001114.15

395

396

interface module, page 384

You proceed with the configuration of HART modules from within the Control

Participant by using the Configure command on a controller entity.

Thereafter, the software transfers the defined configuration to the entity of the

Topology Explorer by using the appropriate topological templates.

NOTE: Addressing the HART protocol by using a Modicon STB island is also possible with the STBAHI8321 HART

Managed Data

The Primary Variable (PV) of HART analog I/O modules is the only variable that is available in the Hardware Mapping Editor later on. During this stage, you can map facets of analog I/O templates (for example, $AnalogInput1 ) instantiated in the application, which represent PV, to the projection of the I/Os of the HART modules.

The other variables and data of the HART modules that you configure are preserved during build and can be deployed to a controller but are not usable at the system level.

NOTE: You need to use an Asset Management System and perform some additional steps (see EcoStruxure ™ Process Expert , Foundation Application

Templates, User Guide) manually to take advantage of the advanced functionality provided by HART analog I/O modules.

HART Module Device DDT Variables

When you add a HART analog I/O module to a configuration, the Participant creates a device DDT (DDDT) variable associated to the I/O the module.

When you add the corresponding HART device type manager (DTM) that is preinstalled, it creates a second DDDT variable associated to the DTM to manage the extended data.

Both variable are present only in the configuration that you can access from the

Topology Explorer and are integrated to the Control Participant project during

build, page 464

. However, if you want to use the two DDDTs in a Control

Participant project during refinement, you can

create them, page 343 .

Configuring HART Modules

To configure HART analog I/O modules, proceed as follows.

Step

Action

Right-click the controller entity in the Topology Explorer and select Configure .

Result: The software displays the Control Participant in a reduced window.

Maximize the Control Participant.

Proceed with the configuration of the HART module inside the Control Participant.

For more information about configuring HART analog I/O module and working inside the

Control Participant, refer to the topic describing the configuration of the controller (see

EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

EIO0000001114.15

Step

Action

Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration to the Topology Explorer . It may display the

dialog box.

NOTE: If the software detects a configuration issue, it displays a notification, which allows you to change the configuration until you are able to save it.

Close the Control Participant window.

NOTE:

If you change the configuration and you click the close button on the outer frame of the Participant window without saving your changes first, the software displays the

Save Configuration dialog box where you can click the following:

• Yes to save the changes in the configuration file and close the Participant window.

• No to discard your changes and close the Participant window.

• Cancel to leave the Participant open without saving your changes.

Changing the HART Module Configuration

To change the configuration of a HART analog I/O module, follow the procedure to configure a HART module, and proceed with the changes inside the Control

Participant.

HART Module Representation

The Topology Explorer allows you to view the topological devices representing

HART analog I/O modules.

It lets you also view and configure their

properties, page 378

The following figure shows the representation of a BMEAHI0812 HART analog I/O module located in the local rack of an M580 controller entity.

1 Device representing the HART module.

NOTE: The HART module is represented similarly in a topological entity based on the Quantum platform.

Configuring an Ethernet Network

Overview

The Ethernet network entity represents a physical or virtual Ethernet local area network (LAN or VLAN) to which you can physically connect topological entities of

EIO0000001114.15

397

398

the system such as controllers, Modbus TCP devices, EtherNet/IP devices, and station nodes.

You create Ethernet network entities and define their parameters in the Topology

Explorer .

Creating an Ethernet Network Entity

To create an Ethernet network entity, proceed as follows.

Step

Action

Right-click the system root folder or a topological folder in the Topology Explorer and select Create Ethernet Network .

Result: The software creates an Ethernet network entity and displays it inside the folder.

NOTE: The software may display the

dialog box.

Ethernet Network Actions

Right-click the Ethernet network entity to open a context menu with the following commands.

Command

Update

Description

Opens the Update Template dialog box, which allows you to update the template that is used by the Ethernet network entity with the highest available version of the Global Templates library on the system server.

Opens the Export window, which allows you to export the entity and its folder hierarchy in the form of a topology export file (.sbk).

Delete

Rename

Deletes the entity including related configurations.

Allows you to change the identifier of the Ethernet network entity.

Properties Opens the Device Editor window in which you can view and edit properties of the Ethernet network.

Ethernet Network Properties

Right-click the Ethernet network entity and select Properties to open the Device

Editor window in which you can view and edit parameters of the Ethernet network.

You can view and/or edit the following parameters.

Parameter

$System

PhysicalInterfaceLinkX

(1)

$Name

Description

The identifier must be unique within the system and satisfy

Default value: EthernetNetwork_n where n is an incremental number starting at 1.

$Description

$Area

Optional.

You can enter a description of the Ethernet network with free form text.

Default value: Blank

Optional.

You can assign an access control number to the

Ethernet network entity.

Range: 1...255 (integer)

Default value: Blank

Indicates which topological entities and/or devices you have connected to the Ethernet network.

EIO0000001114.15

communication mapping, page 420

Parameter Description

A section containing these parameters is displayed for each of the connected topological entities and devices, including connections to standby controllers of redundant configurations.

Destination

Instance

Indicates the $Name of the connected entity or

device, page 377

Role

Interface

Indicates the identifier of the role of the interface.

Indicates the identifier of the interface that the Ethernet network entity exposes for connecting with the topological entity or device.

(1) The section is displayed if you have

connected, page 399

topological entities or devices to the Ethernet network. The parameters are not editable.

X represents the number of the physical interface link, which is an incremental number starting at 1.

Connecting to an Ethernet Network

Overview

The Physical Connections command allows you to connect topological entities that support Modbus TCP or EtherNet/IP connectivity to an Ethernet network entity of the system.

The physical interface link that is created represents the physical connection of communication modules to a network.

At the platform level, physical connections for entities are required to be able to perform the

in Control and Supervision executables. They are not required to perform service mapping or deployment and execution tasks.

Devices with which you can create a physical connection are identified by using their $Name

parameter, page 377 .

To make a physical connection,

create an Ethernet network first, page 397 .

NOTE: The command also allows you to disconnect an entity from an

Ethernet network.

IP Address Uniqueness Requirement

The IP address of a topological entity and/or its communication module on the

Ethernet network must be unique to make the physical connection possible. This rule applies to:

• CPU modules (including main IP address and IP address A depending on controller platform)

• Communication modules such as:

◦ NOE

◦ NOC (for 140NOC78•00 modules, main IP address only, not IP address A)

◦ CRA

◦ NIC of station nodes

◦ NIM of STB islands

◦ Embedded

RIO scanner services, page 377

of M580 CPUs

• Modbus TCP and EtherNet/IP I/O devices

• PROFIBUS remote masters (PRMs)

NOTE: Refer also to rules for redundant controller

entities, page 400 .

EIO0000001114.15

399

400

Ethernet network entity, page 398

Viewing Connections to Ethernet Networks

The PhysicalInterfaceLink parameter allows you to view, which entities are connected to which Ethernet network. Access the parameter by right-clicking either of the following and selecting Properties :

• The

• The communication module of a topological entity

NOTE: You can also right-click an entity and select Physical Connections to view the Ethernet network to which the entity if connected to.

Availability of Ethernet Networks

If the communication or hardware mapping editor is open for an entity, then the

Ethernet network to which this entity is connected is not available. Because of this, you cannot use the Physical Connections command to connect other entities to this Ethernet network or change existing connections to this network.

Close the communication mapping editor to release the Ethernet network.

Managing Conflicting Connections to Ethernet Networks

If the system contains at least 2 entities, each with a communication module physically connected to an Ethernet network, and during the configuration of 1 of the entities, you enter a conflicting IP address for the module, a dialog box opens when you attempt to save the configuration, requiring confirmation to remove the physical connection of the module.

Click either of the following:

• OK to remove the physical connection of the module, disconnecting it from the Ethernet network.

• Cancel to cancel the save operation and keep the Control Participant open, which allows you to change the configuration.

For more information, refer to Considerations When Updating an Existing

Configuration (see EcoStruxure ™ Process Expert, Control Participant Services,

User Guide).

NOTE: Removing the physical connection to an Ethernet network deletes all or part of the existing communication and hardware mapping of the associated

Control Participant project executable.

Connections with Redundant Controllers

For redundant controllers, the rule about uniqueness of the IP address on an

Ethernet network to make the connection possible applies also to:

• For CPU modules:

◦ (Main) IP address +1 (where IP address is the address of the CPU module of the primary controller)

◦ IP address B (M580 platform)

• For BMENOC3•1 communication modules, main IP address +1 only (not IP address B)

• For 140NOC78•00 communication modules, IP address +1 (where IP address is the address of the NOC module of the primary controller)

• For NOE communication modules, IP address +1 (where IP address is the address of the NOE module of the primary controller)

Therefore, when a standalone controller is connected to an Ethernet network and you change the configuration to a redundant one, already connected modules of the controller that has become the primary controller may be disconnected. This affects

existing mappings, page 375 .

The table describes the various scenarios when you change the configuration of a standalone controller to a redundant one depending on the status of the IP

EIO0000001114.15

address of counterpart modules in the standby controller. It is assumed that the standalone controller becomes the primary controller of the redundant configuration.

Status of physical connection of module in standalone configuration

IP address (1) of counterpart module in the standby controller after changing to redundant configuration

Unique

Impact on the physical connection of both modules to the Ethernet network

Connected Both modules are connected.

Connected Already exists Module of the primary controller is disconnected.

Module of the standby controller is not connected.

Not connected irrelevant Both modules are not connected.

(1) If the module has two IP addresses both are considered unless otherwise mentioned.

For example, if the local rack of an M580 standalone controller contains an NOC module, which is connected to an Ethernet network (main IP address) and the

CPU communication module is also connected (Main IP address and IP address

A) if, when you change this configuration to a redundant one, the IP address of the

NOC module of the standby controller (main IP address +1) is not unique on the same network, then it is not connected to the network and the NOC module of the primary controller is disconnected from the network. If the IP addresses of the

CPU communication module of the standby controller are unique, both primary and standby CPU communication modules are connected to the network.

The other way around, when you change the configuration of a redundant controller to a standalone one, the modules that were connected to the Ethernet network remain connected.

Connecting a Controller to an Ethernet Network

You can connect controller entities that offer physical connectivity to existing

Ethernet networks of the system.

To connect a controller to an Ethernet network, proceed as follows.

Step

Action

Right-click the controller entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of the communication modules of the controller in the Communication

Modules column.

NOTE:

• The identifier only appears if you have assigned an IP address to the communication module in the configuration.

• When connecting a redundant controller, only communication modules of the primary controller are displayed in the Physical Connections window.

• When connecting a controller that has a CRP module or an embedded RIO scanner service (M580 CPUs), the EthRIO bus device that is displayed in the

Physical Connections window represents the physical connection with the remote I/O network. It connects the corresponding communication modules such as CRP and CRA modules, and the embedded RIO scanner service.

Click the field in the Allowed Network(s) column next to the communication module that you want to connect to the network.

Result: The Ethernet networks to which a connection is possible are displayed.

EIO0000001114.15

401

402

software disconnects, page 400

Step

Action

Select a network.

Click OK to save your selection and close the Physical Connections window.

Result: The communication module is connected to the selected Ethernet network.

NOTE:

• For redundant controllers, the software automatically connects the counterpart module of the standby controller to the same Ethernet network.

• For BMENOC3•1 communication modules, IP addresses A and B are not connected.

Disconnecting a Controller from an Ethernet Network

To disconnect a controller from an Ethernet network, proceed as follows.

Step

Action

Right-click the controller entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of:

• The communication modules of the controller in the Communication Modules column

• The Ethernet network to which the controller is connected in the Allowed Network

(s) column

NOTE:

• When disconnecting a redundant controller, only the communication modules of the primary controller are displayed in the Physical Connections window.

• When disconnecting a controller that as CRP module or an embedded RIO scanner service (M580 CPUs), the EthRIO bus device that is displayed in the

Physical Connections window, represents the physical connection with the remote I/O network. It disconnects the corresponding communication modules, such as CRP and CRA modules, and the embedded RIO scanner service.

The other way around, when the

, for example, a CRA module because of an IP address conflict, it is the EthRIO bus device that is disconnected.

Click the field in the Allowed Network(s) column next to the communication module that you want to disconnect from the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select Not Assigned in the Allowed Network(s) menu.

NOTE: You may also select another Ethernet network from the menu (if available) to create a connection with it instead.

Click OK .

Result: If a communication mapping exists for the executable to which the controller is mapped, the software displays a notification, asking you to confirm the disconnection.

Otherwise, the software disconnects the communication module from the selected

Ethernet network, and closes the Physical Connections window.

NOTE: For redundant controllers, the software automatically disconnects the counterpart module of the standby controller from the same Ethernet network.

Click Yes to confirm.

Result: The software:

• Disconnects the communication module from the selected Ethernet network.

• Deletes the

existing mappings, page 375

of the executable to which the controller is mapped.

• Changes the status of the executable to which the controller is mapped to Out Of

Date if it is built.

• Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the communication module from the Ethernet network.

NOTE: For a redundant controller, the software automatically disconnects the counterpart module of the standby controller from the same Ethernet network.

EIO0000001114.15

EIO0000001114.15

Connecting a Station Node to an Ethernet Network

You can connect or disconnect station node entities to existing Ethernet networks through their NIC devices.

To connect a station node to an Ethernet network, proceed as follows.

Step

Action

Right-click the station node entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of the NIC of the station node in the Communication Modules column.

NOTE: The NIC identifier only appears if you have assigned an IP address to the

NIC.

Click the field in the Allowed Network(s) column next to the NIC that you want to connect to the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select a network.

Click OK to save your selection and close the Physical Connections window.

Result: The station node is connected to the selected Ethernet network.

Disconnecting a Station Node from an Ethernet Network

To disconnect a station node entity from an Ethernet network, proceed as follows.

Step

Action

Right-click the station node entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of:

• The NIC of the station node in the Communication Modules column

• The Ethernet network to which the NIC is connected in the Allowed Network(s) column

Click the field in the Allowed Network(s) column next to the NIC that you want to disconnect from the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select Not Assigned in the Allowed Network(s) menu.

NOTE: You may also select another Ethernet network from the menu (if available) to create a connection with it instead.

Click OK .

Result: The software:

• Disconnects the station node from the selected Ethernet network.

• Deletes the existing

of the executable to which the station node is mapped.

• Changes the status of the executable to which the station node is mapped to Out

Of Date if it is built.

• Closes the Physical Connections window.

Connecting a Modbus TCP or EtherNet/IP Device to an Ethernet

Network

You can connect or disconnect Modbus TCP and EtherNet/IP device entities to existing Ethernet networks.

To connect an I/O device entity to an Ethernet network, proceed as follows.

403

404

Step

Action

Right-click the device entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the device entity identifier in the Communication Modules column.

NOTE: The device identifier only appears if you have assigned an IP address to the device.

Click the field in the Allowed Network(s) column next to the device that you want to connect to the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select a network.

Click OK to save your selection and close the Physical Connections window.

Result: The device is connected to the selected Ethernet network.

Disconnecting a Modbus TCP or EtherNet/IP Device from an

Ethernet Network

To disconnect a Modbus TCP or EtherNet/IP device entity from an Ethernet network, proceed as follows.

Step

Action

Right-click the device entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of:

• The I/O device in the Communication Modules column

• The Ethernet network to which the device is connected in the Allowed Network(s) column

Click the field in the Allowed Network(s) column next to the device that you want to disconnect from the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select Not Assigned in the Allowed Network(s) menu.

NOTE: You may also select another Ethernet network from the menu (if available) to create a connection with it instead.

Click OK .

Result: If a hardware or communication mapping exists for the executable of the client controller communicating with the device, the software displays a notification, asking you to confirm the disconnection.

Otherwise, the software disconnects the I/O device from the selected Ethernet network, and closes the Physical Connections window.

Click Yes to confirm.

Result: The software:

• Disconnects the I/O device from the selected Ethernet network.

• Deletes the existing

and

of the executable of the client controller communicating with the device.

• Changes the status of the client controller communicating with the device to Out

Of Date if it is built.

• Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the I/O device from the Ethernet network.

Connecting an STB Island to an Ethernet Network

You can connect or disconnect STB islands to existing Ethernet networks through their NIM.

To connect an STB island to an Ethernet network, proceed as follows.

EIO0000001114.15

EIO0000001114.15

Step

Action

Right-click the STB island entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of the communication module of the STB island in the Communication

Modules column.

NOTE: The module identifier only appears if you have assigned an IP address to the NIM.

Click the field in the Allowed Network(s) column next to the communication module that you want to connect to the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select a network.

Click OK to save your selection and close the Physical Connections window.

Result: The STB island entity is connected to the selected Ethernet network.

Disconnecting an STB Island from an Ethernet Network

To disconnect an STB island entity from an Ethernet network, proceed as follows.

Step

Action

Right-click the STB island entity in the Topology Explorer and select Physical

Connections .

Result: The software opens the Physical Connections window and displays the identifier of:

• The NIM of the STB island in the Communication Modules column

• The Ethernet network to which the NIM is connected in the Allowed Network(s) column

Click the field in the Allowed Network(s) column next to the NIM that you want to disconnect from the network.

Result: The Ethernet networks to which a connection is possible are displayed.

Select Not Assigned in the Allowed Network(s) menu.

NOTE: You may also select another Ethernet network from the menu (if available) to create a connection with it instead.

Click OK .

Result: If a hardware or communication mapping exists for the executable of the client controller communicating with the STB island, the software displays a notification, asking you to confirm the disconnection.

Otherwise, the software disconnects the STB island entity from the selected Ethernet network, and closes the Physical Connections window.

Click Yes to confirm.

Result: The software:

• Disconnects the STB island entity from the selected Ethernet network.

• Deletes the existing

and

of the executable of the client controller communicating with the STB island.

• Changes the status of the client controller communicating with the STB island to

Out Of Date if it is built.

• Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the communication module from the Ethernet network.

Connecting a PRM to an Ethernet Network

You can connect or disconnect PRM entities to existing Ethernet networks.

To connect a PRM entity to an Ethernet network, proceed as follows.

405

Step

Action

Right-click the PRM entity in the Topology Explorer and select Physical Connections .

Result: The software opens the Physical Connections window and displays the PRM entity identifier in the Communication Modules column.

NOTE: The PRM identifier only appears if you have assigned an

IP address, page

390

to the PRM.

Click the field in the Allowed Network(s) column next to the PRM.

Result: The Ethernet networks to which a connection is possible are displayed.

Select a network.

Click OK to save your selection and close the Physical Connections window.

Result: The PRM is connected to the selected Ethernet network.

Disconnecting a PRM from an Ethernet Network

To disconnect a PRM entity from an Ethernet network, proceed as follows.

Step

Action

Right-click the PRM entity in the Topology Explorer and select Physical Connections .

Result: The software opens the Physical Connections window and displays the identifier of:

• The PRM in the Communication Modules column

• The Ethernet network to which the PRM is connected in the Allowed Network(s) column

Click the field in the Allowed Network(s) column next to the PRM.

Result: The Ethernet networks to which a connection is possible are displayed.

Select Not Assigned in the Allowed Network(s) menu.

NOTE: You may also select another Ethernet network from the menu (if available) to create a connection with it instead.

Click OK .

Result: If a hardware or communication mapping exists for the executable of the client controller communicating with the PRM, the software displays a notification, asking you to confirm the disconnection.

Otherwise, the software disconnects the PRM from the selected Ethernet network, and closes the Physical Connections window.

Click Yes to confirm.

Result: The software:

• Disconnects the PRM entity from the selected Ethernet network.

• Deletes the existing

and

of the executable of the client controller communicating with the PRM.

• Changes the status of the client controller communicating with the PRM to Out Of

Date if it is built.

• Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the PRM from the Ethernet network.

Managing the Topology

Overview

This section describes how to use the software to manage the topology of the system.

406 EIO0000001114.15

concurrent actions, page 52 . In such case, check the

for details.

Moving Topological Folders and Entities

Moving Topological Folders

You can move any topological folder to another folder, including the system root folder, by dragging it.

Updating Templates of Topological Entities

Overview

By using the Update Template command in the Topology Explorer , you can update the templates that are used by the following topological entities and their devices:

• Controllers

• STB islands

• Station nodes

• Modbus TCP and EtherNet/IP devices

• PROFIBUS Remote Masters and DPs

• Ethernet networks

If the update of one template cannot be completed for an entity, the entire update process is rolled back.

When used at the folder level, the command applies to any entity that is contained in the folder, and in any of its subfolders.

NOTE: The update functionality affects:

• Existing service, communication, and hardware mapping interface links.

• Deployment information related to the executable to which the entity is mapped.

NOTE: No command is available to replace a topological template, such as the $UnknownModule template (see EcoStruxure ™ Process Expert, Control

Participant Services, User Guide).

Accessing the Command

Right-click a folder or an entity, and select Update Template .

Description of the Update Functionality

The software proceeds with the update of templates in the following order:

• The templates that are associated to the entity are updated.

• Interface links are processed.

The table describes the effects on the different template items when you update the templates that are used by a topological entity:

Item Identifier in New Template

Parameter values Is same as in current template

Is not in current template

Action

Explicitly defined parameters of the current template keep their respective value in the new template.

New parameters that are not part of the current template keep their default values.

EIO0000001114.15

407

Physical interface links, page 399

Item

Identifier in New Template

Is same as in current template

Is not the same as in current template

Mappings, page

420

–

Deployment information

–

Action

Physical interface links of the entity are maintained.

New physical interface links can be added. Physical interface links that are not part of the new template or that do not satisfy applicable rules are removed.

The software maintains existing service, communication, and hardware mapping interface links of the Control and Supervision executables to which the entity is mapped if the corresponding mapping interfaces are available, and satisfy applicable rules.

If you had deployed a Control project to a station node or controller entity, the corresponding deployment information is unchanged.

NOTE: When you update the template of a redundant controller entity, the update takes places for both the primary and the standby controller entities.

Default Template Selection

By default, the software selects the topological template with the same identifier that has the highest version number with the Usability State of Approved .

Updating Templates

To update the templates that are used by a topological entity, proceed as follows:

Step Action

1 In the tree view of the Topology Explorer , right-click the entity and select Update

Template .

Result: The Update Device Template dialog box opens. It shows for each device template that can be updated, the new version that will be used.

2 Click OK .

Result: The software:

• Updates the templates that are used by the entity.

• May delete existing mapping information of the corresponding executable of the

Control project.

NOTE: Click Cancel to close the Update Device Template dialog box without updating templates.

NOTE: If you use a filter in the Name column of the Update Device Template dialog box and as a result, only some of the device templates for which a later version exists are displayed, the update operation is still performed on the entire selection of device templates of the entity for which a later version exists.

Exporting Topological Entities

Overview

The Export command allows you to create a non-editable export file (.sbk), which contains information of selected topological entities, their folder hierarchy, and dependencies.

You can use this data with the

import, page 411

functionality of the Topology

Explorer to do the following:

• Transfer project information to a different system or EcoStruxure Process

Expert infrastructure.

• Add and/or modify topological entities.

• Duplicate topological entities.

• Move, remove, replace, and/or add devices of entities.

• Update properties of entities and folders.

408 EIO0000001114.15

engineer systems with M580 safety controllers, page 590

• Prepare the topology of a system before importing Control and/or Supervision

Participant projects.

Exporting M580 Safety Controllers

For specific information about exporting M580 safety controllers, refer to the topic describing how to

Software Version Compatibility

Export File Contents

You can select the Export command at different levels to export the following:

• For an entity: Exports the data pertaining to this topological entity and its devices. The parent folder hierarchy up to the system root folder is also included.

• For a topological folder: Exports the entities contained in the folder and in any subfolders, and their devices. The parent folder hierarchy up to the system root folder is also included.

• For the system root folder: Exports the entities of the entire system and their devices. The parent folder hierarchy up to the system root folder for any entity is also included.

By default, in each case, the folder hierarchy of the exported entities is selected for export.

You cannot export empty folders or folders that contain entities that are not selected for export. The rule does not apply for folders that are part of the parent folder hierarchy of an exported entity or folder.

NOTE: If physical connections exist for a selected entity at the time of export, these links are automatically included in the export file. This allows recreating the physical connection at the time of import if

applicable rules are satisfied, page 413

NOTE:

Passwords, page 488

are not exported. Yet, the

password protection properties, page 373

and their value are exported.

Topological Templates

The export file does not contain the topological templates of the entities and devices that you are exporting. To import entities in a different EcoStruxure

Process Expert infrastructure, the Global Templates library of the target architecture needs to contain the necessary templates with the same version.

Entities for which the template is not present cannot be imported.

For information on how to export templates, refer to the topic that describes

managing Global Templates, page 675

Topological Export Window

The topological Export window allows you to select the entities and folders that you export.

EIO0000001114.15

409

notification panel, page 54 . Click the icon to cancel the task.

The following figure shows an example of the Export window in tree view mode.

410

1 Button to toggle between the grid view and tree view

Header

Name

Type

Path

Description

Shows the identifier of topological entities that you can export.

By default, entities are selected for export.

NOTE: When check boxes of folders are filled with a black square, at least one entity or folder in a sublevel is not selected for export.

Type of the topological entity (controller, station node, Ethernet network, and so on).

Path to the folder or entity.

The column is displayed only in grid view.

Contents of the Description property of the entity.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter .

Aborting Export Tasks

After confirming the export by clicking Save in the Save dialog box, the abort icon is displayed in the

The export file is not created.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are exporting only a few entities, the task may complete before you are able to click the icon.

Creating the Export File

To create a topology export file, proceed as follows.

EIO0000001114.15

various scenarios, page 417 .

Step

Action

In the Topology Explorer , right-click the folder or entity that you want to export and select Export .

Result: The software opens the Export window and displays the entities that you can export.

Select the entities that you want to export.

Click OK .

Result: The software opens the Save dialog box.

NOTE: Click Cancel to close the Export window without creating the export file.

Select a location where you want to save the export file, enter a file name, and click

Save .

Result: The software creates the export file (.sbk), which contains information of the selected topological entities.

NOTE: Click Cancel to close the Save dialog box and revert to the Export window.

Importing Topological Entities

Overview

The import functionality allows you to import data of topological folders and entities from a topological export file (.sbk), which was created by using the

export, page 207

functionality of the Topology Explorer .

You can import this data into an existing system by using the Import command of the Topology Explorer .

You have the possibility to select which items you want to import out of those contained in the export file.

Before proceeding with the import, the software verifies if importing the selected instances creates a duplicate entity identifier or an IP address conflict. If required, the import operation includes a second step, which allows you to resolve conflicts by selecting an action to perform during import:

• Skip the entity; it is not imported.

• Update the entity of the target system with the configuration of the export file.

• Create the entity with a different, unique identifier.

The notification panel displays information on both the tasks that completed successfully and those that could not be completed.

Applicable import rules are described in this topic. Examples are given to illustrate

NOTE: You cannot proceed with the import of an entity if in the target system one of its dependencies is locked by another operation or user. For example, if in the target system the Hardware Mapping Editor is open, you cannot import into the topology of this system entities that are linked to the Ethernet network because it is locked by the hardware mapping process. However, you could import a station node that has no physical connection.

Importing M580 Safety Controllers

For specific information about importing M580 safety controllers, refer to the topic describing how to

engineer systems with M580 safety controllers, page 590

Software Version Compatibility

EIO0000001114.15

411

managing Global Templates, page 675

Topological Templates

The export file does not contain the topological templates of the exported entities and devices. If you are importing entities in a different EcoStruxure Process

Expert infrastructure and the required template for an entity is not present, then the entity is skipped during import.

Information on the required templates and template version is indicated in the

Import window.

When the import is finished, the notification panel displays information on the entities that were not imported if applicable.

For information on how to import templates, refer to the topic that describes

Identification of Conflicts

The table indicates the meaning of the color coding that the software uses to indicate the status of entities and folders in the Import

window, page 414

in the context of the target system.

Identification method

Tooltip

Tooltip text Description

Tooltip

IP with yellow dot

Entity already exists

Conflict to be resolved

IP conflict

An entity of the same type with the same name does not exist in the topology of the target system.

If you select if for import, the entity is created.

An entity of the same type with the same name, and with an identical configuration already exists in the topology of the target system. If you select if for import, the entity is created but with a different name to comply with the naming rule of the topology. This rule specifies that identifiers of entities must be unique within a system.

An entity of the same type with the same name already exists in the topology of the target system but the software detected a change, which can, for example, be related to:

• Properties.

• Devices of entities: Properties, position of modules on the rack, configuration, CPU or module type.

• Services of station nodes.

• Physical connections.

If you want to import the entity anyway, you need to select an action for it.

NOTE: Refer to the topic describing

import rules for conflicting entities, page 413 .

At the time of export, the entity that you want to import was connected to an Ethernet network that exists in the target system and its

IP address is already used on this network, page 399 .

In addition, the tooltip text indicates <conflicting IP address in the target system> - <path to the entity in the target system> - <Ethernet network identifier in the target system>.

You can still import the entity but physical connections are impacted. For details, refer to the topic describing

import rules for physical connections, page 413

NOTE: If the entity that has the same IP address in the target system also has the same identifier and is of the same type, the software does not indicate an IP address conflict.

General Import Rule for Non-Conflicting Entities and Folders

Each entity that is contained in the export file and that you have selected for import is created in the topology of the target system if the software does not detect a conflict.

Depending on the import path setting that you select, the software may create folders as needed to recreate the original hierarchy.

If a folder with the same identifier already exists in the target system, its properties

(for example, its description or area) are automatically updated with the configuration of the export file.

412 EIO0000001114.15

import rules for physical connections, page 413

Entity type

Station node

Controller

STB island

PRM PROFIBUS DP

Ethernet network

Import Rules for Conflicting Entities

The table describes the actions that you can perform for various types of entities when the software detects a conflict, depending if you select Update or Create . To be able to perform the changes that are indicated in the table, the export file needs to contain an entity that has the same identifier as an entity of same type in the target system. The imported entity needs to have a configuration that is different from the target entity. Update actions apply to the entity in the target system.

Create action

Creates the entity with a new identifier.

Modbus TCP and

EtherNet/IP I/O device

Creates the entity with a new identifier.

Update action

• Services are updated.

• Properties of the entity and its services are updated.

• Entity is moved if path in export file differs.

• Properties of the entity and its devices are updated.

• Position of modules are updated.

• Modules are added, replaced, and/or removed.

• Entity is moved if path in export file differs.

NOTE: Action not allowed if the controller is not of the same

hardware platform, page

373 .

•

Properties of the entity and its devices are updated.

Position of modules are updated.

Modules are added and/or removed.

Entity is moved if path in export file differs.

Properties are updated.

• Entity is moved if path in export file differs.

• Properties are updated.

• New physical connections are recreated if the entity is also imported and no IP conflict is detected.

• Entity is moved if path in export file differs.

Comments

Removing a service from a station node may affect existing service mappings of related executables.

Moving, adding, replacing, or removing a module of a controller may affect existing service, hardware, and/or communication mappings of the related executables.

This includes:

• Replacing the CPU module of a controller.

• Changing a standalone controller into a redundant one or the other way around.

You can overwrite parameters such as:

• IP address.

• Subnet mask.

• Explicit parameters that are defined in the corresponding templates.

Updating an I/O device may affect existing hardware and/or communication mappings of the related executables.

Existing physical connections in the target system are not maintained.

NOTE: Refer also to the topic describing

Import Rules for Physical Connections

When you import an entity for which a

physical connection, page 399

to an

Ethernet network existed at the time of export and the target system contains no

Ethernet network with the same identifier, the software recreates the physical connection in the target system if the following conditions are true:

• The Ethernet network is included in the export file.

• Both the entity and the Ethernet network are imported successfully with their original identifier (if an entity is created with a new identifier, the physical connection is not recreated).

On the opposite, if an Ethernet network with the same identifier already exists in the target system, the Ethernet network does not need to be contained in the export file and you do not need to select it if it is contained. The physical connection to this Ethernet network is automatically maintained if the IP address of the imported entity is still available on the Ethernet network of the target system.

EIO0000001114.15

413

414

connections to Ethernet networks, page 400 .

NOTE: As a rule, physical connections that exist in the target system prevail.

When you import an entity that is connected to an Ethernet network, if the

Ethernet network in the target system has the same name and the IP address of the entity is

already used, page 412

on this Ethernet network, after import, the entity is not connected to the Ethernet network anymore. The disconnection from the Ethernet network happens whether you create an entity or update an existing one. The IP address of the entity after import is the one contained in the export file.

NOTE: More information on physical connections of redundant controllers is available in the topic describing

Password Management After Importing Topological Entities

After you import into a system a controller and/or a station node for which

password protection, page 373

has been enabled, you need to do the following to be able to deploy a Control Participant project:

• If no password was set, you need to set one.

• If a password was set, you need to enter the password when prompted.

For more information, refer to the topic describing how to manage

passwords for

Control Participant projects, page 488 .

NOTE: The above applies even if you are importing these topological entities into the same system from which they were exported or if you have not logged out of the engineering client since the export was performed.

Accessing the Topology Import Window

To access the topology Import window, proceed as follows.

Step

Action

From the Systems Explorer , right-click the system into which you want to import topological entities and select Open Topology .

Result: The software opens the Topology Explorer .

Right-click the system root folder and select Import .

Result: The software opens the Import dialog box.

Browse to the topology export file (.sbk) that contains information on the topological entities that you want to import and click Open .

Result: The software opens the Import window and displays the contents of the file that you have selected.

Topology Import Window Description

The topology Import window allows you to select the entities that you want to import in the topology of a system and to take appropriate actions in case of

detected conflicts, page 412

EIO0000001114.15

new import window opens, page 416

The following figure shows an example of the Import window displaying the contents of the selected topological export file.

EIO0000001114.15

Item

Description

The check boxes allow you to select the folders and/or entities that you want to import.

Selecting a folder selects any item it contains and the other way around.

By default, items contained in the export file are selected.

NOTE: A check box filled with a black square indicates that at least one item in a sublevel is not selected.

Identifier of the folders and entities contained in the export file ( Name column).

Entities for which the software has detected a conflict are

identified, page 412

In tree view mode, the column also reflects the hierarchy of the items at the time of export. The hierarchy may be different depending on the import path setting.

Type of the entity.

Path column. which indicates the path to the folder or entity.

The column is displayed only in grid view. Refer to item (6).

Description that comes from the properties of the entity or folder contained in the export file.

OK or Resolve button.

Either button is displayed depending on the status of the instances selected for import in the context of the target system:

• OK : The software did not detect duplicate identifier conflicts and selected instances are created in the target system upon clicking the button.

• Resolve : The software detected at least one duplicate identifier conflict for an instance selected for import. Upon clicking the button, a

, which displays only entities for which a conflict was detected. It allows you to resolve identifier conflicts.

The other entities for which no conflict was detected and that you have selected remain selected for import.

NOTE: If Resolve is displayed and you clear the check box of instances for which a conflict has been detected, the button changes to OK , and the other way around.

415

Item

Description

Button to toggle between grid view and tree view.

Import path setting check box:

• Relative Path : Default setting. The folder from which the import command was selected becomes the parent folder of the imported folder structure. The hierarchy of the imported folder structure remains unchanged.

• Absolute Path : When selected, the software maintains the hierarchy that existed at the time of export. The software creates folders as needed to recreate the original hierarchy.

NOTE: The check box is not displayed when you select the import command from the system root folder because in such case, relative and absolute paths are the same.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter .

Resolving Detected Conflicts

The following figure shows an example of the Import window that is displayed when the software has detected conflicts and you click Resolve in the first import window.

416

The table describes the second topology Import window, which opens when you click Resolve .

Item

Description

Identifier of entities that you have selected for import and for which the software has detected an identifier and/or IP address conflict ( Name column).

The type of conflict is

identified, page 412 .

NOTE: Only grid view mode is available in this window.

New name that will be used to create the entity when you select the Create action for the entity ( New Name column). The software automatically changes the identifier of the entity by adding the _n suffix where n is an incremental number starting at 1. This is for not having two entities with the same identifier in the topology after import.

For example, if the original identifier of the instance is Controller_1 , the new identifier is

Controller_1_1 .

Type of the entity.

Description that comes from the properties of the entity or folder contained in the export file.

Buttons that allow you to select an action for individual instances:

• Skip : The instance is not imported.

• Update : Default action. The instance that has the same identifier in the target system is

updated, page 413

with the configuration contained in the export file.

Depending on the type of entity, this update can pertain to descriptions, services,

IP addresses, I/O modules, and so on.

• Create : The instance is created in the target system with the new identifier indicated in the New Name column.

EIO0000001114.15

EIO0000001114.15

Item

Description

Buttons that allow you to select an action for the conflicting instances as a whole.

The actions are the same as when you select the action for instances individually.

NOTE: Clicking on of these buttons overrides the selection you have made for individual instances.

Back . Click to revert to the first import window.

NOTE: If you modify the default selection in this window and click Back to revert to the first import window, when you click Resolve again in the first import window, the changes you had made to the selection are retained. Instances that you may have unselected in the first import window do not appear anymore, and the other way around.

Aborting Import Tasks

After confirming the import by clicking OK in the Import dialog box, the abort icon is displayed in the

. Click the icon to cancel the task. No entities are imported.

Only the user who has selected the command is allowed to abort it.

NOTE: If you are importing only a few entities, the task may complete before you are able to click the icon.

Importing Topological Entities

To import topological entities into an existing system, proceed as follows.

Step

Action

In the Import

window, page 414

, select the entities that you want to import.

If you selected the import command from a folder other than the system root folder, select Absolute Path if

needed, page 414 .

If the software has detected an identifier conflict, click Resolve , otherwise proceed to step 5.

Result: The software opens a new import window, which displays entities for which the software has detected a conflict. The other entities for which no conflict was detected and that you have selected remain selected for import.

NOTE: Click Cancel to close the Import window without importing entities.

Select the action that you want to perform for each conflicting entity.

NOTE: Click Back to revert to the first import window. Your selection is retained when you return to this window by clicking Resolve again.

Click OK .

Result: The software:

• Applies the import rules based on your selection and updates the topology of the target system.

• Displays an import summary in the notification panel.

Examples

This topics gives examples of various import scenarios of an entity into a system, which contains an Ethernet network with the same name as the network in the source system.

The table gives an example of an imported entity that creates an identifier conflict.

The Update action is selected in the second step of the import.

Element

Entity identifier

Services

What is in the target system

StationNode_1

ControlExpert

What is Imported

StationNode_1

Supervision

Result

StationNode_1

Supervision

417

Element

Entity identifier

IP address

Physical connection to network_1

Entity identifier

IP address

Physical connection to network_1

Element

Properties

Folder properties

What is in the target system

What is Imported

Description: Station1 Description: Station2

None Description: Control Room

Result

Description: Station2

Description: Control

Room

The table gives two examples of an imported entity that does not create an identifier conflict. In the second example, the software detects an IP address conflict. In both cases, you can import Entity_2 in one step.

What is Imported Result What is in the target system

Entity_1

IP_1

Not connected

Entity_2

IP 1

Entity_1

IP 1

Connected at time of export Not connected

Entity_2

IP 1

Connected

418

Entity_1

IP 1

Connected

Entity_2 Entity_1

IP 1 IP 1

Connected at time of export Connected

Entity_2

IP 1

Not connected

The table gives two examples of an imported entity that creates an identifier conflict but without an IP address conflict. The action that is selected in the second step of the import is indicated.

What is Imported Result Element What is in the target system

Update action is selected

Entity identifier Entity_1

IP address

Physical connection to network_1

IP 1

Connected

Entity_1

IP 1 or any IP

Not connected at time of export

Entity_1

IP address of export file

Not connected

Entity identifier

IP address

Physical connection to network_1

Not connected

Create action is selected

Entity identifier Entity_1

IP address IP 1

Physical connection to network_1

Entity_1

IP 1 (not used on network_1)

Entity_1

IP_1 or any IP address not used on network_1 of target system

Connected at time of export

Entity_1

IP address of export file

Connected

Entity_1

Any IP address not used on network_1 of target system

Connected at time of export

Entity_1

IP 1

Connected

Entity_1_1

IP address of export file

Not connected

The table gives two examples of an imported entity that creates an IP address conflict. In each example, a different action is selected in the second step of the import.

What is Imported Result Element What is in the target system

Update action is selected

Entity identifier Entity_1 Entity_1 Entity_1

EIO0000001114.15

Element

IP address

What is in the target system

IP 1

Physical connection to network_1

Connected

Create action is selected

Entity identifier Entity_1

IP address

Physical connection to network_1

IP 1

Connected

What is Imported Result

IP address already used on network_1 of target system

Connected at time of export

IP address of export file

Not connected

Entity_1

IP 1

Connected at time of export

Entity_1

IP 1

Connected

Entity_1_1

IP 1

Not connected

EIO0000001114.15

419

Control Project Mapping Stage ..................................................................... 420

What’s in This Chapter

Exporting and Importing Hardware Mappings ................................................ 449

Supervision Project Mapping Stage .............................................................. 457

Overview

This chapter describes how to map the Control and Supervision projects to the topological entities of the system, and to create communication channels, which allow you to use the I/O scanner function of controllers.

The following figure shows the position of the Mapping stage within the system engineering life cycle.

Refer to the

Mapping stage, page 39

for a description of the purpose of this stage.

Control Project Mapping Stage

Overview

This section describes how to use the Project Explorer to map a logical Control

Participant project to one or more topological entities of the system to map the application to hardware channels. It also describes how to create and configure communication channels that allow using the controller I/O scanner function for communication with devices and peer to peer communication.

You must have completed the

Generation stage, page 297

and the

Configuration stage, page 364

of the Control Participant project to proceed with the mapping stage.

concurrent actions, page 52 . In such case, check the

for details.

420 EIO0000001114.15

Service mapping, page 423 : Associates the logical Control Participant

Creating Control Project Executables

Overview

A Control executable allows you to associate to the logical Control Participant project a topological entity acting as

engine, page 364

by mapping the Service .

Based on that, you can further map Hardware (I/O and communication modules) and Communication (communication channels for various communication modules) of this engine.

You can map a logical Control Participant project to several engines of the system.

To do so, create one executable for each engine.

For example, you can map the same logical Control Participant project to both:

• The controller that is in the plant by using executable_A.

• Another controller that is in the laboratory for test purposes by using executable_B.

Executables are associated to an Execution Domain , which serves as a filter for selecting applicable services, for example, to define the boundaries for peer to peer communication or runtime navigation services.

Creating Control Executables

To create a Control executable, proceed as follows.

Step

Action

In the Control Project Browser , right-click the Executables node of the Control project that you want to map and select Create Executable .

Result: A Control executable is created under the Executables node.

Control Executable Actions

The table describes the executable context menu commands.

Command

Manage

Build , page 464

Build All

Generate and

Build , page 299

Description

Opens the Manage window in the work area of the Project Explorer , which lets you perform the following actions:

•

project to an engine of the system.

• View and edit the

properties, page 422

of the executable.

•

Communication mapping, page 424 : Defines the Modbus TCP Ethernet

(I/O scanning) communication channels between a controller and devices and/or other controllers for peer to peer communication.

•

Hardware mapping, page 442

: Lets you map the interfaces of the instances of the application that are assigned to the project to hardware channels of the controller.

Starts an automated process to integrate certain changes in the built Control

Participant project by performing an incremental build.

The command is available once you have done the service mapping.

Starts an automated process to

create, page 464

the built Control Participant project the first time or to recreate it to

integrate certain changes, page 470

that you have made to the Control Participant project or the system topology.

The command is available once you have done the service mapping.

Starts a generation of the Control Participant project followed by a build.

If you have not built the logical Control Participant project yet, the build process that is executed is the same as when you select the Build All command.

If the generation process does not complete successfully, no build is performed and information is displayed in the notification panel.

NOTE: After selecting the command, the abort icon is displayed in the

. Click the icon to cancel the task.

EIO0000001114.15

421

422

Command

Open Built

Project , page

469

Delete

Rename

data backup files, page 224 .

Description

Opens the built Control project in the Control Participant, which allows you to view the program and configuration.

The command is available once you have built the Control Participant project.

Deletes the executable including any associated:

• Service and hardware mappings.

• Communication mappings.

NOTE:

• You cannot delete an executable that you have deployed. The software displays a message to inform you that the command cannot be executed.

• Deleting an executable does not delete

Lets you enter a new

identifier, page 422

for the executable.

Control Executable Properties

To open the properties of the executable, double-click it.

You can view and edit the following properties.

Property

Identifier

Description

The identifier must be unique within a Control Participant project.

Description

Execution

Domain

Optional.

You can enter a description for the executable with free form text.

Optional.

String.

Default value: Blank.

For the following types of communication, you can exchange data only if these executables have the same execution domain:

• For peer to peer communication: The executable of the owner project and the executable of the consumer project.

• For runtime navigation services (see EcoStruxure ™ Process Expert, Runtime

Navigation Services , User Guide ): The executable of the Control Participant project and the executable of the Supervision Participant project.

Values that you enter remain in the menu and you can select those of executables of other Control and Supervision Participant projects.

You can assign a logical execution domain to the executable with free form text.

You can modify the Execution Domain value at any time during the engineering life cycle.

NOTE: Leaving Execution Domain blank is considered as a value.

Build State Indicates the

status, page 469

of the executable.

Built On

Default value: Not Built

Date and time when you last built the executable successfully by using a build command.

Assigning an Execution Domain

To assign an execution domain to a Control executable, proceed as follows.

Step

Action

Double-click the executable to open its properties.

Select a value from the Execution Domain menu or enter a new value.

NOTE: To remove or change the associated execution domain, select the empty row at the top of the menu.

EIO0000001114.15

properties of the PRM, page 389 .

Mapping Services

Overview

The Service Mapping Editor opens within the Manage window when you doubleclick the Control

executable, page 421

. It allows you to associate the logical

Control Participant project to entities acting as

engines, page 364

through its

Control executable.

These engines are controllers and station nodes that exist in the topology of the system.

NOTE: If the Controller Family is not the same for the entity and the Control

project, page 204

that you want to map, you may not be able to map certain hardware I/O interfaces.

Mapping to Other Topological Entities

The software does not display STB islands, PROFIBUS Remote Masters (PRMs),

Modbus TCP, nor EtherNet/IP I/O devices in the Service Mapping Editor . For these topological entities, you need to map to the Control executable the controller that communicates with the entity.

NOTE: For PRMs, verify that the family of the controller is the same as the family that is selected in the

Mapping to a Redundant Controller

The software displays the identifier of the controller entity in the Service Mapping

Editor when you map the Control executable to a redundant controller. The mapping however, is performed with both the primary and the secondary controllers.

Mapping to a Station Node

When you map a Control executable to a station node for simulation purposes, the software displays the station node in the Service Mapping Editor window only if you have

created a ControlExpert service, page 379

in the station node first.

Changing the Service Mapping of Deployed Executables

If you have already deployed the Control executable to an engine of the system, you cannot change nor remove the service mapping of this executable. You need to create a new executable.

Mapping Services

To map the Control executable to an engine, proceed as follows.

EIO0000001114.15

423

connected to an Ethernet network, page 399 , the

Step

Action

Double-click the executable of the Control project that you want to map and select

Manage .

Result: The Service Mapping Editor opens.

Click the Engine menu.

Result: The menu displays the identifiers of compatible entities of the topology of the system.

Select an entity.

Result: The software:

• Maps the Control executable to the selected entity.

• Displays the Hardware Mapping tab at the bottom of the window. If the controller is

Communication Mapping tab appears also.

NOTE: To remove a mapping, in the Service Mapping Editor , right-click an entity and select Unmap .

Mapping Communication

Overview

To open the Communication Mapping Editor , click the Communication

Mapping tab within the Manage

window, page 421

. The tab appears once you have performed the

service mapping, page 423

with a controller that is

connected to an Ethernet network, page 399

It allows you to define the communication channels that are used for communication between the controller that you have configured as client and service mapped and:

• Modbus TCP devices.

• STB islands.

• PRMs.

• Other controllers that are mapped to other logical Control Participant projects for peer to peer communication.

This method uses the I/O scanner service of the controller that is configured as client.

A communication channel is the logical representation, at the platform level, of the

Control Participant I/O scanner row.

During the creation of a communication channel, you can configure its

properties, page 428

For peer to peer communication, the Communication Mapping Editor also allows you to map

network variables, page 435

to communication channels.

The software creates the I/O scanner lines that correspond to the communication channels in the controller acting as client during the

build process, page 464 .

NOTE: For peer to peer communication, proceed with the communication mapping from the executable of the

consumer project, page 350 .

NOTE: The communication mapping feature is not supported for executables that you have mapped to a station node that is emulating a simulator.

Prerequisites

For a description of the prerequisites for communication mapping, refer to the topics that describe the steps to complete:

• Communication with

devices, page 597

•

Peer to peer communication, page 603

424 EIO0000001114.15

Communication Mapping Editor

The following figure shows an example of the Communication Mapping Editor window, which displays two peer to peer communication and one Modbus I/O device communication channels. It also indicates that free memory remains in the server counterpart to create additional peer to peer communication channels and/ or increase the size of existing channels.

Item

Description

Communication Channels pane, which displays the client memory area of the communication module of the controller that you have mapped to the Control executable.

There is one tab for each communication module (including the CPU communication module) that is configured in the controller and whose I/O scanning service is enabled.

Select a tab to display the communication channels that are configured in the memory area of the corresponding communication module of the controller acting as client.

<controller_identifier> (Server) tab, which displays the communication channels that are configured in the memory area of the controller when acting as server (if applicable). The information is displayed in the Server Memory Map pane.

Server Communication Counterparts - Device IO pane, which displays, topological entities such as Modbus TCP devices, PRMs, and STB islands, acting as servers, and with which you can define a communication channel. Click the arrow in the title bar to expand/collapse the pane

Server Communication Counterparts - Peer to Peer pane, which displays other Control projects, their executable, and the mapped controller entity with which you can define a communication channel. Click the arrow button in the title bar to expand/collapse the pane.

NOTE: When the executable of the Control project is mapped to a redundant controller, the Communication Channels pane displays only the client memory area of the communication module of the primary controller.

The figure shows an example of the Server Memory Map pane, which is displayed when you select the <controller_identifier> (Server) tab. It indicates that one peer to peer communication channel exists in the memory area of the client controller when acting as

server, page 430 .

EIO0000001114.15

The table describes the fields of the Communication Channels pane when you select the tab of the client communication module.

Column header

Type

Description

System

Indicates in the Size column, the size of memory that is reserved, and in the

Description column, the corresponding usage.

Free

425

426

is the identifier of the Control Participant project ( owner, page 350 ) that exposes the variables and

Column header Description

Service

Server

Direction

Description

Size

Free

Last

Refer to the description of the Size column.

Device IO

Identifies channels that exist to communicate with Modbus TCP Ethernet devices, PRMs, and STB islands.

Peer to Peer

Identifies channels that exist to exchange data between Control Participant projects through the controllers that are mapped to these projects.

• For I/O device communication channels: element category.

communication element

Where element category is the category of the I/O scanner element, and communication element the name of the I/O scanner element for the I/O device.

• For peer to peer communication: project.executable

Where project

executable the identifier of the executable of this project.

Identifier of the server counterpart using the communication channel:

• The I/O device identifier for I/O device channels.

• The controller identifier for peer to peer communication channels.

Indicates the direction of the communication as Read , Write , or Both .

Displays the value of the parameters Read description and Write description that you can view in the

Channel Properties dialog box, page

428 .

NOTE: For channels of type System indicates the usage of the reserved memory.

For each channel, indicates the memory size that is allocated for reading from the server and writing to the server. It corresponds to the read and/or write size that you enter when you create a communication channel with a server counter part.

You can create communication channels until there is not enough sufficient memory left.

NOTE:

• For channel type Free , indicates the remaining free memory size that you can use to create communication channels. It is calculated based on the memory size that you have configured in the memory heap of the client by using the ClientMemoryLength

parameter, page 373

and on the memory allocation of existing communication channels.

Additional words used by the System (for example, for disabling flags) are also deducted from the memory size.

• For controllers of the M580 platform and NOC communication modules of any controller, the size value for channel type Free is not indicated because it is managed

during build only, page 464

Displays the remaining free memory in words for each existing peer to peer communication channel. The size is indicated separately for read and write channels when they exist. It is calculated based on Size and the size of

variables that you have mapped, page 435

to read and/or write communication channels.

For example, if the read channel size is 100 and you have mapped variables to this channel, which use up 10 words, the displayed value is 89. If you have mapped variables that use less than a word (a variable of BOOL data type), the free size can be indicated in decimals. These correspond to 1/16th of a word. For example, a free memory size indicated as 8.14 (out of 10) corresponds to 8 words and 14/16th of a word (2/16th of a word are used by variables of BOOL data type, which use up 1/16th of a word each).

NOTE: 1 word of each channel is reserved to move the channel address to manage the 32-bit alignment for peer to peer communication across

Modicon Quantum and M340 platforms. This word is deducted from the remaining free memory size.

Displays the value of the parameter Last value that you can select and adjust through the

Channel Properties dialog box, page 428

EIO0000001114.15

Channel Properties dialog box, page 428 .

EIO0000001114.15

Column header

Scan

Timeout

Description

Displays the value of the parameter Scan rate that you can adjust through the

Displays the value of the parameter Timeout that you can adjust through the

Channel Properties dialog box, page 428 .

The table describes the fields of the Server Communication Counterparts -

Device IO pane.

Field

Service

Server

Description

Read Size

Write Size

Description element category.communication element , where element category is the category of the I/O scanner element, and communication element the name of the I/O scanner element for the I/O device.

Identifier of the STB island, PRM, or Modbus TCP device entity, acting as server and with which you can create a communication channel.

Description of the data to be exchanged through the channel.

Number of words that are read from the server.

Number of words that are written to the server.

The table describes the fields of the Server Communication Counterparts -

Peer to Peer pane.

Field

Service

Server

Free

Description project.executable

Where project is the identifier of the Control Participant project (

owner, page

350 ) that exposes the variables and

executable the identifier of the executable of this project.

Identifier of the controller mapped to the owner project described in the Service field, which acts as counterpart, and that is available to create a communication channel.

When no communication channel exists, indicates the number of words that you have configured in the memory heap of the controller acting as server, which is defined in the Server field.

When you create a communication channel, the read and write sizes that you define in the Peer to Peer: Properties dialog box are deducted from this value.

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking a column header and selecting Customize . Certain columns are always shown.

When you hide a column for which a filter is applied, the filter is cleared.

Communication Channel Actions

Right-click a communication channel in the Communication Channels pane to display a context menu with the following commands.

Command Description

Map

Variables

Opens the

Variable Mapping Editor

variables and define the relative position of such variables in the selected communication channel.

, page 435

, which allows you to map network

The command is available only for peer to peer communication channels.

Unmap

Removes the selected communication channel, page 433 .

Properties Opens the Device IO: Properties or Peer to Peer: Properties

dialog box, page 428 ,

which lets you view and/or adjust parameter values of the selected communication channel.

427

428

create a communication channel, page 431

Communication Channel Properties

When you

, the software opens the appropriate dialog box, which allows you to adjust the values of the parameters of the communication channel in the memory heap of the client.

NOTE: You can view and/or adjust the values of certain parameters of existing communication channels.

The following figure shows an example of the Device IO: Properties dialog box that the software opens when you create a channel to communicate with an STB island. The dialog box is also displayed when you right-click the existing communication channel and select Properties .

The following figure shows an example of the Peer to Peer: Properties dialog box that the software opens when you create a peer to peer communication channel. The dialog box is also displayed when you right-click the existing communication channel and select Properties .

EIO0000001114.15

EIO0000001114.15

Parameter

Service

Server

Communication Service

Read description

Read size

Write description

Write size

Last value

Description

Refer to the description of the Service column of the Server Communication

Counterparts - Device IO or Server Communication Counterparts - Peer to

Peer pane.

Refer to the description of the Server column of the Server Communication

Counterparts - Device IO or Server Communication Counterparts - Peer to

Peer pane.

The parameter appears only in the Peer to Peer: Properties dialog box.

Identifier of the communication module device through which data is exchanged.

You can select from the communication modules that exist in the server controller and which are connected to the same Ethernet network as the client controller communication module.

Description for the read channel.

NOTE: For peer to peer communication channels, the default value is blank.

You must enter a description.

Number of words that are allocated to the channel and read from the server counterpart.

The corresponding memory size is reserved in both the client and server memory heap.

NOTE: For peer to peer communication channels:

• Default value: 0

• Maximum value: 125

• You can adjust the value:

◦ The total value of columns Read size and Write size cannot exceed the lowest value indicated in either column Free of the Server

Communication Counterparts pane or column Size (row Free ) of the Communication Channels pane.

◦ You cannot set the size to a value that is lower than the total size of variables that are

to the channel.

◦ You can increase the size as long as there is no overlapping channel in the server memory heap within the new size limit.

Description for the write channel.

NOTE: For peer to peer communication channels, the default value is blank. If you enter a value in the Write size field, you must enter a description.

Number of words that are allocated to the channel and written to the server counterpart.

The corresponding memory size is reserved in both the client and server memory heap.

NOTE: For peer to peer communication channels:

• Default value: 0

• Maximum value: 100

• You can adjust the value:

◦ The total value of columns Read size and Write size cannot exceed the lowest value indicated in either column Free of the Server

Communication Counterparts pane or column Size (row Free ) of the Communication Channels pane.

◦ You cannot set the size to a value that is lower than the total size of variables that are

to the channel.

◦ You can increase the size as long as there is no overlapping channel in the server memory heap within the new size limit.

Value that is retained when a communication interruption occurs.

Select between:

• Reset : Set to 0

• Hold : Last value

Default value: Hold

NOTE: This setting applies to the I/O scanner line created in the Control

Participant project. When communicating with an I/O device modeled by a device template, confirm that the DFB contained in the device template supports the selected setting. If not, the value of variables read from the

429

430

Parameter

Scan rate

Timeout

Description device may not be synchronized with the value sent to the Supervision layer by the DFB.

For information on parameters of DFBs of device templates, refer to the help of the corresponding template library, which documents the Control resources

(services).

The rate at which data is scanned in the channel.

Range: 0...65535 ms

Default value: 60 ms

If you change the default value, verify that the new value is a multiple of the repetitive rate step.

For more information, refer to the Control Participant help.

The maximum interval between responses from the entity for the channel. After this time expires, the communication is considered interrupted, and the last value is retained according to the configuration of the Last value parameter.

Range: 1...65535 ms

Interval: 1 ms

Default value: 1000 ms

NOTE: Verify that the TimeOut value is greater than the ScanRate value.

For more information, refer to the Control Participant help.

Server-Side Communication Channel Properties

Once you have created a peer to peer communication channel in the memory heap of the client, you can view properties of the channel server-side by rightclicking the communication channel and selecting Properties .

To view the communication channel, first

open, page 424

the Communication

Mapping Editor from the owner project.

NOTE: You can open the an identical properties dialog box for the communication channel that exists in the client controller when acting as server by selecting the <controller_identifier> (Server) tab from the client-side communication mapping window, right-clicking the communication channel in the Server Memory Map pane, and selecting Properties .

NOTE: When you modify the properties of a communication channel serverside, and you have already deployed the associated built Control Participant project, you can only apply the change to the engine, using the

Deploy Built

Project , page 514

command, which requires stopping the controller.

The following figure shows an example of the Server Peer to Peer Channel:

Properties dialog box, which indicates properties of the peer to peer communication channel server-side.

EIO0000001114.15

move communication channels serverside, page 434 .

EIO0000001114.15

Parameter

Partner

Client

Description

Direction

Start position

Size

Description project.executable

Where project is the identifier of the Control Participant project (

consumer, page 350

) that receives the variables and executable the identifier of the executable of this project.

Identifier of the controller entity (server) to which the owner project is mapped.

Description for the read or write channel.

Read or Write .

Starting address of the communication channel in the memory heap of the server.

The value is editable, allowing you to

Number of words that are allocated to the communication channel server-side.

Communication Channel Position

Communication channels are contiguous in the memory area of the controller acting as client.

Communication Channel Order

Device I/O communication channels appear in the memory area reserved for this type of communication channel in the order you create them.

When both peer to peer communication channels and device I/O communication channels exist then device I/O communication channels are positioned after peer to peer communication channels.

Restrictions when Creating Communication Channels

For each communication module of a controller acting as client (a tab of the

Communication Channels pane), you cannot create communication channels with several executables that are mapped to the same controller.

For example, if the following executables appear in the Service column of the

Server Communication Counterparts - Peer to Peer pane and both are mapped (service mapping) to controller Controller_1 ( Server column):

• Project_1.Executable_1

• Project_2.Executable_2

Then, for a given client controller communication module, you can create a communication channel only with either one of these executables.

Creating Communication Channels

When you create a communication channel, and you have already deployed the associated built Control Participant project, you can only apply the change to the engine, using the

command, which requires stopping the controller.

NOTE: Following the creation of a peer to peer communication channel, you can view it in the memory heap of the server, in the Server Memory Map pane (<controller_Identifier> (server) tab), by

opening, page 424

the

Communication Mapping Editor from the counterpart owner project.

Creating a peer to peer communication channel in the executable of the consumer project also affects the executable of the counterpart owner project. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

431

432

during build only, page 464

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To create a communication channel between the client and the server counterpart, proceed as follows.

Step

Action

From one of the Server Communication Counterparts panes, drag the server counterpart with which you want to create a communication channel to the

Communication Channels pane.

Result: The corresponding communication channel Properties dialog box opens.

Adjust the values of the communication channel properties as required.

Click OK .

Result: The software:

• Creates a communication channel between the selected server counterpart and the client with the parameter values that you have configured in the corresponding

Properties dialog box.

• Shifts the information of the server counterpart to the respective columns in the

Communication Channels pane.

• Updates values of the Size and Free columns.

NOTE: Click Cancel to close the Properties dialog box without creating the communication channel.

NOTE:

• If there is no sufficient space in the memory of the client or server to accommodate the communication channel, the software displays a notification and you cannot create the channel. Adjust the client or server memory properties of the corresponding controller entity and repeat.

• The validation of sufficient space in the memory of the client is not performed for controllers of the M580 platform and NOC communication modules of any controller because the free memory size is managed

Modifying Communication Channel Properties

You can view modify the values of certain parameters of existing communication channels in the Properties dialog box of the channel.

When you modify the properties of a communication channel, and you have already deployed the associated built Control Participant project, you can only apply the change to the engine, using the

command, which requires stopping the controller.

Modifying peer to peer communication channel properties in the executable of the consumer project also affects the executable of the counterpart owner project. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

EIO0000001114.15

during build only, page 464 .

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To modify properties of an existing communication channel, proceed as follows.

Step

Action

In the Communication Channels pane, right-click the communication channel and select Properties .

Result: The software opens the Properties dialog box.

NOTE: The Properties dialog box does not open if the Variable Mapping Editor

window, page 435

of this communication channel is open.

Adjust the values of the communication channel properties as required.

Click OK .

Result: The software:

• Adjusts the communication channel properties.

• Updates the values that are displayed in the Communication Mapping Editor .

• Displays information on the modification in the notification panel.

NOTE: Click Cancel to close the Properties dialog box without creating the communication channel.

NOTE: If the software is not able to apply your modification, it displays a notification. The validation of sufficient space in the memory of the client is not performed for controllers of the M580 platform and NOC communication modules of any controller because the free memory size is managed

Unmapping Communication Channels

Unmapping a communication channel has the following impacts:

• The memory size allocated to the channel is released in the memory heap of the client and of the server.

• Other channels that exist in the memory heap of the client are realigned to be contiguous.

• Network variables that are

to the deleted channel are unmapped from the client and server communication channels.

• The

build status, page 470

of the Control executable to which the controller is mapped changes to out of date if it is built.

• When you unmap a communication channel and you have already deployed the associated built Control Participant project, you can only apply the change to the engine, using the

command, which requires stopping the controller.

The executables of both the consumer and the counterpart owner Control projects are affected. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

EIO0000001114.15

433

434

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To unmap a communication channel, proceed as follows.

Step

Action

In the Communication Channels pane, right-click the communication channel and select Unmap .

Result: The software opens the Unmap dialog box.

Click OK to confirm.

Result: The software:

• Unmaps the communication channel between the selected server counterpart and the client.

• Displays the server counterpart in the corresponding Server Communication

Counterparts pane.

• Updates values of the Size and Free columns.

NOTE: Click No to close the Unmap dialog box without unmapping the channel.

Moving Communication Channels Server-Side

When you move an existing peer to peer communication channel within the memory heap of the server counterpart:

• You can only enter an odd starting address.

• The starting address has to leave enough free memory area to fit the size of the communication channel; otherwise you cannot move the channel.

When you move a communication channel and you have already deployed the associated built Control Participant project, you can only apply the change to the engine, using the

command, which requires stopping the controller.

Moving a peer to peer communication channel in the executable of the owner project also affects the executable of the consumer counterpart project. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To move a peer to peer communication channel in the memory heap of the server counterpart, proceed as follows.

Step

Action

Open, page 424

the Communication Mapping Editor from the

owner, page 350

project.

Select the <controller_identifier> (Server) tab to display the memory heap of the server.

EIO0000001114.15

Network variables, page 350 : To read data from the server.

Step Action

Result: The software displays the Server Memory Map pane.

Right-click the communication channel that you want to move and select Properties .

Result: The software opens the Server Peer to Peer Channel: Properties dialog box.

Enter a new positive, odd integer value in the Start position field.

Click OK .

Result: If sufficient free memory is available at the specified position, the software:

• Moves the selected communication channel to the new start position.

• Updates values of the Start Position and Size columns in the Server Memory

Map pane of the Communication Mapping Editor .

If not, the software displays a dialog box informing you that it cannot move the communication channel.

NOTE: Click Cancel to close the Server Peer to Peer Channel: Properties dialog box without moving the channel.

Mapping Network Variables

Overview

The Variable Mapping Editor opens when you right-click a peer to peer communication channel in the Communication Mapping

pane, page 425

and select Map Variables .

It allows you to map variables of the consumer project to peer to peer communication channels that exist in the memory heap of the client:

•

• Variables, which are the counterpart to network variables that exist in the owner project: To write data to the server.

You can assign a position manually or let the software manage positions.

The software indicates if variables are already mapped to another channel and lets you open the Variable Mapping Editor of this channel.

NOTE: You can work simultaneously on different communication channels.

The variable mappings that are performed on a channel and that affect other channels are reflected right away on these channels.

NOTE: The first time you open the Variable Mapping Editor and the first time you open it after refining the project, it may take time before the window appears.

Prerequisites

To proceed with the variable mapping, first

create a peer to peer communication channel, page 424

EIO0000001114.15

435

position variables automatically, page 438

Variable Mapping Editor

The following figure shows an example of the Variable Mapping Editor .

436

Item

Description

Information bar, which displays scan rate and timeout properties of the selected communication channel, as well as the check box to

Pane that displays the network variables that the client reads from its server counterpart, and that are mapped to the selected communication channel. In this example, network variable Var_3 , which is created in the consumer project is mapped to the communication channel that exists in the client controller.

Pane that displays the network variables that exist in the consumer project and that you can map to the communication channel that is created in the client controller. In this example, network variable Var_2 has already been mapped by opening the

Variable Mapping Editor from the owner project and using its counterpart variable to

write to the server, page 350 . You cannot map it again. You can view its mapping

information by right-clicking Mapped .

Pane that displays the variables that the client writes to its server counterpart, and that are mapped to the selected communication channel. In this example, no variables are mapped.

Pane that displays the variables that exist in the consumer project for which a corresponding network variable exists in the owner project and that you can map to the communication channel. In this example, Var_1 exists as network variable in the owner project and here you can map its counterpart variable to the channel that exists in the client controller to

write to the server, page 350 .

The table describes the fields of the Network Variables and Variables panes.

Column header

Identifier

Type

Size

Description

Identifier of the variable.

Data type of the variable.

If the software detects inconsistencies in the type, the variable is shown in red color and a tooltip provides additional information.

NOTE: When peer to peer communication with the topological entity acting as client is implemented by using an M580 CPU or a NOC communication module, only variables of the

reference type (REF_TO) are shown, page 354 .

Size of the variable in words.

NOTE: For variables of a size of less than 1 word, the size is displayed in corresponding fractions of words (for example, for data type BOOL, the size is displayed in 1/16th of words).

Displays the contents of the Comment property of the Control Participant of the variable in the consumer project.

EIO0000001114.15

32-bit alignment, page 468

EIO0000001114.15

Column header

Status

Description

Map

Description

Indicates the mapping status of the variable.

Possible values:

• Free : The variable is not yet mapped to a communication channel.

• Mapped : The variable is already mapped to another communication channel of the Control executable.

Click the filter icon in the column header to select the statuses that you want to see.

NOTE: You can open the Variable Mapping Editor of the communication channel to which a variable with status Mapped is mapped by right-clicking the variable and selecting Go To Variable Mapping Editor .

For variables that are mapped to another communication channel, displays the content of the Read description or Write description field of this channel; otherwise the field is empty.

The table describes the fields of the Read from Server and Write to Server panes.

Column header

Description

Pane title bar For the Read from Server pane, displays:

• The contents of the field Read description .

• The read size (in words) of the selected channel in the client memory heap and the remaining words available to map variables.

For the Write to Server pane, displays:

• The contents of the field Write description .

• The write size (in words) of the selected channel in the client memory heap and the remaining words available to map variables.

NOTE: One word of each channel is reserved to move the channel address to manage the

for peer to peer communication across

Modicon Quantum, M580, and M340 platforms.

Position Position of the word to which you have mapped the variable within the memory size that you have allocated to the channel or the next available empty position within a word or of the next word.

The position in the communication channel is the same in the client and in the server.

Identifier

For variables of a size of less than 1 word, positions are displayed using the x.y

format where:

• x represents the word

• y represents the position inside the word

Identifier of the mapped variable or Empty .

Empty : Appears for the next available position to which you can map variables.

Type

Size

Description

Type of the mapped variable, of the remaining space in a word, or Any .

To map variables to the remaining space of a word, the data type of the variables needs to match.

Any : Appears when Identifier is Empty . You can map a variable of any data type to this space.

Indicates either, the size of the mapped variable in words, the size of the remaining space inside a word, or the size of the empty space available for mapping.

NOTE: For mapped variables of a size of less than 1 word, the size is displayed in corresponding fractions of words (for example, for data type

BOOL, the size is displayed in 1/16th of words). The empty space of a word is indicated similarly.

Displays the contents of the Comment property of the Control Participant of the variable in the consumer project.

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking a column header and selecting Customize . Certain columns are always shown.

437

438

When you hide a column for which a filter is applied, the filter is cleared.

Position of Mapped Variables

The Position variables automatically check box lets the software define automatically the position of the variables that you are mapping or moving:

• Selected (default setting): The software automatically maps or moves the variable to the compatible empty position that you have selected.

If you have selected several variables:

◦ If the space in the empty position that you have chosen allows it, variables are mapped or moved contiguously starting from this position.

◦ If there is not sufficient contiguous space in the empty position that you have chosen to map or move all variables but is sufficient for at least one variable, the software opens the Mapping Confirmation dialog box to inform you. You have the following options:

Yes : Maps or moves the variables for which sufficient space is available at the chosen empty position and maps or moves the other ones to the next available position.

No : Maps or moves only the variables for which sufficient space is available at the chosen empty position but does not map or move the other ones. It then opens a dialog box to inform you of which variables it could not map or move. These variables remain in the Network Variables or

Variables section.

Cancel : Cancels the mapping or move operation.

• Cleared: The software opens the Select Memory Position dialog box, which allows you to select any available compatible position to map or move the variable within the read or write size that you have defined for the channel.

If you have selected several variables, the position that you select in the

Select Memory Position dialog box applies to the first variable only. The software then maps or moves the other variables in the contiguous space that is available right after the position hat you have selected. If not sufficient contiguous space is available, it informs you of which variables it was not able to map or move because of insufficient space.

In both cases, the software verifies that the position satisfies the variable mapping rules based on its size. The Mapping Confirmation dialog box opens only if there is empty space in a channel before and after an already mapped variable.

NOTE: You can map 32-bit variables (for example, variables of type REAL or

DWORD) only to odd addresses in the Variable Mapping Editor . The variables are aligned correctly during the

build, page 468

depending on the controller platform.

EIO0000001114.15

Example of Variable Mapping Editor Usage

In this example, network variable Var_1 is already mapped to a peer to peer communication channel and there is one word of free space available before

(position 1) and five words available after (position 3). The Position variables automatically check box is selected.

Var_2 and Var_3 are selected and dragged to be mapped at position 1. Because there is no sufficient space to map both variables but only one of them at position 1, the software displays the Mapping

Confirmation dialog box when you release the mouse button.

If you click Yes , the software maps Var_2 at position 1, which you had selected and Var_3 at position 3, which is the next available space where the variable fits.

If you click No , the software maps only Var_2 at position 1, which is the only variable out of the two selected ones that fits in this position. It then informs you that Var_3 is not mapped by opening a dialog box.

Var_3 remains in the Network

Variables section and is available for mapping.

EIO0000001114.15

Variable Mapping Rules

The software applies the following rules when mapping a variable:

• A variable cannot be mapped to a position overlapping with another mapped variable.

• A variable cannot be mapped if:

439

440

◦ It is split up between two or more positions.

◦ It does not fit entirely inside the communication channel.

Mapping Network Variables

Mapping variables to a peer to peer communication channel affects the executables of both the consumer and the counterpart owner projects. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To map network variables (to read from the server) to a communication channel, proceed as follows.

Step Action

1 In the Communication Mapping Editor , right-click the communication channel to which you want to map variables and select

Map Variables .

Clear the Position variables automatically check box if you want to select the position to map the variable yourself.

In the Network Variables pane, select the variables that you want to map and drag them onto a compatible empty position in the Read from Server pane.

Result

Result: The Variable Mapping Editor opens.

Refer to Position of Mapped Variables for

details, page 438 .

Result: If you have unselected the Map on

Top check box, the software opens the

Select Memory Position dialog box.

Proceed to step 4; otherwise the software:

•

to the available space starting from the position that you have selected and satisfying the mapping rules.

• Displays them in the Read from

Server pane.

• Removes the variable from the

Network Variables pane.

• Informs you if it was not able to map any variable.

In the Select Memory Position dialog box, click the arrow button of the Memory

Position field and select a position to map the variable.

Click OK .

NOTE: Click Cancel to close the

Select a Memory Position dialog box without mapping the variable.

Result: The software:

•

to the selected position.

• Displays them in the Read from

Server pane.

• Removes the variable from the

Network Variables pane.

• Informs you if it was not able to map any variable.

NOTE: Proceed in the same way to map a variable (to write to the server) to the selected communication channel by using the Variables and Write to

Server panes of the Variable Mapping Editor .

EIO0000001114.15

EIO0000001114.15

Changing a Variable Mapping Position

To change the mapping position of a variable, drag it to the new position.

You can select several variables to move them at once.

Moving variables mapped to a peer to peer communication channel affects the executables of both the consumer and the counterpart owner projects. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To change the mapping position of network variables or variables with the Select a Memory Position dialog box selected, proceed as follows.

Step Action

1 Select the variables in the Read from

Server or Write to Server pane and drag them to the new compatible empty position.

Result

Result: The software:

• Unmaps the variables from their current positions, which become available for mapping.

•

to the available space starting from the new position that you have selected and satisfying the mapping rules.

• Informs you if it was not able to map any variable.

To change the mapping position of network variables or variables with the Select a Memory Position dialog box cleared, proceed as follows.

Step Action

1 Select the variables in the Read from

Server or Write to Server pane and drag them to the new compatible empty position.

Result

Result: The software:

• Opens the Select Memory Position dialog box.

In the Select Memory Position dialog box, click the arrow button of the Memory

Position field and select a position to map the variable.

Click OK .

NOTE: Click Cancel to close the

Select a Memory Position dialog box without mapping the variable.

Result: The software:

•

to the selected position.

• Informs you if it was not able to map any variable.

Removing a Variable from a Communication Channel

To remove a mapped variable from the communication channel, unmap it.

Unmapping variables mapped from a peer to peer communication channel affects the executables of both the consumer and the counterpart owner projects. To apply changes, you need to start/stop the controllers to which these executables are deployed in the right order; otherwise incorrect data may be read and/or written.

441

window, page 421 . The tab appears once you have performed the

WARNING

LOSS OF CONTROL

• Deploy the executables to the controllers between which the peer to peer communication channel exists.

• Start/stop controllers in the right order.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

To unmap a network variable or variable, proceed as follows.

Step

Action right-click the variable in the Read from Server or Write to Server pane and select

Unmap .

Result: The software:

• Unmaps the variable from the selected position, which becomes available for mapping.

• Removes the variable from the corresponding Read from Server or Write to

Server pane.

• Displays the variable in the corresponding Network Variables or Variables pane.

NOTE: You can also right-click the variable and press Del .

Deleting or Changing Mapped Variables

A network variable or variable is unmapped from the communication channel if you delete either:

• The network variable itself.

• The corresponding variable in the owner project.

It is also unmapped from the communication channel if you change any of the following parameters of it, in either the owner or the consumer project:

• Name

• Type (ID or version)

• Size

Corresponding information is displayed in the notification panel.

Mapping Hardware

442

Overview

To open the Hardware Mapping Editor , click the Hardware Mapping tab within the Manage

service mapping, page 423

with a controller.

It allows you to map the interfaces of instances of the application to compatible hardware interfaces representing the I/O and communication modules of the entity that you have service mapped to the Control executable of the project.

Application objects that expose mapping interfaces are instances of either:

• HAL templates (for example, $DISignal_UL ).

• Communication port templates (for example, $EMPortM ).

• Hardware application templates (for example, $TesysTE or $TSignCptBmx ).

The mapping interfaces of application objects appear in the Hardware Mapping

Editor once you assign their facets to the Control project; even without generating them. They are updated in the mapping editor when you make changes in the application (for example, rename an instance or disable a service) and/or generate the Control project (for example, after setting a facet to Out Of Date or

Deleted ).

EIO0000001114.15

export and import hardware mappings, page 449

You can map interfaces to modules that are connected:

• Physically (for example, in-rack I/O modules).

Their topological mapping interfaces are updated in the mapping editor when you

save changes, page 375

in the Control Participant Configuration window.

• Logically (for example, Modbus TCP Device I/Os, PRMs, or STB islands).

Their topological mapping interfaces appear in the mapping editor when you

connect, page 399

the device to the same Ethernet network as the controller.

If you have created several executables, proceed with the hardware mapping for each one of them.

To facilitate the management of many mappings, you can

NOTE: The software

marks variables and DFB instances, page 472

that are used for the hardware mapping when you build the logical Control Participant project.

Mapping Modbus TCP Devices, PRMs, and STB Islands

For the following entities communicating with the controller through Modbus TCP implicit messaging (I/O scanning), and that are connected to the same Ethernet network as the controller, you can proceed with the hardware mapping:

• Modbus TCP I/O devices: Even without existing communication channels.

• STB islands and PRMs: Only after you create a

communication channel, page 424 .

NOTE: You need to instantiate the necessary application templates first. For details, refer to the topic describing how to

implement communication, page

597

Mapping Hardware with a Simulator

Hardware mapping is not supported, and not required, for executables that you have mapped to a station node running software emulating a simulator.

Mapping Generic Device Interfaces

When a topological entity uses the $EGenericDeviceHW , $EIPGenericDeviceHW , or $EGenericPBSlave template to model a device, a generic hardware mapping interface is available for this device in the Hardware Mapping Editor . You can use it to map the interface of a project facet to this I/O device. However, because of the generic nature of the interface, the software does not verify if both interfaces are

compatible, page 447

before proceeding with the mapping.

Opening the Hardware Mapping Editor in Read-Only Mode

The editor can open in read-only mode, for example, if the executable is locked by another process such as the configuration of the controller. In this case, hardware mapping creation, modification, and import are not allowed.

EIO0000001114.15

443

display only compatible interfaces, page 445

Hardware Mapping Editor

The following figure shows an example of the Hardware Mapping Editor window.

444

Item

Description

Topological devices pane (left, gray title bar), which displays the interfaces of the controller entity that you have mapped to the executable of the Control project. It also displays interfaces of Modbus TCP/EtherNet/IP device, PRM, and STB island entities that are connected to the same Ethernet network as the controller. A communication mapping for PRM and STB island entities needs to exist.

Project facet pane (right, blue title bar), which displays the mapping interfaces of the facets that you have assigned to the Control project, including interfaces of facets of

Modbus TCP/EtherNet/IP explicit messaging device instances, Modbus serial device instances, and the corresponding communication port instances.

Check box to

that meet the selected filter criteria in both panes. The functionality helps locate compatible interfaces when you have many different ones in either pane. The functionality is enabled by default.

Lets you

export, page 449

to file (.csv) the existing hardware mappings and the interfaces of project facets that have not been mapped yet.

Lets you

import, page 449

valid and compatible hardware mappings that you have created outside the Hardware Mapping Editor and that are contained in a file (.csv).

NOTE: When the executable of the Control project is mapped to a redundant controller, the topological devices pane displays only the hardware interfaces of the primary controller.

Editor section

Topological devices pane

Column header

HWInstance

HWTemplate

HWMapping

Interface

Description

Identifier of the topological device.

Displays:

• Controller devices.

• Modbus TCP and EtherNet/IP devices that are physically connected to the same network as the controller.

• PRM entities and STB island devices after you have completed the communication mapping.

NOTE: The designation of devices is described in the topic showing the

representation of topological entities, page

377 .

Identifier of the template that is used by the topological device.

Identifier of the facet that models the hardware channel followed by the identifier of the facet template.

HWInterfaceType Type of the mapping interface and role.

AppInstance

AppFacet

These columns are blank before you start the mapping process.

The software moves the information contained in the corresponding columns of the project facet pane to these columns when you map the project facet interface.

AppTemplate

AppMapping

Interface

AppInterface-

Type

EIO0000001114.15

Editor section

Project facet pane

Column header

AppInstance

AppFacet

AppTemplate

AppMapping

Interface

AppInterface-

Type

Description

Identifier of the instance that references the facet.

Identifier of the facet that is assigned to the Control project.

Identifier of the template that is used by the instance.

Identifier of the hardware mapping interface that is exposed by the facet.

Type of the mapping interface and role.

The prefix of the type indicates the type of I/O hardware channel:

• DI : Digital input

• DO : Digital output

• AI : Analog input

• AO : Analog output

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking a column header and selecting Customize . Certain columns are always shown.

When you hide a column for which a filter is applied, the filter is cleared.

Displaying Compatible Interfaces

To show only interfaces that are compatible in both panes, proceed as follows.

Step

Action

Verify that the Display only compatible interfaces on filtering

check box, page 444

is selected.

In either pane, click the filter icon of the column that you want to use to filter interfaces.

Result: The

filter menu, page 93

opens.

Enter criteria to be used as filter and click Filter .

Result:

• In the pane in which you have applied the filter, only interfaces that meet the filter criteria are shown.

• In the other pane, a filter is automatically applied to the *InterfaceType column to show only interfaces that are compatible with those that result of the filter that you have applied.

You can apply additional filters in either pane to further refine results.

NOTE:

• When you clear the filter in either pane, a filter is applied to the

*InterfaceType column in the other pane to show only interfaces that are compatible with those displayed in the pane where you have cleared the filter.

• To clear filters in both panes, clear the Display only compatible interfaces on filtering check box.

EIO0000001114.15

445

446

The following example illustrates the use of the automatic filter mechanism to display only compatible interfaces. The figures shows only a partial view of the

Hardware Mapping Editor to simplify the example.

Item

Description

A controller is configured with an analog input, an analog output, and a digital input module. The corresponding interfaces appear in the HWInterfaceType column of the topological devices pane.

Facets of analog input, digital input and digital output templates are assigned to the project and the template identifiers appear in the AppTemplate column of the project facet pane.

In this step, the objective is to show only topological interfaces that are compatible with digital input interfaces to perform the hardware mapping between the two.

Item

Description

Verify that the

check box, page 444

is selected.

The AppTemplate column, a filter was applied to show only interfaces of digital input templates. One interface meets this criteria.

In the topological devices pane, the software has automatically applied a filter to the

HWInterfaceType column to show only interfaces of digital input modules. Interfaces of other modules are not shown anymore. You can map the interface of the project facet to any of these topological input channels.

EIO0000001114.15

In this step, the objective is to show only project facet interfaces that are compatible with the topological interfaces of the modules present in the controller configuration. This can be helpful to verify if any hardware-compatible project facet interfaces have not yet been mapped.

EIO0000001114.15

Item

Description

In the topological devices pane, the filter that the software had automatically applied to the HWInterfaceType column was cleared by the user. The column now shows all the interfaces of the various modules of the controller to which you can map project facet interfaces.

In the project facet pane, the software has cleared the filter of the AppTemplate column.

Instead, it has applied a filter to the AppInterfaceType column to show only interfaces that are compatible with the topological interfaces that are exposed by the configuration. As a result, the interface of the digital output template is not shown anymore because the configuration does not contain a digital output module.

The check box must be selected.

Mapping Hardware

To map facets of the Control project to topological interfaces of an entity, proceed as follows.

Step

Action

In the right-hand project facet pane, locate and select the facets of the Control project that you want to map. Use filters if necessary.

Result: The selected facets are highlighted.

In the left hand, topological device pane, locate the topological interfaces to which you want to map the facets that you have selected in step 1. Use filters if necessary.

Result: The selected instance is highlighted.

NOTE: For the mapping to succeed, the type of the interface that is displayed in both *InterfaceType columns needs to be identical and the interface roles need to be compatible.

For example, interface type $DIChannel with roles HO (Hardware Object) and SO

(Signal Object).

From the project facet pane, drag the selected project facets onto the topological interfaces.

Result: The software shifts the information of the project facets to the respective columns of the topological device pane.

NOTE: If the interfaces do not match, a tooltip opens and they are not mapped.

NOTE: To map an already mapped project facet interface to a different topological device with matching interface, drag the mapped project facet onto another compatible topological device interface.

447

448

Deleting Hardware Mappings

To delete the mapping of one or more already mapped project facet interfaces, proceed as follows.

Step

Action

In the topological device pane, select the rows that correspond to the mappings.

Proceed either way:

• Drag the selection back to the project facet pane.

• Press Del and confirm the command.

• Right-click the selection, click Unmap , and confirm the command.

Result: The selected facet appear again in the project facet pane.

NOTE: To delete all the mappings at once, click inside the topological device pane, press Ctrl + A , and use Del or Unmap .

Mapping Several Project Facet Interfaces Simultaneously

You can drag more than one project facet interface onto the topological device pane at once by using multiple selection. The software maps the project facet interfaces to contiguous topological interfaces in the order they are displayed in the tooltip while dragging them.

The interfaces of each project facet/topological device pair need to match to complete the mapping process.

If there is a missing or incompatible topological interface in between, the first matching interfaces are mapped but not the remaining ones, which appear again in the right-hand project facet pane. A message informs you of the project facet interfaces that could not be mapped.

NOTE: Use the filters to display topological devices in the desired sequence.

Changing the Application and Projects After Mapping

If you make any of the following changes to a facet that you have already mapped by using the Hardware Mapping Editor , the software deletes the mapping and makes the facet available again for mapping:

•

Unassigning, page 293

the facet and generating the project or section.

• Deleting the instance referencing the facet.

• Unselecting the

element, page 135

that corresponds to the facet.

Changing the Topology After Mapping

If you make any of the following changes to topological devices whose interfaces you have already mapped by using the Hardware Mapping Editor , the software may delete the mapping. In such case, it makes the corresponding project facets available again for mapping:

• Deleting the controller entity.

• Changing the CPU module of the controller entity.

• Deleting the I/O device.

• Moving the I/O device.

• Deleting the communication channel with an STB island or a PROFIBUS

PRM Master.

• Updating templates of topological entities.

Changing Hardware Mapping After Deploying

Consider a Control project that contains one or more facets representing signals that need to be mapped to I/O modules.

EIO0000001114.15

deploy the hardware mapping change, page 509 , the new initial value of the variables that correspond

You build and deploy the Control project but without doing these hardware mappings.

If you then do the hardware mapping, build the Control project, and select the

Deploy changes / Undo Online Changes command to

to the mapped signals are deployed.

However, the current value of these variables remains unchanged in the deployed

Control project.

The change becomes effective, either through a cold start of the controller or by replacing the current value of the variables in the animation table by their new initial value.

For example, you deploy a Control project without mapping the facet interface representing the signal quality of an AnalogInput instance to the facet interface representing the analog input module channel of the controller.

If you refine the deployed Control project online, the initial value of the variable assigned to the ComStatus pin of the corresponding DFB is displayed as False because the hardware mapping is not done. Its current value is 0 .

If you proceed with the hardware mapping, build the Control project, and execute the Deploy changes / Undo Online Changes command, the initial value of this variable is changed to True .

However, its current value remains 0 .

NOTE: The same applies when you change an existing hardware mapping after deploying it and deploy it, using the Deploy changes / Undo Online

Changes command.

Exporting and Importing Hardware Mappings

Overview

The functionality lets you manage, in a three-step process, a large number of

hardware mappings, page 442

by:

• Exporting the data that is shown in the Hardware Mapping Editor to commaseparated data format (CSV).

• Editing the file so that it contains the hardware mappings that you want to create or modify.

• Importing the file into the Hardware Mapping Editor of the same or a different Control executable.

Before proceeding with the import, the software validates the data and informs you of invalid entries, which will not be imported.

Exporting Hardware Mapping Data

Overview

In a first step, the export functionality lets you create export files that contain the data of the Hardware Mapping Editor for a given Control executable.

Good Practices

• Before modifying hardware mappings, back up all the existing hardware mappings by exporting them. If needed, it lets you restore the original configuration by importing the file.

• Apply a filter before exporting so that the export file contains only the topological interfaces whose hardware mapping you want to create or modify.

EIO0000001114.15

449

comma-separated, page 175

Export File Compatibility

Hardware mapping export files are forward compatible unless mentioned otherwise.

Export File Description

When you export hardware mapping data, two export files are created. Each one contains data in a

format (CSV).

By default, export files are saved at the path %ProgramData%\Schneider Electric

\Process Expert x\Db, where x represents the software version. When this location does not exist (for example, if only clients are installed on the computer), files are saved at either location:

• At the path where you have last exported or imported any file of EcoStruxure

Process Expert.

• If the above does not apply or is not reachable, in the Windows ® Documents folder.

Default file name

<Executable identifier>_HWMapping where

_HWMapping is appended to the file name that you enter once the file is created.

<Executable identifier>_Pending where

_Pending is appended to the file name that you enter once the file is created.

Description

The file contains the same data as shown in the

topological devices pane, page 444

of the Hardware Mapping Editor at the time of export.

It is a snapshot of:

• The mapping interfaces of the topological entity that is mapped to the Control executable (columns A to D (1) ).

• The mapping interfaces of application objects that are already mapped (columns

E to I (1) ).

If you have applied a

filter, page 445

before exporting, only the filtered data is exported.

The first row contains the column headers of the editor.

You need to

edit the content, page 451

of this file to create, modify, or delete hardware mappings.

This supporting file contains the same data as shown in the

project facet pane, page

444

of the Hardware Mapping Editor at the time of export.

It is a snapshot of the mapping interfaces of application objects that are available for mapping.

If you have applied a

filter, page 445

before exporting, only the filtered data is exported.

The first row contains the column headers of the pane in the editor.

You can use this file to perform cut-and-paste operations to move to the <Executable identifier>_HWMapping.csv file the data that corresponds to hardware mappings that you want to create.

(1) When you open the file by using Microsoft ® Excel ®

Example of Export Files

The following figure shows an example of the Hardware Mapping Editor where:

• In the topological devices pane, four interfaces of digital input project facets are mapped to the corresponding hardware channel interfaces.

• In the project facet pane, four interfaces of analog output project facets are shown as available for hardware mapping.

450 EIO0000001114.15

export button, page 444 .

The following figure shows the content of the exported hardware mapping data file

( *_HWMapping.csv

) that corresponds to the previous example.

And the following figure shows the content of the supporting file ( *_Pending.csv

Exporting Hardware Mapping Data

To export the data shown in the Hardware Mapping Editor , proceed as follows.

Step Action

1 In the Hardware Mapping Editor

filters, page 93 .

, select the data that you want to export by using the

2 Click the

Result : The Save As dialog box opens.

3 Enter a file name, select a location, and click Save .

Result : The two export files are created.

NOTE: The export files do not contain the Control project and the system identifiers. If required, include this information in the file name.

Editing the Hardware Mapping Export File

Overview

In this second step, the objective is to edit the exported hardware mapping data file ( *_HWMapping.csv

) so that it contains the hardware mappings that you want to create or modify for a Control executable.

You can use the supporting file ( *_Pending.csv

) which contains the project facet interfaces that are available for mapping.

Schneider Electric recommends using a spreadsheet editor to facilitate the editing of data contained in the export files.

EIO0000001114.15

451

452

list separator format, page 175

NOTE: Although you can delete hardware mappings by using the import functionality, you can delete them directly in the Hardware Mapping Editor by using the Unmap

command, page 448

Good Practices

• Before modifying hardware mappings, back up all the existing hardware mappings by exporting them. If needed, it lets you restore the original configuration by importing the file.

• Edit only an up-to-date export file to avoid data conflicts.

• Verify that the

is set to comma on the computer if you are using a spreadsheet editor.

• When you use data from the supporting file to create hardware mappings, cut the data rather than copying it to help avoid mapping the same project facet interface several times.

The other way around, add to the supporting file project facet interfaces that you are unmapping.

Compatibility With Hardware Mapping Files of Earlier Versions

You can use hardware mapping data files (topologyexport.csv and supporting file projectexport.csv) that have been exported by using the system server console of earlier versions of the software if you edit the column headers to match the current format.

The table describes which column headers of the topologyexport.csv file need to be updated and their new value (not case-sensitive).

Column (1) Header

Instance

Template

HW Mapping IF

HW Mapping Type

Instance

Project Facet

Facet Type

HW Interface

I HW Mapping Type

(1) When you open the file by using Microsoft ® Excel ®

Change to

HWInstance

HWTemplate

HWMappingInterface

HWInterfaceType

AppInstance

AppFacet

AppTemplate

AppMappingInterface

AppInterfaceType

Editing the Hardware Mapping Data File

Edit only rows that correspond to topological interfaces whose hardware mapping you want to create, modify, or delete. Refer also to the

examples, page 454

Entries that exist in the Hardware Mapping Editor but not in the hardware mapping data file (for example, because a filter was applied before exporting or because they have been deleted from the file) are not modified.

The tables describe the result of various editing actions in the

hardware mapping data file, page 450

( *_HWMapping.csv

) once you import the file.

Editing to create, modify, and delete hardware mappings :

EIO0000001114.15

Edited data

Rows of columns

E to I (1)

Action

New, compatible (2) project facet interface data is added by cutting and pasting it from the *_Pending.csv

file.

Result after import

The corresponding hardware mapping is created.

The hardware mapping is valid if the values of the two *InterfaceType columns match (same interface type and compatible roles).

The corresponding hardware mapping is modified.

Existing project facet interface data is modified appropriately.

For example:

• By mapping another project facet interface to the topological interface (the data is cut and pasted from the

*_Pending.csv

file).

• By swapping two mapped project facet interfaces.

Existing project facet interface data is deleted.

(1) When you open the file by using Microsoft ® Excel ®

The corresponding hardware mapping is deleted.

Other editing :

Edited data

Rows of columns

A to D (1)

Action

Existing topology interface data is deleted.

Result after import

If columns E to I (1) for the same row:

• Are empty, no impact.

This lets you remove from the file rows that you do not need to work with.

• Contain data, an invalid entry is reported.

You cannot import the file.

The first row

Other rows

Any columns

The first row is deleted.

A header of columns A to E (1) is deleted or modified.

A row is not edited.

An entire row is deleted.

A row containing a string is added.

Enter the string in column A (1) and start with a semi-colon (for example, ;My comment).

An empty row is added.

The order of complete rows is changed.

The topology or project facet interface data (or both) of a row is duplicated.

A column is added in first position (A (1) ) or between columns A to E (1) .

One or more columns are added after the last column (E (1) ).

No impact given the same row is still present in the

Hardware Mapping Editor .

No impact.

NOTE: This lets you remove from the file rows that you do not need to work with.

No impact.

NOTE: This lets you add comments to the file.

No impact.

You cannot import the original hardware mapping nor its copy.

You cannot import the file.

No impact.

NOTE: This lets you add comments at the end of a row.

No impact.

The order of columns A to E (1) is modified.

(1) When you open the file by using Microsoft ® Excel ®

EIO0000001114.15

453

454

Example of Editing to Create Hardware Mappings

The following example shows how to create hardware mappings with two channels of an analog output module by pasting the corresponding project facet interface data of the supporting file (shown outlined) to the hardware mapping data file.

The following figure shows the result in the topological devices pane of the

Hardware Mapping Editor . Also, the corresponding analog output project facet interfaces have been removed from the project facet pane of the editor (not shown).

Example of Editing to Delete Hardware Mappings

Continuing with the previous example, the figure shows how to delete hardware mappings with two channels of a digital input module by deleting the corresponding project facet interface data (shown outlined) from the hardware mapping data file.

NOTE: It is recommended to cut the project facet interface data and paste it in the supporting file to keep track of project facet interfaces that are available for mapping.

The following figure shows the result in the topological devices pane of the

Hardware Mapping Editor . Also, the corresponding project facet interfaces have been added to the project facet pane of the editor (not shown).

EIO0000001114.15

Example of Editing to Modify Hardware Mappings

Continuing with the previous example, the figure shows how to move an existing hardware mapping with the channel of an analog output module ( Ch_02 ) to another channel ( Ch_01 ). This is achieved by moving the corresponding project facet interface data of AnalogOutput_2 to the other topological interface, thus overwriting the original interface data of AnalogOutput_1 .

NOTE: Before overwriting the project facet interface data of AnalogOutput_1 , it is recommended to cut the data and paste it in the supporting file to keep track of project facet interfaces that are available for mapping.

The following figure shows the result in the topological devices pane of the

Hardware Mapping Editor . The interface of AnalogOutput_2 is now mapped to

Ch_01 . The project facet interface of AnalogOutput_1 has been unmapped and added to the project facet pane of the editor (not shown).

Example of Editing to Add Comments to the Export File

The following figure illustrates the various ways to add comments (shown in bold) to the hardware mapping data file ( *_HWMapping.csv

) so that they are not detected as invalid entries. Comments are not imported.

NOTE: The CSV format does not allow saving special formatting.

Importing Hardware Mappings

Overview

In this third step, the data contained in the hardware mapping data file

( *_HWMapping.csv

) is imported into the topological devices pane Hardware

Mapping Editor that is open for the Control executable.

Each row in the hardware mapping data file is compared to the same row in the

Hardware Mapping Editor and if different, triggers an action that corresponds to the

editing, page 452

that you have performed. Rows in the editor that are not present in the hardware mapping data file remain unchanged.

You can import a file into the same or a different system, Control, or executable as long as the prerequisites are fulfilled.

EIO0000001114.15

455

456

service mapping, page 423

Prerequisites

To be able to import hardware mapping data, the following conditions must be fulfilled:

• You must have performed the

for the Control executable.

• Hardware mapping data files that were created by using earlier versions of the software must be

compatible, page 452

• Both the mapping interfaces of the

topological entity and of the application objects, page 450

that are in the hardware mapping data file must exist when you open the Hardware Mapping Editor for the Control executable.

Additional interfaces of both types can appear in the editor and they have no effect on the import.

Invalid Hardware Mapping Log File

When you attempt to import a hardware mapping data file and the software detects invalid mappings, it creates a log file with these mappings.

• The file is located in the folder from where you have imported the hardware mapping data file.

• It has the same name as the imported file but with the _log suffix and .txt file extension.

Thereafter, each time you try to import the same hardware mapping data file

(same file name), invalid mappings that the software detects are added to the log file.

Importing Hardware Mapping Data

To import hardware mapping data in the Hardware Mapping Editor , proceed as follows.

Step Action

1 In the Hardware Mapping Editor , click the

Result : The Open dialog box opens.

import button, page 444 .

Select the file ( *_HWMapping.csv

) that contains the hardware mapping data and click

Open .

Result : The Import Mappings dialog box opens.

Click Yes .

Result : If the hardware mapping data is valid, the corresponding hardware mappings are performed in the Hardware Mapping Editor ; otherwise, if the software detects

invalid hardware mappings, page 452

in the imported file, a dialog box opens, which contains information about the invalid entries. Proceed to step 4.

NOTE: Once the import operation is completed, you can see a summary in the notification pane.

Click:

• Yes to import only the valid data; invalid entries will be skipped.

• No to cancel the entire import operation.

NOTE: If you proceed, you can see a summary in the notification pane once the operation is completed.

If required, correct the invalid entries in the hardware mapping file or make the necessary adjustments in the Control project and import the file again.

EIO0000001114.15

concurrent actions, page 52 . In such case, check the

Supervision Project Mapping Stage

Overview

This section describes how to use the Project Explorer to map the Supervision project of the system.

You must have completed

Generation, page 297

and the

Configuration, page 364

stages of the Supervision project to proceed with the mapping.

for details.

Creating Supervision Project Executables

Overview

The Executables node gives you access to the service and communication mapping functionality of the Supervision Participant project.

As such, it allows you to associate:

• The Supervision infrastructure (I/O, alarm, trend, and/or report servers, and/ or runtime clients) that is defined in the Supervision Participant project to station nodes of the topology representing operation servers and operator stations.

• The I/O device to a controller and its communication module and/or to compatible Modbus TCP devices and their Modbus TCP server service by using the OFSOPC and/or OPCUA communication protocol.

You can create several executables for a Supervision Participant project, associating the Supervision infrastructure to various topological entities, and its I/

O device to various controllers and Modbus TCP devices.

An executable is associated to an Execution Domain , which serves as a filter to select applicable services, for example, to define the boundaries for runtime navigation services.

Creating Executables

To create an executable, proceed as follows.

Step

Action

In the Supervision Project Browser , right-click the Executables node of the project and select Create Executable .

Result: A Supervision executable is created under the Executables node.

Executable Actions

The table describes the executable context menu commands.

EIO0000001114.15

457

458

Service mapping, page 459 : Associates the Supervision servers and

Command

Manage

Build , page 475

Build All

Generate and

Build , page 299

Description

Opens the Manage window in the work area of the Project Explorer , which lets you perform the following actions:

•

clients to one or more station nodes of the system topology.

• View and edit the

properties, page 458

of the executable.

•

Communication mapping, page 460

: Maps the Supervision I/O device to:

◦ A controller and its communication module.

◦ Compatible Modbus TCP devices and their Modbus TCP server service.

Starts an automated process to integrate changes quickly in the built

Supervision Participant project by performing an incremental build. The command applies only for changes that you have made while editing

Supervision pages ( Edit command).

This command becomes available once you have completed the service and communication mapping.

NOTE: If the Supervision Participant project is not built yet, you can use this command in place of Build All indifferently.

Starts an automated process to

create, page 475

the built Supervision

Participant project the first time or to recreate it to

integrate certain changes, page 479

that you have made to the Supervision Participant project.

This command becomes available once you have completed the service and communication mapping.

Starts a generation of the Supervision Participant project followed by a build of the project executable.

If you have not built the executable yet, the build process that is executed is the same as when you select the Build All command.

If the generation process does not complete successfully, no build is performed and information is displayed in the notification panel.

NOTE: After selecting the command, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the task.

Allows you to deploy the built Supervision project to the station nodes that are mapped to the executable.

Deploy Built

Deploy

Download

Delete

Rename

Properties

The command is available only if you have already deployed the built

Supervision project to at least one station node that is mapped to the executable and if the number and type of changes are supported.

Opens the Download Projects tab, which allows you to select Supervision project files individually to save them on the computer, such as:

• The master project (.ctz) with the name ProjectIdentifier_

ExecutableIdentifier , which was created by the last successful build process.

• Included projects (.ctz) that are related to animated graphics assigned to

Supervision pages and those that you have

added manually, page 362 .

• OFS/OPC UA configuration files (.xml).

Deletes the executable including the associated configurations.

NOTE: You cannot delete an executable that you have deployed. The software displays a message to inform you that the command cannot be executed.

Lets you to enter a new identifier for the executable.

Opens the Properties tab in which you can view and edit properties of the executable.

Executable Properties

To open the properties of the executable, double-click it.

You can view and/or edit the following items.

EIO0000001114.15

Supervision service, page 379

Mapping Services

Property Description

Identifier

Description

The identifier must be unique within a Supervision project.

Optional.

You can enter a description for the Executable with free form text.

Execution

Domain

Optional.

String.

Default value: Blank.

You can use runtime navigation services (see EcoStruxure ™ Process Expert,

Runtime Navigation Services , User Guide ) only if the executable of the Control

Participant project and the executable of the Supervision Participant project have the same execution domain value.

You can assign a logical execution domain to the executable with free form text.

Values that you enter remain in the menu and you can select them from executables of other Control and Supervision Participant projects.

You can modify the Execution Domain parameter at any time during the engineering life cycle.

NOTE: Leaving the Execution Domain parameter empty is considered as a value.

Build State Indicates the

status, page 477

of the executable.

Built On

Default value: Not Built

Date and time when you last built the executable successfully by using a build command.

Assigning an Execution Domain

To assign an execution domain to an executable, proceed as follows.

Step

Action

Double-click the executable to open its properties.

Select a value from the Execution Domain menu or enter a new value.

NOTE: To remove or change the associated execution domain, select the empty row at the top of the menu.

Overview

The Service Mapping Editor opens within the Manage window when you doubleclick the Supervision

executable, page 457

The service mapping defines to which station nodes that represent the operation server and operator station computers you

deploy, page 520

the Supervision project.

Before you proceed with the service mapping, create the necessary station nodes in the topology of the system and configure them with the services as needed:

• A

• An OFS

service, page 379

You must map all the services of the Supervision Participant project to station nodes in order to complete the

build stage, page 475

NOTE: Install OPC Factory Server or OPC UA Server Expert on the station node that you map to the IOServer service.

EIO0000001114.15

459

network address, page 238

Mapping Station Nodes Configured with Several NICs

The service mapping does not let you select a specific NIC for each station node.

The IP address of each NIC is created as a

in the

Supervision Participant project and associated to the I/O server.

For details on the behavior when deploying to a station node that is configured with more than one NIC, refer to the topic describing the

target computer setup, page 520

Changing the Service Mapping of Deployed Executables

If you have already deployed a Supervision executable to one or more station nodes of the system, when you change the service mapping of this executable, the software clears the related entry in the Last Deployed On

field, page 524

of the station nodes that you have unmapped. As a result, if you recreate this mapping right away and deploy, it is handled like a first deployment.

NOTE: The service mapping of a station node is unmapped if you delete its

Supervision service. It is unmapped if you delete its OFS

service, page 379

and the station node was mapped to the IOServer service of the Supervision project.

Mapping Services

To map a Supervision server or client to a station node, proceed as follows.

Step

Action

Double-click the executable of the Supervision project that you want to map and select

Manage .

Result: The Service Mapping Editor opens.

Click the Engine menu next to the server or client that you want to map.

Result: The menu displays the identifiers of

compatible station nodes, page 459 .

Select a station node.

Result: The software maps the service to the selected station node.

NOTE: Once you have mapped the I/O server, the Communication Mapping tab is shown at the bottom of the window.

NOTE: To remove a mapping, in the Service Mapping Editor , right-click a service and select Unmap .

Mapping Communication

Overview

To open the Communication Mapping Editor , click the Communication

Mapping tab within the Manage

window, page 457

. The tab appears once you have performed the

selected driver, page 235 .

with an I/O server.

The communication mapping defines from which topological entity I/O devices acquire data during runtime by using the

The editor lets you map the I/O devices of the Supervision project to:

• A controller of the system and its communication modules. This includes modules that embed an OPC UA server.

• Modbus TCP devices that feature the Modbus TCP server service (for example, Altivar drives, power meters, STB islands, or PRMs).

• Modbus serial devices by using a topological Modbus TCP device acting as gateway.

460 EIO0000001114.15

configuration file, page 475 . Exceptions apply.

• A station node acting as an emulated simulator and to which a Control Expert project has been deployed.

For each I/O server that you map, the software creates a protocol-dependent

OFS/OPC UA

NOTE: Changing the

protocol of a tag container, page 264

whose associated

I/O device is already mapped to a topological entity removes the mapping.

Physical Connection Prerequisites

To be able to proceed with the communication mapping, the following need to be

connected to the same Ethernet network, page 399 :

• The NIC of the station node that is mapped to the I/O server in the

service mapping, page 459 .

• The communication modules of the controller entity.

• The Modbus TCP device (if present).

Mapping Modbus Devices

Before you can map a Modbus TCP or Modbus serial device to be able to monitor data directly from the Supervision infrastructure that is defined in the Supervision project, you need to perform some additional steps.

For details, refer to the topic describing how to

monitor Modbus device data directly from Supervision, page 639

Mapping Modules Embedding an OPC UA Server

When Protocol of the tag container that is associated to the I/O device is set to

OPCUA Embedded , Data Server (Address B) is disabled. You can map only one module per I/O device.

When modules embedding the OPC UA server are mounted in both local racks of a redundant configuration, either module can be selected under Data Server

(Address A) .

To map also the module embedding an OPC UA server located in rack B, create a second I/O device

configured as standby, page 232

and associate it to the same tag container.

Mapping Redundant Communication Ports

For controllers and station nodes, you can map up to two communication ports or

NICs to a same I/O device if the following conditions are satisfied:

• The communication ports/NICs belong to the same topological entity.

• They are connected to the same physical network.

• Direct TCP/IP Addressing Mode of the

tag container, page 264

that is associated to the I/O device is set to Unallocated/Allocated Data, PAC

Modicon (/U) .

NOTE: When Protocol of the tag container that is associated to the I/O device is set to OPCUA Embedded , communication port redundancy for the same I/O device is not possible.

EIO0000001114.15

461

462

Ethernet network, page 461

Communication Mapping Tab

The following figure shows an example of the Communication Mapping Editor in which one controller and two Modbus TCP devices are mapped to I/O devices through their communication modules.

Header

IO Device

Topological Entity

Data Server

(Address A)

Data Server

(Address B)

Modbus Unit ID

Description

I/O devices that you have created in the cluster and which is associated to a tag container.

Topological entities that have at least one communication module (data server) connected to the same Ethernet network as the station node to which the I/O server is mapped. These can be controllers, station nodes,

Modbus TCP devices, and generic Modbus TCP device entities acting as gateways for Modbus serial devices.

The selected entity becomes the data source.

NOTE: Restrictions apply when the protocol of the tag container that is associated to the I/O device has the following value:

• OPCUA : Controllers of the Quantum platform are not shown.

• OPCUA Embedded : Only controllers that have a module, which embeds an OPC UA server and that is connected to the

same

are shown.

Communication modules of the selected topological entity that are connected to the same Ethernet network as the station node to which the I/

O server is mapped.

For Modbus I/O device entities, it is the Modbus TCP server service of the topological entity.

The IP address of the module is set as the primary address in the OFS/OPC

UA configuration file.

NOTE: When the protocol of the tag container that is associated to the

I/O device is set to OPCUA Embedded , only modules that embed an

OPC UA server are shown.

Optional. The menu is available only if the topological address A has been mapped.

Communication modules of the selected topological entity that are connected to the same Ethernet network as the station node to which the I/

O server is mapped excluding the one that has been mapped to address A.

The IP address of the module is set as the secondary address in the OFS/

OPC UA configuration file.

NOTE: The menu is disabled in either case:

• The topological entity is a Modbus TCP device.

• Protocol of the tag container that is associated to the I/O device is set to OPCUA Embedded .

• For Modbus TCP devices, it is the ID parameter of the topological entity. The value corresponds to the default value of the template or to the value that you had configured (when available) before selecting the device and its data server. You can change the value for the device. The change is not propagated to the topological entity.

Changing the value in the topological entity is not propagated to devices that are already mapped.

• For Modbus serial devices, if you have already configured an application template of the device (for example, an instance of

$ATV71MB ), enter the ModbusAddress parameter value of the instance. Otherwise, enter the unique serial slave ID of the device.

Valid range: 0 to 255

Refer to the documentation of the device for information on the parameter configuration.

NOTE:

• The software does not verify the uniqueness of entries.

• The parameter is disabled for station nodes and controllers.

EIO0000001114.15

Control Expert service, page 379

Mapping Station Nodes

When you map an I/O device to a station node, you can simulate runtime services.

The software displays the station node in the Communication Mapping Editor only if its NIC is connected to an Ethernet network and if you have

created a

in the station node.

NOTE:

Map, page 463

the Control executable of the corresponding Control

Participant project to the same station node.

Mapping Communication

To map the I/O device to the communication module/card of a topological entity, proceed as follows.

Step

Action

Select the Communication Mapping tab within the Manage window.

Click the Topological Entity menu next to the I/O device you want to map.

Result: The menu displays the identifiers of the compatible entities of the system.

Select an entity.

Click the Data Server (Address A) menu.

Result: The menu displays the identifiers of the available communication modules/ cards of the selected entity.

Select a communication module/card.

If needed, click the Data Server (Address B) menu and select a second communication module/card of the same entity.

NOTE: To remove the entire communication mapping for an I/O device, rightclick a communication module/card in either Data Server column and select

Unmap .

To remove the mapping of one data server only, select Not Assigned from the menu.

EIO0000001114.15

463

Control Project Build Stage .......................................................................... 464

What’s in This Chapter

Supervision Participant Project Build Stage ................................................... 475

Overview

This chapter describes how to create the built Control and Supervision Participant projects, which are the executables and project files that you deploy to controllers and/or station nodes of the system.

The following figure shows the position of the Build stage within the system engineering life cycle.

Refer to the

Build stage, page 40

for a description of the purpose of this stage.

Control Project Build Stage

Overview

This section describes how to use the Project Explorer to create the built Control

Participant project for the first time and, in a second step, to integrate changes that you have made to the Control Participant project and to the topology of the system.

concurrent actions, page 52 . In such case, check the

for details.

Building the Logical Control Participant Project

Overview

In this automated process, the software creates a unique built Control Participant project, which merges:

• The logical Control Participant project information, including changes made during refinement.

464 EIO0000001114.15

sufficient memory is available, page 376 .

EIO0000001114.15

• The mapping information, which is associated to the Control executable of the logical project:

◦ Services

◦ Hardware

◦ Communication (if applicable)

• The topological information, which is associated to the mapped services

The software stores the resulting program file (.stu) in the

content repository, page

704 .

The build process also:

• Creates the necessary DDDT variables with the number of input and output words that you have configured to allocate memory.

• Creates the I/O scanner lines for the communication channels that exist in the communication mapping given that

• Defines the value of REF_TO data types (see EcoStruxure ™

Control Participant Services, User Guide):

Process Expert,

◦ As REF(%MWx) or REF(%CH<@mod>.<c>) (IODDT) for direct addressing data instances (HAL2.0 variables) that are used in hardware mapping.

◦ As REF(DDDT) for variables that are used in communication mapping.

◦ As REF(PES_CONST_TRUE) for variables that need to be initialized as

TRUE .

• Introduces the REF_TO ANY_BOOL data type because of the legacy feature to convert BOOL to EBOOL, and the other way around becoming obsolete. If you have updated existing Schneider Electric HAL templates in systems with

HAL2.0 templates (see EcoStruxure ™ Process Expert, Control Participant

Services, User Guide), both data types are converted to REF_TO ANY_

BOOL.

NOTE: The conversion does not apply to templates created by users except if they reference Schneider Electric HAL templates (for example,

$DISignal_UL ).

To perform a subsequent build or if the Build command has become unavailable, refer to the topic

Changing the Built Control Participant project, page 470

NOTE: You may need to update the firmware version of topological entities to support the ANY_BOOL data type during build. For information on compatible firmware versions, refer to the platform release notes.

Device Type Manager and Device DDT Variables for Modbus

TCP Devices

During build, the software adds a generic Modbus Device device type manager

(DTM) for each Schneider Electric

Ethernet Modbus TCP device, page 391

that you have configured in the topology of the system and which communicates with a controller of the M580 platform or by using a NOC communication module. You do not need to add it.

Modbus TCP devices can be:

• An STB Island

• A PRM

• A Modbus TCP I/O device

The DTM name is composed of four elements. It has the following syntax.

Where:

• <I/O device name> is the identifier of the

topological entity, page 364 . The

identifier is truncated not to exceed 10 characters.

465

466

created a device DDT variable, page 343

• <Counter> is an incremental 1 or 2-digit number generated by the software so that truncated device names are unique.

• <Client communication module> is the commercial reference of the communication module of the client controller that is used to communicate with the device. The reference is truncated to not exceed 12 characters.

• <Position> is the position of the communication module on the rack.

For example, EATV71HW_11_BMENOC030122 ( 1 in 11th position from the left is the counter and 2 in last position is the position of the module.

EATV71HW_1 is the

I/O device name. BMENOC03012 is the commercial reference of the communication module).

The Control Participant creates the corresponding DDDT variable.

Device Type Manager and Device DDT Variables for Peer to

Peer Communication

During build, the software adds a generic Modbus Device device type manager

(DTM) in the consumer (client) Control project for each communication module of a server counterpart with which a peer to peer communication channel exists. The

DTM is added if the controller acting as client is of the M580 platform or if communication client-side is implemented by using a NOC communication module.

The DTM name is composed of four elements. It has the following syntax.

Where:

• <Server entity> is the

identifier, page 373

of the topological entity acting as

server, page 425

. The identifier is truncated to not exceed 10 characters.

• <Counter> is an incremental 1 or 2-digit number generated by the software so that truncated server entity names are unique.

• <Server communication module> is the commercial reference of the communication module of the controller acting as server. The reference is truncated to not exceed 12 characters.

• <Position> is the position of the communication module on the rack.

For example, Controller1_140NOE771012 ( 1 in 11th position from the left is the counter and 2 in last position is the position of the module.

Controller_1 is the server entity name, which has been truncated. 140NOE77101 is the commercial reference of the communication module server side).

The Control Participant creates the corresponding DDDT variable.

Device DDT Variables Created in the Logical Control Project

If you have

in the logical Control project and this variable does not exist in the controller that is mapped to the executable

(for example, because you have removed the module to which it is associated), the resulting built Control project contains it in unmapped (unlocked) state.

If a device DDT variable with the same name exists in both the logical Control project and the controller that is mapped to the executable but with a different data type or type version, the resulting built Control project contains the variable of either type based on the following rule.

DDDT variable in the controller

Mapped

Unmapped

DDDT variable in the logical Control project

Unmapped

Result in the built Control project

Unmapped

Variable of the same type as in the controller mapped to the executable.

Variable of the same type as in the logical

Control project.

EIO0000001114.15

exceptions apply, page 300 .

EIO0000001114.15

Validity Indicators

If a

validity icon, page 252

is displayed, you may not be able to build the project successfully. Some

In such case,

Refine the Control Participant project, page 336

to fix the issue.The

Control Participant features tools that help you identify validity issues.

When you save the Control Participant project after

refining, page 339

it and

project analysis is enabled, page 205 , the project is analyzed. The status of the

Control project is indicated by a validity icon.

Building the Control Project for the First Time

Use the Build or Build All command indifferently to create the built Control

Participant project for the first time.

NOTE: If you have not built the Control Participant project yet, you can also use the Generate and Build command. For information on the generation process, refer to the topic describing the

generation of Participant projects, page 297

Control Participant Project Settings

When you build a logical Control Participant project by using the Build All command, the software may override some project settings (see EcoStruxure ™

Process Expert, Control Participant Services, User Guide) that you have set during configuration.

To view the Project Settings of the built Control Participant project, use the

Open

Built Project command, page 469 .

NOTE: This applies also when you are using the Generate and Build command to build a Participant project executable for the first time.

Allocation of Memory in I/O Scanner Lines

The build process allocates the memory in the following order: First write, then read.

Read and write addresses are created contiguously for clients of the M580, M340, and Quantum platforms.

The read/write memory allocation varies depending on the platform.

Platform

Quantum

Memory allocation process

M340

M580

The write address should be the end of the read address of the previous channel.

However, for example, if 2 channels exist for entity A, and 1 channel exists for entity B, then the memory allocation is the following:

1. Write memory allocation for any existing channels of entity A.

2. Read memory allocation for any existing channels of entity A.

3. Write memory allocation for the channel of entity B.

4. Read memory allocation for the channel of entity B.

NOTE: The first 8 words are allocated for the device control block.

1. Allocates the memory for writing for any existing channels.

2. Allocates the memory for reading for any existing channels.

NOTE: The software detects an error in the configuration during build if you have not configured sufficient memory for a client controller based on the

Quantum platform with NOC communication module (see EcoStruxure ™

Process Expert, Control Participant Services, User Guide).

467

468

Allocation of Peer to Peer Communication Variables

The build process allocates addresses or values to the network variables that you have

consumer project, page 350

to communication channels.

The start address of a variable in the channel needs to be even and contiguous with the channel. Therefore, if the start address of the communication channel created in the client is:

• Odd:

◦ No variable is allocated to the first word of the client communication channel.

◦ Addressing of variables in this channel starts from the second word.

◦ The offset of the server read/write memory counterpart is the first word of the server communication channel.

• Even:

◦ Addressing of variables in this channel starts from the first word.

◦ Read and write size of the memory is equal to the value of the

ServerMemoryLength parameter - 1.

◦ The offset of the server read/write memory counterpart is the second word of the server communication channel.

NOTE: If by using the Refine command, you delete or change the name, type

(ID or version), or size of any variable or network variable that is mapped to a communication channel, the build process cannot complete successfully. The software displays diagnostic information in a dialog box. In such case, open the Variable Mapping Editor to

remove, page 442

the inconsistent variable or undo the changes to the variable. Start the build process over.

The figure shows examples of entries created during build in the

(client based on the M580 platform) for the Value attribute of two sample peer to peer communication variables that are used to read data from the server ( DISignal_UL_1V ) and write data to the server ( Valve_1_VALVE_OPV ).

The figure shows examples of entries created during build in the owner project

(server based on the M580 platform) for the Value attribute of the two counterpart sample peer to peer communication variables.

Aborting Build Tasks

After selecting a build command or confirming it, the abort icon is displayed in the

. Click the icon to cancel the task. No build is performed.

Only the user who has initiated the command is allowed to abort it.

NOTE: If you are building only a small Control Participant project, the task may complete before you are able to click the icon.

Using the Build Commands

To build the Control Participant project, modify the built Participant project through an incremental build, or build it again, proceed as follows.

EIO0000001114.15

Refine the Control Participant project, page 339

EIO0000001114.15

Step

Action

Right-click the executable and select

Build , Build All , or Generate and Build depending on the

situation, page 471

In the confirmation message, click No .

NOTE: Click Yes to proceed with the build anyway; the process may not complete successfully.

to fix the issue.

Start the build process over.

–

Result

If no

validity icon, page 467

is displayed, the software executes the following actions; otherwise it displays a confirmation dialog box. In such case, proceed to step 2.

• Proceeds with the creation or update of the built Control Participant project.

• Stores the program file (.stu) in the content repository.

• Displays information in the notification panel.

• Displays a dialog box containing a summary of the build process.

The confirmation dialog box closes without building the Control Participant project.

NOTE: If the build process does not complete successfully, the software displays a notification to inform you and provides indications about the cause.

In such case, make the necessary corrections and build the project again.

Build Status

The table describes the build status of an

executable, page 422

Status

Not Built

Built

Out Of Date

Description

No built Participant project exists.

Default status when you create an executable.

The built Participant project is up to date.

The built Participant project is out of date and needs to be

built again, page

471

NOTE: You may need to build the Control Participant project again if you have made certain

changes, page 470

to the system even though the software displays the Build State as Built .

Viewing the Built Participant Project

Once you have built the Control Participant project, you can open the project in the

Control Participant to view it.

You may also be able to open the built Control Participant project if the software reports detected errors during the build process to help you with the troubleshooting.

NOTE: Do not make changes to the built Control Participant project from within the Control Participant as the software discards any changes upon closing the reduced Participant window.

To make changes to the system, you can use the following methods:

• Open the system using the corresponding explorer.

•

Refine, page 336

the logical Control project.

To open the built Control Participant project in the Control Participant, proceed as follows.

469

Step

Action

Right-click the Control executable and select Open Built Project .

Result: The Control Participant opens

variable mapping, page 435 (1)

and maximized. You can view the contents of the built executable.

NOTE: For more information, refer to Viewing the Built Control Participant project

(see EcoStruxure ™ Process Expert, Control Participant Services, User Guide).

Close the Control Participant window.

NOTE: To save a copy of the built Control Participant project, use the Save as command of the Content Repository

explorer, page 706

Changing the Built Control Participant Project

Overview

This automated process allows you to change the built Control Participant project by integrating changes that you have made to the Control Participant project, or to the topology of the system.

Depending on the modifications you made, the status of a built Control Participant project changes and you may need to use a specific command to integrate changes.

Changes Modifying the Build Status

The table describes how changes affect the executable of a Control Participant project whose status is Built .

Change

Changes to the topology of the system (for example, properties, controller rack configuration, IP addresses, physical connections, replacing templates of I/O device entities, deleting STB island entities, Ethernet networks entities, safety password, and so on).

Changing the logical Control Participant project and generating it.

Deleting a section in the Project Explorer .

Selecting the Refine command after adding, renaming, or changing the order of sections in the Project Explorer .

Refining the Control Participant project.

Selecting Built Participant Project for an executable when importing a Control

Participant project in the Project Explorer .

It applies in the following cases:

• An executable with the same identifier already exists in the target project and its status is Built .

• You are importing an executable that does not exist yet in the target project and its status was Built at the time of export.

Updating, page 567

the logical Control Participant project.

Changing the service, communication, or hardware mapping of the Control executable.

For communication mapping, in case a peer to peer communication channel exists, changes include creating, modifying, or deleting a

Removing the service mapping.

Deleting a controller or station node that is selected in the service mapping, or deleting the ControlExpert

service, page 379

of such a station node.

Resulting build state

Out Of

Date

Not Built

(1) When a communication channel and variable mappings for peer to peer communication exist between two built Control project executables, making a change affecting the communication channel or variable mapping in one executable, which sets its build status to Out Of Date also changes the build

470 EIO0000001114.15

appropriate command, page

EIO0000001114.15

status of the other executable to Out Of Date . Such change can be, for example, deleting the Control project or its executable, deleting a mapped variable, deleting a section containing a mapped variable, disconnecting a mapped controller entity, and so on.

NOTE: After making a change, which modifies the build status, build the logical Control Participant project again using the

471

Building after Creating, Updating, or Deleting Device DDT

Variables in the Logical Control Project

If you have

created a device DDT variable, page 343

in the logical Control project and this variable does not exist in the built Control project, the updated built

Control project contains it in unmapped (unlocked) state.

The following table describes the result when building changes if a device DDT variable with the same name exists in both the logical and the built Control project but with a different data type or type version.

DDDT variable in the built Control project

Mapped

Unmapped

DDDT variable in the logical Control project

Unmapped

Result in the updated built Control project

Variable of the same type as it was in the built Control project.

Variable of the same type as in the logical

Control project if the type that is updated is not used by a mapped device DDT variable.

The following table describes the result when building changes if a device DDT variable that exists in the built Control project has been deleted from the logical

Control project.

DDDT variable in the built Control project

Mapped

Unmapped

DDDT variable in the logical Control project

Variable is deleted and references to it in code are removed.

Result in the updated built Control project

• The device DDT variable is not removed.

• Code is updated.

• The device DDT variable is removed.

• Code is updated.

Using the Appropriate Command to Integrate Changes

The table indicates which command to use to update the built Control Participant project depending on the change that you have made.

Change

• Adding, deleting, or changing:

◦ Any section (including the order of sections)

◦ Variables (1) (including

device DDT variables, page 343 )

◦ The hardware mapping

•

CCOTF-compatible changes, page 369

in the configuration of a controller (2)

Changing the topology of the system (3) .

Changing the communication or network variable mapping

(3) .

After an import into a Control Participant project (3) .

After regenerating a Control Participant project (3) .

Adding, deleting, or changing:

• Animation tables (4)

Command Action

Build (5) Performs an incremental build.

Build All Performs a complete build.

471

set the build status to Not Built , page 470

Change

• Operator screens (4)

• DDTs or DFBs (4)

Changing the order of FBD or non-FBD sections in the

Control Participant project by using the Refine command (4) .

Moving FBD or non-FBD sections from one task folder to the other (for example, from MAST to FAST) while refining the Control Participant project ( Refine command).

Changes that

Command Action

Build or

Build All

Either command performs a complete build.

(1) To integrate changes to attributes of

variables used in hardware mapping, page 472 , use the

Build All command.

(2) Except changes to the S908 architecture, which require using the Build All command to integrate these changes even if the Build command is available.

(3) Such changes disable the Build command. Except for CCOTF-compatible changes.

(4) Using the Build command after such change does not update the built Control

Participant project.

(5) You can also use the Generate and Build

command, page 299 .

NOTE: When you modify an existing peer to peer communication channel, rebuild the

owner and the consumer, page 350

Control Participant projects.

Performance Considerations

When you have made changes to a built Control Participant project and the appropriate command to update it is Build , in certain cases you may be able to reduce the time required to update the built Participant project by using the Build

All command instead.

This can be the case, for example when you make changes to many sections of a built Control Participant project at once.

Managing Hardware Abstraction Layer (HAL) Variables and DFBs

Overview

The Global Templates library contains HAL application templates, which generate elementary variables representing the value and/or quality of hard-wired signals.

HAL is a mechanism that emulates access to hardware resources to maintain an application device-independent. By using such templates, you can use the elementary variables that they generate although the hardware channels are not yet part of the logical Control Participant project. Data related to the topology is associated to the logical Control project during build.

The following types of templates exist:

• HAL templates generating elementary digital or analog Control Participant variables (for example, signal conditioning templates).

• Special card templates containing DDTs, DFBs, and/or IODDTs, allowing to use the data exchanged with the special in-rack modules (for example,

Modicon M340 high speed counter module device templates).

Facets referenced by these templates are used during the hardware mapping.

For details on these templates, refer to the

of the Schneider Electric libraries for EcoStruxure Process Expert.

472 EIO0000001114.15

Update the logical Control Participant project, page 567

Marking HAL Variables and DFBs

When you build the logical Control Participant project, the software marks the following code that is used in the hardware mapping with the Custom attribute

HAL :

• Elementary variables coming from mapped facets of hardware abstraction layer templates or special card templates.

• DFB instances and IODDTs coming from mapped facets of special card templates and that are added to a section during build.

Limitations can apply when you:

• Refine sections containing marked DFB instances, using the Refine Online command (see EcoStruxure ™ Process Expert, Control Participant Services,

User Guide).

•

with changes made to HAL variables or sections containing marked DFB instances.

NOTE: DFB instances and IODDTs are marked with the attribute HALFB to distinguish them from EDTs.

Properties of HAL Variables

In this example, facets of instance DigitalInput_1 have been assigned to an FBD section and generated. In the hardware mapping, the DigitalInput_1_DINPUT_

DIS facet is mapped to a channel of the digital input module of the controller. The controller entity is based on the M580 CPU. The following figure shows the built

Control Participant project where the software has marked the DigitalInput_1_

DINPUT_DISV variable that is used in the hardware mapping.

EIO0000001114.15

Properties of HAL IODDT Variables and DFBs

In this example, the facet of instance TSignCptBmx_1 (modeling a high speed counter module) has been assigned to an FBD section and generated. In the hardware mapping, the TSignCptBmx_1 facet is mapped to a channel of the high speed counter module of the controller. The following figure shows the built

Control Participant project where the software has added the TSignCptBmx_1

DFB encapsulated in this facet to the section and marked it.

NOTE: The data type and addressing method for variables shown in this example may vary depending on the version of the template generating them.

473

Using the Right Command to Integrate Changes, page 471

The following figure shows the same built Control Participant project where the software has created the corresponding IODDT TSignCptBmx_1_CHANNEL and marked it.

474

NOTE: A TSignCptBmx_2_DATA facet of another high speed counter instance, for the second channel of the counter module, has been assigned to the FBD section and generated. However, the hardware mapping for the second channel has not been done, thus the second DFB instance and the corresponding IODDT have not been added to the section.

Viewing Sections Containing HAL DFBs and Variables

Once you have built the Control Participant project, use the Open Built Project command to view the HAL attribute, allowing you to identify variables and DFB instances that the software has marked.

NOTE: After deployment, you can also view this attribute by using the Refine

Online command.

NOTE:

This attribute is not visible when you refine the logical Control Participant project by using the Refine command.

Changing HAL Variables

To integrate into the built Control Participant project changes that you make to variables that the software marks as HAL , using the Refine command, refer to

EIO0000001114.15

concurrent actions, page 52 . In such case, check the

Supervision Participant Project Build Stage

Overview

This section describes how to use the Project Explorer to create the built

Supervision Participant project for the first time and, in a second step, to integrate changes that you have made to the Supervision Participant project.

content repository, page 703

for details.

Building the Supervision Participant Project

Overview

In this automated process, by using the compilation mechanism of the Supervision

Participant, the software creates a unique built Supervision Participant project, which merges:

• The logical Supervision Participant project information.

• The mapping information, which is associated to the executable of the logical

Participant project:

◦ Services

◦ Communication

• The topology information, which is associated to the mapped services.

The software stores the resulting Supervision project file (.ctz) in the

This is the file that you can deploy to computers running Supervision software.

I/O Device Addresses

When the protocol for a tag container is OPCUA or OPCUA Embedded , the build process replaces the

temporary IP address and port value, page 233

in the address of the I/O device that is associated to the container in order to create the actual I/O device address in the Supervision Participant project.

Protocol for tag container

OPCUA

I/O device address format

OPCUA

Embedded opc.tcp://<IP address>:<TCP listening port>/OPCUAServerExpert

Where:

• <IP address> is the IP address of the

station node, page 381

that is

mapped, page 459

to the IOServer service.

• <TCP listening port> is the value that is configured for TCP Port for this station node.

opc.tcp://<IP address>:<TCP listening port>

Where:

• <IP address> is the IPv4 address (see EcoStruxure ™ Process Expert,

Control Participant Services, User Guide) of the communication module embedding the OPCUA server and that is selected in the

communication mapping, page 460

for the I/O device associated to the tag container.

• <TCP listening port> is the value that is configured for this module in the

Control Participant.

NOTE: For other protocols, refer to the Address

property, page 232

of the I/O device.

EIO0000001114.15

475

476

tag container identifier, page 264 .

OFSOPC and OPC UA Configuration Files

During the build process, the software generates the necessary OPC Factory

Server and OPC UA Server Expert configuration files and stores them in the contents repository.

One configuration file is created for each station node that is

mapped, page 459

to an IOServer service. The name of the configuration file contains a suffix that identifies the protocol that is used.

In case more than one protocol is used in the Supervision project, at least one configuration file per protocol is generated.

Protocol used

OFSOPC

OPCUA

Configuration file name

<Topological entity>_DeviceConfig_

OFSDA.xml

For example,

OPCUA.xml

For example,

OperationServer_

DeviceConfig_OFSDA.xml

<Topological entity>_DeviceConfig_

OperationServer_

DeviceConfig_OPCUA.xml

Configuration file aliases

One device alias exists for each I/O device of the same I/O server.

The alias name is Alias_<I/O device> where <I/O device> is the identifier of the

I/O device that is

mapped, page 460

to the data source.

For example, Alias_IODevice_1 .

One device alias exists for each tag container.

The alias name is the

For example, TagContainer_1 .

NOTE: The User authentication and X509 user token properties are enabled by default.

For details, refer to User

Authentication and Authorization in the help of OPC UA Server Expert.

OPCUA with OPC

UA server

embedded in module of controller, page 264

No configuration file is generated.

Not required.

The OPC UA server is embedded in a module of the controller that is the data source.

The variable tag address has the format ns=2;s=0:<variable name> where ns indicates the namespace and 2 corresponds to the OPC UA server as defined by Schneider Electric.

For example, ns=2;s=0:InputVar1

Where <Topological entity> is the identifier of the station node to which the IOServer service is mapped in the

Control project deployment process, page 484

If you rename the station node, the name of the configuration file is updated without the need to build the Supervision Participant project.

NOTE: For information on how to generate symbol table files (.xvm), refer to the topic describing the

Network Addresses of Supervision Project Components

When you build a Supervision Participant project, and you have not done the

of a server and/or client of the project, the software does not generate an IP address for this component. Because of this, the build process of the Supervision Participant project cannot complete successfully.

Proceed with the service mapping of any Supervision Participant project component that you have created before building the project.

For example, if you have not mapped the alarm server of the project, the network address of the associated topological entity is not generated into the Supervision

Participant project.

EIO0000001114.15

generation of Participant projects, page 297 .

EIO0000001114.15

Building When Instance Identifiers Start with a Digit

When the logical Supervision Participant project that you want to build contains facets referenced by instances whose identifier starts with a digit, you need to set the tagstartdigit parameter of the Supervision Participant configuration file (.ini) to

1 for the build process to complete successfully.

Building the Supervision Project for the First Time

Use the Build or Build All command indifferently to create the built Supervision

Participant project for the first time.

NOTE: If you have not built the Supervision Participant project yet, you can also use the Generate and Build command. For information on the generation process, refer to the topic describing the

Aborting Build Tasks

After selecting a build command, the abort icon is displayed in the

notification panel, page 54 . Click the icon to cancel the task. No build is performed.

Only the user who has initiated the command is allowed to abort it.

NOTE: If you are building only a small Supervision Participant project, the task may complete before you are able to click the icon.

Using the Build Commands

To create the Supervision Participant project, modify it, or to create it again, proceed as follows.

Step Action

1 Right-click the executable and select Build ,

Build All , or Generate and Build depending on the

situation, page 479 .

Result

The software executes the following actions:

• Creates the creation or update of the

Supervision Participant project.

• Stores the project files in the contents repository.

• Displays information in the notification panel.

• Displays a dialog box containing a summary of the build process.

NOTE: Building the Supervision project may take time.

NOTE: If the build process does not complete successfully, the software displays a notification to inform you, and provides indications about the cause.

In such case, make the necessary corrections and build the project again.

Build Status

The table describes the build status of an

executable, page 458

Status

Not Built

Built

Out Of Date

Description

No built Participant project exists.

Default status when you create an Executable .

The built Participant project is up to date.

The built Participant project is out of date and needs to be built again.

477

478

communication board, page 235

NOTE: You may need to build the Supervision Participant project again if you have made certain

changes, page 478

to the system even though the software displays the Build State as up to date.

Changes Modifying the Build Status

The table describes how changes affect the status of the executable of a

Supervision Participant project that is already built.

Change

Renaming an I/O device or the Supervision project.

Generating the project after making changes.

Creating a page.

Changing the project through refinement.

Any import operation in the Project Explorer .

Changing service or communication mapping of the Supervision executable.

Changes to the topology of the system, for example:

• Changing the IP address of the NIC of a station node or of a module that is selected in the service or communication mapping.

• Deleting the ControlExpert or OFS service, or the NIC instance of a station node that is selected in the communication mapping.

• Deleting the Supervision service of a station node that is selected in the service mapping.

• Deleting a controller that is selected in the communication mapping.

• Changing the TCP Port of a station node that is selected in the service mapping for the I/O server when the protocol that is used for at least one tag container is OPCUA.

Removing all service mappings of the Supervision executable.

Deleting a station node that is selected in the service mapping.

Resulting build state

Out Of Date

Not Built

Downloading Supervision Project Files

After the build process completes successfully, the following files are available for download in the Download Projects

window, page 457

• The master project (.ctz) with the name ProjectIdentifier_ExecutableIdentifier

(for example, Supervision_1_Executable_1 ).

The project also contains any

user files, page 360

that are attached to the

Supervision Participant project.

• The included projects (.ctz) that are related to animated graphics, which have been added to Supervision

pages, page 360 .

• Any other included project that you have

added manually, page 362

to the

Supervision Participant project.

• The OFSOPC/OPC UA configuration files (.xml) if you have configured the

driver as OFSOPC or OPCUA .

NOTE: You can download included projects as soon as the software has added them to the Supervision Participant project.

To download a project file, proceed as follows.

EIO0000001114.15

Step

Action

Right-click the executable that you have built and select Download Projects .

Result: The Download Projects window opens and shows the project files associated to the built Supervision Participant project.

Select one file and click Download .

Result: The Save As dialog box opens.

Browse to the location where you want to save the file and click Save .

Changing the Built Supervision Participant Project

Overview

This automated process allows you to change the built Supervision Participant project by integrating changes that you have made to the Supervision Participant project.

For performance considerations, when possible, use the Build command. It requires less time to complete than Build All . However, you can use the Build All command in any case.

NOTE: You can also use the Generate and Build

command, page 299

Using the Right Command to Integrate Changes

The table indicates which command to use to update the built Supervision

Participant project depending on the type of change that you have made.

Change

Changes involving Supervision pages:

• Creating or deleting a page.

• Editing a page ( Edit command):

◦ Adding or deleting one or more genies or graphical elements.

◦ Editing page properties.

• Generating a page that contains a genie facet with the status

Out Of Date or Deleted .

Changes involving Supervision data facets (2) :

• Assigning or unassigning a facet from a tag container.

• Moving an existing facet to another tag container.

• Generating a tag container that contains a facet with the status

Out Of Date or Deleted .

Modifying a parameter of the Message

category, page 135

of a

Supervision element of an instance and generating the corresponding Supervision project (for example, modifying the description of an interlock condition of the InterlockTags element under the Supervision node of an instance).

Command Action

Build (1)(2) Performs an incremental compilation.

No compilation is performed.

EIO0000001114.15

479

Change

Other changes, for example, to:

• Clusters.

• The trend, alarm, report, and/or I/O server.

• Service and communication mappings.

• Advanced project settings.

• Generating or refining the Supervision Participant project

(except when generating only changes that involve a

Supervision data facet as described in this table).

• Topological entities, for example, changing the TCP Port of the

I/O server station node when the OPCUA protocol is used or changing the configuration of a module that embeds an OPC

UA server.

Command Action

Build All (2)

(3)

Performs a complete compilation.

(1) You are limited in the number of changes that you can make per Supervision Participant project to be able to use the Build command:

• A maximum of 5 changes involving Supervision pages.

• A maximum of 30 changes involving data facets.

When you exceed either limit, you must use the Build All command.

(2) You can also use the Generate and Build

command, page 299 .

(3) When you make this type of change, the Build command is not available.

480 EIO0000001114.15

Control Project Deployment Stage ................................................................ 481

What’s in This Chapter

Supervision Project Deployment Stage ......................................................... 520

Overview

This chapter describes how to deploy the built Control and Supervision Participant projects to entities that exist in the topology of the system.

The following figure shows the position of the Deployment stage within the system engineering life cycle.

Refer to

Deployment Stage, page 41

for a description of the purpose of this stage.

Control Project Deployment Stage

Overview

This section describes how to use the Topology Explorer to deploy entire built

Control Participant projects or parts of them to physical controllers or to PCs emulating simulators, which are modeled by engines in the topology of the system.

concurrent actions, page 52 . In such case, check the

built Control Participant project, page 464

for details.

Control Participant Project Deployment Process

Overview

The software allows you to deploy a

to engines by using the following commands:

• Deploy Built Project

• Re-Deploy Last Project

EIO0000001114.15

481

Update the project, page 567 with hardware changes made online (if

• Deploy Changes / Undo Online Changes

Deployment Flowchart

The following figure illustrates the different steps that are part of the deployment process of the built Control Participant project and their associated commands.

482

(1) Or emulated simulator (station node).

Prerequisites

The following table describes the actions that are prerequisite for using a command.

Command

Deploy Built Project

Actions

Build the Control Participant project and configure the corresponding topological entity.

Deploy the built Control Participant project.

Re-Deploy Last

Project

Deploy Changes /

Undo Online

Changes

applicable).

In addition, the following are prerequisite for specific actions:

For Deploy Changes :

• Deploy the built Control Participant project.

• Change the logical Control Participant project and build it.

For Undo Online Changes :

• Deploy the built Control Participant project.

• Change the deployed Control Participant project, using the Refine

Online command.

NOTE: Certain changes

cannot be deployed, page 514

by using the

Deploy Changes command.

For the other actions that are required, for example, mapping the Control executable to a controller, refer to the system engineering life cycle.

Supported Engines for Deployment

The software allows you to deploy/re-deploy a built Control Participant project, and deploy changes to engines representing:

EIO0000001114.15

EIO0000001114.15

• A controller

• A redundant controller of the M580 or Quantum platform.

• A computer running software that emulates a

simulator, page 379

(modeled by a station node in the topology of the system).

Engines need to exist in the topology of the system and be mapped to a Control executable of the project.

Identifying Engines

The software uses the IP address of each engine to identify it on the Ethernet network.

WARNING

UNINTENDED EQUIPMENT OPERATION

Before deploying to a controller, verify that:

• You have assigned a valid IP address to the controller.

• The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: To obtain a list of IP addresses of nodes that are connected to the same physical network and their corresponding physical address (media access control (MAC) address), use the Address Resolution Protocol (ARP).

The procedure describes how to use the ARP to obtain a list of IP addresses of nodes connected to the same physical network and their corresponding physical address (MAC address).

Step Action

1 Write down the MAC address that is printed on the communication module through which you want to deploy or execute.

2 Connect the computer to the Ethernet network to which this communication module is connected and through which you want to deploy or execute.

On the computer, execute the cmd.exe

program.

Result: A command prompt opens.

Type arp -a and press Enter .

Result: The local ARP cache table opens.

In the table, locate the MAC address matching the one printed on the communication module.

In the table, verify that for this address, the corresponding IP address matches the IP address that you have assigned to the engine in the Control Participant; otherwise proceed to step 7.

Assign to the communication module the IP address that you have assigned to the corresponding engine in the Control Participant and repeat the procedure, starting from step 2.

Client/Server Connection

In case of an unexpected stop of the system server, the notification panel of engineering clients that were connected to the system server before the communication interruption may contain information about operations that did not complete successfully because of this interruption. It may also indicate corrective actions.

After an interruption of the client/server connection, the states of both the engineering client and the system server may have become inconsistent if a deployment operation was in progress.

483

client/server connection, page 47

NOTICE

DATA CORRUPTION

After an interruption of the client/server connection, verify that the last operation executed by the software was completed successfully, and if necessary, repeat the last operation.

Failure to follow these instructions can result in equipment damage.

NOTE: For more information on client and server behavior in case of a communication interruption, refer to the topic describing

Start/Stop Commands

The software can send a start or stop command to the controller or software emulating a simulator.

Unintended situations can occur if the operations that are in progress are not known when acting on a controller.

WARNING

UNKNOWN OPERATIONAL STATE OF EQUIPMENT

Before starting or stopping a controller, always positively confirm that there is no critical operation in progress.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Generating Symbol Table Files

You cannot generate symbol table files (.xvm) by selecting the saveXVM property in the project settings of the Control Participant. You need to edit a dedicated configuration file instead before deploying a Control project.

To generate symbol table files (.xvm) of the Control Participant and retrieve them from the content repository, proceed as follows.

Step

Action

Open the ControllerSettings.xml file that is located at the path C:\Program Files

\Schneider Electric\EcoStruxure\Process Expert\System Server on the computer on which the system server is installed.

Set the value for the SaveXVM attribute to 1 and save changes.

Result : When you

deploy changes, page 509

to a Control project or

refine it online, page 548 , the symbol table file is added to the content repository.

In the content repository, open the XvmHolder folder located under Systems

<System name> > Project > Upro .

Save the file, page 706

Deploying to an Emulated Simulator

Overview

You can deploy built Control Participant projects to computers for simulation purposes. In the topology of the software, this computer (engine) is represented by a

station node, page 379

on which a ControlExpert service is installed.

By default, the simulator is configured to start with a password-protected Control project (see EcoStruxure ™ Process Expert, Installation and Configuration Guide)

484 EIO0000001114.15

change the password, page 491

EIO0000001114.15

provided with the software. You can start the simulator with a different passwordprotected project file or

of the project that is loaded by default.

NOTE: If your Windows ® session is not the one that was used to install the software, you need to

configure the simulator manually, page 486

to load a password-protected Control project at startup.

Before Deploying to the Simulator

The table describes the actions you need to perform to be able to proceed with the deployment, depending on the computer on which the emulated simulator is running.

Computer selected for deployment

Computer on which a software component is installed.

(Recommended method)

Other computer on which no software component is installed.

Actions

Start the simulator.

1. Install the simulator.

2. Start the simulator.

Refer to the topic describing how to install the Controller Simulator. (see EcoStruxure ™

Process Expert, Installation and

Configuration Guide)

Starting the Emulated Simulator

EcoStruxure Process Expert supports only deployment to the controller simulator that uses port 502.

To start the simulator provided with the software, proceed as follows.

Step

Action

Double-click the shortcut of the controller simulator on the desktop.

Result: The emulated simulator starts minimized as an icon in the notification area. By default the password-protected Control project (see EcoStruxure ™ Process Expert,

Installation and Configuration Guide) is loaded.

NOTE: If you had installed the simulator manually, double-click the sim.exe

file located in the PLC_Simulator folder.

NOTE: For information on using the simulator, refer to the simulator help, which is located in the PLC_Simulator folder. You can open the help of the simulator also directly from the simulator panel after starting it.

Starting the Simulator With Another Password-Protected

Control Project

You can modify the way the simulator starts and have it load your own passwordprotected Control project file (.sta).

Once you have configured the simulator to start by loading your own Control project, you will need to

provide the password to use it, page 489

To start the simulator by loading a specific password-protected Control project, proceed as follows.

Step

Action

Start the simulator.

Right-click the simulator icon in the Windows ® taskbar and select Options...

Result : The Simulator Panel Options dialog box opens.

Select the Use default application to start simulator (enforce security) check box.

485

486

provide the password to use it, page 489 .

Step

Action

Click the browse button and select your password-protected Control Expert Control project file (.sta).

Click OK .

Result : The simulator stops.

Start the simulator.

Result : The simulator starts by loading the selected Control Expert Control project file.

Starting the Simulator Without Password-Protected Control

Project

You can modify the startup setting and start the simulator without loading a password-protected Control project file (.sta). However, modifying this setting is not recommended because it leaves the Ethernet port of the computer, which is used by the simulator vulnerable to cyber attack.

To start the simulator without loading a password-protected Control project, proceed as follows.

Step

Action

Start the simulator.

Right-click the simulator icon in the Windows ® taskbar and select Options...

Result : The Simulator Panel Options dialog box opens.

Clear the Use default application to start simulator (enforce security) check box.

Click OK .

Result : You do not require to enter a password to use the simulator.

NOTE: When you restart the simulator, it starts without loading a Control project

(no configuration).

Starting the Simulator Under Another Windows

session

Once you have configured the simulator to start by loading a password-protected

Control project, you will need to

To start the simulator by loading the default Control project provided with the software or another one when you are logged on to a Windows ® that is different from the one used to install the software, proceed as follows.

Step

Action

Start the simulator.

Right-click the simulator icon in the Windows ® taskbar and select Options...

Result : The Simulator Panel Options dialog box opens.

Select the Use default application to start simulator (enforce security) check box.

Click the browse button and select the password-protected Control project file (.sta) that you want to use. This is either of the following files:

• Simulatorprofile.sta that is provided with the software and that you have copied to the computer. The file is located in the AFS folder in the root of the installation package of the software.

• Your own Control Expert Control project file.

Click OK .

Result : The simulator stops.

Start the simulator.

Result : The simulator starts by loading the selected Control project file.

EIO0000001114.15

NIC of the station, page 383

Obtaining the IP Address of the Simulator

If you leave 127.0.0.1 as IP address for the

on which the simulator is running, it automatically defaults to the simulator that is installed on the system server. To use the simulator that is installed on a computer on which no system server is installed (for example, an engineering station on which only the engineering client is installed), you need to enter the actual IP address of the local computer on the subnet (host IP address).

To obtain the host IP address used by the emulated simulator software, proceed as follows.

Step

Action

Start the software emulating a simulator provided by the software.

Double-click the simulator icon in the notification area.

Result: The Controller Simulator Panel is displayed.

Read the IP address in the Host IP address field.

Using Deployment Commands With the Simulator

The procedure is similar to using deployment commands with a controller. You need to use the commands that appear in the context menu of the station node that you have mapped to the executable of the Control Participant project.

Refer to the description of commands that are documented in this

section, page

481 .

Communication Between the Computer and Engines

Controllers

To deploy a built Control Participant project, ensure that the computer that is running the virtual machine (VM) can communicate through the Ethernet network with the controller or its communication module, which is modeled by the entity that you want to deploy to.

Depending on the configuration of the software components (see EcoStruxure ™

Process Expert, Installation and Configuration Guide), the computer can be the one on which either software is installed:

• The system server (if the engineering client is using this VM).

• The engineering client (if it is using its local VM).

For more information on connecting controllers to an Ethernet network, refer to the

Control Participant help.

Station Nodes

To deploy a built Control Participant project, ensure that the computer that is running the system server can communicate through the Ethernet network with the computer, which is modeled by the station node that you want to deploy to.

Refreshing Engine Status and Reconnecting Engines

When you use the various deployment and execution commands, a confirmation dialog opens in which you need to select the IP address of the target engine.

The engine needs to be reachable to be able to proceed with the deployment or execution command. Once you have selected the IP address, the status of the engine is indicated in the Status field. If the status of the engine changes while the confirmation dialog box is open, its status is not refreshed.

EIO0000001114.15

487

enabled password protection, page

This can be the case, for example, if the status of the engine is detected as Not

Reachable because a network cable is unplugged. After you reconnect the cable, the status is unchanged. Click the reconnect button to refresh the status of the engine and attempt to establish the connection.

The following figure shows an example of deployment confirmation dialog box featuring the reconnect button.

1 Reconnect button

Managing Passwords of Control Participant Projects

Overview

Using password protection restricts deployment and execution operations for

Control Participant projects that you perform by using an engineering client. It also restricts operations performed by using the operation client.

This topic describes how you can perform the following actions on controllers and the simulator running on a station node:

• Setting a password for the first time.

• Changing a password. This includes changing a password for a controller for which a password was already set by using other applications than the software.

• Clearing a password.

• Resetting the password if you forgot it.

Setting a password is mandatory if you have

107

for topological entities; otherwise, you cannot deploy Control Participant projects.

NOTE: For information on the default password for the simulator (to be entered in the Current Password text box when you want to set a password), refer to the topic describing how to install the controller simulator (see

EcoStruxure ™ Process Expert, Installation and Configuration Guide).

NOTE: Deploying a Control Participant project after setting or changing the password takes slightly longer than deploying with an existing or without password.

488 EIO0000001114.15

safe area password, page 588

EIO0000001114.15

Scope of the Password Protection

The Controller password that you can set by using the commands in the context menu of the topological entity corresponds to the Application password of the

Control Participant. The corresponding settings are disabled in the Control

Participant ( Protection tab of the properties of the project).

NOTE: Other passwords that are managed by the Control Participant are not supported except for the

for M580 safety controllers.

The table describes which Control projects managed by the software benefit of the password protection.

Control Participant project

Logical Control project

Built Control project

Deployed Control project

Password protection applies

Yes

Actions That Require Providing the Password

The table outlines the various actions for which you need to provide a password if password protection is enabled for the controller or simulator running on a station node.

Topological entity

Station node/ simulator only

Controller only

Action

Setting the password.

First deployment.

Subsequent deployment and execution operations.

Setting the password.

Password that is required

The password that is used in the Control project file (.

sta) that is loaded when the simulator starts.

By default, this is the Control project file that is provided with the software (see EcoStruxure ™

Process Expert, Installation and Configuration

Guide).

NOTE: The simulator may have been

configured, page 485

to load another Control project file when starting or the password may have been

changed, page 491 .

You need to set a password first.

No password required as long as you keep the engineering client open.

If you close the engineering client or lock it and another user logs in, the password that you have set is required.

No password is required.

If a password is already set for the controller (for example, by using an application other than the software), the current password is required to be able to set a new one.

NOTE: Setting the password when no Control

Participant project is deployed to the controller requires stopping the controller.

You need to set a password first.

The current password.

First deployment.

Any deployment and execution operation after setting or changing the password.

Subsequent deployment and execution operations.

Navigating to a section by using Runtime Navigation

No password required as long as you keep the engineering client open.

If you close the engineering client or lock it and another user logs in, the current password is required.

The current password.

489

490

Topological entity

Action Password that is required

Controller or station node/ simulator

Services (operation client).

Resetting the password if you have forgotten it.

Changing the password.

Clearing the password.

If you close the operation client or lock it and another user logs in, the current password is required again.

The temporary password provided by Schneider

Electric support.

The password that is currently set.

Using the

Project

Re-Deploy last command.

The password that is currently set.

NOTE: If before redeploying the initial project

(protected with password A), another project that is protected with password B and belonging to a different system has been deployed from a different client to the same engine, during redeployment of the initial project, you need to enter password B. The deployment operation performed from a different system and client has changed the password that had been set during the initial deployment (password A).

The password that is currently set.

Using the Back Up Data command for the first time after deploying a Control project.

Any deployment and execution operations after importing the controller or station node.

Any deployment and execution operations after restoring a system containing the controller or station node.

Any deployment and execution operations after restoring a database containing a system with the controller or station node.

Recovering from a signature mismatch.

The password that is currently set.

If no password is set yet, you need to set one (or, for a station node, provide the password that is used in the Control project file (.sta) that is loaded when the simulator starts).

The password that is currently set.

Disabling the or Simulator

Controller password property when a Control

Participant project was deployed while the setting was enabled.

The password that is currently set.

NOTE: Disabling the password property opens the Disable Password Protection dialog box.

This also clears the password.

Password Requirements

Your password must contain between 8 and 16 alphanumeric characters.

It can contain lower and upper case as well as special characters.

NOTE: Password strength is increased when it contains a mix of upper and lower case, alphabetical, numerical, and special characters.

Managing Application Passwords with Redundant Controllers

The following are the specific password management rules that apply to redundant controllers:

• Both primary and standby engines of the topological entity must be reachable by using the IP addresses that you have configured and the Hot Standby cable link must be present.

• The same application password is set for the Control project of both engines.

Changing or clearing the password also applies to both engines.

EIO0000001114.15

change the password, page 493

• When the ControllerExist

property, page 494

of a redundant controller is set to Primary , passwords are managed the same way as for a standalone controller.

The following describes the operating mode for redundant controllers when a password mismatch occurs:

• If setting, changing, or clearing the password for the Control project of the standby controller did not succeed, you need to synchronize it by using the

Sync (Primary→Standby) command. You can still proceed with the deployment to the primary controller.

• When you are prompted to provide the password for security purposes, the password is compared with that of the Control project in both engines. If the password of the project in the standby engine does not match, you cannot perform the operation on the standby engine.

Setting the Application Password of a Control Project

The following are prerequisites to be able to set the application password for a

Control project:

• You have created a topological entity of type controller or station node.

• The topological entity is configured:

◦ For a controller: You have used the Configure command and saved changes.

◦ For a station node: You have created the ControlExpert service.

• The Controller or Simulator password property of the topological entity is enabled.

• The engine of the topological entity must be reachable by using the IP address that you have configured. In case of the simulator, it must be running.

You can set a password even if you have already deployed a Control project while the password protection for the topological entity was disabled. The password is set for the already deployed Control project without stopping the controller.

NOTE: You can use this functionality also to change the password of the

Control project that is loaded when you start the simulator.

The following figure shows the Manage Password dialog box for the simulator running on a station node.

EIO0000001114.15

1 Check box that lets you also

of the Control project that is loaded when you start the simulator.

To set the application password for a Control project, proceed as follows.

491

492

Step

Action

Right-click the topological entity and select:

• For a controller: Manage Password

For an M580 safety controller, select Controller in the submenu.

• For a station node (simulator): Control > Manage Password

Result: The Manage Password dialog box opens.

Enter the current password in the Current Password text box if

required, page 489

Enter the new password and confirm the new password in the corresponding text boxes.

If you want to use this password also in the Control project that is loaded when the simulator starts, select the check box. It replaces the password that is currently used in this Control project file.

Click OK .

Result: The password is saved and set as application password.

Verifying the Password to Perform Deployment and Execution

Tasks

When you select a command and are prompted to enter the password that is set for a controller or simulator running on a station node, proceed as follows.

Step

Action

In the Verify Password dialog box, enter the required password.

NOTE: Alternatively, you can select the Use last entered password check box. It fills the text box with the last password that you have entered in a Verify Password dialog box during the current engineering client session. The text box becomes read-only.

Click OK .

Result: If the password is correct, the command is executed. If not, an information message is displayed, prompting you to reenter the password. You can enter the password three times before the command is canceled.

NOTE: Click Cancel to cancel the command you had selected.

Changing the Application Password of a Control Project

To be able to change the password, the engine of the topological entity must be reachable by using the IP address that you have configured.

To change the application password for a Control project, proceed as follows.

Step

Action

Right-click the topological entity and select:

• For a controller: Manage Password

For an M580 safety controller, select Controller in the submenu.

• For a station node (simulator): Control > Manage Password

Result: The Manage Password dialog box opens.

Enter the current password in the Current Password text box.

Enter the new password and confirm the new password in the corresponding text boxes.

If you want to use this password also in the Control project that is loaded when the simulator starts, select the

check box, page 491

. It replaces the password that is currently used in this Control project file.

Click OK .

Result: The password is saved and set as application password.

EIO0000001114.15

change the password, page 492

Clearing the Application Password of a Control Project

To be able to clear the application password, the engine of the topological entity must be reachable by using the IP address that you have configured.

NOTE: Clearing the application password does not clear the password of the

Control project that is loaded when the simulator starts.

To clear the application password for a Control project, proceed as follows.

Step

Action

Right-click the topological entity and select:

• For a controller: Clear Password

For an M580 safety controller, select Controller in the submenu.

• For a station node (simulator): Control > Clear Password

Result: The Clear Password dialog box opens.

Enter the current password in the Current Password text box.

Click OK .

Result: The password is cleared.

Resetting a Forgotten Password

To reset the application password of a Control project, proceed as follows.

Step

Action

Right-click the topological entity and select Forgot Password .

For an M580 safety controller, select Controller in the submenu.

Result: The Forgot Password dialog box opens and a number is displayed in the

Authentication Code field.

NOTE: If you close the Forgot Password dialog box and open it again, the same number is displayed.

Contact Schneider Electric

support, page 79

and provide the number.

Result: You receive a temporary password.

NOTE: You can use the temporary password as long as you do not modify the application that is deployed to the controller.

Right-click the topological entity and select Manage Password .

For an M580 safety controller, select Controller in the submenu.

Result: The Manage Password dialog box opens.

Follow the procedure to

and enter the temporary password in the Current Password text box.

Changing the Password of the Control Project Loaded at

Simulator Start-Up

You can change the password of the default Control project file or

your own file, page 485

that is loaded when the simulator starts if the functionality is enabled.

The folder containing the project file must not be write-protected.

The table indicates from where you can change the password of the Control project file depending on the location of the controller simulator.

EIO0000001114.15

493

Configure the simulator, page 485

Computer on which the controller simulator is running

System server computer.

Software component on which you need to perform the password change

Any engineering client.

The IP address of the NIC of the station node in the Topology

Explorer must correspond to the system server computer.

Engineering client computer.

The local engineering client.

Operation client computer.

Other computer on which the controller simulator was installed manually.

1. Copy the project file loaded in the controller simulator to the local engineering client computer (if the project file loaded in both simulators is different; otherwise, proceed to step 3).

on the local engineering client computer to load this project file at start-up.

3. Change the password of the project file by using the local engineering client.

4. Replace the project file on the operation client or the other computer.

To change the password of the Control project file that is loaded when the simulator starts, proceed as follows.

Step

Action

Start the controller simulator or restart it.

Right-click the station node that represents the computer on which the controller simulator is running and select Control > Manage Password .

Result: The Manage Password dialog box opens.

In the Current Password text box, enter the password of the Control project file that is loaded when the simulator starts.

Enter the new password and confirm the new password in the corresponding text boxes.

Select the

check box, page 491 .

Click OK .

Result: The password is changed in Control project file.

Deploying to Redundant Controllers

Overview

This topic describes aspects that are specific to the deployment of Control

Participant projects to redundant controllers, which are modeled in the topology of the system.

The same commands that are used on standalone configurations are also used for redundant controllers.

Detailed information on the commands that are available as part of the deployment stage are described later in the chapter.

For a description of the sequence of actions that Control performs on the engines, refer to the topic describing

main redundant controller scenarios, page 561 .

ControllerExist Property

Verify that the value of the ControllerExist

property, page 373

that is selected in the properties of the redundant controller entity matches the physical configuration of the hardware.

If the software detects a mismatch, you cannot proceed with the deployment.

NOTE: Selecting PrimaryAndStandby for the ControllerExist property requires that both controllers are reachable and connected by a Hot Standby cable link.

NOTE: The value of the property also affects

execution commands, page 531

494 EIO0000001114.15

status of the engine, page 561 ) does not complete successfully, the entire deployment process

EIO0000001114.15

Engine Status for Redundant Controllers

When you select a command for a redundant controller, composed of one primary and one standby engine to which IP addresses IP and IP + 1 are assigned respectively, before proceeding with the deployment, the software opens various dialog boxes, depending on the command that you have selected.

Each of these dialog boxes features the Status field, which informs you of the current state of each of the engine roles (A and B) that the software has detected.

States for M580 platform controllers

Run Primary

Run Standby

Wait

Stop

No conf (non-configured state)

States for Quantum platform controllers

Run Primary

Run Standby

Run Offline

Stop Offline

No conf (non-configured state)

NOTE: If you have selected Primary for the ControllerExist property of the controller entity, the status of the standby engine is not available.

General Deployment Behavior for Redundant Controllers

When you deploy to a redundant controller:

• The software deploys to both the primary and the standby engines unless you have selected Primary for the ControllerExist property of the controller entity. You can view and/or select the IP address for the primary engine ( IP ) and the software automatically selects IP address IP + 1 as the standby engine.

• If you select to start the engines after deployment, both engines are started.

If deployment to the first engine ( IP or IP + 1 , depending on the

is canceled.

If deployment to the second engine ( IP or IP + 1 , depending on the status of the engine) or if synchronization does not complete successfully, logic that was deployed successfully to the first engine is preserved.

NOTE: For controllers of the M580 platform, you cannot perform deployment tasks on the CPU module or a NOC communication module by using IP address A and IP address B . You can only select

Redundant Controller Stop Sequence

When deployment requires to stop the controller and both engines are running, the software stops in the following order:

• The standby engine

• The primary engine

Deploying Changes to Redundant Controllers

If the primary controller is in Running Primary state, and you deploy changes that do not require stopping the controller by using the Deploy Changes / Undo

Online Changes

command, page 509

• The software enables the configuration mismatch feature of the controller so that the standby controller does not enter the offline operating mode when changes are deployed to the primary controller.

• The software deploys to the primary controller first, and upon successful completion of the deployment, automatically synchronizes the standby controller.

495

synchronization of the standby controller, page 563

• Then, the software disables the configuration mismatch feature.

When you deploy changes to a redundant controller, although deployment to the primary controller succeeded, it is possible that

does not complete. If an interruption of the connection to the system server or an unexpected stop of the system server is the cause, the notification panel also contains additional information about steps that you must complete when the connection to the system server is re-established. This is the case, for example, when the software cannot disable the configuration mismatch feature. If this feature is enabled and a switchover occurs, the standby controller operates with a program that does not contain the changes that you have deployed to the primary controller.

WARNING

UNINTENDED EQUIPMENT OPERATION

• Verify that deployment to the standby controller completed successfully.

• Do not operate the primary controller if deployment to the standby controller does not complete successfully.

• Synchronize the standby controller manually, using the Sync

(Primary→Standby) command and verify that the synchronization completed successfully.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: If the primary controller is not in Running Primary state, synchronization of the standby controller cannot complete successfully. In such case,

starting, page 536

the primary engine synchronizes the standby engine.

Deploying the Control Participant Project

Overview

The Topology Explorer allows you to deploy the complete Control Participant project to a controller or station node that is modeled by an engine in the topology of the system by using the following commands:

• Deploy Built Project : Deploys the built Control Participant project to the controller/station node that is

mapped to the corresponding executable, page

423 .

• Re-Deploy Last Project : Deploys the same built Control Participant project that you have deployed to the controller/station node last. This is done by using a mirror of the deployed Participant project, called the last deployed reference, which is stored in the

contents repository, page 703

To deploy or redeploy a built Participant project, the controller or the emulated simulator that you are deploying to must be in Stop state before proceeding. If it is not, the software informs you of it, and stops the engine when you proceed with the deployment.

Also, the software gives you the option to start the controller following the deployment.

Built Participant Project Build Status

The software lets you deploy a built Control Participant project whose executable is either marked as being out of date or that you have not built again after

making changes to the system, page 470

, which affect the built Participant project.

The software displays a message in the confirmation dialog boxes of deployment commands if the

Build State , page 469

of the associated executable is Out Of

Date .

496 EIO0000001114.15

Controller family, page 203

Selecting Participant Project and Control Executable

When you select the Deploy Built Project command for an engine, the software displays the Deploy Built Project dialog box, which allows you to select:

• Project : Any Control project that exists in the system and:

◦ Whose

property has the same value as the engine.

◦ Contains a built or out of date executable that is mapped to the engine.

• Executable : For each project, any Control

executable , page 421

that is

mapped to the engine, page 423 .

NOTE: When you select Deploy Built Project from a station node, you can select any Control project that has a Control executable that is mapped to this station node.

Deploying to a Redundant Controller

For information that applies specifically to the deployment to redundant controllers, refer to the related

topic, page 494 .

Control Participant Project Information

Before proceeding with the deployment or redeployment of a built Participant project, the software displays information in the Confirm Deploy Built Project dialog box about:

• The engine that you are deploying to.

• The built Participant project to be deployed.

• The Participant project deployed last to the engine.

EIO0000001114.15

497

The figure shows an example of the Confirm Deploy Built Project dialog box for a redundant controller.

498

The table describes the information that is displayed in the Engine Information section of the Confirm Deploy Built Project dialog box.

Label

Role (1)

Status

Description

Role of the engine: A or B .

If the software cannot communicate with the engine, the role is indicated as Not Detected .

Status of the engine that is selected for deployment.

If the status is Not Reachable you cannot proceed with the deployment. In such case, verify the IP address, the connection to the engine, and the status of the engine.

NOTE: If the status is Running , a notification is displayed in the dialog box to inform you that the engine will be stopped if you proceed with the deployment.

IP Address Identifier of the communication module through which the software will deploy the built

Participant project and its IP address that is configured in the Topology Explorer .

If the topological entity has several communication modules, you can select which one you want to deploy to.

NOTE: For controllers of the M580 platform, you cannot deploy to the CPU module or a NOC communication module by using IP address A . You can only select

(1) Displayed only when you deploy a built Participant project to a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect

button, page 487

The table describes the information that is displayed in the Project Information section of the Confirm Deploy Built Project dialog box. It also describes the check box.

EIO0000001114.15

Identifying Engines, page 483 .

Name column

System

Project

Executable

Controller

Last Built On

Last Deployed

Last Online

Change

Performed On

Last Sync.

Performed On (1)

Selected Project column

Identifier of the system that both the engine and the

Control project, which you have selected belong to.

Identifier of the Control Participant project that you have selected.

Identifier of the Control executable that you have selected and that contains the built Participant project to be deployed.

Identifier of the topological entity to which you are deploying the built Participant project.

Date and time when you successfully built the Control

Participant project to be deployed.

Not applicable

Last Deployed Project column (2)

Identifier of the system that both the engine and the

Control project, from which you have deployed the

Participant project last belong to.

Identifier of the Control Participant project associated to the executable that you have deployed last.

Identifier of the Control executable that contains the built

Participant project that you have deployed last.

Identifier of the topological entity to which you have deployed the built Participant project last.

Date and time when you successfully built the Control

Participant project that you have deployed last.

Date and time when you last deployed the Participant project to the engine or you last completed the Deploy

Changes / Undo Online Changes command, independently if there were changes to be deployed or not.

Date and time when you last changed the deployed

Participant project by using the Refine Online command; otherwise the field is empty.

Date and time when you last synchronized the standby controller with the primary one by using the Synchronize

(Primary→Standby) command.

Start engine after deployment

Select the option if you want to start the controller or emulated simulator when deployment is complete; otherwise the engine remains in stop state.

NOTE: The software stops the engine before proceeding with the deployment if the engine is not yet in stop state.

(1) Displayed only when you deploy a built Participant project to a redundant controller.

(2) When you deploy to a redundant controller, the dialog box shows separate columns for the primary and the standby engine.

NOTE: When you deploy for the first time to an engine, the fields of the Last

Deployed Project section are empty.

Deploying the Control Participant Project

WARNING

UNINTENDED EQUIPMENT OPERATION

Before deploying to a controller, verify that:

• You have assigned a valid IP address to the controller.

• The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to

WARNING

UNINTENDED EQUIPMENT OPERATION

Before deploying to an engine, verify that you have selected the correct project files.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Unintended situations can occur if the operations that are in progress are not known when acting on a controller.

EIO0000001114.15

499

500

deployment to the standby controller, page 563

WARNING

UNKNOWN OPERATIONAL STATE OF EQUIPMENT

Before starting or stopping a controller, always positively confirm that there is no critical operation in progress.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

When deploying to a redundant controller,

may not complete successfully. In such case, the software displays a message in the notification panel to inform you.

WARNING

UNINTENDED EQUIPMENT OPERATION

• Verify that deployment to the standby controller completed successfully.

• Do not operate the primary controller if deployment to the standby controller does not complete successfully.

• Synchronize the standby controller manually, using the Sync

(Primary→Standby) command and verify that the synchronization completed successfully.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the Sync (Primary→Standby) command, refer to the

Execution stage, page 531 .

To deploy the Control Participant project, proceed as follows.

Step

Action

Verify that the engine can

communicate with the PC, page 487

and that it is in Stopped state.

When deploying to a station node, verify that the software emulating the simulator is

running, page 484 .

In the Topology Explorer , right-click the entity to which you want to deploy the built

Participant project and select Deploy Built Project .

Result: The software displays the Deploy Built Project dialog box.

Click the menu next to Project and select the Control project.

Click the menu next to Executable and select the executable associated to the built

Control project that you want to deploy.

Click OK .

Result: The software displays the Confirm Deploy Built Project dialog box.

NOTE: Click Cancel to close the dialog box without deploying.

Verify the information that is displayed.

Verify the status of the engine in the Status field.

Verify the communication module identification or select one in the IP Address field.

Select Start engine after deployment if you want the software to start the engine after the deployment is complete.

EIO0000001114.15

deployment process, page 501

Step

Action

Click OK .

Result: The software displays the Reconfirm Deploy Built Project dialog box.

NOTE: Click Cancel to close the Confirm Deploy Built Project dialog box without deploying.

Click OK .

Result: The software:

• Stops the engine if it is running.

• Deploys the Control Participant project.

• Displays Completed in the notification panel once it has successfully completed the deployment process to the engine, which is identified by its IP address.

◦ For a redundant controller, the notification panel displays separate messages for the primary and the standby engines by using their respective IP address to identify them. If deployment to either engine does not complete successfully, the software displays a corresponding message in the notification panel.

• Updates the related date/time field.

• Starts the controller (cold start) or software emulating a simulator if you selected the option.

NOTE: Click Cancel to close the Reconfirm Deploy Built Project dialog box without deploying. This reverts to the Confirm Deploy Built Project dialog box.

NOTE: If the deployment process does not complete successfully and the software has stopped the engine before deploying the Participant project, the engine remains in Stopped state.

Re-Deploying the Control Participant Project

Overview

The Re-Deploy Last Project command for an engine becomes available once you have deployed a project to this engine.

The process of redeploying the Control Participant project is identical to the

with the exception that you cannot select a Control project and an associated Control executable for deployment. The software deploys to the controller or station node emulating a simulator a mirror image of the last deployed Participant project, which is the last deployed reference.

To redeploy a built Participant project, the engine that you are deploying to, must be in Stopped state before proceeding. If it is not, the software informs you of it, and stops the engine when you proceed with the deployment.

NOTE: If you made changes to the deployed Participant project using the

Refine Online and/or if you have deployed changes using the Deploy

Changes commands, then the Participant project that the software redeploys to the controller contains these changes.

Redeploying to a Redundant Controller

For information that applies specifically to the redeployment to redundant controllers, refer to the topic describing

deployment to redundant controllers, page

494 .

Control Participant Project Information

Before proceeding with the re-deployment of the last deployed reference, the software displays information in the Confirm Re-Deploy Last Project dialog box about:

• The engine that you are re-deploying to.

• The project to be re-deployed.

• The Participant project deployed last to the engine.

EIO0000001114.15

501

The figure shows an example of the Confirm Re-Deploy Last Project dialog box for a redundant controller.

502

The table describes the information that is displayed in the Engine Information section of the Confirm Re-Deploy Last Project dialog box.

Label

Role (1)

Status

Description

Role of the engine: A or B .

If the software cannot communicate with the engine, the role is indicated as Not Detected .

Status of the engine that is selected for deployment.

If the status is Not Reachable you cannot proceed with the deployment. In such case, verify the IP address, the connection to the engine, and the status of the engine.

NOTE: If the status is Running , a notification is displayed in the dialog box to inform you that the engine will be stopped if you proceed with the deployment.

EIO0000001114.15

Label

IP Address

Description

Identifier of the communication module through which the software will deploy the built

Participant project and its IP address that is configured in the Topology Explorer .

If the topological entity has several communication modules, you can select which one you want to deploy to.

NOTE: For controllers of the M580 platform, you cannot redeploy to the CPU module or a NOC communication module by using IP address A . You can only select

(1) Displayed only when you redeploy a built Participant project to a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect

button, page 487

The table describes the information that is displayed in the Project Information section of the Confirm Re-Deploy Built Project dialog box. It also describes the check box.

Name column

System

Project

(1)

Executable (1)

Selected Project column Last Deployed Project column (2)

Identifier of the system that both the engine and the Control project, which you have selected belong to.

Identifier of the Control Project that you have selected.

Identifier of the Control executable that you have selected and that contains the built Participant project to be deployed.

Controller (1)

Last Built On

Last Deployed

Last Online

Change

Performed On

Last Sync.

Performed On (3)

Identifier of the controller/station node to which you are deploying the built Participant project.

Date and time when you successfully built the Control

Participant project to be deployed.

Not applicable

Date and time when you successfully built the Control

Participant project that you have deployed last.

Date and time when you last deployed the Participant project to the engine or you last completed the Deploy

Changes / Undo Online Changes command, independently if there were changes to be deployed or not.

Not applicable Date and time when you last changed the deployed

Participant project by using the Refine Online command; otherwise the field is empty.

Date and time when you last synchronized the standby controller with the primary one by using the Synchronize

(Primary→Standby) command.

Start engine after deployment

Select the option if you want to start the engine when deployment is complete; otherwise the engine remains in stop state.

NOTE: The software stops the engine before proceeding with the deployment if the engine is not yet in stop state.

(1) The values of the Selected Project and Last Deployed Project fields are identical.

(2) When you redeploy to a redundant controller, the dialog box shows separate columns for the primary and the standby engines.

(3) Displayed only when you redeploy to a redundant controller.

Re-Deploying the Last Deployed Reference

WARNING

UNINTENDED EQUIPMENT OPERATION

Before deploying to a controller, verify that:

• You have assigned a valid IP address to the controller.

• The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114.15

503

504

Identifying Engines, page 483 .

NOTE: For more information, refer to

WARNING

UNINTENDED EQUIPMENT OPERATION

Before deploying to an engine, verify that you have selected the correct project files.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Unintended situations can occur if the operations that are in progress are not known when acting on a controller.

WARNING

UNKNOWN OPERATIONAL STATE OF EQUIPMENT

Before starting or stopping a controller, always positively confirm that there is no critical operation in progress.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

When redeploying to a redundant controller,

re-deployment to the standby controller, page 563

may not complete successfully. In such case, the software displays a message in the notification panel to inform you.

WARNING

UNINTENDED EQUIPMENT OPERATION

• Verify that deployment to the standby controller completed successfully.

• Do not operate the primary controller if deployment to the standby controller does not complete successfully.

• Synchronize the standby controller manually, using the Sync

(Primary→Standby) command and verify that the synchronization completed successfully.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the Sync (Primary→Standby) command, refer to the

Execution stage, page 531 .

To redeploy the last deployed reference, proceed as follows.

Step

Action

Verify that the engine can

communicate with the PC, page 487

and that it is in Stopped state.

When redeploying to a station node, verify that the software emulating the simulator is

running, page 484 .

In the Topology Explorer , right-click the entity to which you want to deploy the built

Participant project and select Re-Deploy Last Project .

Result: The software displays the Confirm Re-Deploy Last Project dialog box.

Verify the information that is displayed.

Verify the status of the engine in the Status field.

Select Start engine after deployment if you want the software to start the engine after the redeployment is complete.

EIO0000001114.15

Step

Action

Click OK .

The software displays the Reconfirm Re-Deploy Last Project dialog box.

NOTE: Click Cancel to close the Confirm Re-Deploy Last Project dialog box without redeploying.

Click OK .

Result: The software:

• Redeploys the last deployed reference to the engine.

• Displays Complete in the notification panel once it has successfully completed the re-deployment process to the engine, which is identified by its IP address.

◦ For a redundant controller, the notification panel displays separate messages for the primary and the standby engines by using their respective IP address to identify them. If redeployment to either engine does not complete successfully, the software displays a corresponding message in the notification panel.

• Updates the related date/time field.

• Starts the controller (cold start) or software emulating a simulator if you selected the option.

NOTE: Click Cancel to close the Reconfirm Re-Deploy Last Project dialog box without re-deploying. This reverts to the Confirm Re-Deploy Last Project dialog box.

NOTE: If the redeployment process does not complete successfully and the software has stopped the engine before redeploying the Participant project, the engine remains in Stopped state.

Deploying Data to Controllers and Station Nodes

Overview

The Deploy Data command lets you deploy data contained in a

backup file, page

554

that has been created by using the Back Up Data command.

You can select one file from a list of backup files that have been created for all executables of the same Control Participant project. The selection dialog shows the information that was associated to each backup file at the time of creation, including the type of data that was selected.

By default, backup files are listed in descending order of time stamp (most recent one on top).

NOTE: For more information, refer to Save/Restore Data Between a File and the PLC in the help of the Control

Participant, page 69

Deploying Data to Redundant Controllers

For redundant controllers, deployment of data is possible only to the primary controller.

To be able to deploy data to the primary controller, the standby controller must be reachable at the IP address that is configured. It may not be reachable, for example, because it is switched off or the Hot Standby cable is removed.

Only if the ControllerExist

property, page 373

is set to Primary you can deploy data to the primary controller while the standby controller is not reachable.

NOTE: The status of the standby controller is not shown in the Confirm

Deploy Data dialog box.

Data Backup File Information

Before proceeding with the deployment of controller data, the software displays information in the Confirm Deploy Data dialog box about:

• The deployed Control Participant project.

EIO0000001114.15

505

• The executable that is deployed.

• Executables of this Control project for which a backup file exists.

• The type of data contained in each backup file.

• The backup file identification.

NOTE: If you change the identifier of a controller or executable, or the role of a controller, the identification information of the corresponding backup file is not modified.

You can

the information that is displayed.

The following figure shows an example of the Confirm Deploy Data dialog box for a standalone controller.

The following figure shows an example of the Confirm Deploy Data dialog box for a redundant controller.

506

The table describes the information that is displayed in the Engine Information section of the Deploy Data dialog box.

Label

Controller (1)

Role (1)

Status

Description

You can deploy controller data only to the primary controller.

Default value: Primary

Role of the engine: A or B .

If the software cannot communicate with the engine, the role is indicated as Not Detected .

Status of the engine that is selected for deployment of data.

EIO0000001114.15

EIO0000001114.15

Label Description

IP Address

If the status is Not Reachable , you cannot proceed with the deployment.

In such case, verify the IP address, the connection to the engine, and the status of the engine.

Identifier of the communication module through which the software will deploy data and its IP address that is configured in the Topology

Explorer .

If the topological entity has several communication modules, you can select which one you want to use.

Default value: IP address that was selected for the last deployment operation to this engine.

NOTE: For controllers of the M580 platform, you cannot deploy data to the CPU module or through a NOC communication module by using IP address A . You can only select