You are on page 1of 250

Honeywell Process Solutions

MasterLogic-Experion PKS
Integration
User's Guide
Release 300
6/08

Release 300
Honeywell Confidential & Proprietary

Notices and Trademarks


Copyright 2006 by Honeywell International Inc.
Release 300 - June 2008

While this information is presented in good faith and believed to be accurate, Honeywell disclaims
the implied warranties of merchantability and fitness for a particular purpose and makes no
express warranties except as may be stated in its written agreement with and for its customers.
In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The
information and specifications in this document are subject to change without notice.
Experion PKS is a registered trademark of Honeywell International Inc.
Other brand or product names are trademarks of their respective owners.

Honeywell Pte Ltd.


Automation & Control Solutions
#17, Changi Business Park Central 1
Singapore 486 073
Tel: (65) 6355 2828 Fax: (65) 6445 3033

ii

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

About This Document


This users guide describes how to integrate the MasterLogic 100R/200 with Experion
Process Knowledge System (EPKS). The guide describes the installation, configuration,
operations, and troubleshooting tasks associated with the MasterLogic PLC - Experion
integration. The term PLC used throughout this document refers to MasterLogic PLC.
The MasterLogic PLC Experion integration discussed in this guide is tested with
ML100R / ML200 (IEC and NonIEC CPU)/ML200R and Experion R300.

Intended Audience
The intended audience for this guide includes:

Project Engineers.

Operators.

Service Engineers.

Prerequisites for using this guide


Before you begin, ensure that you are familiar with the following:

Experion PKS concepts and Quick Builder usage.


REFERENCE EXTERNAL

For details about Experion PKS, see Experion Knowledge Builder >
Experion PKS R300 > Purpose > Overview > Introduction > Experion
Process Knowledge System.

For details about Quick Builder features and operations, see Experion
Knowledge Builder > Experion PKS R300> Configuration > Quick Builder
Guide.

PLC concepts and SoftMaster tool usage.


REFERENCE - EXTERNAL
For details about PLC concepts and SoftMaster tool usage, see SoftMaster
User Guide and PLC User Guide.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

iii

About This Document


How to use this guide

How to use this guide


Here is a list of topics covered in this guide:
Topic

See page

Introduction

15

Installation

23

ML Server License

43

Configuration

57

Monitoring PLC status from Experion


displays

121

Alarms and Events integration

159

Advanced configuration of ML Server

175

Troubleshooting

195

Appendix

212

References
The following list identifies references for material discussed in this publication:

iv

Experion Knowledge Builder.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

About This Document


Acronyms and Definitions

Acronyms and Definitions


The following section describes some commonly used industry-wide and Honeywellspecific terminology:
Terminology
Experion PKS

R300
6/08

TM

Description
Experion Process Knowledge System.

ML Server

MasterLogic Server software which interfaces MasterLogic PLC


with Experion.

MLPLC

MasterLogic Programmable Logic Controller.

PLC

Programmable Logic Controller.

PV

Process variable parameter of a standard Point.

QDB

Quick Builder project file containing one or more Channels,


Controllers and Points.

SM

SoftMaster PLC monitoring tool.

MLDP

MasterLogic Dedicated Protocol supported by


ML100R/ML200/ML200R.

RTC

Real Time Clock data represents the current time in the PLC.

SP

Set point parameter for the Experion Analog point.

OP

Output parameter for the Experion Analog / Status point.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

About This Document


Contacts

Contacts
World Wide Web
The following Honeywell websites may be of interest to Industry Solution customers:
Honeywell Organization

WWW Address (URL)

Corporate

http://www.honeywell.com

Process Solutions

http://www.honeywell.com/ps

Telephone
Contact us by telephone at the following numbers listed:

vi

Location

Organization

Phone

United States
and Canada

Honeywell IAC Solution


Support Center

1-800-822-7673

Europe

Honeywell TAC-EMEA

+32-2-728-2704

Pacific

Honeywell Global TAC Pacific

1300-300-4822
(toll free within Australia)
+61-8-9362-9559
(outside Australia)

India

Honeywell Global TAC India

+91-20-2682-2458 / 1600-44-5152

Korea

Honeywell Global TAC Korea

+82-2-799-6317

Peoples
Republic of
China

Honeywell Global TAC China

+86-10-8458-3280 ext. 361

Singapore

Honeywell Global TAC South East Asia

+65-6580-3500

Taiwan

Honeywell Global TAC Taiwan

+886-7-323-5900

Japan

Honeywell Global TAC Japan

+81-3-5440-1303

Elsewhere

Call your nearest


Honeywell office.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

About This Document


Symbol Definitions

Symbol Definitions
The following table lists those symbols used in this document to denote certain conditions:
Symbol

Definition
ATTENTION: Identifies information that requires special
consideration.

TIP: Identifies advice or hints for the user, often in terms of


performing a task.
REFERENCE -EXTERNAL: Identifies an additional source of
information outside of the bookset.
REFERENCE - INTERNAL: Identifies an additional source of
information within the bookset.
CAUTION: Indicates a situation which, if not avoided, may result in
work (data) on the system being damaged or lost, or may result in
the inability to properly perform the process.
WARNING: Indicates a potentially hazardous situation, which, if not
avoided, could result in serious injury or death.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

vii

About This Document


Symbol Definitions

viii

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

Contents
1.

INTRODUCTION ..........................................................................15
1.1

Overview ........................................................................................................ 15

MasterLogic PLC - Experion integration solution .................................................................15


Integration Scope .................................................................................................................16
MasterLogic PLC-Experion integration elements .................................................................16
Supported MasterLogic PLCs ..............................................................................................20

2.

INSTALLATION ...........................................................................23
2.1

Overview ........................................................................................................ 23

Pre-requisites for installing ML Server .................................................................................23


Package Information ............................................................................................................23

2.2

Installing ML Server ...................................................................................... 24

2.3

Verifying Installation..................................................................................... 32

Verifying ML Server Installation............................................................................................32

2.4

Getting started............................................................................................... 37

Configuring MasterLogic PLC - Experion integration ...........................................................37

2.5

Removing ML Server .................................................................................... 38

Using Add/Remove programs ..............................................................................................38


Using setup.exe in the installation CD..................................................................................40

2.6

Repairing ML Server ..................................................................................... 41

Using setup.exe in the installation CD..................................................................................41

3.

ML SERVER LICENSE ................................................................43


3.1

Overview ........................................................................................................ 43

Background ..........................................................................................................................43
Before you begin ..................................................................................................................43
Obtaining the license............................................................................................................43
Using the demo versions of ML Server ................................................................................43
ML Server license features...................................................................................................44
Experion point and PLC point...............................................................................................44

3.2

Obtaining a new license ............................................................................... 45

Obtaining a new license through e-mail ...............................................................................45


Installing license certificate...................................................................................................46

3.3
R300
6/08

Updating license certificate ......................................................................... 49


MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

Contents
Updating license certificate ................................................................................................. 49

3.4

Transferring license certificate ....................................................................54

Terminating license certificate ............................................................................................. 54


Transferring license certificate............................................................................................. 56

4.

CONFIGURATION....................................................................... 57
4.1

Overview .........................................................................................................57

Configuring MasterLogic server........................................................................................... 57

4.2

Configuring ML Server using Configuration Tool......................................58

ML Server Configuration Tool.............................................................................................. 58


Configuring PLC Information ............................................................................................... 60
Configuring PLC Log information ........................................................................................ 63
Configuring PLC SOE Information....................................................................................... 65
Configuring ML Server Advanced information ..................................................................... 68
Adding a new PLC............................................................................................................... 69
Deleting a PLC .................................................................................................................... 71
Configuring ML Server general information ......................................................................... 72

4.3

Configuring ML Server using Quick Builder...............................................74

Overview of Quick Builder components............................................................................... 74


Configuring the Quick Builder component manager ............................................................ 74
Configuring a MasterLogic Channel .................................................................................... 76
Configuring a MasterLogic Controller .................................................................................. 78
Configuring an Experion Point (Analog and Status) ............................................................ 81
PLC Point configuration details ........................................................................................... 90
Defining data formats ........................................................................................................ 108

4.4

Downloading Quick Builder Points to Experion.......................................111

Overview ........................................................................................................................... 111

4.5

Verifying the Configuration ........................................................................112

Overview ........................................................................................................................... 112


Verifying data exchange between PLC and Experion ....................................................... 112

4.6

Adding new PLC dynamically ....................................................................120

Overview ........................................................................................................................... 120

5.

MONITORING PLC STATUS FROM EXPERION DISPLAYS... 121


5.1

Overview .......................................................................................................121

Experion displays .............................................................................................................. 121

5.2

Building a Point in Experion corresponding to the PLC .........................122

Using PointBuild Utility ...................................................................................................... 122

5.3

Using Experion custom displays ...............................................................125

PLC System Status Display .............................................................................................. 125


Config Info ......................................................................................................................... 125
10

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

Contents
Status Info ..........................................................................................................................132
Driver Info...........................................................................................................................142

5.4

Using Experion standard Station displays............................................... 148

Channel Summary page ....................................................................................................148


Point Detail display.............................................................................................................149

5.5

Monitoring PLC displays from an Experion client system ..................... 150

Overview ............................................................................................................................150

5.6

Bad quality items ........................................................................................ 152

Overview ............................................................................................................................152
Viewing bad quality item in Point Detail display .................................................................153

6.

ALARMS AND EVENTS INTEGRATION...................................159


6.1

Alarm integration ........................................................................................ 159

Types of Alarms .................................................................................................................159


Viewing PLC alarms in Experion Station ............................................................................160
Sample alarms raised in Experion......................................................................................166

6.2

PLC Events .................................................................................................. 167

Types of PLC events ..........................................................................................................167


Transferring PLC events to Experion/Log files ...................................................................167

6.3

Sequence of Events .................................................................................... 170

Raising SOE.......................................................................................................................170
Viewing SOE alarms in Experion Station ...........................................................................171
Configuring SOEs using Quick Builder...............................................................................174

7.

ADVANCED CONFIGURATION OF ML SERVER ....................175


7.1

Configuring ML Server using XML files.................................................... 175

Overview of XML files ........................................................................................................175

7.2

ML Server features configured using xml files ........................................ 178

Overview ............................................................................................................................178

7.3

Alarms .......................................................................................................... 178

Configuring alarms in MLMonitor.xml .................................................................................178

7.4

SOEs............................................................................................................. 181

Configuring SOE in MLSOEConfig.xml ..............................................................................181

7.5

Experion User defined parameters ........................................................... 183

Overview ............................................................................................................................183
Configuring PLC Status information in MLMonitor.xml.......................................................183
Configuring Base-Slot Information in MLMonitor.xml .........................................................184
Configuring IO Module Information in MLMonitor.xml ........................................................184
Configuring AD Module Information in MLMonitor.xml .......................................................185
Configuring Special Module information in MLMonitor.xml ................................................186
R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

11

Contents
Configuring All Module Information in MLMonitor.xml ....................................................... 187
Time Synchronization between PLC and EPKS ................................................................ 189

7.6

Bad quality items .........................................................................................190

Overview ........................................................................................................................... 190


Setting quality for Channel disconnection in the field ........................................................ 190
Setting quality based on Read command responses ........................................................ 192

7.7

Adding a new IO Module .............................................................................193

Configure new IO Module information ............................................................................... 193


Adding new shape for IO Module ...................................................................................... 194

8.

TROUBLESHOOTING............................................................... 195
8.1

MasterLogic Server logs .............................................................................195

Overview ........................................................................................................................... 195


ML Server logs .................................................................................................................. 195
ML protocol logs ................................................................................................................ 196

8.2

MasterLogic PLC error messages .............................................................198

6000 .................................................................................................................................. 198


6001 .................................................................................................................................. 198
6002 .................................................................................................................................. 198
6003 .................................................................................................................................. 199
6004 .................................................................................................................................. 199
6005 .................................................................................................................................. 199
6006 .................................................................................................................................. 199
6007 .................................................................................................................................. 200
6008 .................................................................................................................................. 200
6009 .................................................................................................................................. 200
6010 .................................................................................................................................. 200
6011 .................................................................................................................................. 200
6012 .................................................................................................................................. 201
6013 .................................................................................................................................. 201
6014 .................................................................................................................................. 201
6015 .................................................................................................................................. 201
6016 .................................................................................................................................. 201
6017 .................................................................................................................................. 202
6018 .................................................................................................................................. 202
6019 .................................................................................................................................. 202
6020 .................................................................................................................................. 202
6021 .................................................................................................................................. 202
6022 .................................................................................................................................. 203
6023 .................................................................................................................................. 203
6024 .................................................................................................................................. 203
6025 .................................................................................................................................. 203
6026 .................................................................................................................................. 203
6027 .................................................................................................................................. 204
6028 .................................................................................................................................. 204
6029 .................................................................................................................................. 204
12

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

Contents
6030 ...................................................................................................................................204
6031 ...................................................................................................................................204
6032 ...................................................................................................................................205
6033 ...................................................................................................................................205
6034 ...................................................................................................................................205
6035 ...................................................................................................................................205
6036 ...................................................................................................................................206
6037 ...................................................................................................................................206
6038 ...................................................................................................................................206
6039 ...................................................................................................................................206
6040 ...................................................................................................................................206
6041 ...................................................................................................................................207
6042 ...................................................................................................................................207
6043 ...................................................................................................................................207
6044 ...................................................................................................................................207
6045 ...................................................................................................................................207
6046 ...................................................................................................................................208
6047 ...................................................................................................................................208
6048 ...................................................................................................................................208
6049 ...................................................................................................................................208
6050 ...................................................................................................................................208
6051 ...................................................................................................................................209
6052 ...................................................................................................................................209
6053 ...................................................................................................................................209
6054 ...................................................................................................................................209
6055 ...................................................................................................................................209
6056 ...................................................................................................................................210
6057 ...................................................................................................................................210
6058 ...................................................................................................................................210

9.

APPENDIX .................................................................................212
9.1

AD Module Information............................................................................... 212

ChannelStatus....................................................................................................................212
InputRange.........................................................................................................................212
OutputType ........................................................................................................................213
FilterProcess ......................................................................................................................214
FilterValue ..........................................................................................................................214
AverageSetting...................................................................................................................215
AverageProcessing ............................................................................................................215
AverageValue.....................................................................................................................215

9.2

Special Module information ....................................................................... 217

ChannelRun .......................................................................................................................217
ChannelConnection............................................................................................................217

9.3

Advanced settings ...................................................................................... 218

Overview ............................................................................................................................218
Configuring ML Server parameters in MLConfig XML........................................................218
Monitoring ML Server parameters in MLMonitor XML........................................................222
R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

13

Contents
Configuring ML Server Application Settings ...................................................................... 236
Configuring PLC SOEs in MLSOEConfig XML.................................................................. 247

14

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

1. Introduction
1.1

Overview

MasterLogic PLC - Experion integration solution


The MasterLogic PLC-Experion integration solution unifies the MasterLogic PLCs with
Experion. The solution enables Experion to read/write PLC data and monitor PLC alarms
and events from Experion Station. The solution is achieved by connecting PLCs to
Experion server through FTE and mapping PLC data items to standard Experion Points.
The following figure illustrates the integration solution:

Figure 1.1-1: MasterLogic PLC - Experion Integration Architecture


The PLC can also be connected directly to the system installed with SoftMaster.
Redundancy is implemented at three different levels:

R300
6/08

Redundant PLC Redundancy in PLC can be achieved using many methods:


-

Having two FENET modules within the same PLC.

Having redundant CPUs.

Having redundant IO Modules or Bases, and so on.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

15

1. Introduction
1.1 Overview

The underlying principle is that when the master module fails, the standby module
takes over the control without interrupting the operation of the process in control.

FTE Network Two Ethernet cables are connected between the Experion and the
PLC or other devices. When the master network connection fails, the standby
network connection is used for the communication between the Experion and the
PLC.

Redundant Experion PKS server The secondary Experion server takes over
when the primary Experion server fails. All the MasterLogic Channels, Controllers,
Points and Graphics are also available when the secondary Experion server is active.
ATTENTION
The MasterLogic PLC functions as a non-FTE node together with other FTE
nodes on the network.

Integration Scope
Experion integration gains special access to intricate areas of MasterLogic PLC through
proprietary MLDP:

Direct variables (%I Input image, %Q Output image, %M internal Memory


variables)

%R File Register variables (non-volatile memory variables data retention)

CPU, I/O module, communication Status and Alarms Flags (CPU error, battery
error, I/O module)

Real Time Clock (RTC) areas

SOE (Sequence of Events) capture with millisecond timestamp

I/O Configuration parameters

PLC History Logs (Error, Activity, Mode changes, Power shutdown)

MasterLogic PLC-Experion integration elements


SoftMaster
The SoftMaster tool is used for the following:

16

Writing ladder logic programs which contain the engineering logics

Monitoring the PLC values and/or force values into PLC.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

1. Introduction
1.1 Overview

The following figure depicts the Address Monitoring window (available only in
SoftMaster):

Figure 1.1-2: Address monitoring window

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

17

1. Introduction
1.1 Overview

Quick Builder
Quick Builder is the tool used for the following:

Configuring MasterLogic Channel, MasterLogic Controller and Analog and Status


Point.

Uploading/downloading Channel, Controller and Point from/to the Experion server.

The downloaded items are stored in the Experion server database.


Experion Station
Experion station is used for the following:

Monitoring the online status of PLCs integrated with Experion as Alarms/Events or


through Custom graphics.

Change the online status of MasterLogic Controllers and MasterLogic Channels.

View the point values obtained from Experion through custom graphics.

Experion has the following two types of stations:


Flex Station This is generally installed on a computer other than the server computer.
Console Station A station that has direct access to Process Controllers as well as to the
Experion PKS server.
MasterLogic PLC
MasterLogic PLC performs the following:

Replaces the necessary sequential relay circuits for machine control.

Used in any application that needs some type of electrical control.

Operates by looking at its inputs and depending on their state, turning on/off its
outputs.

Current MasterLogic PLCs available are ML100R, ML200 (IEC and NonIEC) and
ML200R.

The high speed Ethernet communication modules (FEnet) of MasterLogic-200 system


reside as non FTE nodes on FTE network providing a high-level interface with Experion
PKS servers.
MLDP (MasterLogic Dedicated Protocol) server embedded in the FENET modules offer
Experion servers, a special proprietary access on TCP-IP layer to various memory
variables of the PLC CPU.
18

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

1. Introduction
1.1 Overview

MasterLogic Server
The PLCs are integrated to Experion server, through the ML Server software. After
downloading the Points to Experion server, ML Server performs the following:

Starts communicating with PLCs.

Reads PLC information and writes to the Experion server.

Writes values from the Experion server to PLCs.

Transfers system status, IO module information, alarms/events and the SOE


associated with PLCs to Experion server which can be monitored via the Experion
Station.

Experion PKS Server


The Experion PKS is a standard distributed control system that provides plant-wide
control.
The Experion server contains supervisory control functions, the Experion Global Data
infrastructure and optional redundancy. The server hosts graphical tools such as Control
Builder and HMIWeb Display Builder and acts as the central repository for all system
data. It also runs all the core system functions, including:

R300
6/08

Data acquisition and processing

Alarm and event management

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

19

1. Introduction
1.1 Overview

The following picture illustrates the software architecture of the MasterLogic PLCExperion integration solution:

Figure 1.1-3: Components of MasterLogic PLC Experion Integration


solution
Supported MasterLogic PLCs
The supported PLCs are:

20

ML200R

ML200 (IEC and Non-IEC CPU)

ML100R

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

1. Introduction
1.1 Overview

ML200R
Honeywells next generation Programmable Logic Controllers which supports CPU level
redundancy. This provides real power, performance and versatility with compact size,
high speed scanning of I/O Channels and execution of program instructions, open
network through Ethernet, Profibus TM-DP, DeviceNet TM, remote I/O and engineerfriendly programming & diagnostic software tools.
ML200
Honeywells next generation Programmable Logic Controllers providing real power,
performance and versatility with compact size, high speed scanning of I/O Channels and
execution of program instructions, open network through Ethernet, Profibus TM-DP,
DeviceNet TM, remote I/O and engineer-friendly programming & diagnostic software
tools.
ML100R
ML100R is an earlier version of ML200 which supports CPU level redundancy. There
are some significant improvements in terms of speed, size, performance in ML200
compared to ML100R.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

21

1. Introduction
1.1 Overview

22

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.1

Overview
This section describes the procedure for installing the ML Server.

Pre-requisites for installing ML Server

Ensure that you have installed Experion server with OPC client license. (The ML
Server information provided in this guide is compatible with Experion R301.1.)

Ensure that the Experion server update R301.1.002 is also installed.

Ensure that you have installed MS-XML version 4.

Ensure that you have logged into the Experion server machine with Administrative
privileges.
REFERENCE - EXTERNAL
For more details on Hardware and Software requirements, refer to Hardware
and Software requirements section in Experion PKS Knowledge Builder.

ATTENTION
You must have Experion OPC client license (Model#: EP-OPCCLI) to
configure MasterLogic Channel, Controller and Point.

Package Information
The ML Server CD contains the setup.exe file required to install ML Server.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

23

2. Installation
2.2 Installing ML Server

2.2

Installing ML Server
To install ML Server, perform the following steps:
Step
1

Action
Click setup.exe file from the ML Server installation CD.

ATTENTION
If an earlier version of ML Server is installed already, the wizard
displays an error message indicating that the previous ML Server
version must be installed before installing the new version.
The wizard displays the following screen:

24

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.2 Installing ML Server
Step

Action
After performing the initial checks, the wizard displays the following screen:

Click Next.
The wizard displays the License Agreement screen.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

25

2. Installation
2.2 Installing ML Server
Step

Action
The License Agreement screen is displayed.

26

Select I accept the terms in the license agreement.

Click Next.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.2 Installing ML Server
Step

Action
The wizard displays the Destination Folder screen.

Click Change to select a different folder.

TIP
Honeywell recommends retaining the default destination folder for
installing ML Server.
6

R300
6/08

Click Next.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

27

2. Installation
2.2 Installing ML Server
Step

Action
The wizard displays the Ready to Install the Program screen.

28

Click Install.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.2 Installing ML Server
Step

Action
The wizard displays the Installing Honeywell MasterLogic Server screen,
displaying the status messages and the progress bar during the installation
process.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

29

2. Installation
2.2 Installing ML Server
Step

Action
The wizard completes the installation and displays the following screen:

Click Finish to close the wizard.

ATTENTION
If Experion server is not installed on the machine where the ML
Server is being installed, the following message is displayed after
step 2:

Click OK.

30

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.2 Installing ML Server
Step

Action
The wizard displays the following message:

Click Finish. Install Experion server with OPC client license and
perform step 1.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

31

2. Installation
2.3 Verifying Installation

2.3

Verifying Installation

Verifying ML Server Installation


Verification of ML Server installation involves the following:

Verify graphics pages and xml files copied to the installation path (typically
C:\Program Files\Honeywell\Experion PKS\Client\Abstract) during installation,
as shown in the following figure:

Figure 2.3-1: Graphics pages and xml files copied during installation

32

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.3 Verifying Installation

The following table lists the graphics pages and xml files copied during installation:
Type

Filename

xml files

Graphics pages

Schema files

R300
6/08

Description

MLConfig.xml

This file contains the PLC


specific configuration.

MLMonitor.xml

This file contains common


settings for the ML Server and
the Graphics.

MLSOEConfig.xml

This file contains SOE


configuration for all PLCs.

MLPLC_Config.htm

This Experion graphics page


displays the base slot
information of the PLCs.

MLPLC_Status.htm

This graphics page displays the


PLC status information.

MLPLC_Driver.htm

This Experion graphics page


displays the ML Server (Driver)
diagnostics information.

MLConfig.xsd

XML schema file for


MLConfig.xml

MLMonitor.xsd

XML schema file for


MLMonitor.xml

MLSOEConfig.xsd

XML schema file for


MLSOEConfig.xml

Verify xml, exe, dll files and document copied to the installation path (typically
C:\Program Files\Honeywell\MasterLogicServer) during installation, as shown in
the following figure:

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

33

2. Installation
2.3 Verifying Installation

Figure 2.3-2: Files copied during installation


The following table lists the xml file, user guide and the template file copied during
installation:
Type

34

Filename

Description

xml file

MLAppSettings.xml

This file is used for configuring


the MasterLogic server
application settings.

Schema files

MLAppSettings.xsd

XML schema file for


MLAppSettings.xml

Document

MLServer_Users_Guide.pdf

This users guide describes how


to integrate the MasterLogic
100R/200 with Experion Process
Knowledge System (EPKS).

Template

StatusPointBuildTemplate.t
xt

This is the template file for Point


building.

Configuration
Tool

MLServerConfigTool.exe

This utility is used for configuring


the PLC information, SOE, and
other information for the ML
Server.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.3 Verifying Installation
Type

Filename

Description

Point Build
Utility

PointBuildUtility.exe

This utility is used for building the


Point corresponding to the PLC
and the parameters associated
with the Point.

License
Application

MLServerLicenseRegistrati
on.exe

This application is used for


obtaining a new license, update,
terminate and transfer the
license.

Demo
certificate

MLPLC_Demo.cert

This is a demo certificate file for


ML Server for 100 PLC points.

QDB file

ML_Sample.qdb

This file contains sample ML


Channel, ML Controller and
sample Analog/Status Points.

The ML Server configuration tool, point build utility, users guide and the license
application is accessed through Start > Programs > Honeywell MasterLogic Server.
The shortcuts for the configuration tool and the point build utility are available in the
desktop.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

35

2. Installation
2.3 Verifying Installation

Figure 2.3-3 Shortcuts to ML Server utilities

36

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.4 Getting started

2.4

Getting started

Configuring MasterLogic PLC - Experion integration


After installation, the following tasks are performed:
Step

R300
6/08

Action

Installing one or more Ethernet modules (EUTB/FENET) in each PLC.


Connecting the Ethernet modules to Experion server through Ethernet
cables.

Configuring the IP Addresses of these modules using the SoftMaster tool.


Ping the IP Address from the Experion server for verifying the communication
between the PLC and the Experion server.

Obtaining the license

Configuring ML Server using Configuration Tool

To view PLC information in the graphics display, build Point for each PLC
Using PointBuild Utility.

Verifying data exchange between PLC and Experion.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

37

2. Installation
2.5 Removing ML Server

2.5

Removing ML Server

Using Add/Remove programs


ATTENTION

After removing the ML Server, the integration between the PLC and the
Experion does not work.

The ML Server must be removed only if the software must be upgraded.

Ensure that the ML Server is stopped before removing the installation.

Back up the xml files before removing the installation.

To remove ML Server, perform the following steps:


Step

Action

Click Start > Settings > Control Panel.

Double-click Add/Remove Programs.


The Add or Remove Programs window appears.

38

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.5 Removing ML Server
Step
3

Action
Select Honeywell MasterLogic Server and click Remove.
The following screen appears:

Click YES.
The wizard displays the Remove the Program screen.

Click OK.
The wizard displays the Uninstalling Honeywell MasterLogic Server
screen, displaying the status messages and the progress bar while the
remove operation is in progress.

The installation is successfully removed.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

39

2. Installation
2.5 Removing ML Server

Using setup.exe in the installation CD


ATTENTION
Ensure that you have stopped ML Server before removing the installation.

To remove ML Server using the setup.exe file in the installation CD, perform the
following steps:
Step
1

Action
Click setup.exe file in the installation CD.
The Program Maintenance screen appears.

Select Remove and click Next.


The installation is successfully removed. There is no explicit message

displayed on completion of removal.

40

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

2. Installation
2.6 Repairing ML Server

2.6

Repairing ML Server

Using setup.exe in the installation CD


The ML Server application can be repaired to fix the installation errors. The missing or
corrupt files, shortcuts, and registry entries can be fixed using this option.
To fix the installation errors, perform the following steps:
Step
1

Action
Click setup.exe file in the installation CD.
The Program Maintenance screen appears.

Select Repair and click Next.


The installation errors are successfully repaired. There is no explicit

message displayed on completion of repair.

R300
6/08

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

41

2. Installation
2.6 Repairing ML Server

42

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.1

Overview

Background
After installing the ML Server, you must register it and obtain the license before using it.
Before you begin
Before obtaining the license, ensure that you have the following items:

Voucher ID This is provided by Honeywell when you purchase the ML Server.

Host ID Files These files are automatically created when you open the ML Server
License Registration Application or enable the ML Channel for the first time. Names
of the Host ID files are <Computer Name>.Zip and <Computer Name>.HID,
example: If the computer name is EPKSSRVRPC1 then the Host ID files created are
EPKSSRVRPC1.zip and EPKSSRVRPC1.HID. These files are available in the
installation path (typically C:\Program files\Honeywell\MasterLogicServer).

Obtaining the license


Request by email Send an e-mail to License.Server@honeywell.com attaching the Host
ID files that is <Computer Name>.Zip and <Computer Name>.HID and mentioning the
voucher ID to obtain the license.
ATTENTION

Separate email needs to be sent for getting license for each Experion
server attaching the Host ID files of the corresponding computer.

For a redundant Experion server two licenses must be obtained, one for
each server machine.

Using the demo versions of ML Server


The license certificate for the demo version of ML Server is automatically created and
activated when the ML Server is installed. The demo version of ML Server allows
configuring 100 Points and there is no restriction on the number of PLCs. There is no
validity period for the demo license.
ATTENTION
After obtaining the original license, the demo license of ML Server is replaced
with the original license.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

43

3. ML Server License
3.1 Overview

ML Server license features


The following two features are licensed for ML Server:

Number of PLCs

Number of PLC points that can be used across all the PLCs

For example if the obtained license supports 10 PLCs and 1000 PLC points,

The ML Server communicates with a maximum of 10 PLCs

A maximum of 1000 PLC points can be used for data communication across all the
PLCs

Experion point and PLC point


Experion Analog/Status points are configured using the Quick Builder in the
MasterLogic Controllers for data communication with the PLC. The PLC points defined
within these Experion points provide a way of addressing the location in PLC where the
values are stored.
A maximum of 3 PLC points can be configured for each Experion Analog point. For
example the PV, SP, and OP addresses may be configured for an Experion Analog point.
For each of these addresses a corresponding PLC point is configured.
Similarly a maximum of 2 PLC points may be configured for each Experion Status point
that is PV and OP.

44

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.2 Obtaining a new license

3.2

Obtaining a new license

Obtaining a new license through e-mail


The process of obtaining a new license through e-mail involves the following steps:
Step

Action

Obtain the voucher ID from Honeywell.

Create the Host ID files by opening the ML Server License Registration


Application or enable the ML Channel for the first time.

Send an e-mail to License.Server@honeywell.com with the following details:


In the Subject line, type the voucher ID as VOUCHID :< voucher ID>. For

example, type VOUCHID: MLPLC_1PLC_50POINTS.


Attach the Host ID files that is <Computer Name>.zip and <Computer

Name>.HID files.

ATTENTION

The Subject line is case-sensitive.

Other than the Subject line, do not type any information in the
e-mail.

After receiving the e-mail, Honeywell sends the new license certificate in a

zip file. This file must be unzipped using the password password.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

45

3. ML Server License
3.2 Obtaining a new license
Step
4

Action
Save the license certificate in the ML Server system. This license certificate
can be re-installed if the Experion server machine is reformatted.

Installing license certificate


To install the new license certificate received from Honeywell, perform the following
steps:
Step
1

Action
Click Start > Programs > Honeywell MasterLogic Server > License
Registration.
The ML Server License Registration dialog box appears.

46

Click Browse to select the license certificate received from Honeywell.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.2 Obtaining a new license
Step

Action

The selected license certificate appears in Certificate file path as shown

in the following figure:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

47

3. ML Server License
3.2 Obtaining a new license
Step
3

Action
Click OK.
The ML Server License dialog box appears displaying the licensed

number of PLCs and PLC points.

ATTENTION
The license need not be terminated before uninstalling ML Server
software. The license is retained and active when the ML Server
software is re-installed in the same machine.

48

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.3 Updating license certificate

3.3

Updating license certificate

Updating license certificate


The updated license certificate can be received from Honeywell with additional features
(like more number of points). After installing the license certificate on an Experion
server, the features including the number of points are updated.
To update the license certificate, perform the following steps:
Step

Action

Obtain the new voucher ID (supersede of the original voucher) from


Honeywell.

Send an e-mail to License.Server@honeywell.com with the following detail:


In the Subject line, type the voucher ID as VOUCHID :< voucher ID>. For

example, type VOUCHID: MLPLC_1PLC_50POINTS _Supersede.


Attach the Host ID files that is <Computer Name>.zip and <Computer

Name>.HID files.

ATTENTION

The Subject line is case-sensitive.

Other than the Subject line, do not type any information in the
e-mail.

After receiving the e-mail, Honeywell sends the new superseded license

certificate in a zip file. This file must be unzipped using the password
password.

R300
6/08

Save the license certificate in the ML Server system. This license certificate
can be re-installed if the Experion server machine is reformatted.

Click Start > Programs > Honeywell MasterLogic Server > License
Registration.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

49

3. ML Server License
3.3 Updating license certificate
Step

Action
The ML Server License dialog box appears.

Click Supersede License.


The Enter Password dialog box appears.

Enter password as mlplcr100 and click OK.

ATTENTION
If the ML Server version is R2xx, use mlplcr200 as password.
The following message box appears.

50

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.3 Updating license certificate
Step
7

Action
Click Yes to continue.
The Re-license ML Server dialog box appears.

R300
6/08

Click Browse to select the new license certificate.

Select the file and click Open.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

51

3. ML Server License
3.3 Updating license certificate
Step

Action
The selected certificate appears in New certificate file path as shown in

the following figure:

10

Click OK.
The following message box appears.

11

52

Click OK.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.3 Updating license certificate
Step

Action
The ML Server License Registration dialog box appears displaying the

superseded license features.

12

R300
6/08

Restart ML Server for the new license to take effect.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

53

3. ML Server License
3.4 Transferring license certificate

3.4

Transferring license certificate


The process of transferring the license certificate from one Experion server to another
involves the following tasks:

Terminate the license certificate on the first Experion server.

Install the license certificate on the new Experion server.


CAUTION
If the license is terminated, it cannot be re-installed in the same
machine. To re-install the license the machine must be formatted.

Terminating license certificate


To terminate the license certificate, perform the following steps on the first Experion
server:
Step
1

Action
Click Start > Programs > Honeywell MasterLogic Server > License
Registration.
The ML Server License dialog box appears.

54

Click Terminate License.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

3. ML Server License
3.4 Transferring license certificate
Step

Action
The Enter Password dialog box appears.

Enter password as mlplcr100 and click OK.

ATTENTION
If the ML Server version is R2xx, use mlplcr200 as password.
The following message box appears.

Click Yes to continue.


The license is terminated and the following message appears.

ATTENTION
The *.term file generated after terminating the license can be used
for transferring the license to a different machine.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

55

3. ML Server License
3.4 Transferring license certificate

Transferring license certificate


To transfer the license certificate to a different Experion server, perform the following
steps:
Step

Action

Create the Host ID files by opening the ML Server License Registration


Application or enable the ML Channel for the first time.

Send an e-mail to License.Server@honeywell.com with the following details:


In the Subject line, type the voucher ID as VOUCHID :< voucher ID>. For

example, type VOUCHID: MLPLC_1PLC_50POINTS.


Select the <Computer Name>.HID and the termination certificate (*.term)

files and create a zip file with password password. Attach this zip file to
the e-mail.
Note: Ensure not to select the option to save the folder information while
zipping the files.

ATTENTION

The Subject line is case-sensitive.

Other than the Subject line, do not type any information in the email.

After receiving the e-mail Honeywell sends the new license certificate in a

zip file. This file must be unzipped using the password password.
4

Save the license certificate in the ML Server system. This license certificate
can be re-installed if the Experion server machine is reformatted.

Install the new license certificate.

REFERENCE INTERNAL
For more details about installing the new license certificate, see
Installing license certificate.

56

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.1

Overview

Configuring MasterLogic server


To communicate with the PLCs, the ML Server must be configured with PLC
information. This configuration involves the following tasks:
a)

Configuring ML Server using Configuration Tool

b)

Configuring ML Server using Quick Builder

c)

Downloading Quick Builder Points to Experion

The following diagram depicts the configuration of ML Server:

Figure 4.1-1: MasterLogic Server configuration

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

57

4. Configuration
4.2 Configuring ML Server using Configuration Tool

4.2

Configuring ML Server using Configuration Tool

ML Server Configuration Tool


The PLC information must be configured for the ML Server using the ML Server
Configuration Tool. The PLC information like PLC Name, Id, Type, IPAddress, Logs,
and SOE are configured for each PLC in the plant. The tool consists of the following
tabs:

PLC

LOGS

SOE

ADVANCED
ATTENTION
The PLC information configured using the configuration tool must be saved.
The ML Server must be restarted for the changes to take effect. However, the
exception is that when the ML Server or Protocol Log file settings are
changed, there is no need to restart the ML Server.

To configure the PLC information, perform the following steps:


Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool.
The following window appears:

58

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

By default, the PLC ML01 and ML02 appear in the window.


Note: The first PLC is selected in the tool.
2

Configuring PLC Information.

Configuring PLC Log information.

Configuring PLC SOE Information.

Configuring ML Server Advanced information.

Click Save Configuration.


The following message appears:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

59

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step
7

Action
Repeat steps 1 through 6 for each PLC in the plant.
Note: The PLCs must be added using the procedure Adding a new PLC.

Tip
The ToolTip appears when the cursor is placed over the options
available in the ML Server Configuration tool.The ToolTip provides
additional information about the setting options.

Configuring PLC Information


The PLC tab in the configuration tool is used for the following purposes:

Configuring the general PLC information used by ML Server to communicate with


the PLC.

Enabling/Disabling the IO Read and other features within the ML Server.

To configure the PLC information, perform the following steps:


Step
1

Action
Select the PLC ID from the left pane.
The PLC information appears in the PLC tab as shown in the following

figure:

60

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step
3

Action
Enter PLC Name.
Note: The PLC Name is a unique name for each PLC. It is alphanumeric and
there is no limit on the number of characters. Example MLPLC1. Separate
logs are created for each PLC based on the PLC ID.

Select the PLC type from the PLC Type list box
Note: The supported PLCs are ML100R, ML200-IEC, ML200-NonIEC and
ML200R.

Enter the EPKS Asset Name for this PLC. All the Alarms/Events raised by
the ML Server is in this asset.

REFERENCE EXTERNAL
For more details on configuring and creating asset, refer Expperion
Knowledge Builder > Experion R300 > Configuration > Enterprise
Model Builder Users Guide > Accessing Enterprise Model Builder
> Creating and Configuring Assets.
6

Enter IPAddress1, IPAddress2, IPAddress3 and IPAddress4.


Note:
IPAddress1- Represents the primary PLCs IP address in Primary Network.
IPAddress2- Represents the secondary or redundant PLCs IP address in
Primary Network.
IPAddress3- Represents the primary PLCs IP address in Secondary
Network, incase of dual network.
IPAddress4- Represents the secondary or redundant PLCs IP address in
Secondary Network, incase of dual network.
The ML Server searches for a valid PLC connection in the following
sequence: IPAddress1, 2, 3 and 4.

R300
6/08

To view PLC status information in the Experion graphics display select


Status Read and EPKS Write check boxes in Monitor.

To view IO module information in the Experion graphics display select IO


Read and EPKS Write check boxes in Monitor.

To view PLC status Alarms / Messages in the Experion Alarm summary


display select Status Read and Alarm Raising check boxes in Monitor.

10

To view the updated RTC time in Experion graphics display select Enable
Read/Write in RTC and EPKS Write under Monitor.
MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

61

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action
Enable Read/Write

If Yes, it allows ML Server to read/write RTC time


from/to PLC.

Synch Interval

Indicates the time frequency for reading the RTC


time from the PLC and updating in Experion.
Note: If this value is 0 then the RTC time is not
read or written from/to the PLC.

Deadband

The value set for Deadband under RTC indicates


the difference in time between the PLC and
System Time beyond which the RTC time is
written to the PLC.
The PLC time is updated with the Experion system
time, if the time difference is equal to or greater
than RTC Deadband.
Note: If this value is 0 then the RTC time is not
written to the PLC.

11

62

To view PLC related alarms like ML Server Licensing Alarms, PLC


connection and disconnection in the Alarm summary display, select Alarm
Raising check box under Monitor.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Configuring PLC Log information


The LOGS tab in the configuration tool is used for the following purposes:

Configuring settings for transfer of the PLC Logs into the ML Server

Enabling/Disabling the PLC level ML Server and Protocol logs

To configure the PLC log information, perform the following steps:


Step

Action

12

Select the PLC ID from the left pane and click LOGS tab.

13

Select the Initial History check box if the already existing events in the PLC
Log need to be transferred to Experion server or Log files during startup of
the ML Server.
Note: Honeywell recommends that this option need not be selected.

14

Select the Log To File check box if the events in the PLC Log need to be
transferred to corresponding ML Server log files.
Note: Honeywell recommends that this option need not be selected.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

63

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

15

Select the Events check box if the events in PLC Log need to be transferred
to Experion server as Events/Alarms.
Note: Honeywell recommends that this option can be selected for the desired
PLC log.

16

The Event Category selection indicates whether the event needs to be


transferred to Experion as Alarms or Events. The possible values are System
Alarm, System Event, and SOE.
Note: Honeywell highly recommends that the default System event setting
must not be changed.

17
Click
under ML Server Logs to browse and select the folder path to
save the ML Server log files.
18
under Protocol Logs to browse and select the folder path to save
Click
the Protocol log files.

64

19

Select Request, Response, Trace and Monitor under ML Server Logs to


enable the generation of corresponding logs.

20

Select Request, Response, Trace and Hex under ML Server Logs to


enable the generation of corresponding logs.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Configuring PLC SOE Information


The SOE tab in the configuration tool is used for configuring settings for the generation
of SOE in Experion server.
To configure the PLC SOE information, perform the following steps:
Step
21

Action
Select the PLC ID from the left pane and click SOE tab.
The PLC SOE information appears as shown in the following figure:

22

Click Add.
A new row is added as shown in the following figure:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

65

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

23

Enter the PLC memory area address for which the SOE needs to be raised in
the Memory address column.
Enter the SOE Option which indicates the condition for raising the SOE. The
possible values are:
1 SOE is raised when value of the memory address changes from 0 to 1
0 SOE is raised when value of the memory address changes from 1 to 0
C SOE is raised when value of the memory address changes either from 0
to 1
F SOE is not raised for any value changes
Enter the Description to be used as the SOE message text.
In the example provided, the SOE would be raised with the message text
Boiler Unit turned ON when the value of M0010F memory location bit
becomes 1.
Note: The data type value cannot be modified.

66

24

Repeat steps 22 and 23 to configure SOE for points.

25

Click Save to save the SOE information.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

ATTENTION
The Delete option is available after saving the SOE information.

26

Select the SOE information and click Delete.


The selected SOE information of the particular PLC is deleted.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

67

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Configuring ML Server Advanced information


The ADVANCED tab in the configuration tool is used for configuring ML Server
advanced settings.
ATTENTION
Honeywell highly recommends that these settings and the default values
need not be changed. If you need to change this configuration, contact the
Honeywell technical support team.

To configure the ML Server advanced information, perform the following steps:


Step
27

Action
Select the PLC ID from the left pane and click ADVANCED tab.
The ML Server advanced information appears as shown in the following

figure:

68

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Adding a new PLC


The PLCs in the plant must be added and configured in the ML Server Configuration tool
for the ML Server to communicate with the PLCs.
To add a new PLC, perform the following steps:
Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool.

Right click ML Server and select Add PLC.

A new PLC is added as shown in the following figure:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

69

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

ATTENTION
For each PLC added, a corresponding point must be built using the
Point build utility, for viewing the PLC status in Experion graphics
displays.

70

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Deleting a PLC
To delete a PLC, perform the following steps:
Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool.

Right click the PLC ID from the left pane and select DeletePLC.

The following confirmation message appears:

If you select Yes, the PLC configuration information is deleted.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

71

4. Configuration
4.2 Configuring ML Server using Configuration Tool

Configuring ML Server general information


To configure the ML Server general information, perform the following steps:
Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool.

Select ML Server from the left pane.


The following window appears:

Enter the EPKS Asset Name for the general ML Server Alarms. All Alarms
raised by the ML Server is in this asset.

Enter the Log Retention Days for the ML Server and Protocol Logs. The ML
Server automatically deletes the log files that are older than these days.

Enter the PLC Info Update Rate which indicates how fast the changes in the
dynamic MLConfig XML parameters (Log files enabling / disabling, and so
on) are detected.

6
Click
under ML Server Logs to browse and select the folder path to
save the ML Server log files.
7

72

Select Request, Response, Trace and Monitor under ML Server Logs to


generate the corresponding general logs.
MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.2 Configuring ML Server using Configuration Tool
Step

Action

8
under Protocol Logs to browse and select the folder path to save
Click
the Protocol Stack log files.
9

Select Request, Response, Trace and Hex under Protocol Logs to


generate the corresponding general logs.

10

Enter the scan period for General Diagnostic, PLC Diagnostic, IO Read,
AD Module Read, Special Module Read and All Module Read under Scan
Period.
General Diagnostics Frequency at which the general diagnostics
parameters in the Driver Info Experion display are collected.
PLC Diagnostics Frequency at which the PLC specific diagnostics
parameters in the Driver Info Experion display are collected.
IO Read Frequency at which the IO Module information is read from all the
PLCs. This setting is not applicable for the ML100R PLCs.
AD Module Read Frequency at which the AD Module information is read
from the PLCs. This setting is not applicable for the ML100R PLCs.
Special Module Read Frequency at which the Special Module parameters
are read from the U memory area of the PLCs. The Bad PV is set for the
corresponding Experion parameters based on this parameter. This setting is
not applicable for the ML100R PLCs.
All Module Read Frequency at which the module level errors,
Max/Min/Current Scan periods are read from the F Area for the ML200 PLCs.
This setting is not applicable for the ML100R PLCs.

11

R300
6/08

Click Save Configuration.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

73

4. Configuration
4.3 Configuring ML Server using Quick Builder

4.3

Configuring ML Server using Quick Builder

Overview of Quick Builder components

The ML Server must be configured using the Quick Builder. The configuration
involves the following tasks:
Configuring the Quick Builder component manager

Configuring a MasterLogic Channel

Configuring a MasterLogic Controller

Configuring an Experion Point (Analog and Status)


REFERENCE - EXTERNAL
For more details on Experion Quick Builder tool, see Experion PKS
Knowledge Builder > Experion PKS R300 > Configuration > Quick Builder
Guide.

TIP
For example on configuring ML Channel, Controller and Points, refer to the
sample QDB file (ML_Sample.qdb) in the installation folder.

Configuring the Quick Builder component manager


To enable configuring the MasterLogic Channel, MasterLogic Controller and Analog and
Status Points in Quick Builder, the Quick Builder component manager must be
configured.
ATTENTION
You must have Experion OPC client license (Model number: EP-OPCCLI) to
configure the MasterLogic Channel, Controller and Point.

To configure the Quick Builder component manager, perform the following steps:
Step
1

Action
Create a new project in Quick Builder.
The Enable Components dialog box is displayed.

74

Select Experion server from Server drop-down list.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

R300
6/08

Action

Click Enable Components tab.

Select MasterLogic from Other components.

Select Analog Point and Status Point from Point components.

Select Server from Server components.

Click OK.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

75

4. Configuration
4.3 Configuring ML Server using Quick Builder

Configuring a MasterLogic Channel


The MasterLogic Channel forms the interface between one or more MasterLogic
Controllers and the ML Server.
ATTENTION
Configure only one MasterLogic Channel in an Experion server even if there
are many PLCs that need to be connected through ML Server.

To configure the MasterLogic Channel, perform the following steps:


Step

Action

Create a new project in Quick Builder.

Right-click the Channel icon from the right-pane of the Quick Builder window
and select Add Item.

The following dialog box appears:

76

Select Channel and MasterLogic Channel type in the Add Item(s) dialog
box.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

Select Channels icon from the left-pane of the Quick Builder window. From
the right pane, select the channel that you want to configure.

Configure the Main tab of the Channel as follows:

Ensure that the Host Name contains localhost.

Select the Background Scan period.


Note: This parameter is used in conjunction with the Controllers Background
Scan parameter. Honeywell recommends you to retain the default value (60).

ATTENTION
Ensure that the Item Number for the channel configured is unique.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

77

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

WARNING

The Background Scan Period,

Must be greater than PV/OP/SP Scan Period. (The


PV/OP/SP Scan Period is set during Point configuration).

Must not be equal to 0.

If the Background Scan Period is lesser than PV/OP/SP Scan


Period, the ML Server does not function properly.

REFERENCE EXTERNAL
For more details on adding and configuring a Channel, see Experion
Knowledge Builder > Experion PKS R300 > Configuration > Quick
Builder Guide > Configuring Controllers and Channels.

Configuring a MasterLogic Controller


The MasterLogic Controller is Quick Builder's mechanism for configuring one or more
groups with the same deadband. It is a logic grouping and does not represent a physical
device (that is the PLC controller).
TIP
Honeywell recommends you to configure only one ML controller for each
PLC. If more than 700 PLC points need to be configured for a PLC, more
than one ML controller can be configured for the same PLC. However, ensure
that within one ML controller, all the points must be configured for the same
PLC.

To configure the MasterLogic Controller, perform the following steps:


Step

Action

Create a new project in Quick Builder.

Add a MasterLogic Channel to the project.

REFERENCE INTERNAL
For more details on adding a MasterLogic Channel, see Configuring
a MasterLogic Channel.

78

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step
3

Action
Right-click the Controller icon from the right-pane of the Quick Builder
window and select Add Item.

The following dialog box appears:

R300
6/08

Select Controller and MasterLogic Controller in the Add Item(s) dialog


box.

Select the Controllers icon from the left-pane of the Quick Builder window.
From the right pane, select the controller that you want to configure.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

79

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

Configure the Main tab of the Controller as follows:

Select the appropriate Channel from Channel Name drop-down list.

Select Enabled from Background Scan drop-down list.


Note: The PLC Points are scanned at Channels Background Scan period
interval if the Background scan period is enabled.

Select deadband value from Deadband drop-down list.


Note: This deadband applies to all items referenced by Point parameters
belonging to this Controller. The unit of measurement is %.

REFERENCE - EXTERNAL
For more details on adding and configuring a Controller, see
Experion Knowledge Builder > Experion PKS R300 > Configuration
> Quick Builder Guide > Configuring Controllers and Channels.

80

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder

Configuring an Experion Point (Analog and Status)


Analog and Status Points are used for exchanging the MasterLogic data with Experion.
The Quick Builder Point parameter represents a mapping to an item on the ML Server.
ATTENTION
The PV, SP and OP values are configured as parameters for a point. They do
not refer to the general Process Control Industry meaning.

Configuring an Experion Analog Point


To configure the Experion Analog Point, perform the following steps:
Step

Action

Create a new project in Quick Builder.

Add a MasterLogic Channel and one (or more) MasterLogic Controller (s)
corresponding to each PLC configured in the Plant.

REFERENCE INTERNAL
For more details on adding MasterLogic Channel and Controller,
see Configuring a MasterLogic Channel and Configuring a
MasterLogic Controller.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

81

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step
3

Action
Right-click the Point icon from the right-pane of the Quick Builder window
and select Add Item.

The following dialog box appears:

82

Select Point and Analog Point type in the Add Item(s) dialog box.

Select the Points icon from the left-pane of the Quick Builder window. From
the right pane, select the point that you want to configure.

Configure the Main tab as follows:

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

Enter the Parent Asset for the point. All Alarms/Events raised by Experion
(value change Events, Range checking Alarms, and so on.) is in this Asset.

TIP
Honeywell recommends that the Parent Asset configured for the
points here must be the same as the EPKS Asset Name configured
in the ML Server Configuration Tool for the PLC referred in this
point.
8

Select ellipse

button next to PV Source Address.

The Address Builder dialog box is displayed.

Select Controller from Address Type drop-down list and appropriate


Controller name from Controller drop-down list. Enter PLC Point name in
Location.
Note: The PLC Point name includes the PLC ID, memory area, command,
and data type. The name of the user-defined data format is also provided in
the PLC Point name.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

83

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

REFERENCE INTERNAL

For more details on PLC Point name, see

PLC Point configuration details.

For more details on user-defined data format, see Defining


data formats.

WARNING
If the user defined data format is not defined in Experion, then the
entire item is not recognized by the ML Server.
10

Configure the Control tab as follows:

11

Enter Setpoints Source Address and Dest Address through Address


Builder dialog box. (Optional)
Note:
Setpoint Source Address: This denotes the address from where SP

reads the associated parameter value that can be viewed in the Experion
Station.
Setpoint Dest Address: The value written to SP is transferred to this

location in the PLC.


84

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

TIP
Honeywell recommends you to configure the same PLC memory
address for both the source and destination addresses of the SP
parameter.
12

Select the Scan Period for SP.


Note: This represents the interval at which the SP parameters value is
updated from the PLC Address specified in SP Source Address.

WARNING
The Scan Period,

13

Must be less than the Background Scan Period configured


for the MasterLogic Channel.

Must not be equal to 0.

Enter Outputs Source Address and Dest Address through Address


Builder dialog box. (Optional)
Note:
Output Source Address: This denotes the address from where OP reads

the associated parameter value that can be viewed in the Experion Station.
Output Dest Address: The value written to OP is transferred to this

location in the PLC.

TIP
Honeywell recommends you to configure the same PLC memory
address for both the source and destination addresses of the OP
parameter.
14

Select the Scan Period for OP.


Note: This represents the interval at which the OP parameters value is
updated from the PLC Address specified in OP Source Address.

WARNING
The Scan Period,

R300
6/08

Must be less than the Background Scan Period configured


for the MasterLogic Channel.

Must not be equal to 0.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

85

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

TIP
The values for SetPoint and Output need not be defined for every
Experion point.

REFERENCE EXTERNAL
For more details on adding and configuring Points, see Experion
Knowledge Builder > Experion PKS R300 > Configuration > Quick
Builder Guide > Point Properties.

Configuring an Experion Status Point


REFERENCE - INTERNAL
Configuring the Main tab of Status Point is similar to configuring the Main
tab of an Analog Point. Instead of selecting an Analog Point, select a Status
Point. For details about configuring an Analog Point, see Configuring an
Experion Analog Point.

To configure an Experion Status Point, perform the following:


Step

Action

Create a new project in Quick Builder.

Add a MasterLogic Channel and one (or more) MasterLogic Controller


corresponding to each PLC configured in the Plant.

REFERENCE INTERNAL
For more details on configuring a MasterLogic Channel and
Controller, see Configuring a MasterLogic Channel and Configuring
a MasterLogic Controller.

86

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step
3

Action
Right-click the Point icon from the right-pane of the Quick Builder window
and select Add Item.

The following dialog box appears:

R300
6/08

Select Point and Status Point type in the Add Item(s) dialog box.

Select the Points icon from the left-pane of the Quick Builder window. From
the right pane, select the point that you want to configure.

Configure the Main tab as follows:

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

87

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

Enter the Parent Asset for the point. All Alarms/Events raised by Experion is
in this Asset.

TIP
Honeywell recommends that the Parent Asset configured here
must be the same as the EPKS Asset Name configured in the ML
Server Configuration Tool for the PLC referred in this point.
8

Select ellipse

button next to PV Source Address.

The Address Builder dialog box appears.

Select Controller from Address Type drop-down list and appropriate


Controller name from Controller drop-down list. Enter PLC Point name in
Location.
Note: The PLC Point name includes the PLC ID, memory area, command,
and data type. The name of the user-defined data format is also provided in
the PLC Point name.

88

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

REFERENCE - INTERNAL

For more details on PLC Point name, see

PLC Point configuration details.

For more details on user-defined data format, see Defining


data formats.

10

Configure the Control tab as follows:

11

Enter Outputs Source Address and Dest Address through Address


Builder dialog box. (Optional)
Note:
Output Source Address: This denotes the address from where OP reads

the associated parameter value that can be viewed in the Experion Station.
Output Dest Address: The value written to OP is transferred to this

location in the PLC.


12

Select the Scan Period for OP.


Note: This represents the interval at which the OP parameters value is
updated from the PLC Address specified in OP Source Address.

WARNING
The Scan Period,

R300
6/08

Must be less than the Background Scan Period configured


for the MasterLogic Channel.

Must not be equal to 0.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

89

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

TIP
The value for Output need not be defined for every Experion point.

REFERENCE EXTERNAL
For more details on adding and configuring Points, see Experion
Knowledge Builder > Experion PKS R300 > Configuration > Quick
Builder Guide > Point Properties.

PLC Point configuration details


The PLC Point name configured in Quick Builder provides a way of addressing the
location in PLC where the values are stored. The PLC Point name specifies the PLC ID,
memory address, the command to be executed, and the data type. For example,
ML01.%MW95$TB. The PLC Point name entered in the Source Address of Quick
Builder for the Analog/Status Points is used for reading PLC data. The PLC Point name
entered in the Dest Address is used for writing data into the PLC.
After downloading standard Points to Experion, enable the Channel, Controller and
Points from the Experion Station. This triggers off connections to the ML Server based
on the configured Channel, Controllers and Points. The ML Server then starts reading
from or writing into PLCs using the commands embedded in the PLC Point name.
This section describes the various PLC Point name formats supported in ML100R,
ML200 (IEC and NonIEC CPU), ML200R and the commands used for reading or writing
PLC information.
TIP
The features specific to ML200-IEC and ML200-NonIEC are explicitly
differentiated in the following sections. The instances ML200 refers to both
ML200-IEC and ML200-NonIEC.

The following are the list of PLC Point name formats supported in ML200 R, ML200
and ML100R:
Table 4.3-1: PLC Point name formats supported in ML200R, ML200-IEC,
ML200-NonIEC and ML100R
PLC Point Name Format

90

ML200R

ML200-IEC

ML200-NonIEC

ML100R

Direct Variable

Named Variable

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
PLC Point Name Format

ML200R

ML200-IEC

ML200-NonIEC

ML100R

Device Variable

The following table lists the different memory areas supported in ML200R and its
associated data type, range and read/write property:

BYTE

WORD

DWORD

LWORD

INT

DINT

LI NT

Range

BIT

Memory
Area

Readable/
Writable

Table 4.3-2: Memory areas supported in ML200R

Low

00.00.00

127.15.63

00.00.00

127.15.63

R/W

00000

8192F

R/W

00000

11263F

R/W

00000

2047F

00000

32767

R/W

00.00.00
0

31.15.511

R/W

00000

65535

R/W

High

Note: The R and W memory areas refer to the same storage locations for the first 32767
words. For example, %RW10 and %WW10 is referring to the same PLC memory
address and therefore always have the same value.
The following table lists the different memory areas supported in ML200-IEC and its
associated data type, range and read/write property:

R300
6/08

BYTE

WORD

DWORD

LWORD

INT

DINT

LI NT

Range

BIT

Memory
Area

Readable/
Writable

Table 4.3-3: Memory areas supported in ML200-IEC

Low

00.00.00

127.15.63

00.00.00

127.15.63

R/W

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

High

91

4. Configuration
4.3 Configuring ML Server using Quick Builder
Range
M

00000

8192F

R/W

00000

11263F

R/W

00000

2047F

00000

32767

R/W

00.00.0

3F.31.F

R/W

00000

65535

R/W

Note: The R and W memory areas refer to the same storage locations for the first 32767
words. For example, %RW10 and %WW10 is referring to the same PLC memory
address and therefore always have the same value.
The following table lists the different memory areas supported in ML200-NonIEC and its
associated data type, range and read/write property:

92

DWORD

LWORD

INT

DINT

LI NT

00000

2047F

R/W

00000

2047F

R/W

00000

11263F

R/W

00000

2047F

R/W

00000

2047F

0000

2047

R/W

0000

2047

R/W

000.00

127.99

R/W

00000

32767

R/W

00000

32767

R/W

00.00.0

7F.31.F

R/W

00000

21503

R/W

BIT

WORD

Range

BYTE

Memory
Area

Readable/
Writable

Table 4.3-4: Memory areas supported in ML200-NonIEC

Low

High

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Range
Z

000

127

R/W

00000

32767

R/W

The following table lists the different memory areas supported in ML100R and its
associated data type, range and read/write property:

DWORD

LWORD

I NT

DINT

LINT

I (Input
Memory)

00.00.00

15.07.63

Q (Output
Memory)

00.00.00

15.07.63

R/W

M (Internal
Memory)

00000

2047F*

R/W

BIT

WORD

Range

BYTE

Memory
Area

Readable/
Writable

Table 4.3-5: Memory areas supported in ML100R

Low

High

Note: The INT (9) data type is supported only for Named Variable.
* The higher range for M memory area must be same as configured in the Softmaster tool.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

93

4. Configuration
4.3 Configuring ML Server using Quick Builder

94

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder

The following table lists the various commands supported in ML100R/ML200/ML200R:


Table 4.3-6: Commands supported in ML100R/ML200
Commands
CON
(ML100R,
ML200/ML20
0R)

Read

Write

Remarks

Continuous Read command

Continuous Write command

Advantages:

If the PLC Point name


ML01.%MW002$CON and
ML01.%MW\K004$CON#RE
AL are passed for read, a
single Continuous Read
command is used for reading
nd
th
the 2 and 4 Word of M
memory area from PLC 01.

If value is written to a Points


parameter that is configured as
ML01.%MW002$CON and
ML01.%MW004$CON#REAL a
single Continuous Write
command is used for writing the
2nd and 4th Word of M memory
area in PLC 01.

1) Useful when contiguous memory addresses


need to be read from the PLC. Upto 1024 bytes
(in ML100R) or 1400 bytes (in ML200) can be
read / written in a single packet. However, multiple
CON packets can be created serving more
number of points.
2) This is the only command available for
configuring large number of Points in ML100R.
This is also the recommended method for ML200
when some continuous memory locations need to
be read from PLC.
Disadvantages:
This command is not useful when a number of
variables need to be read, where
the addresses are not contiguous or
belong to different memory areas

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

95

4. Configuration
4.3 Configuring ML Server using Quick Builder
Commands
TB
(ML200/ML2
00R)

Read

Write

Remarks

Timer Based Command

Device Area Write

Advantages:

If the PLC Point name


ML01.%MW95$TB is passed
for read, the Timer Based
command is used for reading
the 95th Word of M memory
area from PLC 01.

If value is written to a Point s


parameter that is configured as
ML01.%MW95$TB, the Device
Area Write command is used
th
for writing the 95 Word of M
memory area in PLC 01.

This is a Subscription based command.


Subscription for these variables is made only
once. The PLC sends the data responses at the
specified interval. This reduces the network traffic.
Disadvantages:
Only upto 1024 variables (512 variables for a
ML200-NonIEC) can be subscribed for each PLC.
Any points defined in excess of this will be treated
as a DEV point.

96

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Commands

Read

Write

Remarks

COS
(ML200/ML2
00R)

Change of Status Command

Device Area Write

Advantages:

If the PLC Point name


ML01.%MW95$COS is
passed for read, the Change
of Status command is used
for reading the 95th Word of
M memory area from PLC 01.

If value is written to a Points


parameter that is configured as
ML01.%MW95$COS, the
Device Area Write command
th
is used for writing the 95 Word
of M memory area in PLC 01.

This is also a Subscription based command,


Subscription for these variables is made only
once. The PLC sends the data responses only
when the value of the variable changes. This
reduces the network traffic.
Disadvantages:
Since the PLC sends the responses as UDP

packets, there is a possibility that some of the


packets might be lost. However this cannot be
detected by the ML Server.
Only upto 1024 variables (512 vairables for a

ML200-NonIEC) can be subscribed for each


PLC. Any points defined in excess of this will
be treated as DEV points.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

97

4. Configuration
4.3 Configuring ML Server using Quick Builder
Commands
DEV
(ML200/ML2
00R)

Read

Write

Remarks

Device Area Read

Device Area Write

Advantages:

If the PLC Point name


ML01.%MW95$DEV is
passed for read, the Device
Area Read command is used
for reading the 95th Word of
M memory area from PLC 01.

If value is written to a Points


parameter that is configured as
ML01.%MW95$DEV, the
Device Area Write command
th
is used for writing the 95 Word
of M memory area in PLC 01.

This command is useful for reading/writing a few


variables from/to different memory areas of the
PLC. It reads/writes upto 80 variables in a single
packet. However, multiple DEV packets can be
created serving more number of points.
Disadvantages:
It is not useful for a larger number of variables.
(For example: 500 variables.)

SEP
(ML100R,
ML200/ML20
0R)

98

Separate Read

Separate Write

Advantages:

If the PLC Point name


ML01.%MW95$SEP is
passed for read, the Separate
Read command is used for
th
reading the 95 Word of M
memory area from PLC 01.

If value is written to a Point s


parameter that is configured as
ML01.%MW95$SEP, the
Separate Write command is
used for writing the information
into the 95th Word of M memory
area in PLC 01.

This is the only command available for reading a


named variable in ML100R.
Disadvantages:
This command is used for reading only 4 (in
ML100R) or 16 (in ML200-IEC/ ML200-NonIEC)
variables of the same type in a single packet. This
is not useful for reading/writing large number of
items from/to the PLC.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Note:
A single Continuous Read/Write command is used for reading or writing data together for multiple addresses within the same

memory area.
In ML100R, the maximum number of bytes read /written is 1024.
In ML200/ML200R, the maximum number of bytes read/written is 1400.
For the Separate Read/Write command, even when the Device Variable format is used, the offset must be provided in the Direct

Variable format. For instance, ML01.%MX10A$SEP is not a valid item, ML01.%MX170 must be used. Configuring
ML01.%MX10A$SEP would generate an error log message.
The examples given in the previous table refer to ML200. For ML100R examples, see Table 4.3-7: Examples of Direct Variable.

ATTENTION

R300
6/08

The Separate Read/Write and Continuous Read/Write command are the only commands supported in ML100R.

The default command in ML100R is Continuous Read/Write.

The default command in ML200/ML200R is Device Area Read/Write.

If an incorrect command is specified in the PLC Point name, an error message is logged and the default command is
automatically used. For instance, if a ML200 PLC Point name is configured as ML01.%MW90$CEP, then it would be
internally converted to ML01.%MW90$DEV.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

99

4. Configuration
4.3 Configuring ML Server using Quick Builder

TIP
Honeywell recommends to use the commands in the following order:
a) CON: First try to use the CON (Continuous Read/Write) command. This is particularly useful when there are a lot of
contiguous memory addresses that need to be read from / written to one or two PLC memory areas.
b) COS (Only for ML200/ML200R): This command can be used as it reduces the network traffic. This command can be
used for a maximum of 1024 points (512 points in ML200-NonIEC) per PLC. This is useful when data from different
memory areas needs to be read and the values do not change frequently. This command could be mainly used for
Status points
c) TB (Only for ML200/ML200R): This command must be used because it reduces Network traffic. However, this
command can be used for a maximum of 1024 points (512 points in ML200-NonIEC) per PLC. This is useful when data
from different memory areas needs to be read and the values change frequently. Therefore this command is
preferred for Analog points.
d) DEV (Only for ML200/ML200R): This command must be used when data from different memory areas needs to be
read and the TB/COS points limit have been exceeded.
e) There is no limit on the number of points that can be configured.
f) SEP: Honeywell discourages the use of this command for performance reasons. However, this command is the only
method available for reading named variables in ML100R.

100

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder

Direct Variable
The following figure depicts the Direct Variable format:

Figure 4.3-1: Direct Variable

PLCID: This refers to the PLC. It is a two digit number ranging from 01 through 99
and always prefixed by ML. This must be configured in ML Server Configuration
Tool.

MemoryAddress: This refers to the address within the PLC memory area where
information is stored.

Format: %<MemoryArea><DataType><Offset>

In ML100R and ML200-IEC, for I and Q memory areas <Offset> is


<Base>.<Slot>.<Position>. For other areas, it represents the address within the
memory area.

In ML200-NonIEC, for all the memory areas, <Offset> represents the address
within the memory area.
REFERENCE - INTERNAL
For more details on memory areas supported in ML200R, see Table 4.3-2.
For more details on memory areas supported in ML200-IEC, see Table 4.3-3.
For more details on memory areas supported in ML200-NonIEC, see Table
4.3-4.
For more details on memory areas supported in ML100R, see Table 4.3-5.

101

Command Type: This refers to the different commands used for reading/writing
data from/to PLC by ML Server. For more details on command types, see Table
4.3-6.
MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder

Data Type: This refers to the PLC data type.


ATTENTION
Only the following combinations of data types can be used in a Direct
Variable.

Data type in Memory


Address

Data type at the end of the PLC


point name (after #)

BIT

BYTE

WORD and INT

DWORD, DINT and REAL

LWORD, LINT and LREAL

The request is sent to PLC with the data types configured in the memory
address part (that is X, B, W, D and L) of the PLC point name. After receiving
the responses, the ML Server converts it to the data type configured after #.
If no data type is configured in the PLC point name (that is no # part), by
default the corresponding basic data type is used by the ML Server. For
example, if the PLC point is configured as ML01.%MW90$COS, then it would
be assumed as ML01.%MW90$COS#WORD.

The following table contains a list of examples for Direct Variable:


Table 4.3-7: Examples of Direct Variable
Direct Variable
Note: In the following examples, ML01 is a ML200-IEC PLC, ML02 is a ML200NonIEC PLC and ML03 is a ML100R PLC. The bit / word positions are 0-based.
Examples

st

rd

ML01.%MB105$CON This denotes the 1 Byte of the 53 Word in

the Internal memory area of PLC ML01. Continuous Read / Write is


used for communication with PLC.
st

rd

ML01.%IW2.3.1$TB#INT This denotes the 1 word in 3 slot of

Base2 in the Input memory area of PLC ML01. Timer Based


command is used for getting values from the PLC. The data is
converted by ML Server and available as a signed integer value on
the Experion side.

102

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Direct Variable
Note: In the following examples, ML01 is a ML200-IEC PLC, ML02 is a ML200NonIEC PLC and ML03 is a ML100R PLC. The bit / word positions are 0-based.
th

st

nd

ML01.%QX1.2.15$COS This denotes the 15 Bit in 1 word in 2

slot of Base1 in the Output memory area of PLC ML01.


ChangeOfState command is used for getting values from the PLC
and the Device Area Write command is used for writing values into
PLC.
th

ML01.%RD80#REAL This denotes the 80 double word (that is

160th and 161st words) in R memory area of PLC ML01. The default
Device Area Read/Write command is used for communication with
the PLC. The data is converted by ML Server and available as a
decimal (or REAL) value on the Experion side.
th

st

nd

ML02.%KL95$COS - This denotes the 380 (=95*4), 381 , 382


rd

and 383 words of F memory area in PLC ML02. The Change Of


State command is used for getting values from PLC and the Device
Area Write command is used for writing values into PLC.
th

th

ML02.%FX093$TB This denotes the 5 Bit in 11 Word of F

memory area in PLC ML02. The Timer Based command is used for
getting values from PLC and the Device Area Write command is
used for writing values into PLC.
th

th

ML02.%UW40$DEV This denotes the 0 Word in 10 Slot of Base

0 (equivalent to U0.10.0) of U memory area in PLC ML02. The


Device Area Read/Write command is used for communication with
PLC.
th

st

ML02.%LD10 This denotes the 20 (=10*2) and 21 words of L

memory area in PLC ML02. The default Device Area Read/Write


command is used for communication with PLC.
th

th

th

ML02.%PL34 This denotes the 136 (=34*4), 137 , 138 and


th

139 word of P memory area in PLC ML02. The default Device Area
Read/Write command is used for communication with PLC.
st

th

ML03.%QX5.6.1 This denotes the 1 Bit in 6 slot of Base 5 in the

Output memory area of PLC ML03. The default Continuous


Read/Write command is used for communication with PLC.
th

st

ML02.%PX10$SEP This denotes the 10 Bit of 1 Word in the P

memory area of PLC ML02. Separate Read/Write command is used


for communication with PLC.
ML01.%MX10A$SEP This is not a valid address because

Hexadecimal digit A is not allowed in the Direct Variable format.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

103

4. Configuration
4.3 Configuring ML Server using Quick Builder

Named Variable
The following figure depicts the Named Variable format:

Figure 4.3-2: Named Variable


Format: @<user-defined variable>#<DataType>
ATTENTION

User-defined variables can have a maximum length of 16 alphanumeric


characters.

It is always prefixed with @.

The default data type for a named variable is WORD.

The only command available in the named variable format is SEP


read/write and therefore it is not part of the Point format. If any other
command is configured, it is ignored.

The data type configured in the PLC Point name must match with the
data type configured for the variable in Softmaster. If the data type does
not match, the PLC returns an error. For instance, in the previous
example, if VAR23 is not defined as a BOOLEAN variable in Softmaster,
an error is returned by PLC.

The following table lists the format and examples of Named Variables supported in
ML100R:
Table 4.3-8: Named Variable supported in ML100R
Named Variable
Note: In the following examples, ML03 is a ML100R PLC. The bit / word positions are
0-based.
Examples

ML03.@OUTPUT_1#WORD This denotes the WORD variable

OUTPUT_1 in PLC ML03.


ML03.@VAR23#BIT This denotes the BIT variable VAR23 in PLC

ML03.
104

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder

Device Variable
The following figure depicts the Device Variable format:

Figure 4.3-3: Device Variable

PLCID: This refers to the PLC. It is a two digit number ranging from 01 through 99
and always prefixed by ML. This must be configured in ML Server Configuration
Tool.

MemoryAddress: This refers to the address within a memory area where PLC
information is stored.

Format: <MemoryArea><Offset> (U, I and Q memory areas have a special


format)

Note: <Offset> represents the word offset address of the memory location in
PLC.

CommandType: This refers to the command that must be used for reading/writing
data from/to PLC by ML Server. For more detail on command types, see Table 4.3-6

DataType: This refers to the PLC data type. The default data type is WORD. For
more details about available data types for ML100R and ML200, see Table 4.3-4.

The following table lists the format and examples of Device Variable supported in
ML200:
Table 4.3-9: Example of Device Variable format in ML200
Device Variable
Note: In the following examples, ML01 is a ML200-IEC PLC and ML02 is a ML200NonIEC PLC.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

105

4. Configuration
4.3 Configuring ML Server using Quick Builder
Device Variable
Examples

ML200-IEC Examples:
th

th

ML01.M0020F$CON#BIT This denotes the 15 Bit of 20 word in

M memory area of PLC ML01. The Continuous Read/Write


command is used for communicating with the PLC.
th

th

ML01.R0004$TB#REAL This denotes the 4 and 5 Words in R

memory area of PLC ML01. The TimerBased command is used for


getting values from the PLC and the Device Area Write command is
used for writing values into PLC The value is converted to REAL by
ML Server and therefore available as a decimal value in Experion.
th

ML01.W0040 This denotes the 40 Word in W memory of PLC

ML02. The default Device Area Read/Write command is used for


communication with the PLC.
ML200-NonIEC Examples:
th

th

ML02.M6$CON#BIT This denotes the 6 Bit of 0 word in M

memory area of PLC ML02.


ML02.N24$CON#WORD This denotes the 24th Word in N memory

area of PLC ML02.


st

rd

ML02.U2.3.1$CON#INT This denotes the 1 Integer in 3 Slot of

Base 2 in U memory of PLC ML02.


Note: In the previous CON examples, to read/write this information
from/into the PLC, the Continuous Read/Write command is used.
th

ML02.Z108$COS#WORD This denotes the 108 Word in Z

memory area of PLC ML02.


th

st

ML02.L41F$COS#BIT This denotes the 15 Bit of 41 Word in L

memory area of PLC ML02.


ML02.D405$COS#LWORD This denotes the Long Word formed

using 405th to 408th Words in D memory area of PLC ML02.

Note: In the previous COS examples, to read this information from the
PLC, the Change of State command is used, but for writing information
into the PLC, the Device Area Write command is used.
nd

ML02.C22$TB#WORD This denotes the 22

Word in C memory

area of PLC ML02.


th

th

ML02.C7$TB#BIT This denotes the 7 Bit of 0 Word in C

memory area of PLC ML02.

106

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Device Variable
ML02.F94$TB#DINT This denotes the Double Integer formed

using 94th and 95th words in F memory area of PLC ML02.

Note: In the previous TB examples, to read this information from the


PLC, the Timer Based command is used, but for writing information into
the PLC, the Device Area Write command is used.
th

th

ML02.M28$DEV#BYTE This denotes the 0 byte of 28 word in M

memory area of PLC ML02.


ML02.R22$DEV#DINT This denotes the Double Integer formed

using 22nd and 23rd words in R memory area of PLC ML02.

Note: In the previous DEV examples, to read/write this information


from/into the PLC, the Device Area Read/Write command is used.
th

ML02.T300#BIT This denotes the 300 Bit in T memory area of

PLC ML02.
th

rd

ML02.P3A#BIT This denotes the 10 Bit of 3 Word in P memory

area of PLC ML02.


ML02.T983#LINT This denotes the Long Integer formed using

983rd to 986th words in T memory area of PLC ML02.

Note: In the previous examples, because there was no command


configured, by default the DEV command is used. Therefore, to
read/write this information from/into the PLC, the Device Area
Read/Write command is used.
th

ML02.P105$SEP#WORD This denotes the 105 Word in P

memory area of PLC ML02.


th

ML02.M11$SEP#INT This denotes the 11 Integer in M memory

area of PLC ML02.


th

th

th

ML02.K117$SEP#BIT This denotes the 117 Bit (5 Bit of 7

word) in K memory area of PLC ML02.


Note: In the previous SEP examples, to read/write this information
from/into the PLC, the Separate Read/Write command is used.

ATTENTION
It is important to note that the offset configured for the SEP
command is used in the same way as the offset configured
for the Direct Variable format. That is the offset does not
indicate the word position, but it indicates the offset with
respect to the data type itself.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

107

4. Configuration
4.3 Configuring ML Server using Quick Builder

Defining data formats


Data formats are defined for converting PLC field values into engineering values.
Experion provides default data formats for converting these field values. You also can
define customized data formats.
REFERENCE - EXTERNAL
For more details on user-defined data formats, see Experion Knowledge
Builder > Experion PKS R300 > Configuration > Server and Client
Configuration Guide > Understanding and configuring points > Advanced
point configuration > Creating user-defined data formats.

To create a customized data format, perform the following:


TIP
The following is a sample procedure explaining how to create a user-defined
data format.
Step

108

Action

Select System Configuration menu from the Experion Station.

Select User-Defined Data Formats in Application Development.


MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

R300
6/08

Action

Click an empty data format row.

Enter data format name in Name.


MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

109

4. Configuration
4.3 Configuring ML Server using Quick Builder
Step

Action

Select data type from Data Type drop-down list. For Example INT2.

Enter the minimum and maximum field values in Minimum and Maximum.
For Example 0 and 16000 respectively.

Enter Field value and corresponding Converted value for Point 1 and Point
2 to define the conversion. For Example 0 and 1000 respectively.
Example: If the field value is 8000, the corresponding converted value must
be 500.

ATTENTION
While configuring the Points in Quick Builder,

If 100% Range value is

Converted value ranges from

1000

0 to 1000

100

0 to 100

The following table describes some sample field values and their corresponding
engineering values in Experion:
Data Format

Input
Range
PLC

110

Field
value

PLC
value

Engineering
value
(Converted
value)

2.5
volts

8000

500

2 volts

4000

250

Engineering

0 to 5
volts

Minimum: 0

Point 1: 0

Maximum: 16000

Point 2: 1000

1 to 5
volts

Minimum: 0

Point 1: 0

Maximum: 16000

Point 2: 1000

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.4 Downloading Quick Builder Points to Experion

4.4

Downloading Quick Builder Points to Experion

Overview
After adding and configuring items, you must download all or part of your project to the
server database. The Channel, Controller or Point that have been imported or manually
created in Quick Builder must be downloaded to Experion server database before you can
use them.
The items are downloaded in the following sequence:

MasterLogic Channel.

MasterLogic Controller(s).

Analog/Status Point(s).
REFERENCE EXTERNAL
For more details on downloading items to Experion, see Experion Knowledge
Builder > Experion PKS R300 > Configuration > Quick Builder Guide >
Managing items > Downloading items.

After downloading, the MasterLogic Channel and MasterLogic Controller are enabled in
the Experion Station using View > System Status > Channels.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

111

4. Configuration
4.5 Verifying the Configuration

4.5

Verifying the Configuration

Overview
After downloading Points to the Experion, enable the Channel and Controller from the
Experion Station.
After enabling the Channel and Controller, the following events occur:

The MasterLogic server starts communicating with the PLCs using the configuration
information from the Experion server database. A connection is established with the
ML Server based on the Channel configuration.

ML Server establishes communication with the PLCs using the IP Address & other
PLC specific details configured using the configuration tool.

The ML Server reads data from the PLC and transfers the values to the
corresponding parameters in Experion Points. The data values written into these
parameters are written into the appropriate memory locations in the PLC.

Based on the status of the PLCs, the alarms/events are raised by the ML Server, in
the Experion.

The data, alarms raised by the PLCs and change of event in the PLCs can be
monitored from the Experion Station.

You must ensure that PLCs are configured with correct IP address and there is a
successful communication between the PLCs and the ML Server as represented by the
Channel status.
Verifying data exchange between PLC and Experion
The Point Detail display in the Experion Station helps in monitoring the online status of
each parameter for a particular Point and the data exchange between the PLC and the
Experion server.

112

The parameter values set in the Point Detail display reflects in the Address
monitoring window of the SoftMaster tool.

The parameter values set in the Address monitoring window reflects in the Experion
station.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.5 Verifying the Configuration

The following procedure is an example to verify data exchange between the PLC and the
Experion:
Step

Action

Configure the PLC information using the ML Server Configuration Tool.

Ensure that the ML16K user defined data format is configured in Experion.

Configure the MasterLogic Channel, MasterLogic Controller, Status and


Analog Point in the Quick Builder and download to the Experion Server.
Note: Consider a standard Analog Experion Point configured in Quick Builder
as follows:
PV source address as ML01.%MW10$DEV ML16K
SP source and destination address as ML01.%MW80$DEV ML16K

The user-defined data format ML16K is used here to convert between the
field value (0 to 16000) and the engineering value (0 to 1000).
4

Download the MasterLogic Channel, MasterLogic Controller and Point to the


Experion Server.

Enable the Channel from the Channel Summary page in the Station.
The MasterLogic Server starts communicating with the PLC using the

configuration information.
The MasterLogic Server reads data from the PLC and transfers the values

to the corresponding parameters in Experion Points. The data values


written into these parameters are written into the appropriate memory
locations in the PLC.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

113

4. Configuration
4.5 Verifying the Configuration
Step

Action
Assume that the data value stored in the 10th word of M memory area is
8000. The following image shows the value displayed in the Address
Monitoring window of the SoftMaster tool:

114

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.5 Verifying the Configuration
Step

Action
The raw value (8000) is converted to the engineering value (500) because of
the ML16K data format and updated in the PV parameter. This value is
displayed in the Station as shown in the following image:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

115

4. Configuration
4.5 Verifying the Configuration

116

Step

Action

Change the value of M0010 memory location through the Change Current
Value dialog box in Address Monitoring Window as shown in the following
image:

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.5 Verifying the Configuration
Step

Action
The raw value (12000) is converted to the engineering value (750) because
of the ML16K data format and updated in the PV parameter. This value is
displayed in the Station as shown in the following image:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

117

4. Configuration
4.5 Verifying the Configuration
Step
7

118

Action
Set a value 250 to SP parameter in the Station as shown in the following
image:

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

4. Configuration
4.5 Verifying the Configuration
Step

Action
The engineering value (250) is converted to the raw value (4000) and
updated in the %MW80 memory location. This can be observed in the
Address Monitoring window of the SoftMaster tool as shown in the following
image:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

119

4. Configuration
4.6 Adding new PLC dynamically

4.6

Adding new PLC dynamically

Overview
The PLCs can be added dynamically in the ML Server Configuration tool when the ML
Server is running.
To add a new PLC dynamically when the ML Server is running, perform the following
steps:
Step

Action

Installing one or more Ethernet modules (EUTB/FENET) in the new PLC.


Connecting the Ethernet modules to Experion server through Ethernet
cables.

Configuring the IP Addresses of these modules using the Softmaster tool.


Ping the IP Address from the Experion server for verifying the communication
between the new PLC and the Experion server.

Add a new PLC as explained in Adding a new PLC.

Configure the PLC information for the new PLC as explained in Configuring
ML Server using Configuration Tool.

Build the points for the new PLC as explained in Using PointBuild Utility.

Configure a MasterLogic Controller for the new PLC as explained in


Configuring a MasterLogic Controller. Configure an Experion Point for the
new PLC as explained in Configuring an Experion Point (Analog and Status).
Download the controller and the points.

The status of data communication for the new PLC can be viewed in the
graphics pages.
To view the PLC status in the custom graphics pages, the Station must be
closed and re-opened.

120

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.1

Overview

Experion displays
The Experion standard Station displays and the Custom displays are used for monitoring
the PLC status.
The following are the Experion standard Station displays:

Channel Summary page

Point Detail display

The following is the Experion Custom display:

PLC System Status display


ATTENTION
To view the PLC information in the graphics pages, ensure that the points
corresponding to the PLCs are configured using the Point Build utility.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

121

5. Monitoring PLC status from Experion displays


5.2 Building a Point in Experion corresponding to the PLC

5.2 Building a Point in Experion corresponding to the


PLC
Using PointBuild Utility
The information required by the Experion Graphics is stored in the User Defined
parameters of Experion points configured for each PLC. These PLC level Points are built
using the PointBuild Utility. If these points are not built, then the data communication
between the ML Server and Experion does not appear in the Experion custom displays.
To build Points for the configured PLCs, perform the following steps:
Step
1

Action
Configure the PLC information using the ML Server Configuration Tool, for
each PLC with which the ML Server must communicate. Ensure that EPKS
Asset Name is configured in the tool.

REFERENCE INTERNAL
For more information about configuring the PLC information, see
Configuring PLC Information.
2

122

Click Start > Programs > Honeywell MasterLogic Server > PointBuild
Utility.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.2 Building a Point in Experion corresponding to the PLC
Step
3

Action
Click Browse to change the point build file path. The output file with
extension .out is created in the same path.
Note: The default path and filename appears in Point Build File Name.
The PLCID, PLCName, PLCType, Asset Name of each PLC configured is

displayed in columns. The PointExists column displays No if there is no


Point built in the Experion corresponding to the PLC. If a point already
exists, then it displays Yes.
4

Select each PLC or click Check All to select all the PLCs.

Click Build Point.


The output files with extension .out and .pnt are created.

For example:
The MLPLC_StatusPoints.pnt file is created. This file contains the

information about the Points to be built in Experion corresponding to the


selected PLCs.
The MLPLC_StatusPoints.out file shows the status of Point building.
After building the Points successfully, the status of PointExists changes to

Yes as shown in the following figure:

7
R300
6/08

Click Search to check the existence of Points for the local Experion server.
MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

123

5. Monitoring PLC status from Experion displays


5.2 Building a Point in Experion corresponding to the PLC
Step

Action
If there is an error during point building the following message appears:

124

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

5.3

Using Experion custom displays

PLC System Status Display


The PLC information is displayed in the Experion Station using custom displays.
The following are the three tabs available in the custom displays used for viewing the
PLC information:
Tab name

File name

Description

Config Info

MLPLC_Config.htm

This page displays the basic PLC


information and diagrammatic
representation of the modules with
base/slot information.

Status Info

MLPLC_Status.htm

This page displays the PLC status


diagnostics information.

Driver Info

MLPLC_Driver.htm

This page displays the ML Server


interface driver diagnostics information.

Config Info
The Config Info page is used for monitoring the base slot information of each PLC and
the status of communication between the PLC and the Experion server.
The following PLC information appears in the Config Info page:

R300
6/08

PLC Name

PLC ID

PLC Type

Base number

Last RTC time

Diagrammatic representation of the modules with base/slot information

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

125

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

To view the general PLC and base/slot information in the Experion display, perform the
following steps:
Step

126

Action

Ensure the Points corresponding to the PLCs are built using the PointBuild
utility.

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool and select the PLC.

Select EPKS Write and IO Read check boxes under Monitor using the ML
Server Configuration Tool.

Invoke the Experion Station.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step
5

Action
Enter MLPLC_Info.htm in the Command zone. Press Enter.
The following page appears:

Click Read PLC Information.


Note: This screen appears whenever the MasterLogic PLC system status
display is invoked in the Experion station for the first time. It may take a few
minutes to execute.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

127

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
The following page appears for ML 200:

128

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
The following page appears for ML 100R:

Select the name of a PLC from the PLC dropdown list.


The PLC ID, PLC Type, Base, IP Addresses and Last RTC Read Time are

displayed.
Note: All the fields in the page (except the PLC Name and Base Number)
are not editable. The IP Address indicated in green is the active IP Address.
8

Select base number from the Base dropdown list.


Note: Base 0 is selected by default.
The following information is displayed diagrammatically:
CPU status
Different slots of the selected base.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

129

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action

ATTENTION
If some of the IO Modules are not displayed properly, then edit
MLMonitor.xml as explained in Adding a new IO Module.
The following information appears in 3 columns in the lower part of the
window:
The Name column indicates the slot position and module name.
The Assigns Information column indicates the module information.
The Description column indicates the module description.

ATTENTION
The base slot information is not available for ML100R and not
displayed in the Config Info page.

Viewing RTC time in Config Info page


The PLC time must be synchronized with the Experion system time. The ML Server
reads the PLC time and compares with the Experion system time, based on the settings in
ML Server Configuration Tool. If there is a time difference, the PLC time is updated with
the Experion system time. The RTC time read from the PLC is displayed in the Config
Info graphics page.
The following figure depicts how the PLC time is synchronized with the Experion system
time:

130

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

To view the RTC time in the Config Info page, perform the following steps:
Step

Action

Click Start > Porgrams > Honeywell MasterLogic Server > Configuration
Tool and select the PLC.

Select EPKS Write under Monitor and Enable Read/Write under RTC using
the ML Server Configuration tool.

Enter SynchInterval under RTC.


Note: This indicates the time frequency for reading the RTC time from the
PLC. If this value is 0 then the RTC time is not read or written from/to the
PLC.

Enter Deadband under RTC.


Note: The PLC time is updated with the Experion system time, if the time
difference is equal to or greater Deadband (in seconds). If this value is 0 then
the RTC time is not written to the PLC.
The RTC time is displayed in the Config Info page as shown in the

following figure:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

131

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

Status Info
The Status Info page is used for monitoring the online status of each PLC, the ML
Server and the data exchange between the PLC and the Experion server.

The parameter value for the PLC status set in the xml files is used for updating the
PLC status information in the Experion graphics pages.

To verify the PLC status information updates in the Experion graphics pages, perform the
following steps:
Step

132

Action

Ensure the Points corresponding to the PLCs are built using the PointBuild
utility.

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool and select the PLC.

Select EPKS Write and Status Read check boxes under Monitor using the
ML Server Configuration tool.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action

The status of the CPU operation mode is updated in the Experion graphics

display.
4

Open MLPLC_Config.htm from the Experion Station and select the PLC for
which you want to view the status. See Config Info for more details.

Click Status Info tab.


The following page appears for ML 200:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

133

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
CPU Operation Mode
RUN

CPU operation is in run mode.

STOP

CPU operation is in stop mode.

ERROR

CPU operation is in error mode.

DEBUG

CPU operation is in debug mode.

Last Mode Change By


KEY

Operation mode change by key.

Local PADT

Operation mode change by local SoftMaster.

Remote PADT

Operation mode change by remote SoftMaster.

Remote Comn.

Operation mode change by remote


communication module.

Local / Remote
Local

Operation mode change only by mode key.

Remote

Remote mode operation.

Online Editing
Download

Revised program stand-by when revising on the


run.

Internal Proc

Revising on the run during internal processing.

Done

Revising on the run is completed as normal.

Error

Revising on the run is completed as normal.

Miscellaneous Flags

134

Forced Input

Force on/off by input points.

Forced Output

Force on/off by out put points.

Skip I/O

Designated Input/output module for stopping


trouble check and data refresh.

Fault Mask

Designated Input/output module for proceeding


operation even in time of trouble.

Monitor Mode

External monitor running for program and


variables.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
CPU MODBUS Port

CPU Mode bus slave service is active.

Stop Instruction

Stop after scan completion by STOP function


during RUN mode operation.

ESTOP Instruction

Immediate stop by ESTOP function during RUN


mode operation.

Scan Time (Milli Seconds)


Maximum

Maximum PLC CPU scan period.

Minimum

Minimum PLC CPU scan period.

Current

Current PLC CPU scan period.

CPU Error Status

R300
6/08

Configuration Error

Normal operation is impossible because of the


CPU module self-diagnosis error.

Module Detach Error

When actual module and each slot I/O


configuration parameter are not matched.

Digital I/O Module Error

When each slot modules input/output module


cannot normally read and write this error is
displayed.

External Equipment

External equipments serious trouble written in


ANC_ERR[n] is shown by user program.

Module Type Mismatch

When actual module and each slot I/O


configuration parameter are not matched.

Module Fuse Blown

When each slot module with fuse is short, this


error is displayed.

Special / Comn. Module

When interface does not work because of


special or communication modules malfunction
its error is displayed.

SCAN Watchdog Error

When scan watchdog time is exceeded because


of its parameter.

Basic Parameter Error

Basic parameter error is checked and displayed.

I/O Parameter Error

When each slot module s input/output module


cannot normally read and write this error is
displayed.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

135

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
Comn. Module
Parameter Error

Communication module parameter error is


checked and displayed.

Program Code Error

User program error is checked and displayed.

Base Power Error

Base power error.

CPU Warnings
RTC Error

RTC data error.

Task Collision

An identical task is double-requested during


user program running; the collision with the
previous task is displayed.

Fixed Cycle Scan Error

If scan time is longer than the designated fixed


cycle, it becomes ON.

External Equipment

When external equipments warning written in


ANC_WB[n] by user program, its trouble is
displayed.

Data Backup Error

Data memory is destroyed because of back-up


error and thus, restart program (hot or warm)
revision is impossible. Regarding cold restart
running, this flag is possible to use for initializing
program and is automatically reset once
initializing program is completed.

Battery Failure

When battery voltage for user program and data


memory back-up is below the standard.

Log Memory Full

When PLCs log memory becomes full.

Communication Status Flags

136

HSL1

They are representative flags when high speed


link is impossible after checking each high
speed link error on high speed link Enabling
situation. If high speed link is disabled, it is
reset.

P2P1

They are representative flags when P2P running


is impossible after checking each P2P
parameter error on P2P Enabling situation. If
P2P is disabled, it is reset.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
The following page appears for ML 100R:

The CPU Type and OS Version (CPU firmware version) are displayed.

The PLC Status information is displayed in 5 different tabs.

R300
6/08

SYS State tab

Displays the PLC system operation status.

Slot Info

Displays the information for different slots.

PADT_CNF

Displays the PADT configuration information.

CNF_ER

Displays error messages and status of stopping the


operation.

CNF_WAR

Displays the warning flags with respect to quick


operations.

DOMAIN_ST

Displays the information on System software


configuration.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

137

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action

ATTENTION
The option of selecting another PLC is not available in Status Info
page. To view another PLCs status, select a PLC name from
Config Info page and click Status Info tab.
The CPU operation in run mode is displayed in the Experion graphics

display as shown in the following figure:

138

Click Stop button in the Softmaster tool or using the keys on the PLC,
change the CPU operation mode to stop.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action

The following message appears:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

139

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step
7

Action
Click Yes.
The CPU operation mode status is updated in the graphics display within

few seconds as shown in the following figure:

8
in the Softmaster tool or using the keys on the PLC, change the
Click
CPU operation mode to run.
The following message appears:

Click Yes.
The CPU operation mode status is updated in the graphics display within

few seconds as shown in the following figure:

140

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

R300
6/08

Action

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

141

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

Driver Info
The ML Server diagnostic parameter information appears in the Driver Info page. This
page is used for viewing the status of communication between the ML Server, PLC and
the Experion.
To view the ML Server diagnostics information, perform the following steps:

142

Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool and select the PLC.

Select EPKS Write check box under Monitor using the ML Server
Configuration tool.

Select ML Server from the left pane. Enter the frequency for General
Diagnostic and PLC Diagnostic under ScanPeriod of the ML Server tab.

Open MLPLC_Config.htm from the Experion Station and select the PLC for
which you want to view the Driver Diagnostics information. See Config Info
for detailed procedure.

Select Driver info tab.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Step

Action
The following page appears:

ATTENTION
The option of selecting another PLC is not available in Driver Info
page. To view another PLCs driver diagnostics, select a PLC name
from Config Info page and click Driver Info tab.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

143

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays

The following table lists the ML Server diagnostics parameters displayed in the graphics
page:
Parameter Name

Description

PLC General Parameters ML Server Parameters


ML Config XML Status

Indicates the status of MLConfig XML read.

ML Monitor XML Status

Indicates the status of MLMonitor XML read.

ML AppSettings XML Status

Indicates the status of MLAppSettings XML


read.

ML Server Start Time

Indicates the latest start time of the ML Server.

PSCommunication Status

Indicates the status of the communication


between the ML Server and Protocol Stack.

Main Response Thread Status

Indicates the status of ML Server main


response thread.

HCI CallBack Thread Status

Indicates the HCI call back thread Status

EPKS Commn Thread Status

Indicates the EPKS communication thread


Status

Main Response Queue Size

Indicates ML Server main queue size.

Current Static Request ID

Indicates the static Request ID assigned to the


command sent to PLC.

Current Dynamic Request ID

Indicates the dynamic Request ID assigned to


the command sent to PLC.

Number of Requests

Indicates number of requests sent to Protocol


stack in one second.

Number of Responses

Indicates the number of responses received


from Protocol stack in one second.

Diagnostics UDP Updated Time

Indicates the time when the Diagnostics related


EPKS UDP parameters were last written by ML
Server.

PLC General Parameters Protocol Stack Parameters


Engine Thread Status

Indicates the status of ML protocol engine


thread.

PLC General Parameters License Parameters

144

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Parameter Name

Description

Licensed Number Of PLCs

Indicates the number of PLCs that can be


communicated using the ML Server.

Licensed Number Of Points

Indicates the number of PLC points that can be


used for data communication across all the
PLCs.

Licensed Mode

Indicates whether the ML Server is running in


Demo or Permanent mode.

PLC Specific Parameters ML Server Parameters

R300
6/08

PLC Connection Status

Indicates the status of the connection between


the PLC and ML Server.

Request Thread Status

Indicates the status of the thread sending


requests to the Protocol stack.

Response Thread Status

Indicates the status of the thread processing


responses from the Protocol stack.

Monitor Thread Status

Indicates the status of the thread sending


requests on Status, Base slot, AD Module to the
Protocol stack.

Response Queue Size

Indicates the size of the response queue


holding the responses from the Protocol stack.

EPKS Write Queue Size

Indicates the queue holding the UDP values to


be written to the EPKS.

EPKS Alarm Queue Size

Indicates the queue holding the alarms to be


raised in EPKS.

Current Static Request ID

Indicates the static Request ID assigned to the


command sent to the PLC.

Current Dynamic Request ID

Indicates the dynamic Request ID assigned to


the command sent to the PLC.

Number of Requests Per Sec

Indicates the number of requests sent to


Protocol stack in a second.

Number of Response Per Sec

Indicates the number of responses received


from the Protocol stack in a second.

Number of EPKS Writes Per Sec

Indicates the number of EPKS UDP writes in a


second.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

145

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Parameter Name

Description

Number of EPKS Alarms/Events


Per Sec

Indicates the number of EPKS alarms raised in


a second.

Status UDP Updated Time

Indicates the time when the Status related


EPKS UDP parameters were last written by ML
Server

Base Slot UDP Updated Time

Indicates the time when the Base slot related


EPKS UDP parameters were last written by ML
Server

AD Module UDP Updated Time

Indicates the time when the AD Module related


EPKS UDP parameters were last written by ML
Server

Special Module UDP Updated


Time

Indicates the time when the Special Module


related EPKS UDP parameters were last written
by ML Server

Miscellaneous UDP Updated Time

Indicates the time when the Miscellaneous


EPKS UDP parameters were last written by ML
Server

Diagnostics UDP Updated Time

Indicates the time when the Diagnostics related


EPKS UDP parameters were last written by ML
Server

RTC Read UDP Updated Time

Indicates the time when the RTC read related


EPKS UDP parameters were last written by ML
Server

RTC Write Updated Time

Indicates the time when the RTC write related


EPKS UDP parameters were last written by ML
Server

PLC Specific Parameters Protocol Stack Parameters

146

Large Buffers Available

Indicates the number of large buffers


maintained by Protocol stack.

Small Buffers Available

Indicates the number of small buffers


maintained by Protocol stack.

Medium Buffers Available

Indicates the number of medium buffers


maintained by Protocol stack.

Request Queue Size

Indicates the size of the request queue


maintained by Protocol stack.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.3 Using Experion custom displays
Parameter Name

R300
6/08

Description

PS Request Thread Status

Indicates the status of thread that processes


requests in Protocol stack.

PS Response Thread Status

Indicates the status of thread that processes


responses in Protocol stack.

PS TB COS Thread Status

Indicates the status of thread that processes TB


COS responses in Protocol stack.

Last Response Received Time

Indicates the time of receiving last response


from the PLC socket.

Last Request Sent Time

Indicates the time of sending last request to the


PLC socket.

Last TB Response Received Time

Indicates the time of receiving last TB response


from the PLC socket.

Last COS Response Received


Time

Indicates the time of receiving last COS


response from the PLC socket.

Max Response Time (ms)

Indicates the maximum time taken to receive


response from PLC.

Min Response Time (ms)

Indicates the minimum time taken to receive


response from PLC.

Avg. Response Time (ms)

Indicates the average time taken to receive


response from PLC.

Last PLC Connected Time

Indicates the last time when protocol stack was


connected to PLC socket.

Last PLC Disconnected Time

Indicates the last time when protocol stack was


disconnected from PLC socket.

Last HB Sent Time

Indicates the last time when Heart Beat


message was sent to PLC.

Last Status Received Time

Indicates the last time when status response


was received from PLC.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

147

5. Monitoring PLC status from Experion displays


5.4 Using Experion standard Station displays

5.4

Using Experion standard Station displays

Channel Summary page


To enable the ML Channel through Channel Summary page, perform the following steps:
Step

Action

Invoke the Experion Station.

Select View > System Status > Channels.


The Channel Summary page appears.

148

Select the check box corresponding to the Channel to enable it.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.4 Using Experion standard Station displays

Point Detail display


To view Point Detail display, perform the following steps:
Step

Action

Invoke the Experion Station.

In the Station Command Zone, enter the name of the Point. Press F12.
The Point Detail page appears.

REFERENCE - EXTERNAL
For more information on Experion displays, see Experion Knowledge
Builder.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

149

5. Monitoring PLC status from Experion displays


5.5 Monitoring PLC displays from an Experion client system

5.5 Monitoring PLC displays from an Experion client


system
Overview
The PLC status can be viewed from an Experion client system using the PLC displays.
To view the PLC status from an Experion client system, perform the following steps:
Step

150

Action

The graphics pages and the xml files must be available in the client system
for viewing the PLC information in the client system. If the files are not
available, ensure to copy the graphics pages and xml files from the
installation path (typically C:\Program Files\Honeywell\Experion
PKS\Client\Abstract) to the client system in the same path.

The connection properties of the Experion Station must have the folder path
C:\Program Files\Honeywell\Experion PKS\Client\Abstract in the list. This
allows the viewing of PLC information in the client system.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.5 Monitoring PLC displays from an Experion client system
Step

Action

ATTENTION
To view the PLC status from an Experion client system, the points
need not be built using the Point Build utility.
3

R300
6/08

To invoke the PLC display pages, follow the procedures explained in Using
Experion custom displays.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

151

5. Monitoring PLC status from Experion displays


5.6 Bad quality items

5.6

Bad quality items

Overview
Experion Point parameters are configured in QuickBuilder with PLC Points for data
exchange between PLC and Experion. The quality of the Experion Point parameter
indicates the status of the data in PLC or the data communication with Experion.
MasterLogic-Experion integration enables the monitoring of analog input signal failures
such as transmitter failure or disconnection of input signal. All channels of all analog
input modules are constantly monitored for input signal failure. If the input signal fails,
all Experion points configured for this input channel is set to BADPV status for safer
control of the plant.
The BADPV setting is applicable for the following modules:
Module Type

Model#

Analog Input
module

2MLF-AV8A

Description
Voltage Input: 8 channel
DC 1 ~ 5V / 0 ~ 5V / 0 ~ 10V / 10 ~ +10V

2MLF-AC8A

Current Input: 8 Channel


DC 4 ~ 20mA / 0 ~ 20mA

2MLF-AD4S

Voltage/Current Input: 4 channel


Isolation between channels

Thermocouple
Input Module

2MLF-TC4S

RTD Input
Module

2MLF-RD4A

Temperature (T/C) Input, 4 Channel, Isolation


between channels
Temperature (RTD) Input, 4 channel

The following explains the two ways of setting quality for the Point parameter:

152

Setting quality for Channel disconnection in the field.

Setting quality for the item based on the PLC Read command responses.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.6 Bad quality items

Viewing bad quality item in Point Detail display


To view the bad quality for Analog Input modules data in the Point Detail display,
perform the following steps:

R300
6/08

Step

Action

Click Start > Programs > Honeywell MasterLogic Server > Configuration
Tool and select the PLC.

Select EPKS Write and IO Read check boxes under Monitor in the
configuration tool to view the IO module information in the Experion graphics
display. To view PLC status information in Experion graphics display, select
Status Read and Alarm Raising check boxes.

Consider an IO Module in Base 0 Slot 2 that is also an AD Module and


Special Module.

Configure the Input Range as 1~5V in the Softmaster tool. Ensure to write the
IO Module configuration to the PLC.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

153

5. Monitoring PLC status from Experion displays


5.6 Bad quality items
Step
5

Action
Configure a PLC Point as ML01.U02.06$DEV#WORD in Quick Builder and
download to the Experion server.

Note: This PLC point must be configured with address U02.02 for channel 0
and with address U02.06 for channel 4. ( .06 is derived by adding the base
.02 and the channel number.)

154

Enable the Channel containing the configured PLC Point.

Connect the input signal to Channel 4 (first Channel is 0) of the IO Module.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.6 Bad quality items
Step

Action
View the status of the data communication in the Station display.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

155

5. Monitoring PLC status from Experion displays


5.6 Bad quality items
Step
8

Action
Disconnect the input signal from Channel 4.
View the status of the data communication in the Station display.

Note: The previous example is for Channel 4. If you want to test with a
different channel in the IO module, ensure that the data item configured in
Experion is also changed appropriately.

156

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

5. Monitoring PLC status from Experion displays


5.6 Bad quality items
Step

Action
Alarm is raised corresponding to the disconnected channel.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

157

5. Monitoring PLC status from Experion displays


5.6 Bad quality items

158

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.1

Alarm integration

Types of Alarms
The following are the two types of Alarms raised by the ML Server:

PLC Status diagnostics Alarms These alarms are raised based on the current
PLC Status.

Error indicating Alarms / Messages Important errors that require immediate


attention are also raised as System Alarms. The other errors are raised as Messages.

The Asset configured in the PLC tab of the configuration tool, for that particular PLC, is
used while generating the Alarms/Events.
PLC Status Diagnostics alarms
After downloading Points to the Experion server, the ML Server starts receiving the
status data from the PLC at every configured interval (default is 10 seconds).
Alarms are raised based on the present PLC status. Another PLC level alarm is raised
corresponding to the PLC Point if any of the alarming conditions is active at that point of
time for the PLC. These alarms can be viewed in the Alarm Summary display of the
Experion Station.
ATTENTION
If one or more alarms are raised at the status bit level of a Point, the OP
parameter value of the Point is set ON and the corresponding alarm is raised
at the PLC level.

Error indicating Alarms / Messages


The important system level error messages such as PLC connection errors are raised as
System Alarms in Experion. The less important errors are logged as Messages. This
includes errors such as errors in point configuration, and so on.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

159

6. Alarms and Events integration


6.1 Alarm integration

Viewing PLC alarms in Experion Station


The Alarms are raised based on the present status of the PLC. A PLC level alarm is
raised corresponding to the PLC Point if any of the alarming condition is active at that
point of time for the PLC. These alarms are displayed in the Alarm Summary display in
the Experion Station.
160

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.1 Alarm integration

To view the PLC alarms in the Experion Station, perform the following steps:
Step

Action

Ensure the Points corresponding to the PLCs are built using the PointBuild
utility.

Select the Status Read and the Alarm Raising check boxes under Monitor
in the ML Server Configuration tool.

The operation mode of the CPU is RUN and therefore the Stop by Stop

Instruction flag is in OFF state as shown in the following figure:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

161

6. Alarms and Events integration


6.1 Alarm integration
Step

162

Action

Add the Stop Instruction to the Ladder logic program using the Softmaster
and write the program to the PLC.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.1 Alarm integration
Step

Action
After executing this instruction, the PLC CPU operation mode changes to

STOP.
The status of the flag indicating that CPU has stopped by Stop instruction

is updated in the Experion Status Info graphics display.

An Alarm is raised in the Experion Station.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

163

6. Alarms and Events integration


6.1 Alarm integration
Step

Action

Remove the Stop Instruction from the Ladder logic program using the

Softmaster and write the program to the PLC. Change the PLC CPU
operation mode to RUN.
The operation mode of the PLC CPU changes to RUN as indicated in the

status page.

164

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.1 Alarm integration
Step

Action

The Stop By Stop Instruction Alarm is cleared in the Experion Station.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

165

6. Alarms and Events integration


6.1 Alarm integration

Sample alarms raised in Experion

Figure 6.1-1: Sample alarms raised in Experion

166

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.2 PLC Events

6.2

PLC Events

Types of PLC events


The PLCs record the following four different types of events:
Event Type

Description

Buffer Size in
CPU

Error log

This log provides information about the errors


generated during the operation. The error code,
date, time and error details are saved in this file.

Shutdown log

This log provides the time details of ON/OFF


information of the system. The date, time and
the ON/OFF state are saved in this file.

1024 events

This saves the changed CPU mode information


and time in case there is a change in mode of
operation.

1024 events

This saves the operation history of system


events that occurr during operation.

2048 events

Mode log

System log

2048 events

Transferring PLC events to Experion/Log files


The Experion Station can be used for viewing a summary of the events.
To transfer the PLC events to Experion/Log file, the parameters in the PLC Logs must be
configured for each PLC using the ML Server Configuration Tool.
The following table lists the PLC Log parameters and their descriptions:
Parameter
Initial History

Possible Values
Enabled/Disabled

Description
If it is Enabled, the already existing

PLC events are transferred to Experion


server or Log files during startup of the
ML Server based on the LogToFile
and Events settings.
If it is Disabled, backlog events are not

transferred during the ML Server


startup. However the events that occur
when the ML Server is running are
transferred to Experion server or Log
files.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

167

6. Alarms and Events integration


6.2 PLC Events
Parameter

Possible Values

Description

Log To File

Enabled/Disabled

If it is Enabled, the PLC events are


transferred to log files. These log files are
stored in the same folder path used for
storing the ML Server log files.

Events

Enabled/Disabled

If it is Enabled, the PLC events are


transferred to Experion server as Sytstem
Events / Alarms.

ScanPeriod

It represents the interval in which the PLC


log is scanned for changes and events
are logged into the log file and /or
Experion server. If this is 0 then the
corresponding PLC log is not scanned for
changes at all.

After the ML Server starts communicating with the PLCs, depending on the values of
these parameters, the events are transferred to the Experion server or the Log files.
The backlog events are saved in the memory area of the respective PLCs. These events
can be viewed in the Softmaster, as shown in the following figure:

After restarting the ML server, these events are transferred to the Experion server or log
files based on the PLC log parameters settings. To get the backlog of the PLC logs into
Experion, the Initial history option could be enabled.
To view a summary of events, select View > Events > Event Summary from the
Experion Station Display. The following figure depicts the list of events viewed from the
Experion Station:

168

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.2 PLC Events

The following figure depicts how the PLC events are transferred to Experion server and
are saved in the log files:

Figure 6.2-1: Summary of Events


R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

169

6. Alarms and Events integration


6.3 Sequence of Events

6.3

Sequence of Events

Raising SOE
The sequence of events (SOE) can be logged based on the value of some status indicating
bits in the PLC. These bits are referred using the memory address. Each status bit refers
to particular information about the PLC. A special command called SOE can be used for
configuring the memory addresses of these bits. The SOEs are timestamped by PLC. The
resolution of the SOE is 5 milliseconds.
After downloading Points to the Experion server, the ML Server starts receiving the
status data from these memory addresses within the PLC. The SOE Information
configured in SOE tab of the configuration tool, indicates if an SOE needs to be raised
depending on the bit value stored in the memory address. These SOEs can be viewed
from the SOE Summary display in the Experion Station.
Parameter

Description

Memory
Address

This indicates the PLC memory area address for


which the SOE needs to be raised.

Option

This indicates the condition for raising the SOE. The


possible values are:
1 SOE is raised when value of the memory address
changes from 0 to 1
0 SOE is raised when value of the memory address
changes from 1 to 0
C SOE is raised when value of the memory
address changes either from 0 to 1
F SOE is not raised for any value changes

Description

170

The Description to be used as the SOE message


text.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.3 Sequence of Events

Viewing SOE alarms in Experion Station


To view the SOE alarms in the Experion Station, perform the following steps:
Step
1

Action
Configure the SOE information for a particular PLC, using the ML Server
Configuration tool.

The Variable Monitoring Window of the Softmaster tool is used for

changing the value of the memory address M0010F.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

171

6. Alarms and Events integration


6.3 Sequence of Events
Step

Action

Double-click Value.
The Change Current Value dialog box appears.

The memory address Set value is changed to On.

172

Click OK.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

6. Alarms and Events integration


6.3 Sequence of Events
Step

Action
The memory address value is changed to 1 (On) as shown in the following

figure:

The SOE raised can be viewed in the Experion Station.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

173

6. Alarms and Events integration


6.3 Sequence of Events

Configuring SOEs using Quick Builder


The SOEs for the PLCs can be set during PLC Point configuration in Quick Builder.
Consider a Point ML01.M0010F$SOE#BIT configured in Quick Builder. The SOE for
this Point is raised in the SOE summary display, if the same memory address is
configured as a SOE in the ML Server Configuration tool also. The SOE command
configured in the Point is executed as a COS command.
ATTENTION

174

If a memory address is not configured in a Quick Builder point, then only


a SOE is raised in Experion SOE summary based on the SOEOption.

If a Quick Builder point is also configured corresponding to the memory


address, then the point value is updated in the configured Experion point
parameter and also in the SOE being raised in Experion.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.1

Configuring ML Server using XML files

Overview of XML files


The XML files can be used for configuring advanced ML Server information.
ATTENTION
Honeywell recommends using the ML Server Configuration Tool for
configuring the PLC information for ML Server. The XML files must be used
only for configuring the advanced ML Server information.

CAUTION
The XML files contain critical parameters used for fine-tuning of the ML
Server. Incorrect configuration of these parameters could adversely affect the
performance of the MasterLogic-Experion integration. Therefore, Honeywell
recommends that you retain the default values for the critical parameters.
However, if you want to reconfigure the critical parameters, understand the
purpose of each parameter and how it works before changing the
configuration.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

175

7. Advanced configuration of ML Server


7.1 Configuring ML Server using XML files

The following table lists the XML files available for configuring the PLC information:
MLConfig.xml

This file is used for configuring the PLC specific settings.


The ML Server reads the PLC IP Addresses and PLC type

to communicate with the respective PLCs.


Various features of ML Server such as Alarm raising and

transferring PLC logs as events can also be controlled at a


PLC level by configuring some settings in this XML file.

REFERENCE INTERNAL
For more information on parameters of MLConfig.xml
file, see Configuring ML Server parameters in
MLConfig XML.
MLMonitor.xml

This file acts as common settings file for the ML Server and

the Graphics.
The ML Server updates the PLC information into Experion

Point parameters based on this xml file settings. The


Graphics reads and uses these Experion Point parameters
for the display.
Status level alarms, Base Slot and IO Module parameters,

Diagnostic parameters can be configured in this xml file.

REFERENCE INTERNAL
For more information on parameters of
MLMonitor.xml file, see Monitoring ML Server
parameters in MLMonitor XML.
MLAppSettings.xml

This file is used for configuring the ML server application

settings.
This contains some important configurations such as

Commands and memory areas supported by the PLCs,


General ML Server and Protocol log settings, and so on

REFERENCE INTERNAL
For more information about parameters of
MLAppSettings.xml file, see Configuring ML Server
Application Settings.
MLSOEConfig.xml

This file is used for configuring the SOEs for the PLCs

configured in MLConfig XML.

176

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.1 Configuring ML Server using XML files

REFERENCE INTERNAL
For more information about parameters of
MLSOEConfig.xml file, see Configuring PLC SOEs in
MLSOEConfig XML.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

177

7. Advanced configuration of ML Server


7.2 ML Server features configured using xml files

7.2

ML Server features configured using xml files

Overview
The XML files are used for configuring the following ML Server features:

7.3

Alarms

SOEs

Experion User Defined Parameters

Bad quality items

Adding new IO Module

Alarms

Configuring alarms in MLMonitor.xml


Alarms can be configured either at the PLC level or at bit level. Configuring alarms at the
PLC level becomes the default alarm setting for all the bits. But when the alarms are
configured at bit level, they override the alarms configured at the PLC level and the
alarms are raised based on the alarms set at the bit level.
To configure alarms, the following parameters are configured in the MLMonitor.xml file:

178

Priority denotes the severity of the alarm. The different values that can be set to
priority are:

3 Urgent

2 High

1 Normal

0 Low

Alarm, indicates when the alarm must be raised. The different values set to alarm
are:

1 If the bit value is 1, then raise an alarm.

0 If the bit value is 0, then raise an alarm.

C If the bit value changes from 0 to 1 or 1 to 0, then raise an alarm. In this


case, the Alarms do not return to normal state at all.

F This denotes that no alarm is raised for this bit value. This is the default
value for alarm setting.
MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.3 Alarms

Configuring alarm settings at PLC level


To configure alarm settings at the PLC level, the Priority and Alarm attributes of
PLCInfo > AlarmInfo tag is configured in the MLMonitor.xml file.
The following code snippet depicts how an alarm is configured at the PLC level:

The XML snippet depicts the following:

Alarm = F indicates that by default, an alarm is not raised for the status bits.

Priority = 3 indicates that the default priority level is Urgent.

Value0ShapeIndex represents the default color indication of the PLC status for the
bit value 0. (1 Black, 2 Red, 3 Green. These color LEDs are indicated in the
MLPLC_Status graphics page)

Value1ShapeIndex represents the default shape index for the bit value 1.

This indicates that if there are no specific settings for any of the status bits, then the
default settings are used for that status bit.
Configuring alarms at bit level
To configure alarms at bit level, the Priority and Alarm attributes of PLCInfo >
AlarmInfo > Bit tag is configured in MLMonitor.xml file.
The following code snippet depicts how an alarm is configured at the bit level:

The code snippet depicts the following:

Alarm = 1 shows that an alarm is raised when the value of 96th status bit is 1.

Desc = CPU configuration error indicates the description of the alarm displayed
in the alarm summary display.

ParameterToUpdate = CNF_ER_CPU_ER indicates the name of the Experion


parameter that is updated with the value of this bit. The 96th bit value is written to
this parameter.

The alarm raised because of this alarm setting is shown in Figure 6.1-1.
R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

179

7. Advanced configuration of ML Server


7.3 Alarms

ATTENTION
To configure alarms for ML100R in MLMonitor.xml file, configure the Alarm
and Priority parameters of PLCInfo100 > AlarmInfo100 tag.

180

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.4 SOEs

7.4

SOEs

Configuring SOE in MLSOEConfig.xml


The SOE can be configured either at the PLC level or at the individual memory address
level. Configuring SOE at the PLC level becomes the default SOE setting for all the
memory addresses within that PLC. But when the SOEs are configured at the memory
address level, they override the SOEs configured at PLC level and the SOEs are raised
based on the settings at the memory address level.
To configure SOEs, the following parameter is configured in the MLSOEConfig.xml file:

SOEOption, indicates when SOE must be raised. The different values set to this
parameter are:

1 If the bit value in the memory address is 1, an SOE is raised.

0 If the bit value in the memory address is 0, an SOE is raised.

C If the bit value in the memory address changes from 0 to 1 or 1 to 0, a SOE


is raised.

F This denotes that no SOE is raised for this bit value.

Configuring SOE settings at PLC level


To configure SOE settings at the PLC level, the SOEOption attribute of SOEInfo tag is
configured in the MLSOEConfig.xml file.
The following code snippet depicts how an SOE is configured at the PLC level:

The code snippet depicts the following:

SOEOption = 1 indicates that by default an SOE is raised when the value of any
configured memory address is 1.

DataType = BIT indicates the data type of the value stored in the memory
address.

This indicates that if there are no specific settings for any of the memory addresses, then
these default settings apply for that memory address.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

181

7. Advanced configuration of ML Server


7.4 SOEs

Configuring SOEs at memory address level


To configure SOEs at the memory address level, the SOEOption attribute of the
SOEInfo > SOE tag is configured in the MLSOEConfig.xml file.
The following code snippet depicts how an SOE is configured at the memory address
level:

The code snippet depicts the following:

182

MemoryAddress = M0010F, shows that an SOE is raised based on the value of


the memory address F0010F.

SOEOption = 0, indicates that an SOE is raised when the value of the memory
address is 0.

Description = Boiler Unit turned ON., indicates the description of the SOE
displayed in the SOE Summary display.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

7.5

Experion User defined parameters

Overview
After configuring and downloading the Points, ML Server starts communicating with the
PLCs. During this communication ML Server periodically reads the PLC information
like status, base-slot, AD module and Special module. The information is updated in the
Experion UDP parameters configured using the MLMonitor.xml and MLConfig.xml
files.
REFERENCE - INTERNAL
For more information on Experion UDP parameters, see Monitoring ML
Server parameters in MLMonitor XML.

The following PLC information is updated in the Experion UDP parameters:

PLC Diagnostics information

Base-Slot information

IO Module information

AD Module information

Special Module information

Time Synchronization between PLC and EPKS

ML Server diagnostics information

Configuring PLC Status information in MLMonitor.xml


The ML Server communicates with PLCs and periodically reads the status information.
To view PLC status information in the Experion graphics display set StatusReadEnable
and EPKSWriteEnable to Yes.
The status information is interpreted at a bit level. These status bit values are written to
the user defined parameters (UDP) in EPKS. The bit ID and the EPKS parameter are
mapped in the MLMonitor.xml using PLCInfo > AlarmInfo > Bit tag.
The following code snippet depicts the mapping of a particular bit to the respective
EPKS UDP:

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

183

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

From the previous snippet, the 96th bit value of the PLC status information is written to
CNF_ER_CPU_ER, the EPKS parameter. The description of the parameter is provided
in Desc. The alarm corresponding to the parameter is also raised using the setting
Alarm=1 and Priority=3.
Note: These settings are also used for viewing the PLC status in the graphics display.
Configuring Base-Slot Information in MLMonitor.xml
The Base Slot information read from the PLC are written to the EPKS parameters using
MLMonitor >PLCInfo > BaseSlotInfo tag settings defined in MLMonitor.xml.
The following xml snippet depicts how the bit value is mapped to EPKS UDP:

From the previous example, the number of slots in Base 0 is written to the EPKS
parameter B0NumSlots. The value corresponding to the module in Slot 0 is written to
the EPKS parameter B0S0. The total number of bases is written to the EPKS parameter
NumBases.
ATTENTION
These settings are also used for viewing base slot information in the Graphics
display. The base slot information is supported only in ML200.

Configuring IO Module Information in MLMonitor.xml


The IO Module information configured in MLMonitor.xml is used for the following
purposes:

Diagrammatically representing the base-slot information in the Graphics display.

Identifying the AD Module and updating the corresponding EPKS UDP parameters.

Identifying the Special Module and updating the corresponding EPKS UDP
parameters.

To view IO Module information in the Experion graphics display, set IOReadEnable


and EPKSWriteEnable to Yes. The IO Module information is configured using
MLMonitor > PLCInfo > IOModuleInfo tag in MLMonitor.xml.

184

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

The following xml snippet explains the IO Module configuration:

Suppose the Module ID=5A40 is read from the EPKS UDP parameter B0S1
configured in base-slot information.

The Name and Description parameter indicate the module name and description.

The value configured in ShapeIndex indicates the index of the shape to be used for
representing the module in the Graphics display.

The FirstColumn=Module# represents the heading for the first column in the
Graphics display. The modules Name=2MLL-CH2A is displayed in this
column.

The SecondColumn=Address Information represents heading for the second


column in Graphics display. The memory location where modules address
information is stored is displayed in this column.

The ThirdColumn=Module Description represents the heading for the third


column in the Graphics display. The modules Description is displayed in this
column.

Note: The value 5A40 stored in ModuleID parameter is a Hexadecimal value.


Configuring AD Module Information in MLMonitor.xml
The value configured in the ADModule parameter of IOModuleInfo tag is used for
indicating whether the module is an ADModule. The ADModule information is read
from the PLC using AD Read command based on the setting.
For example, consider the following IOModule configuration in MLMonitor.xml:

The IOModule 5A80 is an ADModule (as ADModule=Yes). The parameter


NumberOfChannels is used for configuring the number of Channels in the module.
The following configuration setting for MLMonitor > PLCInfo > ADModuleInfo
indicates the mapping between the offset in AD Read command response and the EPKS
UDP parameter to be updated:
R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

185

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

For example, consider the module in Slot 1of Base 0 is an ADModule.


The previous configuration setting indicates the following:

The Offset=08 in the AD Module command response indicates the status of the
Channels in that AD Module. (Note: The offset value is an hexadecimal)

The status of the Channel is updated in the EPKS UDP parameter


B0S1_ChannelStatus.

The Offset=0C in the AD Module command response indicates the input range to
that AD Module.

The input range to this module is updated in B0S1_InputRange parameter.

The other AD Module information like OutputType, FilterProcess, FilterValue,


AverageSetting, AverageProcessing and AverageValue are updated in the
corresponding EPKS UDP parameters.
REFERENCE - INTERNAL
For more details on ADModule information, see AD Module Information in
Appendix.

Configuring Special Module information in MLMonitor.xml


The Special Module configuration is used for detecting the disconnected Input channels
as Bad PV in Experion. The value configured in the SpecialModule parameter of
IOModuleInfo tag is used for indicating whether the module is a SpecialModule. The
Special Module information is configured using MLMonitor > SpecialModuleInfo tag
in MLMonitor.xml.

186

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

For example, consider the following IOModule configuration in MLMonitor.xml:

The IOModule 5A80 is a Special Module (as SpecialModule=Yes). The parameter


NumberOfChannels is used for configuring the number of Channels in the module.
The Special module information configured in MLMonitor.xml is used for reading
information about the Special Module, stored in the U memory area and updating the
EPKS UDP parameters.
The Special Module information is always stored in Uxy.<Address>, where x refers to
the base number and y refers to the slot number. The <Address> is different as depicted
in the following code snippet:

For example, consider the module in Slot 1of Base 0 is a SpecialModule. The following
table explains the mapping between the Special module information stored in the U
memory area and the EPKS UDP parameter:
Memory
location
U01.10

EPKS UDP parameter


B0S1_ChannelConnection

Remark
The value stored in this location
indicates whether the Channels of that
module are Connected or not
Connected.

REFERENCE - INTERNAL
For more details on Special Module information, see Special Module
information in Appendix.

Configuring All Module Information in MLMonitor.xml


The value configured in the AllModuleInfo parameter of IOModuleInfo tag is used for
indicating whether the module is an AllModule. The All Module information is
configured using MLMonitor > PLCInfo > AllModuleInfo tag in MLMonitor.xml.
The All module information configured in MLMonitor.xml is used for reading general
information about all IO Modules stored in the F memory area and updating the EPKS
UDP parameters. The general information includes the following:

R300
6/08

Number of slots in each base


MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

187

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

The PLC CPU scan periods (Min, Max and Current)

Five types of module errors at each slot level which are consolidated and placed in a
single ModuleError parameter corresponding to the Base Slot UDP.

The alarms for the module errors are raised in Experion.

The alarms for the module errors are raised in Experion containing the exact error details
i..e cause of the error, base/slot position of the I/O module.
The All Module information is always stored in F memory area. The address range in the
F memory area and the corresponding alarm description for the module errors are set
using the BaseModule parameter of AllModuleInfo tag, as shown in the following code
snippet:

The StartAddress and EndAddress refer to the start and end address within the F
memory area for all the Bases. The Base range starts from 0 and ends at 7. The value
stored in each range corresponds to the number of slots or the CPU scan period or
module errors as explained in the Description.
The following are inferred from the previous example:

188

StartAddress=F0150 EndAddress=F0157 refers to the number of slots within


a particular base. The start address F0150 contains the number of slots for Base 0.
The end address F0157 contains the number of slots for Base 7.

StartAddress=F0104 EndAddress=F0111 refers to the Module


detachment/disconnect error. The start address F0104 contains the module
detachment/disconnection error status for Base 0. The end address F0157 contains
the number of slots for Base 7.
MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.5 Experion User defined parameters

The 5 different module error values set using the AllModuleInfo tag is used for
displaying the module status in PLC custom graphic displays. The module status is
indicated using the LEDs in the graphic display. The module level LED glows Red if any
of the errors are active for the particular I/O module or it glows green.
The PLC scan periods are set using the MLMonitor > PLCInfo > MiscellaneousInfo >
PLCScanPeriodInfo tag in MLMonitor.xml. The parameter includes the minimum,
maximum and the current scan period for the PLC.

Time Synchronization between PLC and EPKS


The PLC time must be synchronized with the Experion system time. The ML Server
reads the PLC time and compares with the Experion system time, based on the settings in
MLConfig.xml. If there is a time difference, the PLC time is updated with the Experion
system time. The RTC time read from the PLC is displayed in the Config_Info graphics
page.
The following code snippet explains the RTC configuration in MLConfig.xml:

Parameter

Description

RTCReadWriteEnable

If Yes, it allows ML Server to read/write RTC time from/to


PLC.

RTCSynchInterval

Indicates the time frequency for reading the RTC time from
the PLC.
Note: If this value is 0 then the RTC time is not read from
or written to the PLC.

RTCDeadband

The PLC time is updated with the Experion system time, if


the time difference is equal to or greater than
RTCDeadband.
Note: If this value is 0 then the RTC time is not written to
the PLC.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

189

7. Advanced configuration of ML Server


7.6 Bad quality items

7.6

Bad quality items

Overview
MasterLogic-Experion integration enables the monitoring of analog input signal failures
such as transmitter failure or disconnection of input signal. All channels of all analog
input modules are constantly monitored for input signal failure. If the input signal fails,
all Experion points configured for this input channel is set to BADPV status for safer
control of the plant.
The BADPV setting is applicable for the following modules:
Module Type

Model#

Analog Input
module

2MLF-AV8A

Description
Voltage Input: 8 channel
DC 1 ~ 5V / 0 ~ 5V / 0 ~ 10V / 10 ~ +10V

2MLF-AC8A

Current Input: 8 Channel


DC 4 ~ 20mA / 0 ~ 20mA

2MLF-AD4S

Voltage/Current Input: 4 channel


Isolation between channels

Thermocouple
Input Module

2MLF-TC4S

RTD Input
Module

2MLF-RD4A

Temperature (T/C) Input, 4 Channel, Isolation


between channels
Temperature (RTD) Input, 4 channel

The following explains the two ways of setting quality for the Point parameter:

Setting quality for Input Channel disconnection in the field.

Setting quality for the item based on the PLC Read command responses.

Setting quality for Channel disconnection in the field


The configuration settings in MLApplicationSettings > MLPLCSettings > BadPVInfo
of MLAppSettings.xml file indicate the mapping between the Channel status address and
the data address.
The following xml snippet explains how the quality is set for the U memory area item
name:

190

Consider an IOModule that is also an AD Module and Special Module.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.6 Bad quality items

The AD Module command response contains the InputRange for that module.

Consider an item name for that PLC configured as (ML01.U01.02$DEV#WORD).

The Special Module command response indicates the values stored in the U memory
area for ChannelConnection.

The InputRange is configured in BadPVInfo > BadPVSupported tag. If the input


range of an AD Module is one of the input ranges configured in BadPVInfo, then the
quality of the item is set.

An alarm is raised for the disconnected Channel in the Experion Station display, if
the AlarmRaisingEnable parameter is set to Yes.

If a PLC Point is configured in EPKS with one of the previous U memory data
addresses (such as UXY.02, UXY.03), then the quality of that particular Point
(ML01.U01.02$DEV#WORD) is set to good or bad based on the corresponding
ChannelConnection status address (UXY.10.0).

The following example explains how the quality of an item name is set to bad:

R300
6/08

Consider an IO Module in Slot 1 of Base 0 which is also an AD Module and Special


Module.
MasterLogic-Experion PKS Integration - User's Guide
Honeywell Confidential & Proprietary

191

7. Advanced configuration of ML Server


7.6 Bad quality items

Assume the input range for that AD Module is 1~5V.

The connection status of Channel 0 in this module is read from the memory location
U01.10.0.

Configure a PLC point in quick builder with the address ML01.U01.02$WORD.

If the value of U01.10.0 is 1, the Channel 0 is disconnected and the quality of the
previous item name in EPKS is set to bad. Also, a Channel disconnection alarm is
raised indicating Base 0, Slot 1.

If the value of U01.10.0 is 0, the Channel 0 is normal and the quality of the previous
item name in EPKS is set to good.

Setting quality based on Read command responses


The quality of the Experion Point is set to good or bad, based on the responses received
on executing the Read commands. If the response is valid, then the quality of the Point is
set to good. If a NAK response is received from the PLC, then the quality of the Point is
set to bad. This is applicable to Separate Read, Device Read and Continuous Read
commands.
ATTENTION
If more than one item is sent in a request packet and there is an invalid
response for a single item, the quality of all the items are set to bad.

The Bad Quality for the PLC points configured with TB command is set based on the
NumberOfCycles parameter in the MLAppSettings XML file.
Consider the following example:

192

A PLC Point name configured as ML02.F94$TB#DINT This denotes the Double


Integer of 94 and 95th words of F memory area in PLC ML02.

The NumberOfCycles parameter for a TimerBased (TB) command is configured as


shown in the following code snippet:

The PV Scanperiod configured in Quick Builder is 2 seconds.

If there is no response for the TB read command for 6 seconds (NumberOfCylcels


* PV Scan Period) then the quality of the item is set to bad.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

7. Advanced configuration of ML Server


7.7 Adding a new IO Module

7.7

Adding a new IO Module

Configure new IO Module information


The IO modules are added to the PLC when required. The new IO module information
must be configured in MLMonitor.xml for viewing the information in the graphics pages.
To configure a new IO Module in MLMonitor.xml, perform the following steps:
Step

Action

Open MLMonitor.xml file located at the installation path (typically


C:\ProgramFiles\Honeywell\ExperionPKS\MLServer).

Configure the IO Module information using PLCInfo > IOModuleInfo >


IOModule.

Add a new Module tag.

Enter Module ID, Name and Description. To get the Module ID, you need to
check the value of the IO Module for which the shape is not being shown
properly. Get the value of the Module in Hexadecimal and then fill in the
Module ID.
For example, if the proper shape is not being shown for Base0, Slot 4, then
configure a custom display and get the Hexadecimal value of say ML01.B0S4
and fill in the Module ID part.

If the IO Module is an ADModule, set ADModule = Yes.


If the IO Module is a Special Module, set SpecialModule = Yes.

Enter index value for the shape of the IO Module represented in the graphics
display. If the shape is not already there for the new IO Module, add a new
shape.

REFERENCE INTERNAL
For more information on adding new shapes for the IO Module, see
Adding new shape for IO Module.
7

R300
6/08

Save MLMonitor.xml

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

193

7. Advanced configuration of ML Server


7.7 Adding a new IO Module

Adding new shape for IO Module


To add a new shape (representing an IO Module), perform the following steps:

194

Step

Action

Open the SlotShape.sha file from the installation path (typically C:\Program
Files\Honeywell\Experion PKS\Client\Abstract\MLPLC_Info_files) using
the HMIWebDisplay builder.

Add the new image representing the IO Module shape.

Observe the index value of the newly added shape. Use this index value for
configuring the shape index for the IO Module in MLMonitor.xml.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.1

MasterLogic Server logs

Overview
The ML Server has two modules, the ML Protocol and the ML Server. The modules
generate a series of logs, which are useful for various troubleshooting, analysis and
recording purposes.
The following is the list of logs generated by the ML Protocol and the ML Server:

Activity

Request

Response

Trace

Error

Hex

MLMonitor

ML Server logs
The Parameters under ML ServerLogs to enable/disable the generation of logs are
selected using the ML Server configuration tool. The path to store the log files are also
configured The LogFolderPath parameter value indicates the path, where the ML Server
logs are saved.

The following table explains the logs generated by the ML Server:


Log
Activity

R300
6/08

Optional /
Mandatory

Description

Mandatory

This log provides general information like ML Server


initialization, thread start/stop and successful add item
messages.

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

195

8. Troubleshooting
8.1 MasterLogic Server logs
Log
Error

Optional /
Mandatory
Mandatory

Description
This log provides information about unsuccessful add
item, exceptions and general error messages.
The information in this log helps for troubleshooting.

Request

Optional

This log provides information about requests sent to the


PLC by the ML Server.
To generate this log, set RequestLog to Yes.

Response

Optional

This log provides information about responses received


from the PLC by the ML Server.
To generate this log, set ResponseLog to Yes.

Trace

Optional

This log provides detailed information that helps


debugging.
To generate this log, set TraceLog to Yes.

MLMonitor

Optional

This log provides information about the status of UDP


writing to Experion, PLC status, base slot information,
RTC, IP Address and alarms raised.
To generate this log, set MLMonitorLog to Yes.

ML protocol logs
The parameters under MLProtocol Logs to enable/disable the generation of logs are
selected using the ML Server Configuration tool.. The path to store the log files is also
configured..
The LogFolderPath parameter value indicates the path, where the ML protocol logs are
stored.

The following table explains the logs generated by the ML protocol:


Log
Activity

196

Optional /
Mandatory
Mandatory

Description
This log provides information on initial xml settings,
socket connection/disconnection status.

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.1 MasterLogic Server logs
Log

Optional /
Mandatory

Description

Error

Mandatory

This log provides information on errors occurred during


communication between the PLC and the ML Server
and all exceptions.

Request

Optional

This log provides information on requests sent to the


PLC by the ML Server.
To generate this log, set RequestLog to Yes.

Response

Optional

This log provides information on responses received


from the PLC.
To generate this log, set ResponseLog to Yes.

Trace

Optional

This log provides detailed information that helps


debugging.
To generate this log, set TraceLog to Yes.

Hex

Optional

This log displays Hex dump packets sent to/received


from the ML Server.

ATTENTION
The Activity and Error logs are mandatory and generated by default. These
logs are not controlled by any parameter setting.
The optional log settings can be enabled/disabled at Runtime by changing
the appropriate XML parameters. Any change for these configurations are
updated every 30 seconds.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

197

8. Troubleshooting
8.2 MasterLogic PLC error messages

8.2

MasterLogic PLC error messages

6000
Type

Critical

Description

Failed to Create XML DOM Instance for %s (Error Code:


0x%X)

Cause

The xml components are not installed.


There is no enough memory space available.

Resolution

Ensure the xml components are installed.


Ensure enough memory space is available by deleting

unwanted files.

6001
Type

Critical

Description

Error in Loading %s file (Error Code: %d)

Cause

The file does not exist.


One or more tags are missing in the xml file.
The tags are not in correct format.

Resolution

Ensure the file exists.


Add the missing tags in the xml file.
Ensure the tags are formatted properly.

6002
Type

Critical

Description

Error in Parsing the File (%s)

Cause

One or more tags are missing.


The values assigned to the parameters are not within

the range.
Resolution

Ensure to add the missing tags.


Ensure to assign values to the parameters within the

range.

198

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages

6003
Type

Critical

Description

Exception Occurred during reading XML (%s)

Cause

One or more tags are missing in the xml file.


The tags are not in correct format.
Internal Program Error

Resolution

Add the missing tags in the xml file.


Ensure the tags are formatted properly.
Contact your local Honeywell TAC.
Refer to the log files for the correct error message and

resolve the problem.

6004
Type

Critical

Description

Failed to Create XML Instance for %s (Error Code:


0x%X)

Cause

Refer to error 6000

Resolution

Refer to error 6000

Type

Critical

Description

Error initializing windows during MLPLCServer startup


(Initialize method)

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Error Occurred during Reading MLConfig XML

Cause

Refer to error 6000, 6001, 6002, 6003, 6004.

Resolution

Refer to error 6000, 6001, 6002, 6003, 6004.

6005

6006

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

199

8. Troubleshooting
8.2 MasterLogic PLC error messages

6007
Type

Critical

Description

Error occurred during Protocol Initialization

Cause

Issuing initialization protocol command failed.


Issuing create channel command failed.
Issuing Enable Channel Command failed.

Resolution

Ensure all protocol parameters are configured using

ML Server Configuration Tool.

6008
Type

Critical

Description

WaitForMultipleObject Failed (%d)

Cause

Internal program error

Resolution

Contact your local Honeywell TAC

Type

Critical

Description

Invalid PLC ID in the Item Name (%s)

Cause

The PLC ID is not configured using the ML Server

6009

Configuration tool.
Resolution

Ensure PLC ID is configured using the ML Server

Configuration tool.

6010
Type

Non-Critical

Description

Invalid Item ID (%s)

Cause

The Item ID is not configured in correct format.

Resolution

Ensure that Item ID is configured using the correct

format as following:
PLCID.%<MemoryArea><DataType><Offset>$Command

6011
Type

200

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages
Description

Invalid Point

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

On Data Change method Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Main Thread Creation Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Issuing Enable Channel Command Failed (%d)

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Issuing create channel command Failed (%d)

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Issuing initialization protocol command failed (%d)

Cause

Internal program error.

6012

6013

6014

6015

6016

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

201

8. Troubleshooting
8.2 MasterLogic PLC error messages
Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

Issuing Disable channel command failed (%d)

Cause

The Channel is not enabled.

Resolution

Enable the Channel.

Type

Non-Critical

Description

Issuing delete channel command failed (%d)

Cause

The Channel does not exist.

Resolution

Create the Channel and try issuing delete Channel

6017

6018

command.

6019
Type

Non-critical

Description

Issuing create device command failed (%d)

Cause

Internal program error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Activation of PLC Failed

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Creation of Device Response Thread Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

6020

6021

202

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages

6022
Type

Critical

Description

Creation of Device Request Thread Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

Issuing device disable command failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

Issuing device delete command failed (%d)

Cause

Internal program error

Resolution

Contact your local Honeywell TAC.

6023

6024

6025
Type
Description

Issuing Enable Device Failed (%d)

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

PLC: %s Item Name: %s Invalid Memory Area %s

Cause

The memory area is not configured using the ML

6026

Server Configuration tool.


Resolution

Ensure the memory area is configured using the ML

Server Configuration tool.

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

203

8. Troubleshooting
8.2 MasterLogic PLC error messages

6027
Type

Non-Critical

Description

PLC: %s Item Name: %s Error: %s

Cause

Refer to error 6032, 6033, 6034.

Resolution

Refer to error 6032, 6033, 6034.

Type

Critical

Description

PLC: %s Item Name: %s Memory Area %s is not


defined in the MLAppSettings XML

Cause

Refer to error 6026.

Resolution

Refer to error 6026.

Type

Non-Critical

Description

PLC %s Item Name: %s Invalid Command %s

Cause

The command is not supported for the Item name.

6028

6029

The command is not configured using the ML Server

Configuration tool.
Resolution

Ensure that the supported commands are used for

that item name.


Ensure that command is configured for the item name

using the ML Server Configuration tool.

6030
Type

Non-Critical

Description

PLC: %s Item Name: %s Invalid Data Type %c

Cause

The data type is not supported for the item name.

Resolution

Ensure the data type for the item name is configured

properly using the ML Server Configuration tool.

6031

204

Type

Non-Critical

Description

PLC: %s Item Name: %s Data Type: %s is not supported

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages
by %s Memory Area
Cause

Refer to error 6030

Resolution

Refer to error 6030

Type

Non-Critical

Description

BitPosition %s does not lie between %s and %s

Cause

The bit position is not within the range as configured

6032

using the ML Server Configuration tool.


Resolution

Ensure the bit position is within the range as

configured using the ML Server Configuration tool.

6033
Type

Non-Critical

Description

Address %d (DataType: %s) does not lie between %d


and %d

Cause

The address is not within the range as configured

using the ML Server Configuration tool for that


memory area.
Resolution

Ensure the address is within the range as configured

using the ML Server Configuration tool for that


memory area.

6034
Type

Non-Critical

Description

does not match the Format (%s)

Cause

Invalid address format.

Resolution

Ensure the address for the memory area is formatted


properly as configured using the ML Server Configuration
tool for that memory area.

Type

Non-Critical

Description

PLC: %s ItemName: %s Error: Invalid Device Address


Format

6035

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

205

8. Troubleshooting
8.2 MasterLogic PLC error messages
Cause

Refer to error 6032, 6033, 6034.

Resolution

Refer to error 6032, 6033, 6034.

Type

Critical

Description

UnKnown Exception Occurred (ErrorCode: %d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Creation of Device Monitor Thread Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

Unable to get Local IP address.

Cause

Invalid IP address

Resolution

Configure correct IP address.

Type

Critical

Description

PLC: %s Point Build Failed ( ErrorCode: %d ErrorMsg:


%s)

Cause

EPKS server is not running.

Resolution

Ensure EPKS server is running.

Type

Non-Critical

Description

Unable to get host name - %d

Cause

Internal program error.

6036

6037

6038

6039

6040

206

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages
Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

Unable to get host information - %d

6041

Cause
Resolution

6042
Type

Non-Critical

Description

Unable to get File Version - %d

Cause

Internal Program Error

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

No Response for Enable Channel (%d)

Cause

Response is not received within the specified time


interval.

Resolution

Increase the value configured in EnableChannelInterval


parameter using the ML Server Configuration tool.

Type

Critical

Description

No Response for Create Channel (%d)

Cause

Response is not received within the specified time


interval.

Resolution

Increase the value configured in CreateChannelInterval


parameter using the ML Server Configuration tool.

Type

Non-Critical

Description

No Response for Disable Channel (%d)

6043

6044

6045

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

207

8. Troubleshooting
8.2 MasterLogic PLC error messages
Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

No Response for Delete Channel (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

No Response for Disable Device (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Non-Critical

Description

No Response for Delete Device (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

PLC: %s Point %s not exists in the EPKS

Cause

The Point is not built in Experion server.

Resolution

Ensure the Point is built in Experion server using the


Point Build Utility.

Type

Critical

Description

Error Occurred during Reading MLAppSettings XML

Cause

Refer to error 6000,6001, 6002

6046

6047

6048

6049

6050

208

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

8. Troubleshooting
8.2 MasterLogic PLC error messages
Resolution

Refer to error 6000,6001, 6002

Type

Critical

Description

Error Occurred during Reading MLMonitor XML

Cause

Refer to error 6000,6001, 6002

Resolution

Refer to error 6000,6001, 6002

Type

Critical

Description

Exception Occurred (ErrorMsg: %s)

Cause

The error message explains the problem occurred.

Resolution

Resolve the problem based on the error message.

Type

Non-Critical

Description

Offset does not exists

Cause

Address format is invalid.

Resolution

Ensure the address is formatted properly as defined


Table 4.3-9: Example of Device Variable format in
ML200.

Type

Non-Critical

Description

PLC: %s ItemName: %s Device Address not exists in the


Item ID

Cause

Refer to error 6053.

Resolution

Refer to error 6053.

Type

Non-Critical

Description

PLC: %s ItemName: %s Area %c doesn't have write


permission

6051

6052

6053

6054

6055

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

209

8. Troubleshooting
8.2 MasterLogic PLC error messages
The memory area configured in item name does not

Cause

have write access.


The PLC does not allow the write access to this

memory area.
Resolution

Ensure that the access setting for the memory is


read/write using the ML Server Configuration tool.

Type

Critical

Description

EPKS CommunicationThread Creation Failed (%d)

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Error occurred during EPKS Communicator Initialization

Cause

Internal program error.

Resolution

Contact your local Honeywell TAC.

Type

Critical

Description

Query Interface for IHCIDataChange Failed (%d)

Cause

There may be a problem with HCI run-time installation.

Resolution

Ensure that HCI run-time is installed correctly.

6056

6057

6058

210

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.1

AD Module Information

ChannelStatus
The value stored in each bit indicates the status of corresponding Channels available in
the module.
B31

B9

B8

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

The following table describes the bit value:


BIT

Description

Disable

Enable

InputRange
XGF-AV8A module
The value stored in two consecutive bits indicates the input range to the module.
B
15
CH7

B
14

B
13
CH6

B
12

B
11

B
10

CH5

B
9

B
8

CH4

B
7
CH3

The following table describes the bit value:

Honeywell International
Process Solutions
2500 West Union Hills
Phoenix, AZ 85027

BIT

Description

00

1V~5V

01

0V~5V

B
6

B
5
CH2

B
4

B
3
CH1

B
2

B
1
CH0

B
0

9. Appendix
9.1 AD Module Information
10

0 V ~ 10 V

11

-10 V ~ 10 V

XGF-AC8A module
B
15

B
14

CH7

B
13

B
12

CH6

B
11

B
10

CH5

B
9

B
8

CH4

B
7

B
6

CH3

B
5

B
4

CH2

B
3

B
2

CH1

B
1

B
0

CH0

The following table describes the bit value:


BIT

Description

00

4 mA ~ 20 mA

01

0 mA ~ 20 mA

OutputType

B
15

B
14

CH7

B
13

B
12

CH6

B
11

B
10

CH5

B
9
CH4

B
8

B
7
CH3

B
6

B
5

B
4

CH2

B
3
CH1

B
2

B
1

B
0

CH0

The following table describes the bit value:


BIT

Description

00

0 ~ 16000

01

-8000 ~ 8000

10

Precise Value

11

0 ~ 10000

Precise value has the following digital output ranges for the analog input range:
- XGF-AV8A
Analog input
-10 ~ 10V

0 ~ 10V

0 ~ 5V

1 ~ 5V

Digital output

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

213

9. Appendix
9.1 AD Module Information
Precise Value

-10000 ~ 10000

0 ~ 10000

0 ~ 5000

1000 ~ 5000

- XGF-AC8A
Analog input
4 ~ 20

0 ~ 20

4000 ~ 20000

0 ~ 20000

Digital output
Precise Value

FilterProcess
B31

B9

B8

BIT

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

B1

B0

Description

Disable

Enable

FilterValue
B31

B9

B8

B7

Channel# filter constant

Offset

214

B6

B5

B4

B3

B2

Details

0x18

CH0 filter value

0x1C

CH1 filter value

0x20

CH2 filter value

0x24

CH3 filter value

0x28

CH4 filter value

0x2C

CH5 filter value

0x30

CH6 filter value


MasterLogic-Experion PKS Integration User's Guide
Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.1 AD Module Information
0x34

CH7 filter value

AverageSetting
B31

B9

B8

BIT

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

B1

B0

Description

Disable

Enable

AverageProcessing
B31

B9

B8

BIT

Description

Count average

Time average

AverageValue
B31

B9

B8

B7

B6

B5

B4

Channel# filter constant

B3

B2

Setting range of time average process value is 4 ~ 16000


Offset

R300
6/08

Details

0x40

CH0 average processing value

0x44

CH1 average processing value

0x48

CH2 average processing value

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

215

9. Appendix
9.1 AD Module Information

216

0x4C

CH3 average processing value

0x50

CH4 average processing value

0x54

CH5 average processing value

0x58

CH6 average processing value

0x5C

CH7 average processing value

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.2 Special Module information

9.2

Special Module information

ChannelRun
B31

B9

B8

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

The following table describes the bit value:


BIT

Description

Stopped

Running

ChannelConnection
B31

B9

B8

B7

B6

B5

B4

B3

B2

B1

B0

CH

CH

CH

CH

CH

CH

CH

CH

The following table describes the bit value:


BIT

R300
6/08

Description

Normal

Disconnection

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

217

9. Appendix
9.3 Advanced settings

9.3

Advanced settings

Overview
The MLConfig.xml, MLMonitor.xml and MLAppSettings.xml contain critical
parameters used for fine-tuning of the ML Server. This section describes the list of
critical parameters available in each of the xml file.
Configuring ML Server parameters in MLConfig XML
The MLConfig.xml file is used for configuring the PLC information.
The following table lists the parameters of PLCInfo > MLPLC tag in the
MLConfig.xml file:
Parameter Name

Description

Default
Value

Possible
Values

Name

A unique name for each PLC. (Separate


logs are generated for each PLC)

MLPLC1

1 40
Characters

ID

A unique number to identify the PLC.

ML01

01 99,
prefixed with
ML.

Type

Supported PLCs in this integration


solution are ML200R, ML200 and
ML100R.

ML200R

ML200R,
ML200-IEC,
ML200NonIEC,
ML100R

IPAddress1

Represents the primary PLCs Internet


Protocol address.

0.0.0.0

xxx.xxx.xxx.x
xx

IPAddress2

Represents the secondary or redundant


PLCs Internet Protocol address in
primary network.

0.0.0.0

xxx.xxx.xxx.x
xx

IPAddress3

Represents the primary PLCs Internet


Protocol address in secondary network,
incase of dual network.

0.0.0.0

xxx.xxx.xxx.x
xx

IPAddress4

Represents the secondary or redundant


PLCs Internet Protocol address in
secondary network, incase of dual
network.

0.0.0.0

xxx.xxx.xxx.x
xx

218

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

RTCSyncInterval

Represents the interval at which PLC


time is read using the RTC Read
Command.

0 3600

RTCDeadband

If the time difference between the PLC


time and the System time is more than
the RTC Deadband, System time is
written to the PLC.

10

1 60

HeartBeatTimeout

Represents the frequency at which the


Heart Beat and the Status Commands
are sent to the PLC.

30

0 3600

InitialAddSubscription

For EPKS, this attribute must be set to


No. For other clients, set to Yes.

No

Yes or No

EPKSAssetName

Represents the EPKS Asset Name


where the Point building is done and all
alarms/events raised for this PLC are in
this asset.

localhost

1 40
Characters

The following table lists the parameters of PLCInfo > MLPLC > MLMonitorInfo in
the MLConfig.xml file:
Parameter Name

Description

Default
Value

Possible
Values

IOReadEnable
(Only for ML200/
ML200R)

If Yes, the Base-Slot information is


read from the PLC.

No

Yes or No

StatusReadEnable

If Yes, the Status response


commands are interpreted from the
PLC

No

Yes or No

EPKSWriteEnable

If yes, the UDPs are updated for the


PLC Point corresponding to the Baseslot info, status info, and so on.

No

Yes or No

AlarmRaisingEnable

If yes, the alarms/events are raised


corresponding to the status changes,
PLC events, and so on.

No

Yes or No

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

219

9. Appendix
9.3 Advanced settings
Parameter Name

Description

RTCReadWriteEnable
(Only for ML200/
ML200R)

If yes, the System time is written to


RTC when the time difference crosses
the deadband, otherwise only RTC
reading is enabled.

No

Yes or No

PointBuildEnable (Only
for ML100R)

If yes, the PLC Point (with all UDPs)


is built and downloaded automatically
into the Experion server. If the PLC
Point exists already, it is deleted and
recreated.

No

Yes or No

Default
Value

Possible
Values

The following table lists the parameters of PLCInfo > MLPLC > MLServerLog in the
MLConfig.xml file:
Parameter
Name

Description

Default
Value

Possible
Values

RequestLog

If yes, the information about each Request


sent by the MLServer (to PLC) is logged.

Yes

Yes or No

ResponseLog

If yes, the information about each Response


received by the ML Server (from PLC) is
logged.

Yes

Yes or No

MLMonitorLog

If yes, logs the status of all UDP writes and


alarm raised to Experion including
Diagnostics parameters.

Yes

Yes or No

TraceLog

If yes, any Trace messages within the


application is logged.

No

Yes or No

LogFolderPath

Folder path where MLServer log is stored.

0 255
characters

The following table lists the parameters of PLCInfo > MLPLC > MLProtocolInfo in
the MLConfig.xml file:
Parameter Name
RequestLog

220

Description
If yes, the information about each
Request received from the MLServer is
logged before sending to the PLC.

Default
Value
Yes

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

Possible
Values
Yes or No

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

ResponseLog

If yes, the information about each


Response received from the PLC is
logged.

Yes

Yes or No

HexLog

If yes, the hex dump of the packets are


logged.

No

Yes or No

TraceLog

If yes, any Trace messages within the


component is logged.

No

Yes or No

LogFolderPath

Folder path where Protocol stack logs are


stored.

PLCCommandTime
out

Protocol stack waits a maximum of this


interval for previous request's response
before sending the next request to PLC.
If no response received by that time, it
disconnects and reconnects the socket

2000

0 60000

NumOfConnectionA
ttempts

Number of socket connection attempts it


tries before switching over.

1 100

ConnectAttemptGa
p

Number of milliseconds between


successive connection attempts.

2000

500 3600000

0 255
characters

The following table lists the parameters of PLCInfo > MLPLC > ErrorLogInfo in the
MLConfig.xml file:
Note: The parameters are applicable to SystemLogInfo, ModeLogInfo and
ShutdownLogInfo. (Only for ML200/ ML200R)
Parameter Name

Description

Default
Value

Possible
Values

InitialHistoryEnable

Indicates whether the PLC logs must


be read during the MLServer Startup
or not.

No

Yes or No

LogToFile

Indicates whether the PLC log must


be written to a file or not.

No

Yes or No

EventsInDCS

Whether the PLC log must be raised


as events to the Experion.

No

Yes or No

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

221

9. Appendix
9.3 Advanced settings
Parameter Name

Description

EventCategoryInDCS

Represents how the PLC logs are


transferred to the Experion (as Events
or SOE or Alarm)

System
Alarm

System
Alarm /
System
Event /
SOE

ScanPeriod

Represents frequency at which the


particular PLC logs must be read.

10

0 3600

Default
Value

Possible
Values

Monitoring ML Server parameters in MLMonitor XML


The contents of the MLMonitor.xml file is used for viewing integrated PLCs information
in Graphics display or Experion station. The I/O module information and Status
information are found in this xml file. The xml file is saved at the installation path
(typically C:\ProgramFiles\Honeywell\ExperionPKS\MLServer).
CAUTION
The MLMonitor.xml file contains critical parameters used for fine-tuning of the
ML Server. Incorrect configuration of these parameters could adversely affect
the functioning of the MasterLogic-Experion integration. Therefore, Honeywell
recommends that you retain the default values for these parameters.
However, if you want to reconfigure these parameters, understand the
purpose of each parameter and how it works, and other information before
configuration. See Description of fields before you proceed.

ATTENTION
Parameters marked * are configured at subnode level to override the default
value.
For example: The data type defined at PLCGeneralParameters is the default
type for all parameters within the tag. The subnode MLServerStart can have
a different data type defined for that particular parameter.

The following table lists the parameters of PLCInfo > DiagnosticsInfo >
PLCGeneralParameters tag in the MLMonitor.xml file:
Parameter Name

222

Description

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

Default
Value

R300
6/08

Possible
Values

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

EPKSPointName

Name of the Point in EPKS which


holds all the parameters related to
general diagnostics.

MLServer

1 40
Characters

ScanPeriod

Represents the frequency at which


the Diagnostics parameters value is
written to the Experion.

0 3600

DataType*

Represents the default data type for


the parameters in this node. The
dataType attribute can be defined at
any subnode level to over-ride this
default value.

INT2

INT2, INT4,
CHAR,
REAL,
DBLE

MLServerI
nitStatusP
arameter

MLConfi
gXML

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the MLConfig
XML reading status.

D_MLConf
igXMLStat
us

1 40
Characters

MLSOE
ConfigX
ML

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the
MLSOEConfig XML reading status.

D_MLSOE
ConfigXM
LStatus

1 40
Characters

MLMonit
orXML

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the MLMonitor
XML reading status.

D_MLMoni
torXMLSta
tus

1 40
Characters

MLAppS
ettingsX
ML

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the MLMonitor
XML reading status.

D_MLApp
SettingsX
MLStatus

1 40
Characters

MLServ
erStart

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the ML Server
start time.

D_MLServ
erStartTim
e

1 40
Characters

Connectio
nStatus

PSCom
municati
on

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the Protocol
Stack Communication Status.

D_PSCom
munication
Status

1 40
Characters

ThreadSta
tus

MainRe
sponseT
hread

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the main
response thread status.

D_MainRe
sponseThr
eadStatus

1 40
Characters

HCICall
BackThr
ead

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the HCI
CallBack thread status.

D_HCICall
BackThrea
dStatus

1 40
Characters

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

223

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

EPKSC
ommuni
catorThr
ead

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the EPKS
Communicator thread status.

D_EPKSC
ommunicat
orThreadS
tatus

1 40
Characters

EngineT
hread

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the Protocol
Stacks Engine thread status.

D_Engine
ThreadSta
tus

1 40
Characters

QueueSiz
e

MainRe
sponse
Queue

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with the main
response queue size.

D_MainRe
sponseQu
eueSize

1 40
Characters

UpdatedTi
me

Diagnos
ticsUDP
Updatio
n

Parameter
ToUpdate

Represents the EPKS parameter


which is updated with Diagnostics
UDP updation time.

D_Diagno
sticsUDPU
pdatedTim
e

1 40
Characters

RequestID

StaticRe
quest

Parameter
ToUpdate

EPKS parameter updated with the


Request ID assigned to next
command statically.

D_Current
StaticRequ
estID

1 40
Characters

DynamicRe
quest

Param
eterTo
Update

EPKS parameter updated with the


Request ID assigned to next
command dynamically.

D_Current
DynamicR
equestID

1 40
Characters

Request

Param
eterTo
Update

EPKS parameter updated with the


number of requests sent to Protocol
Stack.

D_Number
OfRequest
s

1 40
Characters

Response

Param
eterTo
Update

EPKS parameter updated with the


number of responses received from
Protocol Stack.

D_Number
OfRespon
ses

1 40
Characters

LicensedNu
mberOfPLC
s

Param
eterTo
Update

EPKS parameter which is updated


with the Licensed Number of PLCs.

D_License
dNumberO
fPLCs

1 40
Characters

LicensedNu
mberOfPLC
Points

Param
eterTo
Update

EPKS parameter which is updated


with the Licensed Number of PLC
Points.

D_License
dNumberO
fPLCPoint
s

1 40
Characters

LicensedMo
de

Param
eterTo
Update

EPKS parameter which is updated


with the Licensed Mode.

D_License
dMode

1 40
Characters

Performan
ceParamet
ers

LicensePa
rameters

224

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings

The following table lists the parameters of PLCInfo > DiagnosticsInfo >
PLCSpecificParameters tag in the MLMonitor.xml file:
Parameter Name

Description

Default
Value

Possible
Values

ScanPeriod

Represents the frequency


at which the Diagnostics
parameters value is written
to the Experion.

0 3600

DataType*

Represents the default data


type.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Connection
Status

PLCConnecti
on

ParameterToU
pdate

EPKS parameter updated


with PLC connection status
(Connected/Disconnected)

D_PLCCon
nectionStat
us

1 40
Characters

ThreadStat
us

RequestThre
ad

ParameterToU
pdate

EPKS parameter updated


with the status of ML
Server Request thread
(Running/Stopped)

D_Request
ThreadStat
us

1 40
Characters

ResponseTh
read

ParameterToU
pdate

EPKS parameter updated


with the status of ML
Server Response thread
(Running/Stopped)

D_Respons
eThreadSta
tus

1 40
Characters

MonitorThre
ad

ParameterToU
pdate

EPKS parameter updated


with the status of ML
Server Monitor thread
(Running/Stopped)

D_MonitorT
hreadStatus

1 40
Characters

ResponseQu
eue

ParameterToU
pdate

EPKS parameter updated


with the current Response
queue size.

D_Respons
eQueueSiz
e

1 40
Characters

EPKSWriteQ
ueue

ParameterToU
pdate

EPKS parameter updated


with the current EPKS
Write queue size.

D_EPKSWr
iteQueueSi
ze

1 40
Characters

EPKSAlarm
Queue

ParameterToU
pdate

EPKS parameter updated


with the current EPKS
Alarm queue size.

D_EPKSAla
rmQueueSi
ze

1 40
Characters

QueueSize

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

225

9. Appendix
9.3 Advanced settings
Parameter Name
RequestID

Performanc
eParameter
s

UpdatedTi
me

226

Description

Default
Value

Possible
Values

StaticReque
st

ParameterToU
pdate

EPKS parameter updated


with the Request ID
assigned to next command
statically.

D_CurrentS
taticReques
tID

1 40
Characters

DynamicReq
uest

ParameterToU
pdate

EPKS parameter updated


with the Request ID
assigned to next command
dynamically.

D_CurrentD
ynamicReq
uestID

1 40
Characters

Response

ParameterToU
pdate

EPKS parameter updated


with the number of
responses received from
Protocol Stack.

D_Number
OfRespons
esPerSec

1 40
Characters

Request

ParameterToU
pdate

EPKS parameter updated


with the number of requests
sent to Protocol Stack.

D_Number
OfRequests
PerSec

1 40
Characters

EPKSWrite

ParameterToU
pdate

Represents number of
EPKS UDP writes per
second.

D_Number
OfEPKSWri
tesPerSec

1 40
Characters

EPKSAlarm

ParameterToU
pdate

Represents number of
EPKS Alarms raised per
second.

D_Nubmer
OfEPKSAla
rmsPerSec

1 40
Characters

StatusUDPUpdati
on

Parameter
ToUpdate

Represents EPKS
parameter with Status UDP
updated time.

D_StatusU
DPUpdated
Time

1 40
Characters

BaseSlotUDPUp
dation

Parameter
ToUpdate

Represents EPKS
parameter with BaseSlot
UDP updated time.

D_BaseSlot
UDPUpdate
dTime

1 40
Characters

ADModuleUDPU
pdation

Parameter
ToUpdate

Represents EPKS
parameter with ADModule
UDP updated time.

D_ADModul
eUDPUpdat
edTime

1 40
Characters

SpecialModuleU
DPUpdation

Parameter
ToUpdate

Represents EPKS
parameter with Special
Module UDP updated time.

D_SpecialM
oduleUDPU
pdatedTime

1 40
Characters

MiscellaneousUD
PUpdation

Parameter
ToUpdate

Represents EPKS
parameter with
Miscellaneous UDP
updated time.

D_Miscella
neousUDP
UpdatedTi
me

1 40
Characters

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter Name

ProtocolSta
ckParamete
rs

R300
6/08

Description

Default
Value

Possible
Values

RTCReadUDPUp
dation

Parameter
ToUpdate

Represents EPKS
parameter with RTC UDP
updated time.

D_RTCRea
dUDPUpdat
edTime

1 40
Characters

DiagnosticsUDP
Updation

Parameter
ToUpdate

Represents EPKS
parameter with Diagnostics
UDP updated time.

D_Diagnost
icsUDPUpd
atedTime

1 40
Characters

RTCWriteUDPUp
dation

Parameter
ToUpdate

Represents EPKS
parameter with RTC Write
UDP updated time.

D_RTCWrit
eUpdatedTi
me

1 40
Characters

RequestQueueSi
ze

Parameter
ToUpdate

EPKS parameter with


current size of the Request
queue.

D_Request
QueueSize

1 40
Characters

LargeBuffer

Parameter
ToUpdate

EPKS parameter with


available number of large
buffers.

D_LargeBuf
fersAvailabl
e

1 40
Characters

SmallBuffer

Parameter
ToUpdate

EPKS parameter with


available number of small
buffers.

D_SmallBuf
fersAvailabl
e

1 40
Characters

MediumBuffer

Parameter
ToUpdate

EPKS parameter with


available number of
medium buffers.

D_Medium
BuffersAvail
able

1 40
Characters

ThreadCount

Parameter
ToUpdate

EPKS parameter with


number of threads in
protocol stack.

D_PSThrea
dCount

1 40
Characters

RequestThreadSt
atus

Parameter
ToUpdate

EPKS parameter which is


updated with the status of
Protocol Stack Request
thread (Running/Stopped)

D_PSRequ
estThreadS
tatus

1 40
Characters

ResponseThread
Status

Parameter
ToUpdate

EPKS parameter which is


updated with the status of
Protocol Stack Response
thread (Running/Stopped)

D_PSResp
onseThread
Status

1 40
Characters

TBCOSThreadSt
atus

Parameter
ToUpdate

EPKS parameter which is


updated with the status of
Protocol Stack TBCOS
thread (Running/Stopped)

D_PSTBCO
SThreadSta
tus

1 40
Characters

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

227

9. Appendix
9.3 Advanced settings
Parameter Name

228

Description

Default
Value

Possible
Values

ResponseReceiv
ed

Parameter
ToUpdate

EPKS parameter which is


updated with the last
response received time.

D_LastRes
ponseRecei
vedTime

1 40
Characters

RequestSent

Parameter
ToUpdate

EPKS parameter which is


updated with the last
request sent time.

D_LastReq
uestSentTi
me

1 40
Characters

TBResponseRec
eived

Parameter
ToUpdate

EPKS parameter which is


updated with the last TB
response received time.

D_LastTBR
esponseRe
ceivedTime

1 40
Characters

COSResponseR
eceived

Parameter
ToUpdate

EPKS parameter which is


updated with the last COS
response received time.

D_LastCOS
ResponseR
eceivedTim
e

1 40
Characters

MinRequest

Parameter
ToUpdate

EPKS parameter which is


updated with the minimum
request processing time.

D_MinRequ
estTime

1 40
Characters

MinResponse

Parameter
ToUpdate

EPKS parameter which is


updated with the minimum
response time.

D_MinResp
onseTime

1 40
Characters

MaxRequest

Parameter
ToUpdate

EPKS parameter which is


updated with the maximum
request processing time.

D_MaxReq
uestTime

1 40
Characters

MaxResponse

Parameter
ToUpdate

EPKS parameter which is


updated with the maximum
response time.

D_MaxRes
ponseTime

1 40
Characters

AvgRequest

Parameter
ToUpdate

EPKS parameter which is


updated with the average
request processing time.

D_AvgRequ
estTime

1 40
Characters

AvgResponse

Parameter
ToUpdate

EPKS parameter which is


updated with the average
response time.

D_AvgResp
onseTime

1 40
Characters

PLCConnected

Parameter
ToUpdate

EPKS parameter which is


updated with the last PLC
connected time.

D_LastPLC
Connected
Time

1 40
Characters

PLCDisconnecte
d

Parameter
ToUpdate

EPKS parameter which is


updated with the last PLC
disconnected time.

D_LastPLC
Diconnecte
dTime

1 40
Characters

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

HBSentTime

Parameter
ToUpdate

EPKS parameter which is


updated with the last HB
sent time.

D_LastHBS
entTime

1 40
Characters

StatusRecievedTi
me

Parameter
ToUpdate

EPKS parameter which is


updated with the last status
response received time.

D_LastStat
usReceived
Time

1 40
Characters

The following table lists the parameters of PLCInfo > ADModuleInfo tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML200/ ML200R.
Parameter Name

Description

Default
Value

Possible
Values

ScanPeriod

Represents the frequency at which the All


Module parameters value is written to the
Experion.

10

0 3600

NumberOfParameter

Default number of parameters of a


particular data type.

1 255

DataType*

Default datatype for the parameters in this


node. DataType attribute can be defined
at any subnode level to over-ride this
default value.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Offset

Offset within the particular AD Module


response.

08

Parameter
ToUpdate

EPKS parameter which is updated with


the AD response value at that offset.

Channel
Status

ADRead

1 40
Charact
ers

The following table lists the parameters of PLCInfo > SpecialModuleInfo tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML200/ ML200R.
Parameter Name

R300
6/08

Description

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

Default
Value

Possible
Values

229

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

Possible
Values

ScanPeriod

Frequency at which the U Area needs to


be scanned in seconds. The values are
written to EPKS parameters only if values
have changed since last write.

10

0 3600

DataType*

Default datatype for the parameters in


this node. DataType attribute can be
defined at any subnode level to over-ride
this default value.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Address

Address within the particular U memory


Area for that Base Slot.

01

Paramet
erToUpd
ate

EPKS parameter which is updated with


the value stored in U Area at that offset.

Channel
Run

SpecialMod
ule

1 40
Charact
ers

The following table lists the parameters of PLCInfo > AllModuleInfo tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML200/ML200R.
Parameter Name

Description

Default
Value

Possible
Values

ScanPeriod

Frequency at which the F Area needs to


be scanned in seconds. The values are
written to EPKS parameters only if values
have changed since last write.

10

0 3600

ParameterToUpdate

EPKS parameter which is updated with


the All Module information.

Module
Error

1 40
Charact
ers

DataType*

Default datatype for the parameters in


this node. DataType attribute can be
defined at any subnode level to over-ride
this default value

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Starting Address within the F memory


Area for all the Bases (starts from Base
0)

F0150

BaseMod
ule

230

StartAddr
ess

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter Name

Description

Default
Value

EndAddre
ss

Ending Address within the F memory


Area for all the Bases (ends at Base 7)

F0157

Descriptio
n

Used for raising the Alarm in Experion


corresponding to the error. Base no. and
Slot no. are prefixed to give full
information.

Number
of slots
in base

Possible
Values

1 255
Charact
ers

The following table lists the parameters of PLCInfo > BaseSlotInfo tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML200/ ML200R.
Parameter Name

Description

Default
Value

Possible
Values

DataType*

Default datatype for the parameters


in this node. DataType attribute can
be defined at any subnode level to
over-ride this default value.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

ScanPeriod

Frequency at which base slot


information is read from PLC in
seconds.

3600

0 3600

NumberOfBasesParameter

EPKS parameter updated with


number of bases.

NumBas
es

1 40
Charact
ers

Base

ID

Base number for which the


parameters are configured.

07

NumberOfSlotsPar
ameter

EPKS parameter with number of


slots in a particular base.

B0Num
Slots

1 40
Charact
ers

Slot

ID

Slot position within a particular base


for which the parameters are
configured.

0 11

Paramete
rToUpdat
e

EPKS parameter name with a value


representing a particular module in
that slot.

B0S0

1 40
Charact
ers

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

231

9. Appendix
9.3 Advanced settings

The following table lists the parameters of PLCInfo > AlarmInfo tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML200/ ML200R.
Parameter

Description

Default
Value

Possible
Values

Value0ShapeIndex

Default index of the shape used for


Graphics display, when the bit value is 0.

0 10

Value1ShapeIndex

Default index of the shape used for


Graphics display, when the bit value is 1.

0 10

DataType*

Represents default data type.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Priority*

Represents default priority for alarms


raised based on the bit value.

03

Alarm*

Represents default setting for raising


alarms based on the bit value.

F, 1, 0,
C

ID

Represents the bit position within the


status response for which parameters are
being configured.

Desc

Represents the description of the status


bit displayed in the Status_Info Graphics
page.

Slot 0
info on
remote
connecti
on from
local
port to
other
ports

1 255
Charact
ers

ParameterTo
Update

Represents the EPKS parameter updated


with the status bit value.

SLOT_I
NFO_R
EMOTE
_CON_L
OC_0

1 40
Charact
ers

Bit

The following table lists the parameters of PLCInfo > IOModuleInfo tag in the
MLMonitor.xml file:

232

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

Description

Default
Value

Possible
Values

ShapeIndex*

Represents the default index for the shape of


the IO Module displayed in the Graphics
page.

0 10

ADModule

Set to Yes if the module is an AD Module.

No

Yes or
No

SpecialModule

Set to Yes if the module is a Special Module.

No

Yes or
No

NumberOfChannels

Default Number Of Channels (useful only if


the modules is a Special module).
NumberOfChannels attribute can be defined
at any subnode level to over-ride this default
value.

0 1024

FirstColumn

Represents the header name displayed for


the first column in the Status_Info Graphics
page.

Module#

SecondColumn

Represents the header name displayed for


the second column in the Status_Info
Graphics page.

Address
Informati
on

ThirdColumn

Represents the header name displayed for


the third column in the Status_Info Graphics
page.

Module
Descripti
on

Module

ID

Represents the ID of the IO module.

25A40

Name

Represents the IO module name.

2MLLCH2A

1 40
Charact
ers

Descripti
on

Represents the description of the IO module.

Cnet
Module,
RS232C/R
S-422

1 255
Charact
ers

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

233

9. Appendix
9.3 Advanced settings

The following table lists the parameters of PLCInfo > MiscellaneousInfo tag in the
MLMonitor.xml file:
Parameter

Description

DataType*

Default
Value

Possible
Values

Represents the default data


type.

CHAR

INT2,
INT4,
CHAR,
REAL,
DBLE

RTCTim
eInfo

ParameterToUpdate

EPKS parameter updated with


the last read RTC time.

RTCTim
e

1 40
Charact
ers

IPAddre
ssInfo

ParameterToUpdate1

EPKS parameter updated with


IPAddress1.

IPAddre
ss1

1 40
Charact
ers

ParameterToUpdate2

EPKS parameter updated with


IPAddress2.

IPAddre
ss1

1 40
Charact
ers

ParameterToUpdate3

EPKS parameter updated with


IPAddress3.

IPAddre
ss1

1 40
Charact
ers

ParameterToUpdate4

EPKS parameter updated with


IPAddress4.

IPAddre
ss1

1 40
Charact
ers

ActiveDataType

Data type for the EPKS


parameter defined by Active IP
Address attribute.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

ActiveIPAddress

Represents the EPKS


parameter updated with the
index of the Active IP Address.

ActiveIP
Address

1 40
Charact
ers

MinSca
nPerio
d

Parameter
ToUpdate

Represents the EPKS


parameter updated with the
minimum scan period.

MinScan
Period

1 40
Charact
ers

MaxSc
anPeri
od

Parameter
ToUpdate

Represents the EPKS


parameter updated with the
maximum scan period.

MaxSca
nPeriod

1 40
Charact
ers

PLCSca
nPeriod

234

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter
Current
ScanP
eriod

Description
Parameter
ToUpdate

Represents the EPKS


parameter updated with the
current scan period.

Default
Value

Possible
Values

Current
ScanPer
iod

1 40
Charact
ers

The following table lists the parameters of PLCInfo100 > AlarmInfo100 tag in the
MLMonitor.xml file:
Note: These parameters are applicable only for ML100R.
Parameter

Description

Default
Value

Possible
Values

Value0ShapeIndex

Default index of the shape used for


Graphics display, when the bit value is 0.

0 10

Value1ShapeIndex

Default index of the shape used for


Graphics display, when the bit value is 1.

0 10

DataType*

Represents the data type.

INT2

INT2,
INT4,
CHAR,
REAL,
DBLE

Priority*

Represents default priority for alarms


raised based on the bit value.

03

Alarm*

Represents default setting for raising


alarms based on the bit value.

ID

Represents the bit position within the


status response for which parameters are
being configured.

32-39

Desc

Represents the description of the status


bit displayed in the Status_Info Graphics
page.

Cpu
Type

1 255

ParameterToUp
date

Represents the EPKS parameter updated


with the status bit value.

CPU_T
YPE

1 40
Charact
ers

Bit

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

235

9. Appendix
9.3 Advanced settings

Configuring ML Server Application Settings


The MLAppSettings.xml file is used for configuring the MasterLogic PLC server
application settings. This file contains important configurations such as Commands and
memory areas supported by the PLCs.
WARNING
The MLAppSettings.xml file contains critical parameters used for fine-tuning
of the ML Server application settings. Incorrect configuration of these
parameters could adversely affect the functioning of the MasterLogicExperion integration. Therefore, Honeywell recommends that you retain the
default values for these parameters. However, if you want to reconfigure
these parameters, understand the purpose of each parameter and how it
works, and other information before configuration. See Description of fields
before you proceed.

The following table lists the parameters of MLServerSettings > MLServerInfo tag in
the MLAppSettings.xml file:
Parameter

Description

ModuleNam
e

Represents the prefix used for naming the


Log files containing the generated ML Server
logs.

MLServer

1 40
characters

PLCIDPrefix

Represents the prefix for the PLC IDs


configured in the MLConfig XML file.

ML

18
characters

ConfigXMLFi
le

Represents the XML file containing the PLC


Configuration settings. The ML Server
settings such as IORead, Status and Alarm
are enabled or disabled based on the
configuration in this XML file.

MLConfig.xml

1 40
characters

MonitorXML
File

Represents the XML file containing the


common settings for ML Server and the
Graphics.

MLMonitor.xml

1 40
characters

SOEConfigX
MLFile

Represents the XML file containing the SOE


settings for the ML Server and the Graphics.

MLSOEConfig.
xml

1 40
characters

CommandSe
parator

Represents the separator used for identifying


the command from the Item ID.

# or $

DataTypeSe
parator

Represents the separator used for identifying


the data type from the Item ID.

# or $

236

Default Value

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

Possible
Values

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

Description

Default Value

Possible
Values

DirectVariabl
eSymbol

Represents the prefix used for the Direct


variables.

RequestLog

If this parameter value is set to Yes, the


information about each request sent by the
ML Server (not specific to a PLC) is logged.

Yes

Yes or No

ResponseLo
g

If this parameter value is set to Yes, the


information about each response received by
the ML Server (not specific to a PLC) is
logged.

Yes

Yes or No

MLMonitorLo
g

If this parameter value is set to Yes, the


information about each EPKS write or Alarm
raised by ML Server (not specific to a PLC) is
logged.

Yes

Yes or No

TraceLog

If this parameter value is set to Yes, the ML


Server trace messages (not specific to a PLC)
are logged.

Yes

Yes or No

LogFolderPa
th

Represents the folder path where the general


ML Server logs (not specific to a PLC) are
stored.

C:\\Temp\\Gen
eralLogs

PLCInfoUpd
ateRate

Represents the rate at which the changes


made in MLConfig XML parameters related to
enabling/disabling of logs are recognized by
the ML Server.

30

0 3600

DemoCertific
ateFilePath

Represents the path of the demo license


certificate for using the ML Server. This
certificate is used when the actual ML Server
license is not installed.

MLPLC_Demo.
cert

1 255
characters

LogRetentio
nDays

Number of days for which the log files in the


PLC (or General) Logs directory is retained.
After this period, all the logs in that directory
is removed.

30

1 365
days

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

237

9. Appendix
9.3 Advanced settings

The following table lists the parameters of MLServerSettings > ProtocolInfo tag in the
MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible
Values

ModuleName

Represents the prefix used for naming


the Log files containing the generated
Protocol Stack logs.

MLProtocol

1 40
characters

RequestLog

If this parameter value is set to Yes, the


information about each request sent by
the ML Server (not specific to a PLC) is
logged.

Yes

Yes or No

ResponseLog

If this parameter value is set to Yes, the


information about each response
received by the ML Server (not specific
to a PLC) is logged.

Yes

Yes or No

Yes

Yes or No
Yes or No

HexLog
TraceLog

If this parameter value is set to Yes, the


ML Server trace messages (not specific
to a PLC) are logged.

Yes

LogFolderPath

Represents the folder path where the


general Protocol Stack logs (not specific
to a PLC) are stored.

C:\\Temp\\G
eneralLogs

Protocol
Settings

MaxNoofChan
nels

Represents the maximum number of


Channels that can be created.

0 3600

MaxNoofDevi
ces

Represents the maximum number of


Devices that can be created.

100

1 100

MaxNoofSmal
lBuffers

Represents the maximum number of


Small buffers.

1000

1
100000

MaxNoofMedi
umBuffers

Represents the maximum number of


Medium buffers.

30000

1
100000

MaxNoofLarg
eBuffers

Represents the maximum number of


Large buffers.

1000

1
100000

SizeofSmallB
uffers

Buffers less than this size (number of


bytes) are considered as Small buffers.

256

256
1024

SizeofMedium
Buffers

Buffers less than this size (number of


bytes) but more than small buffers are
considered as Medium buffers.

512

512
10240

238

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

QueueS
ettings

Description

Default
Value

Possible
Values

SizeofLargeB
uffers

Buffers more than this size (number of


bytes) are considered as Large buffers.

2000

1024
1048576

SizeofEventQ
ueue

Represents the maximum size of the


queue maintaining the requests at each
PLC level.

10000

1
100000

PLCHeartBea
tTimeout

Represents the frequency at which the


PLC threads send Heart Beat to the
thread manager.

5000

1 5000

ThreadMaxCo
unt

Represents the maximum number of


threads that can be created.

500

1 1000

StatusPollingFr
eq

Represent the frequency at which the


status requests are sent for each PLC.

10000

1000
3600000

HeartBeatUpd
ateTimeout

Represents the frequency at which the


internal threads send the heart beat to
the thread manager.

1000

1000
3600000

MainResponse
QueueSize

Represents the maximum size of the


queue maintaining the main thread
responses.

5000

1
100000

The following table lists the parameters of MLServerSettings >EPKSServerInfo tag in


the MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible
Values

ServerName

Represents the EPKS server name used


for point building.

Localhost

1 40
characters

Area

Represents the Area/Asset name for raising


server level Alarms/Events.

System

1 40
characters

AlarmPriority

Represents the default alarm priority for


raising server level Alarms/Events.

03

AlarmSubPriority

Represents the default alarm sub priority


for raising server level Alarms/Events.

0 15

PointBuildFileName

Represents the prefix for naming the Point


build file name.

PointBuildFil
e

1 40
characters

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

239

9. Appendix
9.3 Advanced settings
Parameter

Description

PointBuildTemplateN
ame

Default
Value

Represents the Point build template file


name. This file is used by the Point Build
Utility to generate the PNT file.

Possible
Values

StatusPointB
uildTemplate
.txt

1 40
characters

The following table lists the parameters of MLServerSettings >XMLPathInfo tag in the
MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible
Values

RegKeyPath

Represents the registry key containing the


Experion installation settings.

SOFTWARE
\Honeywell\T
PS50\InstallI
nfo

1 255
characters

InstallDriveVal
ue

Represents the registry value within the


registry key containing the Experion
installation settings.

InstallDrive

0 40
characters

FolderPathVal
ue

Represents the registry value within the


registry key containing the Experion
installation common folder path.

InstallComm
onDir

0 40
characters

SubFolderPath

Represents the subfolder path which needs to


be added to the Experion installation common
folder path.

Client\Abstra
ct

0 40
characters

The following table lists the parameters of MLServerSettings >PLCLogInfo tag in the
MLAppSettings.xml file:
Parameter
ShutDownL
ogInfo

240

Description

Default
Value

Possible
Values

Name

Represents the log file name used


for logging the PLC events if the
LogToFile option set.

PLCShutdow
n

1 40
characters

LogSize

Represents the size of the log


record.

1 10000

NumberOfLogR
equest

Represents the maximum number of


log requests per packet.

128

1 10000

MaxLogPosition

Represents the maximum log


position in the PLC.

1024

1 10000

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

Description

Default
Value

Possible
Values

Sou
rce

Represents the source field of the


log. This is used while raising the
corresponding event in the Experion.

MAIN_BASE
_SHUT_DO
WN

0 40
characters

Cod
e

Represents the code for the log


message. This is used for
interpreting the log message.

-1 10000

Des
c

Represents the description for the


corresponding log code.

Main base
shut down

1 255
characters

Name

Represents the log file name used


for logging the PLC events if the
LogToFile option is set.

PLCMode

1 40
characters

LogSize

Represents the size of the log


record.

16

1 10000

NumberOfLogR
equest

Represents the maximum number of


log requests per packet.

64

1 10000

MaxLogPosition

Represents the maximum log


position in the PLC.

1024

1 10000

Mode

Sourc
e

Represents the source field of the


log. This is used while raising the
corresponding event in the Experion.

STATE_MO
D_RUN

0 40
characters

Code

Represents the code for the log


message. This is used for
interpreting the log message.

-1 10000

Desc

Represents the description for the


corresponding log code.

State Mode
Run

1 255
characters

Sourc
e

Represents the source field of the


log. This is used while raising the
corresponding event in the Experion.

MODE_TYP
E_LOCAL_K
EY

0 40
characters

Code

Represents the code for the log


message. This is used for
interpreting the log message.

-1 10000

Desc

Represents the description for the


corresponding log code.

Mode Type
Local Key

1 255
characters

Shutdow
n

ModeLogInf
o

Type

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

241

9. Appendix
9.3 Advanced settings
Parameter
ErrorLogInf
o

Description

242

Possible
Values

Name

Represents the log file name used


for logging the PLC events if the
LogToFile option is set.

PLC Error

1 40
characters

LogSize

Represents the size of the log


record.

16

1 10000

NumberOfLogR
equest

Represents the maximum number of


log requests per packet.

128

1 10000

MaxLogPosition

Represents the maximum log


position in the PLC.

2048

1 10000

Source

Represents the source field of the


log. This is used while raising the
corresponding event in the Experion.

ROMPACK

0 40
characters

Code

Represents the code for the log


message. This is used for
interpreting the log message.

22

-1 10000

Desc

Represents the description for the


corresponding log code.

Invalid User
program
(Memory
Module)

1 255
characters

Name

Represents the log file name used


for logging the PLC events if the
LogToFile option is set.

PLCSystem

1 40
characters

LogSize

Represents the size of the log


record.

16

1 10000

NumberOfLogR
equest

Represents the maximum number of


log requests per packet.

64

1 10000

MaxLogPosition

Represents the maximum log


position in the PLC.

1024

1 10000

System

Sour
ce

Represents the source field of the


log. This is used while raising the
corresponding event in the Experion.

SYS_HIS_P
ADT

0 40
characters

Code

Represents the code for the log


message. This is used for
interpreting the log message.

-1 10000

Error

SystemLogI
nfo

Default
Value

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

Description
Desc

Default
Value
PADT

Represents the description for the


corresponding log code.

Possible
Values
1 255
characters

The following table lists the parameters of MLServerSettings > IntervalInfo tag in the
MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible
Values

MainResponseInterval

Represents the interval at which the


main thread responses must be
checked.

500

500 - 3600000

PLCConnectionInterval

Represents the PLC connection


interval.

500

500 - 3600000

WriteResponseInterval

Represents the Write response


interval.

500

500 - 3600000

MonitorRequestInterval

Represents the Monitor request


interval.

500

500 - 3600000

ReadRequestInterval

Represents the Read request interval.

500

500 - 3600000

HCICallBackInterval

Represents the HCI call back interval.

500

500 - 3600000

DisableDeviceInterval

Represents the Disable Device


Interval.

500

100 10000

DeleteDeviceInterval

Represents the Delete Device


Interval.

500

100 10000

DisableChannelInterval

Represents the Disable Channel


Interval.

500

100 10000

DeleteChannelInterval

Represents the Delete Channel


Interval.

500

100 10000

CreateChannelInterval

Represents the Create Channel


Interval.

500

100 10000

EnableChannelInterval

Represents the Enable Channel


Interval.

500

100 10000

R300
6/08

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

243

9. Appendix
9.3 Advanced settings

The following table lists the parameters of MLServerSettings > StaticRequestIDInfo


tag in the MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible Values

GeneralReqIDStart

Represents the Starting RequestID for


the General Static Requests.

1000

1 4294967295

GeneralReqIDEnd

Represents the Ending RequestID for


the General Static Requests.

5000

1 4294967295

DeviceReqIDStart

Represents the Starting RequestID for


the PLC Static Requests.

5000

1 4294967295

DeviceReqIDEnd

Represents the Ending RequestID for


the PLC Static Requests.

10000

1 4294967295

The following table lists the parameters of MLServerSettings >


DynamicRequestIDInfo tag in the MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible Values

GeneralRequestIDStart

Represents the Starting


RequestID for the General
Dynamic Requests.

15000

1 4294967295

GeneralRequestIDEnd

Represents the Ending RequestID


for the General Dynamic
Requests.

20000

1 4294967295

DeviceRequestIDStart

Represents the Starting


RequestID for the PLC Dynamic
Requests.

25000

1 4294967295

DeviceRequestIDEnd

Represents the Ending RequestID


for the PLC Dynamic Requests.

30000

1 4294967295

244

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

R300
6/08

9. Appendix
9.3 Advanced settings

The following table lists the parameters of MLPLCSettings > PLCFamily tag in the
MLAppSettings.xml file:
Parameter

Description

Default
Value

Possible
Values

PLCType

Represents the PLC type. The


configuration is defined for this PLC type
and must match with the PLC type
configured in MLConfig XML.

ML100R

ML200R,
ML200-IEC,
ML200_NonIE
C, ML100R

DefaultCommand

Represents the default command type


used if the command is not specified for
the PLC Point of this PLC type.

CON

SEP, CON,
TB, COS,
DEV

DefaultDataType

Represents the default data type used if


the data type is not specified for the PLC
Point of this PLC type.

WORD

BIT, BYTE,
WORD,
DWORD,
LWORD

ConnectPort

Represents the TCP/IP port used by the


ML Server to connect with thePLC.

2004

1 65536

RequestHeader

Represents header string included in the


header for each PLC request command.

LGISGLOFA

1 20
characters

ResponseHeader

Represents the response header.

LGISGLOFA

1 20
characters

CommandS
upported

MemoryInfo

R300
6/08

Name

Represents the command


name.

SEP

SEP, CON,
TB, COS,
DEV

MaxPacket
Size

Represents the maximum size


of the packet.

1024

100 1400

NumberOfV
ariables

Represents the number of


variables supported by the
command.

1 1000

Area

Represents the name for the


memory area for which the
configuration is defined. This is
the first part of the device
address within the PLC Point
name.

1 40
characters

Readable

If Yes, the memory can be read


using any Read command.

Yes

Yes or No

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

245

9. Appendix
9.3 Advanced settings
Parameter

Description

Default
Value

Possible
Values

Writable

If Yes, the value can be written


to the memory using any Write
command.

No

Yes or No

ScanPeriod

Default Scan Period when a


PLC item of this memory area is
configured, used only by the QB
Export component.

10

0 3600
seconds

BitLow

Represents the lower limit for


the memory area address. The
device address offset value
must be equal to or greater than
this value.

00.00.00

1 20
characters

Represents the higher limit for


the memory area address. The
device address offset value
must be equal to lesser than this
value.

15.07.63

DataTypes
Supported

Represents the data types


supported by this memory area.
(X-BIT, B-BYTE, W-WORD, DDWORD, L-LWORD, w-INT, dDINT, l-LINT)

XBWDL

AddressFor
mat

Represents the address format


for the memory area. The
device address must be
configured using this format.

ww.ww.b
b

CustomAre
aType

Configured only if it is a special


memory area and therefore the
offset is calculated according to
the special logic
(BASE_SLOT_AREA - follows
the Base.Slot.offset address
format).

BASE_S
LOT_AR
EA

BASE_SLOT_
AREA,
COMMON_A
REA,
BIT_WORD_
AREA

QueueSetti
ngs

DeviceResp
onseQueue
Size

Represents the PLC level


response Queue size.

10000

1 100000

CPUType

Code

Represents the CPU type code


provided by the PLC Status
command.

01

-1 10000

BitHigh

246

xx.xx.xx

1 20
characters
xx.xx.xx

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

X/B/D/W/L/d/
w/l/r/R

R300
6/08

9. Appendix
9.3 Advanced settings
Parameter

Description
CPUName

Default
Value

Represents the name of the


corresponding CPU.

GM1

Possible
Values
1 20
characters

The following table lists the parameters of MLPLCSettings >BadPVInfo tag in the
MLAppSettings.xml file:
Parameter

Description

BadPVSup
ported

InputRange

SpecialMo
duleMap

Special
Channel

Default
Value

Represents the input range of the I/O


channel for which the bad PV is
supported.

1v~5v

StatusA
ddress

Represents the status memory Address


bit for the I/O channel.

UXY.10.0

DataAdd
ress

Represents the Data Address for the I/O


channel. If this PLC is configured in
Experion, Bad quality is set.

UXY.02

Configuring PLC SOEs in MLSOEConfig XML


The MLSOEConfig.xml file is used for configuring the MasterLogic PLC SOEs.
The following table lists the parameters of MLSOEConfiguration > SOEInfo tag in the
MLSOEConfig.xml file:
Parameter

Description

Default
Value

Possible
Values

PLCID

Represents the PLC ID as configured in


the MLConfig XML file.

ML01

01 99,
prefixed
with ML.

SOEOption

Represents the default setting to raise the


PLC SOE based on the current bit value.

1, 0 ,C, F

DataType

Represents the default data type for the


SOE parameters at the PLC level. When
the data type is defined at the SOE level,
the default data type is overridden.

BIT

BIT, bit, Bit

Represents the address within the PLC for


which an SOE is raised.

M0010F

0 255
characters

SOE

R300
6/08

Device
Address

MasterLogic-Experion PKS Integration - User's Guide


Honeywell Confidential & Proprietary

247

9. Appendix
9.3 Advanced settings
Parameter
Descript
ion

248

Description
Represents the description of the SOE
displayed in the SOE Summary display.

Default
Value
M00100
SOE
Alarm

MasterLogic-Experion PKS Integration User's Guide


Honeywell Confidential & Proprietary

Possible
Values
0 255
characters

R300
6/08

Honeywell International
Process Solutions
2500 West Union Hills
Phoenix, AZ 85027

You might also like