LineGuard™ 2300 Program User Manual (FloBoss 107)
LineGuard™ 2300 Program User Manual (FloBoss 107)
November 2012
This manual may be revised periodically to incorporate new or updated information. The revision date of each
page appears at the bottom of the page opposite the page number. A change in revision date to any page also
changes the date of the manual that appears on the front cover. Listed below is the revision date of each page (if
applicable):
Page Revision
All Pages Nov-12
Initial release Jun-08
ii Rev Nov-12
LineGuard 2300 Program User Manual
Contents
Chapter 1 – Introduction 1
Chapter 2 – Installation 7
Chapter 3 – Configuration 13
iv Rev Nov-12
LineGuard 2300 Program User Manual
Chapter 1 – Introduction
This chapter describes the structure of this manual and presents an
overview and installation instructions of the LineGuard 2300 Program for
the FloBoss 107 (FB107).
Rev Nov-12 1
LineGuard 2300 Program User Manual
2 Rev Nov-12
LineGuard 2300 Program User Manual
each) after a major log alarm condition becomes active and will not resume
until after the user has manually cleared the major log alarm state.
Major Data Logs A Major Log is initiated when a major alarm becomes active, the alarm is
enabled and the event duration period has been satisfied. Alarm conditions
include Average Pressure less than the Major Low SetPoint, Average
Pressure greater than Major High SetPoint, and Average RoD greater than
Major RoD SetPoint. Major Log SetPoints, alarms, and event durations are
user configurable.
A complete Major Log consists of a time stamp (MM/DD/YY
HH:MM:SS), thirty Average Pressure values, and thirty Average RoD
values prior to the major alarm becoming active and thirty Average
Pressure values and thirty Average RoD values after the major alarm
became active. The time stamp indicates the actual time of the line break.
Only one major log is saved in the LineGuard unit. A major log will be
retained and not overwritten until you manually clear the major alarm state
by pressing Clear Logs on the LineGuard Status screen. Values are stored
in the log at a user configurable major log period. Valid log periods for a
major log include 5 seconds, 10 seconds, 15 seconds, and 30 seconds. The
current Average Pressure and Average RoD is written to the major log at
each log period.
Event Logs Event Logs are triggered by changes in SetPoints or parameters that affect
program operation. The event Log function is performed by the standard
FloBoss firmware. Event Log entries include conditions such as remote and
local commands to change valve position, change SetPoints, and change in
parameters that affect any aspect of the LineGuard operation. Event data
may be used to establish a history of LineGuard status and pipeline valve
activity. The event log allows for a maximum of 240 records and
overwrites old data as new events occur.
Alarm Logs Alarm Logs are triggered by exceeding operating limits and SetPoints. The
alarm log function is performed by the standard FloBoss firmware. The
alarm log collects and stores data not directly related to operator change
requests. Alarm entries include battery low voltage condition and any other
input point high and low condition. The alarm log can store up to 240
alarms and overwrites old entries as new alarms are encountered.
An alarm entry is also created when a Minor or Major Alarm becomes
active, a Minor or Major Alarm becomes inactive, and when automatic
valve closure is initiated and a transmitter fail condition becomes active or
clears. The following user text type alarm is created by the calculation
program.
Rev Nov-12 3
LineGuard 2300 Program User Manual
Major RoD Indicates the value and time at which the major RoD alarm
became active or inactive.
Major High Indicates the value and time at which the major high alarm
became active or inactive.
Minor Low Indicates the value and time at which the minor low alarm
became active or inactive.
Minor RoD Indicates the value and time at which the minor RoD alarm
became active or inactive
Minor High Indicates the value and time at which the minor high alarm
became active or inactive.
Trans Low Indicates the value and time at which the pressure value
reported from the transmitter dropped below the low limit.
Trans High Indicates the value and time at which the pressure value
reported from the transmitter rose above the high limit.
Trans OK Indicates the value and time at which the pressure value
reported from the transmitter are within alarm limits.
Shutdown Control The LineGuard program is responsible for automatic valve closure upon
the detection of a major line break.
Line Break Detection The Average Pressure and Average RoD are used to detect line-break
conditions every sample cycle (5 seconds). Valve closure is activated when
the four following conditions are met: a major log alarm becomes active, it
remains active for the configured Event Duration, auto-closure is enabled
for the event, and the Close Output field is defined. The major log will
continue to record data until it becomes full. The Event Duration can be
configured from 0 seconds to 1800 seconds (30 minutes).
If the Average Pressure or Average RoD returns to an allowable level
during the Event Duration period, then valve closure is not initiated and
normal pressure monitoring resumes.
Once a line-break situation has been detected, valve closure is completed, a
major log is filled, and then all log recording and valve control stops. The
user must select Clear Logs on the LineGuard Status screen before normal
pressure monitoring, logging, and control is resumed. If the Open Output
field is defined, the user can open the valve by selecting Force Open on
the LineGuard Valve Control screen or remotely. If the Open Output field
on the LineGuard Valve Control screen is not defined, the user must
manually open the valve on site.
Valve Control The control valve can be opened and closed both remotely and on-site by
setting the “Manual Close Flag” or “Manual Open Flag”. When the
“Manual Open Flag” is set the configured “Open Output” is energized for
the “Open Duration”. When the “Manual Close Flag” is set the configured
“Close Output” is energized for the “Close Duration”. “Open Duration”
and “Close Duration” values can be configured from 5 seconds to 1800
seconds (30 minutes).
4 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 5
LineGuard 2300 Program User Manual
voltage to the FloBoss 107 is outside of one of the alarm limits, the
program first checks to see if a valve closure is already in progress. If a
closure is in progress, the program will wait for the closure to complete
before taking action. When the input voltage is out of limits and no closure
in is progress, line break detection software and value closure algorithm are
disabled until the input voltage returns to within limits.
Note: You must connect a PC to the FB107’s LOI port before starting the
download.
For information on viewing the memory allocation of user programs, refer
to the ROCLINK 800 Configuration Software User Manual (for FB107)
(Form A6217).
6 Rev Nov-12
LineGuard 2300 Program User Manual
Chapter 2 – Installation
This section provides instructions for installing the LineGuard program.
Read Section 1.3 of this manual for program requirements.
Note: The program and license key can be installed in any order. The
manual shows the installation of the license key first.
Rev Nov-12 7
LineGuard 2300 Program User Manual
Note: This screen has three sections. The upper portion (Licenses on
Device) shows any software licenses installed on the FB107. The
middle portion (Licenses on Key) shows software licenses on the
license key. The lower portion of the screen (License Key Event
Log) provides a rolling log of the last eight events related to this
license key.
Note: An FB107 can hold up to six different licenses, although you can
install only one instance of each license on the FB107. When you
click Move to Device, ROCLINK 800 moves only one instance of
the license onto the FB107 and automatically decreases the license
quantity on the USB key by one.
8 Rev Nov-12
LineGuard 2300 Program User Manual
4. Click Browse in the Download User Program File frame. The Select
User Program File screen displays (see Figure 4).
5. Select the path and user program file to download from the CD-ROM.
(Program files are typically located in the Program Files folder on the
CD-ROM). As Figure 4 shows, the screen lists all valid user program
files with the .BIN extension:
Rev Nov-12 9
LineGuard 2300 Program User Manual
10 Rev Nov-12
LineGuard 2300 Program User Manual
7. Click Download & Start to begin loading the selected programs. The
following message displays:
8. Click Yes to begin the download. When the download completes the
following message displays:
Rev Nov-12 11
LineGuard 2300 Program User Manual
Note: If you install the program before you install the license key, the
Status field reads License Not Found. Install the license key to
change the status of the program.
10. Click Close. The ROCLINK 800 screen displays and the download is
complete. Proceed to Chapter 3, Configuration.
12 Rev Nov-12
LineGuard 2300 Program User Manual
Chapter 3 – Configuration
After you have loaded the LineGuard user-program on the FB107, you
configure the program using two program-specific screens (LineGuard
Status and LineGuard Valve Control):
Use the LineGuard Status screen to view program settings and
configure alarms, the sample period, and the units of measurement
used by the program.
Use the LineGuard Valve Control screen to configure parameters for
valve opening and closing and to configure the actions taken by the
program when a failed transmitter is encountered or input voltage is
out of limits
To configure the program (after logging onto ROCLINK 800 and
successfully installing the program and license key), proceed through the
program screens as shown in this section.
You can access all the program-specific screens from the main ROCLINK
800 screen:
Rev Nov-12 13
LineGuard 2300 Program User Manual
14 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 15
LineGuard 2300 Program User Manual
Field Description
transmitter status. Valid values are Good –
Normal Operation, Failed – Low Pressure,
and Failed – High Pressure.
Live Pressure This read-only field displays the current (live)
value from pressure input. This value is
updated every five seconds.
Average Pressure This read-only field displays the average
pressure over the last average sample period.
This value is updated every five seconds.
Current RoD This read-only field displays the current Rate
of Pressure Drop (RoD). The RoD is the
average pressure one minute ago minus the
current average pressure in units of
pressure/minute. This value is updated every
five seconds.
Average RoD This read-only field displays the last
calculated average of Rate of Pressure Drop
(RoD) over the last average sample period.
This value is used to determine the state of
major and minor RoD alarms. This value is
updated every five seconds.
Major Low Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Major Low Alarm. An average pressure below
the indicated threshold activates an alarm,
initiates a major log, and starts valve control if
the Major Low Alarm is Enabled. If disabled,
this alarm is ignored.
Major High Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Major High Alarm. An average pressure
above the indicated threshold activates an
alarm, initiates a major log, and starts valve
control if the Major High Alarm is enabled. If
disabled, this alarm is ignored.
Major RoD Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Major RoD Alarm. An average RoD above the
indicated threshold activates an alarm,
initiates a major log, and starts valve control if
the Major RoD Alarm is enabled. If disabled,
this alarm is ignored.
Minor Low Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Minor Low Alarm. An average pressure below
the indicated threshold activates the alarm
and a minor log is initiated. If disabled, this
16 Rev Nov-12
LineGuard 2300 Program User Manual
Field Description
alarm is ignored.
Minor High Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Minor High Alarm. An average pressure
above the indicated threshold activates the
alarm and a minor log is initiated. If disabled,
this alarm is ignored.
Minor RoD Alarm This read-only field displays the current
setting (Enabled/Disabled), threshold
(SetPoint), and current state (Status) of the
Minor RoD Alarm. An average RoD above the
indicated threshold activates the alarm and a
minor log is initiated. If disabled, this alarm is
ignored.
Major Log Period This read-only field displays, in seconds, the
period at which pressure and RoD values are
placed in the major log. Valid periods are 5,
10, 15, and 30 seconds.
Major Log State This read-only field displays the current state
of the major log function. Valid values are Not
Logging, Actively Logging, and Log is
Complete.
Number Major Logs This read-only field displays the number of
major logs archived.
Note: This number is always 0 or 1.
Minor Log Period This read-only field displays, in seconds, the
period at which pressure and RoD values are
placed in the minor log. Valid values are 30,
60, 120, 180, 240, and 300 seconds.
Minor Log State This read-only field displays the current state
of the minor log function. Valid values are Not
Logging, Actively Logging, and Log is
Complete.
Number Minor Logs This read-only field displays the number of
minor logs archived.
Note: The maximum number of minor logs is
100.
Minor Log Index This read-only field displays the minor log
index points to the most recent minor log in
the system. Up to 100 minor logs are
maintained in the LineGuard database.
Event Duration This read-only field displays, in seconds, the
configured period in which a major log alarm
must be active before major log archival and
valve closure initiates.
Active Event Time This read-only field displays, in seconds, the
length of time a major alarm has been active.
Rev Nov-12 17
LineGuard 2300 Program User Manual
Field Description
Reset/Clear Logs Clicking this button clears all major and minor
logs from the database and sets the log status
to Not Active. The records of the highest RoD
values are also cleared.
2. Click Apply to save any changes you have made to this screen.
3. Click Close to return to the ROCLINK 800 screen. Proceed to Section
3.1.2 to configure the Log/Alarm Setup screen.
18 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 19
LineGuard 2300 Program User Manual
Field Description
above the indicated threshold activates an
alarm and initiates a minor log if the Minor
High Alarm is enabled. If disabled, this alarm
is ignored.
Minor RoD Alarm Sets the Minor RoD Alarm as Enabled or
Disabled and defines the threshold (Setpoint)
for triggering an alarm. An average RoD
above the indicated threshold activates an
alarm and initiates a minor log if the Minor
RoD Alarm is enabled. If disabled, this alarm
is ignored.
20 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 21
LineGuard 2300 Program User Manual
22 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 23
LineGuard 2300 Program User Manual
Field Description
Manual Close Flag Click Force Close to force control valve
closure by activating the close output
point for the configured close duration.
This field may be written on-site or
through remote communications.
Close Duration Sets, in seconds, the length of time the
close output point remains active after
closure is initiated. Valid values are from
5, 10 15, 30, 60, 120, 180, 240, 300,
600, 1200, and 1800 seconds.
Current Close Time This read-only field displays the length
of time the close output point has been
active since valve closure was initiated.
This value will always be less than or
equal to the close duration.
Open output Click “…” to define the discrete output
point used to open the control valve.
Open Limit Switch Click “…” to define the discrete input
point monitoring status of the valve open
state. During valve opening, if this field is
defined and the status becomes active,
the open output will be de-activated.
Manual Open Flag Click Force Open to force opening of
the control valve by activating the open
output point for the configured open
duration. This field may be written on-site
or through remote communications.
Open Duration Sets, in seconds, the length of time the
open output point remains active after
opening is initiated. Valid values are from
5, 10 15, 30, 60, 120, 180, 240, 300,
600, 1200, and 1800 seconds.
Current Open Time This read-only field displays the length
of time the open output point has been
active since valve opening was initiated.
This value will always be less than or
equal to the open duration.
24 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 25
LineGuard 2300 Program User Manual
Field Description
Low Alarm Autoclosure Sets the Low Alarm Autoclosure as on
(Enabled) or off (Disabled) which allows
automatic closure of the valve when the major
log low alarm has been active for the event
duration period.
High Alarm Autoclosure Sets the High Alarm Autoclosure as on
(Enabled) or off (Disabled) which allows
automatic closure of the valve when the major
log high alarm has been active for the event
duration period.
RoD Alarm Autoclosure Sets the RoD Alarm Autoclosure as on
(Enabled) or off (Disabled) which allows
automatic closure of the valve when the major
log RoD alarm has been active for the event
duration period.
26 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 27
LineGuard 2300 Program User Manual
Field Description
Valid values are Transmitter Good - No
Reset In Progress, Possible Failure
Detected, Failed - Power Cycle
Initiated, Failed - Waiting for Power Up,
Failed - Warm Start In Progress, Failed
- Transmitter Updates Suspended, and
Good - Transmitter Recovered.
Fail Delay Period Sets, in seconds, the time delay after a
transmitter fail is detected before the reset
sequence is initiated.
Transmitter Fail Status This read-only field shows the current
status of the transmitter. Valid values are
Good – Normal Operation, Failed –
Low Pressure, and Failed – High
Pressure.
Transmitter Low Setpoint Sets the value for the Transmitter Low
Setpoint. When the input pressure drops
below this value, the transmitter is
considered failed.
Transmitter High Setpoint Sets the value for the Transmitter High
Setpoint. When the input pressure rises
above this value, the transmitter is
considered failed.
Transmitter Power Contact Click “…” to define a discrete output used
to cycle power to the input pressure
transmitter. This output is used to cycle
power to a failed transmitter in an attempt
to restore normal transmitter operation.
Transmitter Alarm Contact Click “…” to define a discrete output to be
used as an alarm indication of a failed
transmitter. This output is activated when
a failed transmitter is detected.
28 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 29
LineGuard 2300 Program User Manual
Field Description
High Voltage – Control Suspended,
Waiting for Valve Closure to Complete.
Live Input Voltage This read-only field shows the current
input voltage supplied to the FloBoss 107
unit.
Low Alarm Limit Sets the value for the limit at which the
input voltage is too low and the line break
functionality suspended. When the
voltage check is enabled and the input
voltage drops below this value, the
program will suspend detection of the line
break software and auto-closure
algorithm.
High Alarm Limit Sets the value for the limit at which the
input voltage is too high and the line
break functionality suspended. When the
voltage check is enabled and the input
voltage raises above this value, the
program will suspend detection of the line
break software and auto-closure
algorithm.
30 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 31
LineGuard 2300 Program User Manual
3. Click Yes to begin the save process. The Flash Write Status field on
the Flags screen displays In Progress. The following message displays:
4. Click OK. The Flash Write Status field on the Flags screen displays
Completed.
5. Click Update on the Flags screen. This completes the process of saving
your new configuration.
Note: For archive purposes, you should also save this configuration to
your PC’s hard drive or a removable media (such as a diskette or a
flash drive) using the File > Save Configuration option on the
ROCLINK 800 menu bar.
32 Rev Nov-12
LineGuard 2300 Program User Manual
Rev Nov-12 33
LineGuard 2300 Program User Manual
34 Rev. Nov-12
LineGuard 2300 Program User Manual
Rev. Nov-12 35
LineGuard 2300 Program User Manual
36 Rev. Nov-12
LineGuard 2300 Program User Manual
Rev. Nov-12 37
LineGuard 2300 Program User Manual
38 Rev. Nov-12
LineGuard 2300 Program User Manual
Rev. Nov-12 39
LineGuard 2300 Program User Manual
40 Rev. Nov-12
LineGuard 2300 Program User Manual
Rev. Nov-12 41
LineGuard 2300 Program User Manual
Headquarters:
Emerson Process Management
Remote Automation Solutions
6005 Rogerdale Road
Houston, TX 77072 U.S.A.
T +1 281 879 2699 | F +1 281 988 4445
www.EmersonProcess.com/Remote
Europe:
Emerson Process Management ©2008-2012 Remote Automation Solutions, a business unit of Emerson Process
Remote Automation Solutions Management. All rights reserved.
Emerson House
Kirkhill Drive Kirkhill Industrial Estate Remote Automation Solutions, a business unit of Emerson Process Management, shall
Aberdeen UK AB21 OEU not be liable for technical or editorial errors in this manual or omissions from this manual.
T +44 1224 215700 | F +44 1224 REMOTE AUTOMATION SOLUTIONS MAKES NO WARRANTIES, EXPRESSED OR
215799 IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
www.EmersonProcess.com/Remote FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THIS MANUAL AND, IN
NO EVENT SHALL REMOTE AUTOMATION SOLUTIONS BE LIABLE FOR ANY
North American/Latin America:
Emerson Process Management INCIDENTAL, PUNITIVE, SPECIAL OR CONSEQUENTIAL DAMAGES INCLUDING,
Remote Automation Solutions BUT NOT LIMITED TO, LOSS OF PRODUCTION, LOSS OF PROFITS, LOSS OF
REVENUE OR USE AND COSTS INCURRED INCLUDING WITHOUT LIMITATION FOR
6005 Rogerdale Road
Houston TX USA 77072 CAPITAL, FUEL AND POWER, AND CLAIMS OF THIRD PARTIES.
T +1 281 879 2699 | F +1 281 988 4445 Bristol, Inc., Bristol Canada, BBI SA de CV and Emerson Process Management Ltd,
www.EmersonProcess.com/Remote Remote Automation Solutions (UK), are wholly owned subsidiaries of Emerson Electric
Middle East/Africa: Co. doing business as Remote Automation Solutions, a business unit of Emerson Process
Emerson Process Management Management. FloBoss, ROCLINK, Bristol, Bristol Babcock, ControlWave, TeleFlow,
Remote Automation Solutions Helicoid, METCO, and OpenEnterprise are trademarks of Remote Automation Solutions.
Emerson FZE AMS, PlantWeb and the PlantWeb logo are marks of Emerson Electric Co. The Emerson
P.O. Box 17033 logo is a trademark and service mark of the Emerson Electric Co. All other marks are
Jebel Ali Free Zone – South 2 property of their respective owners.
Dubai U.A.E. The contents of this publication are presented for informational purposes only. While every
T +971 4 8118100 | F +971 4 8865465
effort has been made to ensure informational accuracy, they are not to be construed as
www.EmersonProcess.com/Remote
warranties or guarantees, express or implied, regarding the products or services described
Asia-Pacific: herein or their use or applicability. Remote Automation Solutions reserves the right to
Emerson Process Management modify or improve the designs or specifications of such products at any time without
Remote Automation Solutions notice. All sales are governed by Remote Automation Solutions’ terms and conditions
1 Pandan Crescent which are available upon request. Remote Automation Solutions does not assume
Singapore 128461 responsibility for the selection, use or maintenance of any product. Responsibility for
T +65 6777 8211| F +65 6777 0947 proper selection, use and maintenance of any Remote Automation Solutions product
www.EmersonProcess.com/Remote remains solely with the purchaser and end-user.