FacilityPro SCADA NG Software User Guide Rev B
FacilityPro SCADA NG Software User Guide Rev B
FacilityPro® SCADA NG
Software
USER GUIDE
P/N 1000023439
FacilityPro® SCADA NG Software
User Guide
HEADQUARTERS
5475 Airport Blvd CHINA KOREA SWITZERLAND
Boulder, Colorado 80301 USA T: +86 21 6113 3600 T: +82 31 286 5790 T: +41 71 987 01 01
T: +1 303 443 7100, +1 800 238 1801 E: pmschina@pmeasuring.com E: pmskorea@pmeasuring.com E: pmsswitzerland@pmeasuring.com
Quality Statement
The Quality Policy of Particle Measuring Systems is to strive to meet or exceed the needs and
expectations of our customers, and to align the activities of all employees with the common
focus of customer satisfaction through continuous improvement in the quality of our products
and services.
Manual Conventions
WARNING
A warning in the text is used to notify the user of the potential for bodily injury or death.
CAUTION
A caution in the text is used to highlight an item that if not done, or incorrectly done, could
damage the instrument and/or any materials or devices affected by the instrument.
– — NOTICE — –
A notice in the text is an instructional communication regarding requirements or policies
issued by Particle Measuring Systems.
NOTE: A note in the text is used to highlight an item that is of operational importance to
the user.
It is important that you observe cautions and warnings while performing the procedures
described in this manual. Caution and warning labels are located on and inside the instrument
to alert you to potentially hazardous conditions. Please familiarize yourself with this
information.
Table of Contents - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - v
List of Figures - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - xi
List of Tables - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - xv
Index - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Index-1
List of Figures - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - xi
List of Tables - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - xv
Chapter 1: Overview - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-1
FacilityPro Server Software Description - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-2
System Requirements - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-3
Installation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-3
Configuration - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-3
Electronic Signature - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-4
Electronic Signature window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1-4
Chapter 2: Get Started - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-1
System Start-Up - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-1
Components of the FacilityPro software screen- - - - - - - - - - - - - - - - - - - - - 2-2
Header information in the FacilityPro software screen - - - - - - - - - - - 2-2
Central area in the FacilityPro software screen - - - - - - - - - - - - - - - - - - 2-2
Buttons row in the FacilityPro software screen - - - - - - - - - - - - - - - - - - 2-2
Main Page Window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-4
Channel Status Legend window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-9
Log In - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-11
Login window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-11
Log Out - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2-11
Chapter 3: Recipes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-1
Recipes Editor Window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-1
Create a New Recipe - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-5
Edit an Existing Recipe - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-5
Delete an Existing Recipe - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3-6
Chapter 4: Sampling - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-1
Sampling Editor Window- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-1
Schedule a Sampling- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-4
Sampling editor dialog box- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-4
Abort a Sampling Event- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-5
Edit a Scheduled Sampling - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-6
Delete a Scheduled Sampling - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-6
Configuring Custom Fields to Apply to a Sampling- - - - - - - - - - - - - - - - - - - - - - 4-7
Custom fields configuration window - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 4-7
Chapter 5: Sampling Point Information - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5-1
Sampling Point Information display - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5-1
Particle Module Values - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5-2
Biological Channel Values- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5-4
Analog Module Values - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5-6
Index - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Index-1
System Requirements
The following are minimum operating system (OS) specifications for compatibility
with the FacilityPro SCADA system:
• SCADA and Terminal Server OS: Windows Server 2016 Standard 64-bit
• Clients: Windows 10 Standard 64-bit
Installation
The C:\ drive should be used for application installation only. The E:\ drive should be
used for the database directory.
Configuration
The SCADA server uses an auto-login operating system where the SCADA workspace is
virtualized. In an active workspace, only iFix administrators will be able to access the
OS. iFix users will not have access. In an active directory, iFix users can be added with
operating-only permissions on the domain.
Electronic Signature
The Electronic Signature feature is a SCADA control that applies password protection
for performance of an operation or a change of critical value for the system.
Presentation of the window for Electronic Signature is context-sensitive for certain
tasks that the logged-in user performs with FacilityPro software. These tasks include:
• Alarm management
(see Acknowledge an Alarm on page 6-8)
• Recipe management
(see Create a New Recipe on page 3-5 and Edit an Existing Recipe on page 3-5)
• Begin or stop sampling
(see Schedule a Sampling on page 4-4 and Edit a Scheduled Sampling on page 4-6)
• Channel ON/OFF management
(see Table 2-2 Main Page window components on page 2-5 and Table 5-1
Customized Map window for Particle Module on page 5-2)
• Change sampling point descriptions in the Sensors Editor window
(see Sensors Editor on page 7-5)
• Shutdown or restart the Facility Pro SCADA server or your FacilityPro client PC
(see Shut Down the System on page 7-32)
FacilityPro software runs as a dedicated desktop on the FacilityPro server and client
PCs, if present.
System Start-Up
At power-up of the primary SCADA server and at subsequent power-up of a client PC,
the FacilityPro software application launches automatically and displays the Main
Page window for the FacilityPro software application (see Figure 2-1) with the default
user logged in (username Nobody).
NOTE: To work with the FacilityPro software interface you will need to
log out the user Nobody and log in as an authorized user (see Log
In on page 2-11).
Buttons for
accessing
windows
Main button
Click this button to display the Main Page
window (described in Main Page Window on
page 2-4).
Alarms button
Click this button to display the Alarms window
(described in Chapter 6 Alarms).
System button
Click this button to display the System window
(described in Chapter 7 System Tasks).
Report button
Click this button to display the Report window
(described in Chapter 8 Reports).
Report button
Click this button to manually log an event with
the Electronic Signature.
Log-in button Click this button to display the Login window
(described in Log In on page 2-11).
Log-out button
Click this button to log out the current user
(described in Log Out on page 2-11).
Aaaaa button
A customer-specific button may also be
available.
Sensor locations
Figure 2-2 Main Page window showing locations of sensors in one room
and tables with sensor information
The locations of modules are indicated as follows:
Biological channels – Indicated by an oval .
Sensor modules – Indicated by a solid rectangle .
The color of a circle or rectangle indicates the current status of the module.
See Table 2-3 Channel Status Legend window components on page 2-10 for descriptions
of what a particular color indicates about the status of a module.
The information displayed in a Sensor Information area for each sensor module in
the FacilityPro System includes:
• Sensor location
• Sensor status indicated by a colored status oval (see Table 2-3 on page 2-10)
• Sensor information area
The components of the FacilityPro Main Page window are described in Table 2-2 on
page 2-5.
>> To open the Main Page window:
• Click the Main button at the bottom of the FacilityPro screen.
The Main Page window appears showing the floorplan and sensor locations (see
Figure 2-2).
A floorplan drawing in the Main Page window may be partitioned into several rooms
to allow better visualization of sensor module locations when you click on a room to
zoom in on it.
>> To zoom in on a particular room in a floorplan on the Main Page window:
1 Click on the room.
The floorplan of the room displays in the center of the Main Page window and the
Sensor Information areas (see Table 2-2 on page 2-5) display on the left and right
sides of the window.
2 To return to the full floorplan view, click the Main button at the bottom of
the FacilityPro screen.
The full floorplan displays in the Main Page window.
Table 2-2 Main Page window components
Component Description
Floorplan area Displays in the floorplan drawing in the center of the window:
• The custom ID of each sensor displays next to its physical location.
• A colored status oval or rectangle displays next to the sensor ID (see Channel
Status Legend window on page 2-9).
• Colored lines connect between the physical location of a sensor on the floor plan
and its corresponding information display in the left or right side of the window.
>> Click a room in the floorplan to zoom in on that room.
Sensor Information areas The Sensor Information areas are display-only.
1 Click the Legend button near the bottom left of the Main Page window.
The Channel Status Legend window appears (see Figure 2-3).
The components of the Channel Status Legend window are described in Table 2-3.
Pause (Blue) – The sampling run for the sampler has been paused.
Delayed start (Pink) – The start time for sampling has been intentionally
delayed for a later start.
Alarm (Red) – The flow rate crossed the threshold or another alarm
condition has occurred.
Particle column Displays the explanations for the status colors for the rectangles displayed on the
drawing in the Main Page window for particle sensors.
Idle (White)
The sensor is not currently sampling.
Starting/Stopping/Waiting…/Warming up (Light green)
The sensor is in a pre-sampling condition, that is, it is either starting,
stopping, waiting, or warming up.
Sampling (Green)
The sensor is currently sampling.
Delayed Start (Pink)
The start time for sampling has been intentionally delayed for a later start.
Warning (Yellow)
The number of particles sampled is approaching the threshold set in the
Sensors Editor.
Alarm/Fault (Red)
The number of particles sampled has crossed the threshold set in the Limits
Editor or a sensor fault has occurred. It is recommended to halt the
sampling and determine why so many particles are present.
Click this button to close the Channel Status Legend window.
Close
button
Log In
At system start-up, the FacilityPro Main Page window displays with the default user
(username Nobody) logged in. In order to interact with the FacilityPro application, a
user is expected to log in with their username and password, as the default user has
limited access to the features in the FacilityPro application.
Management of user privileges, usernames, and passwords for access to FacilityPro
features is described in Chapter 9 User Management.
Login window
>> To log in to FacilityPro:
1 Click the Log-in button at the bottom of the FacilityPro screen.
The Login window appears (see Figure 2-4).
NOTE: If another user is currently logged in, the Login window displays the
Log-out button, which you need to click before you can log in.
For more information on managing users, see Chapter 9 User Management.
Log Out
>> To log out the current user:
1 Click the Log-out button at the bottom of the FacilityPro screen.
FacilityPro logs out the current user.
NOTE: DO NOT log off of the system by clicking the Log-in button and then
using the Log-out button in the Login window.
The FacilityPro Recipes Editor window (see Figure 3-1) is used to create, edit, and
delete recipes for running the FacilityPro System. A recipe defines a group of sensors
selected to sample at the same time.
Cancel button Click this button to exit the new recipe mode or the modify
recipe mode and enable the Available recipes field and
the Load button.
History button Select a recipe from the Available recipes field, then click
this button to open a report window that shows the
definition of the selected recipe and has a
Print button for sending a copy of the report to the printer.
Sensors area Contains a check box for each sensor in the system.
sensor n check boxes
• When checked, the sensor can be added to a recipe.
Select All button Click this button to quickly place a checkmark in all the
sensor check boxes.
Deselect All button Click this button to quickly remove the checkmark from
all the sensor check boxes.
Select All button Click this button to quickly place a checkmark in all the
Analog sensor check boxes.
Deselect All button Click this button to quickly remove the checkmark from
all the Analog sensor check boxes.
Add selected sensors to recipe button field or the New Recipe button has been
clicked, AND one or more Analog sensor check boxes is
checked , click this button to add the checked BIO
sensors to the recipe.
Length (min) column When the Mode is set to Time, enter the duration of the
sampling in minutes.
Volume (liters) column When the Mode is set to Volume, enter the amount of air to
be sampled (in liters).
Pause (min) column Enter the number of minutes to pause before sampling.
Delayed start column Select Yes to set a delay on the start-up of sampling, then
enter the delay in the Delay (min) column.
Delay (min) column When Yes is entered in the Delayed start column, enter the
length of the delay (range 1 to 480 minutes).
Clean Time (min) column It is possible to set the cleaning time at the start of the
sampling.
• Only pump is driven in order to clean the vacuum line.
• During this time, the system does not handle warnings
and alarms.
Status bar Displays the status of the connection to the FacilityPro
Processor Module:
• Connected – Indicates FacilityPro software application is
connected to the FacilityPro Processor Module.
• Disconnected – Indicates FacilityPro software
application is disconnected from the FacilityPro
Processor Module.
Click this button to close the Recipes Editor window and
Close button
return to the Main Page window.
The FacilityPro Sampling Editor window (see Figure 4-1) is used to schedule
sampling times for running specific recipes.
The components of the Sampling Editor window are described in Table 4-1 on page
4-2.
Table 4-1 Sampling Editor window components
Component Description
Click this button to view the first page.
First Page button
Click this button to view the previous page.
Previous Page button
Next Page button Click this button to view the next page.
User column The name of the user that scheduled the sampling.
Group column The name of the group that contains the user that scheduled
the sampling.
Note column Comments included when the sampling was created.
Schedule a Sampling
Scheduling a sampling using the Sampling Editor window involves defining the fields
of the Sampling editor dialog box such as:
• Selection of an existing recipe
• A Batch Number
• Date and time the sampling should begin
• Mode for the sampling
• Comments
and performing the Electronic signature
OK button Click this button of save the new sampling schedule and close
the Sampling on input editor dialog box.
Cancel button Click this button to close the Sampling on input editor dialog
box without scheduling a sampling.
1 Click the Insert button at the top of the Sampling Editor window.
The Sampling editor dialog box appears (see Figure 4-2 on page 4-4).
2 In the Select recipe field of the Sampling on input editor dialog box, select the
recipe you want to use for the sampling.
3 If desired, in the Batch Number field, enter a Batch number to include in the
Sampling Report.
Optional; see Custom fields configuration window on page 4-7.
4 From the Process field list box, select the type of process to include in the Sampling
Report (ex: Cleaning, Other).
Optional; see Custom fields configuration window on page 4-7.
5 If desired, in the Input notes: field, enter notes to include in the Sampling Report.
6 From the Select start date and time: fields, select the day and time the recipe
should begin sampling.
7 From the Sampling Mode dropdown list, select the operating mode in which to start
the sampling (ex: Operational, At Rest, Normal Operation, Custom).
8 Click the OK button in the Sampling on input editor dialog box.
9 Perform the electronic signature to start the sampling (see Electronic Signature on
page 1-4).
The new sampling definition appears in the Samplings Table list.
>> To define custom fields for the Sampling editor dialog box:
1 Open the Sampling Editor window as described on page 4-1.
2 Click the Configuration button at the bottom of the Sampling Editor
window.
The Custom fields configuration window appears (see Figure 4-3 on page 4-7).
3 In the Custom fields configuration window, define the display label for the field:
a. Click in the Display Name column for the field you want to work with.
b. Type the text to use as the name of the field.
4 In the Custom fields configuration window, set True/False for whether to display
the field in the Sampling Editor window:
a. Click in the Enable column for the field you want to work with.
b. From the list box, select:
• True – Causes the field to be displayed in the Sampling editor dialog box with
the label defined in the Display Name field.
—OR—
• False – Prevents the field from being displayed in the Sampling editor dialog
box.
5 In the Custom fields configuration window, set whether the field will allow text
data entry:
a. Click in the Editable column for the field you want to work with.
b. From the list box, select:
• True – Causes the field to be edited by the user in the Sampling editor dialog
box.
• False – Prevents the field from being edited by the user in the Sampling editor
dialog box.
6 When the value in the Editable column for the field has been set to False in the
Custom fields configuration window, you can define the names for choices to
display in a list box for the field.
a. Type the first value.
b. Type a comma.
c. Type the next value.
d. And so forth.
The values must be typed as a comma-separated list without a space after a
comma.
7 Click the Save Changes button in the Custom fields configuration window to
save your changes.
8 Click the Close Window button to close the Custom fields configuration
window.
9 The custom fields will display the next time the Sampling editor dialog box is
opened.
The FacilityPro Sampling Point Information windows (see Figure 5-1) are used to view real-
time information for each sampling point of instruments connected to the system:
• Particle counter (see Particle Module Values on page 5-2)
• Biological module (see Biological Channel Values on page 5-4)
• Analog module (see Analog Module Values on page 5-6)
• Click the Main button at the bottom of the FacilityPro screen. Then click on a
specific sampling point.
A window with sampling point information appears (see Figure 5-1).
Figure 5-1 FacilityPro window showing information panels for particle sensors
Window components are described in Table 5-1.
button – When in the OFF position, click this button to turn the biological
sensor ON. The Electronic Signature window will appear (see Electronic
Signature on page 1-4).
button – When in the ON position, click this button to turn the biological
sensor OFF. The Electronic Signature window will appear (see Electronic
Signature on page 1-4).
Manifold Pressure Optional map customization object.
Current vacuum pressure in the main FacilityPro manifold (in kiloPascals).
The FacilityPro Alarms window (see Figure 6-1) is used to acknowledge an alarm. Data that is
saved with each alarm include the following:
• Alarm description (can be translated)
• Timestamp
• Acknowledgement user
• Acknowledgement comments
Alarms Window
>> To open the Alarms window:
• Click the Alarms button at the bottom of the FacilityPro screen.
The Alarms window appears (see Figure 6-1).
The components of the Alarms window are described in Table 6-1 on page 6-2.
NOTE: The information that displays in the table in the Alarms window is the same
information that displays in the table in the Popup Alarms pane (see Pop-
Up Alarms on page 6-11).
Once executed, the application will open in a new window (see Figure 6-2).
Note that individual alarms can be checkmarked or un-checkmarked in the Alarms Editor tab.
The following procedure is the optimal way to edit a group of alarms, but it also applies to any
alarms listing, which may consist of only one alarm via filtering.
Imported Alarms
The Imported Alarms tab is used to import and view alarms from other systems. See
Table 6-1 for a description of the contents that also appear in this tab.
Acknowledge an Alarm
Acknowledging an alarm requires entry of a password in the Electronic Signature window.
>> To acknowledge an alarm:
1 Open the Alarms window as described on page 6-1.
2 In the Alarms window (see Figure 6-1 on page 6-1), locate the alarm you want to
acknowledge:
a. In the Severity Filter (min) list field (in the lower-right part of the Alarms window),
select the minimum severity level you want to use to populate the alarms list.
The table reorganizes to only show alarms with the minimum and higher level of
severity selected (ex. If a severity level of 2 is chosen, only those alarms with a severity
of 1 and 2 are shown).
3 Double-click on the individual alarm you want to acknowledge.
The Electronic Signature window appears.
4 Enter your electronic signature (see Electronic Signature on page 1-4).
After you enter the electronic signature, the system acknowledges the alarms.
NOTE: When using redundant servers, each alarm must be acknowledged on both
SCADA servers. Both alarms will appear in the audit report.
Alarm Tables
The following alarms are provided by the system.
Table 6-3 Alarm list – SCADA
Alarm Description
FacilityPro n: Debuffering FacilityPro processor is debuffering
FacilityPro n: Buffer Alarm Node A SCADA node A is disconnected more than Buffer hour time
FacilityPro n: Buffer Alarm Node B SCADA node B is disconnected more than Buffer hour time
FacilityPro n: Disconnected FacilityPro Processor n Communication alarm
FacilityPro n: Node B Communication Alm Secondary SCADA Communication alarm
FacilityPro n: Tag List 1 Mismatch Processor – SCADA Configuration Mismatch
FacilityPro n: Redundancy 1 Mismatch Tag Mismatch between SCADA Primary and Secondary
FacilityPro n: Node A Communication Alm Primary SCADA Communication alarm
Alarm Description
FacilityPron: PMn Chn Flow Valve Status Pneumatic Channel Flow valve Alarm
FacilityPron: PMn Com Alarm Pneumatic module communication alarm
FacilityPron: PMn Calibration Alert Pneumatic Module Calibration alert
FacilityPron: PMn Calibration Alarm Pneumatic Module Calibration alarm
FacilityPron: PMn Pressure Test Fault Pneumatic Module High Pressure test Fault
Pop-Up Alarms
When an alarm event occurs, FacilityPro stores data about the alarm, including:
• Date and time the alarm occurred
• Area where the alarm occurred
• Alarm value (OK, alarm, debuffering)
• Alarm state (active, inactive, acknowledged, unacknowledged)
• Description of the condition that triggered the alarm
You can superimpose a pane that has a listing of alarm event data over the active window by
clicking the Popup Alarms button at the bottom of the FacilityPro screen.
NOTE: The information that displays in the table in the Popup Alarms pane is the
same information that displays in the table in the Alarms window (see
Alarms Window on page 6-1 in Chapter 6 Alarms).
>> To display the Popup Alarms pane at the bottom of the screen:
1 Click the Popup Alarms button at the bottom of the FacilityPro screen.
A pane overlays the bottom fifth of the FacilityPro window showing a table that lists alarm
event details. Columns are identical to those in the Alarms window (see Table 6-1 on page
6-2).
2 To move the view of the rows up and down in the table, use the vertical scroll bar on the right
side of the pane.
3 To move the view of the columns in the table left and right, use the horizontal scroll bar at
the bottom of the pane.
4 To close the Popup Alarms pane, click the Close button at the right edge of the
table.
The FacilityPro System window (see Figure 7-1) has buttons to access the windows for
the following tasks:
• Access the user management interface (see Chapter 9 User Management,
Managing Users on page 9-4)
• Edit sensor configuration (see Sensors Editor on page 7-5)
• Backup and restore (see Backup and Restore on page 7-7)
• Windows Explorer interface (see Windows Explorer on page 7-29)
• Use the Buffer Manager window to manage restore the buffered data that was
collected prior to a SCADA server connection disruption (see Driver Tools on
page 7-30)
• Shutdown the system (see Shut Down the System on page 7-32)
• Edit particle limits (see Limits Editor on page 7-34) and view particle limits history
(see Limits Editor History window on page 7-37)
• Analog Limits Editor (see Analog Limits Editor on page 7-41)
• Run Time Logic Editor (see Run Time Logic Editor on page 7-43)
• Administer history (see Historian Administrator on page 7-62)
• Translating entire system in other languages (accessible only by ASCOTEC user)
System Window
The System window (see Figure 7-1) is a menu with buttons for accessing the
windows for managing the following system features:
• users (see Chapter 9 User Management, Managing Users on page 9-4)
• sensors (see Sensors Editor on page 7-5)
• backups and restores (see Backup and Restore on page 7-7)
• accessing Windows Explorer (see Windows Explorer on page 7-29)
• managing OPCLinkServer data buffer back-up restoration after a SCADA connection
network failure (see Driver Tools on page 7-30)
• shutting down the system (see Shut Down the System on page 7-32)
• particle limits, historian administration (see Limits Editor on page 7-34)
• Translating entire system in other languages (accessible only by ASCOTEC user).
Available languages are:
• English
• Italian
• Spanish
• French
• German
• Portuguese
• Swedish
• Russian
• Japanese
• Korean
• Chinese PRC
• Chinese Taiwan
Sensors Editor
The Sensors Editor window is used to view (Operator users) and change
(Administrator users) the descriptions of individual sampling points that populate
labels for data entry fields and display-only fields in other windows of the FacilityPro
software application.
The components of the Sensors Editor window are described in Table 7-2.
Table 7-2 Sensors Editor window components
Component Description
Toolbar The buttons on the toolbar at the top of the Sensors
Editor window are used to navigate to the record in
the table you want to work with and to “post” and
save your edits.
The components of the Backup Application window are described in Table 7-3.
Table 7-3 Backup Application window components
Component Description
Automatic Backup Copy Directory At the chosen BackupTime on a daily basis, backup will be executed
and stored to the specified directory.
Manual Backup Copy Directory After clicking the Backup Now button, backup will be executed and
stored to the specified directory.
Long Term Backup Copy Directory On a daily basis at the specified BackupTime, data files that meet
both the following criteria:
• contain data saved at or after the number of
Log Term Backup Months
• located on the local disk
will be moved into the specified directory.
Used to free space on the local data disk.
History Directory This directory will store backup information related to limit and
recipe changes.
FacilityPro Number The number of processor modules in the system. Configuration files
from each processor module are retrieved and are part of backup.
Log Term Backup Months The number of months (from 1 to 120) before daily backups will occur
at the specified BackupTime into the specified Long Term Backup
Copy Directory.
Backups Clean up Days The number of days where backup data is stored in the Automatic
Backup Copy Directory before being deleted. This option prevents
the storage folder from growing too large.
Archive Dimension (Days) The number of days after which the Historian Data Archiver
application is forced to close.
BackupTime The time (in HH:MM:SS) at which automatic and long term backup will
occur to the specified directories.
Last backup date The date (in day/month/year) when the last backup occured.
Facility Pro 1 IP Addr. IP Address of FacilityPro Processor 1
Facility Pro 2 IP Addr. IP Address of FacilityPro Processor 2 (added when FacilityPro
Number is increased from 1 to 2)
Facility Pro 3 IP Addr. IP Address of FacilityPro Processor 3 (added when FacilityPro
Number is increased from 2 to 3)
Facility Pro 4 IP Addr. IP Address of FacilityPro Processor 4 (added when FacilityPro
Number is increased from 3 to 4)
Facility Pro 5 IP Addr. IP Address of FacilityPro Processor 5 (added when FacilityPro
Number is increased from 4 to 5)
Test Mode Used to change the specified number of Log Term Backup Months
into hours (for qualification purposes).
Legacy mode Historian Version 5.0 Checkmarked when the system has Historian 5.0 installed.
Backup Now Button that initiates backup of data to set parameters.
5 Click the Connect to service button (located on the top left of the window).
6 All fields are now available for editing. See Table 7-4 for descriptions of the buttons
present in addition to the fields described in Table 7-3.
2 Click on the adjacent folder button or manually type the directory into the
Automatic Backup Copy Directory field.
3 Set the desired BackupTime which has a format of HH:MM:SS.
Manual backup
A manual backup of a database can be configured through the Backup Service
Configuration Editor, and performed through the Backup Application window (see
Figure 7-4 on page 7-10). Manual backup uses the following parameters:
• Manual Backup Copy Directory
2 Click on the adjacent folder button or manually type the directory into the
Manual Backup Copy Directory field.
2 Click on the adjacent folder button or manually type the directory into the
Long Term Backup Copy Directory field.
3 Set the desired BackupTime which has a format of HH:MM:SS.
4 Set the desired Log Term Backup Months.
Restore
Restore can only be performed by the domain administrator. The restore operation is
not dependent on the backup location. Backup locations for use can be any of the
following:
• Automatic Backup Copy Directory: Contains complete backup files at the time
of backup
• Manual Backup Copy Directory: Contains complete backup files at the time of
backup
• Long Term Backup Copy Directory: Contains folders with Historian Archives
(Data)
Before starting any restore procedure, Shutdown iFIX and Create a Restore
Directory:
Shutdown iFIX
Before starting any restore procedure, do the following:
1 From the System window, click Shutdown System.
2 Click Shutdown iFIX only.
WARNING
The Restore procedure completely overwrites existing data!
Disaster Recovery
Disaster recovery is the complete restore of the latest automatic or manual backup.
• If the Historian Database is corrupt, empty the Historian Database before
performing the restore. See Restoring an SQL Database.
• If the Historian Database is empty (ex. from a new installation), only use Restoring
Historian Configurations on page 7-16.
Deleting Archives
Left column
To execute disaster recovery for a manual or automatic backup, the following must all
be restored:
• Historian Configurations
• Data Archives
• Alarms&Events
• TAG_CATALOG
• FacilityPro Processor Module Configuration
• iFix Security
• History files
5 Click iHistorian_Admin.exe.
6 From the top panel, click on DataStores.
7 Extract all files from the archive .zip file to restore in a separate folder.
8 Click Restore an Archive from Backup.
9 Click the Browse button to select the archives to restore.
10 Press OK when prompted both times.
11 The restored archives are added to the list of “online archives” in Proficy Historian
Administrator.
12 Repeat this procedure for all archives to be restored.
13 Close Proficy Historian Administrator.
14 Restart the PC.
8 In the Select a page pane on the left side, click General (see Figure 7-8).
9 In the Source for restore pane on the right side, choose From device.
10 Click OK.
11 The Specify Backup window opens.
14 Ensure the Selected path field is the one specified in step 2, with PMS_AE_DB.bak
selected as the File name.
15 Click OK.
16 In the Specify Backup window, click OK.
17 In the Restore Database window, checkmark the Restore box adjacent to the
backup set entry in the Name column. See the circled area in Figure 7-11.
19 Checkmark Overwrite the esisting database (WITH REPLACE). See Figure 7-12.
20 Press OK.
21 The Microsoft SQL Server Management Studio window opens.
22 Press OK.
23 Restart the PC.
Restoring TAG_CATALOG
The TAG_CATALOG database contains all ReportGenerator settings for data extraction.
7 In the Select a page pane on the left side, click General (see Figure 7-15).
8 In the Source for restore pane on the right side, choose From device (see Figure
7-15).
9 Click OK.
10 The Specify Backup window opens.
13 Ensure the Selected path field is the one specified in step 2, with
TAG_CATALOG.bak selected as the File name.
14 Click OK.
15 In the Specify Backup window, click OK.
16 In the Restore Database - TAG_CATALOG window, checkmark the Restore box
adjacent to the backup set entry in the Name column. See the circled area in Figure
7-18.
21 Click OK.
22 Restart the PC.
4 Run AirCaptUpdate.exe.
5 The FacilityPro Update window opens.
6 Type the IP Address of the processor module that is being restored into the Remote
Host IP Address field. See Figure 7-21. Default IP Addresses are:
• FacilityPro Processor Module 1: 192.168.86.4
• FacilityPro Processor Module 2: 192.168.86.3
• FacilityPro Processor Module 3: 192.168.86.5
10 Once all files have been selected, click the Transfer button to transfer all files via
FTP.
11 Press the Restart button to apply uploaded settings. The FacilityPro processor
module will restart.
12 After the processor module has restarted, repeat the above restore procedure for all
other processor modules in the system.
13 Restart the PC.
Windows Explorer
From the System window you can open the Computer window for Windows
Explorer, where it is possible to access the PC’s operating system.
Only Administrator users have sufficient privileges to open Windows Explorer.
Driver Tools
Buffer Manager
The FacilityPro SCADA PC communicates with the FacilityPro Processor using OPC.
The OPCLinkServer on the Processor stores 8 hours of buffer data from the sensor
module(s) as a back-up in case the SCADA connection to the client gets broken during
a temporary network failure.
If the client’s SCADA connection gets broken, but the client connection to the
FacilityPro Processor Module survives, the buffer is streamed to the connected clients
as soon as the SCADA connection has been reestablished. At this point, the
Administrator user can use one of the Driver Tools, the Buffer Manager window (see
Figure 7-24), to manage the restoring of the buffered data that was collected prior to
the SCADA server connection disruption.
As soon as the SCADA connection has been re-established, the sensor buffer data is
streamed to the connected clients. If the operator opens the Buffer Manager in the
Driver Tools window (see Figure 7-24 on page 7-30) the operator will see the message
FacilityPro Debuffering at the top of the Driver Tools window while the buffered data
is being received by the client.
Through the Buffer Manager window the operator has several choices of how to
manage the buffered Airnet data stream:
• Wait for the client to download the entire 8 hours of data collected in the
OPCLinkServer buffer prior to the connection loss.
• Reset the buffer in the client to start getting live data immediately.
• Download just a portion of the old data from the buffer to the client and discard the
remaining data.
The components of the Buffer Manager in the Driver Tools window (see Figure 7-24
on page 7-30) are described in Table 7-5.
Table 7-5 Components of the Buffer Manager in the Driver Tools window
Components Description
table columns
Debuffering Reset column List of SCADA clients in the FacilityPro System. When the check box
next to the name of a SCADA client is checked, that client will be
affected by the choices selected in the Buffer Manager window.
Debuffer up to Displays the end date and time for the data download from the
buffer.
Last Received Data
Timestamp of the last Airnet data stored in the OPCLinkServer data
buffer.
Debuffering Progress
Progress displayed as a progress bar.
date field Defines the end date for the data in the buffer you want to work with
(in the format that matches the date format displayed in the top
right side of the window). For example, 14/03/2012 causes the
sensor data in the buffer collected on March 14, 2012 before the time
specified in the time field on that day to be downloaded to the client
when the Buffer Reset button is clicked.
time field Defines the time of day for the data in the buffer you want to end
with (in the 24-hour clock format).
After you have defined a end date and end time using the date and
time fields, click this button to begin the Airnet data download to the
Buffer Reset button
SCADA client.
Click this button avoid downloading the Airnet data in the buffer and
erase the OPCLinkServer data buffer to make it ready to accept fresh
sensor module data.
Immediate Buffer Reset button
Restart
>> To restart the Facility Pro SCADA server or your FacilityPro client PC:
Shut down
Limits Editor
The Limits Editor window can be used to view and edit the particle limits used by the
system to handle warnings and alarms.
Only Administrator users have sufficient privileges to make changes to this list.
The components of the Limits Editor window are described in Table 7-6 on page 7-35.
Field name field When the Enable check box is checked, use this list box to select
the name of the following fields to use with a Field value to focus the
values in the table to just those selections:
• Limit type
• Particles size
• Sampling mode
• Sensor class
Field value field When the Enable check box is checked and a field name is
selected in the Field name field, enter the value for limiting the
scope of the values displayed in the table.
First Pos. option When selected, positions the row pointer at the first row in the
table.
Any Pos. option When selected, positions the row pointer wherever you click
on a row.
Navigation buttons Use the arrow buttons at the top of the Limits Editor window to view
a different page of the table.
of the list.
• Next Page button – Click this button to view the next page
of the list.
• Last Page button – Click this button to view the last page
of the list.
Click this button to save changes made in the Limits Editor window.
Save button
3 Click the History button at the top of the Limits Editor window.
The Limits Editor History window appears (see Figure 7-27).
4 To close the Limits Editor History window, click the X button at the top right
corner of the window.
The components of the Limits Editor History window are described in Table 7-7.
Table 7-7 Components of the Limits Editor History window
Components Description
Click this button to open a Print dialog box where you can send a
Print button
copy of the listing to the printer.
Click this button to export the history in PDF format.
PDF Export button
Dates list Click on a date to populate the Alarms Limits table with information
from that date. The date you selected displays be low the table title.
Alarms Limits table columns
Class column Class identification of particle limit sampling.
Size column The particle size.
Sampling Mode column The Sampling mode. For example:
• At Rest
• Operational
Limit type column Alarm or Alert.
Limit value column Value of the limit.
Cubic Meter Alarms column True or False.
Cubic Meter Type column • Rolling – The system performs a floating window of data per
minute to calculate counts per cubic meter (fast trend).
• Reset – When the sampling reaches the cubic meter, the system
resets the count (total count).
• CF X 35 – The system multiplies the value of the cubic foot by 35.
Predictive column True or False.
Interval column The interval value.
Number column The number of events out of bounds.
Figure 7-28 Sensors Classes and Sampling Modes Configuration window displayed in front
of the Limits Editor window
3 To close the Sensors Classes and Sampling Modes Configuration window, click
the X button at the top right corner of the window.
The components of the Analog Limits Editor window are described in Table 7-8.
Table 7-8 Analog Limits Editor window view components
Component Description
Short ID column Displays the output’s system identification number.
Custom ID column Displays the output’s user-specified identification number.
Description column Displays a description of the output.
Alert Limits columns
LO Displays the minimum value set for the output’s range before the alert is triggered.
HI Displays the maximum value set for the output’s range before the alert is triggered.
Delay (sec) Displays the number of seconds delay before the alert is triggered.
Alarm Limits columns
LOLO Displays the minimum value set for the output’s range before the alarm is triggered.
HIHI Displays the maximum value set for the output’s range before the alarm is triggered.
Delay (sec) Displays the number of seconds delay before the alarm is triggered.
Records Filter
Use the drop down list of Field names (i.e., LOLO Limit, Description, etc.) to
facilitate your search to a specific column.
Field value
First Pos. Use this button to search only for the first positive search result.
Any Pos. Use this button to search for all positive search results.
There are three panes of the Run Time Logic Editor. From left to right:
• Available Tags pane
• Usage for Tag pane
• Editor pane
Table 7-9 contains all buttons displayed on the Run Time Logic Editor screen and their
usage.
System Folder
System tags refer to SCADA for communication and information exchange (SCADA
Alarm).
In Figure 7-30, the Available Tag selected is “Do002”. The usage associated with this
tag is as an Input for Sampling on input Rule 1 (S01).
Editor pane
The Editor pane contains all rules organized by type (Rules, Sampling on input, and
Tower lights)
Figure 7-31 Editor pane contains all edited rules organized by type
Rule Editor
Use the Rule Editor to create logic to drive digital output (DO).
Rule Type
DO activation is a product of combinatory logic that uses the operators “and”, “or”,
“not” and “delay”. The list of Rule types (see Figure 4-4) are derived from “and”, “or”
and “not”:
• OR
• NOR
• AND
• NAND
The cause and effect of each logic statement is summarized in the tables below.
ON OFF
ON NOR OR
All Input
OFF AND NAND
Output
ON OFF
ON NAND AND
Any Input
OFF OR NOR
2 The Rule Editor window will appear (see Figure 7-34). In this window, you will be
able to set the Rule type, Output delay and Timer OFF Delay option.
3 Assume that our child rule uses Rule type “OR”, with the output activating after an
Output delay of 0 seconds (Timer OFF Delay is unchecked).
4 Once finished, select OK.
5 An additional Inputs folder is created within the original rule’s input. Both rule
statements are used for Output activation/deactivation.
6 Save the created rule by selecting the Save Rules button from the bottom menu.
Tower Lights
Use the TowerLightEditForm to create rules to drive light activation with the use of
input/ output tags.
A Tower Light rule is a special rule that runs separately from all other rules. When a
tower light rule is added, the following may be specified:
• 5 digital outputs to drive light activation
• 5 digital inputs to drive the logic
• One additional digital input (Acknowledge Input) for siren silencing (with a Horn
off delay option)
• A timer for siren reactivation if the alarm should persist after silencing (Ack. reset
delay).
Table 7-22 Tower Light Outputs and Inputs
Icon Description
User-specified tower light rule name. Primary node for a tower light rule.
Horn Input
Inputs required to be true to cause Horn activation (in addition to Red Light Inputs).
Acknowledge Input
Silences the horn (deactivates Horn Output). Use the Ack. reset delay to set the timer in
seconds (between 0 and 3600) before horn reactivation if the alarm persists after silencing.
The Horn off delay is the time in seconds (between 0 and 3600) before the Horn
Output becomes false (=0) after the horn is activated.
The Ack. reset delay is the amount of lapsed time before the horn is reactivated after
Acknowledgement Input is activated. The variable can be set to be between 0 to 3600
seconds.
Checkmark the desired inputs in order to test output activation within a specific
rule. When an output is activated, its adjacent box will turn green , in addition to
the box adjacent to the rule’s description. A white box indicates inactivation.
Historian Administrator
The Proficy Historian Administrator window can be opened to run the Proficy
Historian interface for the FacilityPro server.
Figure 7-38 Proficy Historian Administrator window for the FacilityPro server
FacilityPro software generates reports via the Report window (see Report Window on
page 8-2).
Overview
Reports available through the Report window
The general report types that can be generated from the Report window are:
• Audit Report
Log-ins, Alarms and Alarms Acknowledge, Electronic Signature events.
See example on page 8-32.
• Trend Report
Sampling data from the sensors in graphical format.
See example in page 8-45.
• Data Report
Sampling data from the sensors in tabular format.
See example on page 8-38.
A Report window report can be filtered for one of the following parameters:
• Select By Group
Selection is made on a pre-defined group of modules.
See Create a report “by group” on page 8-13.
• Select By Sampling
Extraction of data is filtered for recipe.
See Create a report “by sampling” on page 8-20.
Generation of reports via the Report window is described in Report Window beginning
on page 8-2.
A Sampling Report can be generated for each recipe that has been started during a
specific time period (see Sampling Report on page 8-48).
Report Window
The Report window has configuration fields across the top of the window and
separate tabs for displaying each type of report in a text box (see Figure 8-2).
The Tags catalog window appears (see Figure 8-9 and Figure 8-7).
Sensor Type, Sensors Alarms, Sensors, and Data Types tabs all contain a Records
Filter pane to facilitate user searches.
Records Filter
Enable box Check this box to enable the user-specified search criteria.
Use the drop down list of Field names (i.e., LOLO Limit, Description, etc.) to
facilitate your search to a specific column.
Field value
First Pos. Use this button to search only for the first positive search result.
Any Pos. Use this button to search for all positive search results.
The buttons at the top right of certain tabs are used to navigate to the record in the
table, add and delete entries, and save your edits.
Component Description
Click this button to view the first row in the table.
View First Row button
View Previous Field button Click this button to view the previous field in the table.
Sensors Alarms
Sensors
All values will have functional defaults in place prior to any editing.
Data Types
Sensor Groups
Use the Multi insert button to select multiple Data Types to associate
with a specific Data Type Group.
Recipes
Use the Recipes tab to assign Sensors Groups and Data Types Groups to specific
recipes (located under Recipe Name, i.e. MiniCapt, Particles, RVU). Entries under
Recipe Name can be added or deleted. See Configure Recipe Tags on page 8-12 for
more details.
Tags Control
8 In the Available Sensors list of the Select sensors in group window, select all
sensors that you want to add to the new group.
9 Click the > button to add the selected sensors to the Selected Sensors list.
10 Click the OK button in the Select sensors in group window to close it.
3 In the Recipes tab of the Tags catalog window, click the Plus button.
A field for the name of the new recipe appears in the Recipe Name column of the
Recipes tab in the Tags catalog window.
4 Type the name of the new recipe
5 Select the desired Sensor group from the Sensors Groups list.
6 Select the desired Data Type group from the Data Types Groups list.
1 Choose between these tabs, then select parameters for the report:
• Select by Group
See Create a report “by group” on page 8-13.
• Select by Sampling
See Create a report “by sampling” on page 8-20.
2 Select the report you want to generate.
See Select report(s) to generate on page 8-18.
3 Select the Report Type. By event lists all alarm and non-alarm events occuring
between the specified time. By interval defines an “every nth” value for which
subset of samples to include in the report. If this field is null, all the data from the
sampling will be included in the report.
4 Set a date/time range for the report.
See Set a date and time range for a report on page 8-23.
5 Click the Execute Report button to type note text you want to include in
the header of the report and generate the report.
See Execute the report on page 8-20.
The system automatically generates the Audit / Data / Trend report and displays it
in the text box of the Report window.
After a report has been generated and displayed in the Report window, you can:
Figure 8-13 Parameter fields in the Report window for Select by Group reports
The parameters available for reports created “by group” in the Report window are
described in Table 8-2.
All Data option Select this option to include in the report all event data
collected.
Only this mode option Select this option to select the mode for the report from
the field:
• Normal Operation
• At rest
• In operation
• Custom
Select Group list Only one of the pre-defined groups can be selected as
the basis for the an Audit Report report(s) during a
session if it is being filtered with the Filtered option.
Audit Report check box and options • When checked, an Audit Report will be generated
and displayed in the Audit Report tab when the
See an example on page 8-32 Execute Report button is clicked.
• When not checked, no Audit Report will be
generated when the Execute Report button is
clicked.
Trend Report check box • When checked, a Trend Report will be generated
and displayed in the Trend Report tab when the
See an example on page 8-45 Execute Report button is clicked.
• When not checked, no Trend Report will be
generated when the Execute Report button is
clicked.
Report type options
By event Selecting this radio button will list every alarm and
non-alarm event in the report.
By interval This field defines an “every nth” value for which subset
of samples to include in the report. If this field is null, all
the data from the sampling will be included in the
report.
Grouping options
Summary option Select this option to enable the Intervals field and
Calculate options in the Summarize pane.
continued on next page
Summarize field and options
Calculate options The sub-interval’s value to use for calculating the trend
can be one of the following options:
• Minimum option – Select this option to use the
minimum value of the samples in the sub interval.
• Maximum option – Select this option to use the
maximum value of the samples in the sub interval.
• Average option – Select this option to use the
average of the samples in the sub interval.
• Sum option – Select this option to use the sum of
the value of each sample of the interval.
2 Use the Up and Down arrow buttons in the Time Set popup to set the Hour,
• Filtered option – Causes the data displayed to be limited to only the data in
the group. (Filters are configured in the Custom fields configuration window
(see Configuring Custom Fields to Apply to a Sampling on page 4-7.)
• Not Filtered option – Causes no filter to be applied to the report.
2 To select the Data Report, place a checkmark in the Data Report check box and
select one of the following options:
• Detailed – When selected, all the data available for the group selected in the
Select Group list will be included when the Data report is generated.
• Stats Only – When selected, only the Statistical data available for the group
selected in the Select Group list will be included when the Data report is
generated.
3 To select the Trend Report, place a checkmark in the Trend Report check box.
>> To display the parameters for generating a report based on “by sampling”:
1 Click the Report button at the bottom of the FacilityPro screen.
The Report window appears (see Figure 8-2 on page 8-3).
Figure 8-17 Parameter fields in the Report window for Select by Sampling reports
The components of the Report window for the Select by Sampling mode are
described in Table 8-3.
Filtered • When selected, only the data available for the custom
filter selected in the Batch Filters list will be included
when the Audit report is generated.
Not Filtered • When not selected, all data for the selected sampling
for all groups will be included when the Audit report is
generated.
Data Report check box •
When checked, a Data Report will be generated and
displayed in the Data Report tab when the Execute
See an example on Data Report examples – Report button is clicked.
Select by Group on page 8-38 • When not checked, no Data Report will be generated
when the Execute Report button is clicked.
Detailed • When selected, all the data available for the sampling
selected in the Select Sampling list will be included when
the Data report is generated.
Status Only • When selected, only the Statistical data available for
the sampling selected in the Select Sampling list will be
included when the Data report is generated.
Figure 8-21 Select data types group dialog box showing data types for
particle counters
Figure 8-22 Select data types group dialog box showing data types for
Biological Modules
>> To change the view of the report displayed in the Report window:
Use the Report window controls shown in Figure 8-23 and described in Table 8-4
General and report-specific controls for changing the view in the Report window to change
the view of a report.
Figure 8-23 Audit Report window controls for changing the view of a generated report
The general controls for changing the view of a report in the Report window are
described in Table 8-4.
Table 8-4 General and report-specific controls for changing the view
in the Report window
General Controls Description
Click this button to view the first page of the report.
First button
Click this button to fit the view to show the entire page of the
Fit to page button report.
Click this button to fit the view to show the entire width of the
Fit to width button report.
Click this button to open the Select pages to print dialog box so
Print report button you can select the pages of the report to send to a printer. See
Select pages to print dialog box on page 8-29.
Click this button to open the Choose the file format dialog box so
Save report button
you can save a PDF file or a CSV file of the report. See Choose
the file format dialog box on page 8-30.
Table 8-4 General and report-specific controls for changing the view
in the Report window (Continued)
Page n of m current page field Type the number of the page you want to view, then press the
Enter key on the keyboard to jump to that page.
Audit records only option Select this option to view only audit events.
Alarms only option Select this option to view only alarm events.
Alarms and Acknowledge Select this option to view alarms and acknowledgements.
option
Select record ID option Select this option to open the Insert alarm ID dialog box where
you can enter an Alarm ID so you can generate a report for that
record.
Table 8-4 General and report-specific controls for changing the view
in the Report window (Continued)
Trend Report Controls Description
All Pages option Select this option to apply the viewing options to all pages in the
Trend Report display. (See example on page 8-45.)
Current Page option Select this option to apply the viewing options to the page
currently being viewed in the Trend Report display.
Slider Drag the slider button to move the view left or right.
Values per page field Sets the number of intervals to display on the page.
Allow hiding check box • When checked, limits the data displayed to the selected
sensor.
3D style check box • When checked, applies the 3-dimensional graphing mode
to the display.
• When not checked, applies the 2-dimensional graphing
mode to the display.
Show Alarm Labels check box • When checked, alarms a labels on the graph.
Left Axis check box • When checked, data are shown in logarithmic scale on the
left axis, if it has been set in the Tag Catalog.
Right Axis check box • When checked, data are showed in logarithmic scale on the
right axis, if it has been set in the Tag Catalog.
Show < 1 Values check box • When checked, together with Left Axis or Right Axis,
includes < 1 values in the logarithmic graph.
Legend Lists the main parameters used to create the report and the
colors that represent an instrument or parameter.
2 Click the Print report icon in the toolbar at the top of the report in the Report
window.
A Select Pages To Print window appears (see Figure 8-25).
NOTE: The supported format size for report printing is A4 and letter size.
To change the page size, export to PDF and adjust using your PDF
viewing program before printing.
Figure 8-27 Name of an exported PDF for a report in the Report Generator dialog box
Figure 8-28 Name of an exported CSV for a report in the Report Generator dialog box
A path to an exported file is shown in Windows Explorer Figure 8-29.
An example showing the first and last pages from a PDF of an Audit Report – Select by
Group is shown in Figure 8-31 on page 8-33.
Figure 8-30 Example of an Audit Report - Select by Group displayed in the Report window
Figure 8-31 Example of an Audit Report - Select by Group showing the first page from a PDF
• Company logo
• Report name
• Comment text included when the report was created
• Report range – The date/time span covered in the report
• Data filtering applied
• All records
• Audit records only
• Alarm only
• Alarm and AcknowledgeTime interval required: From (date/time) to (date/
time)
• Select record ID
• Event Log only
• Filter by area
• Filter by severity
• Printed By – Name of the user logged in
• Column headings:
• ID – The event identification number
• Date and Time – The event’s date and time
• Source – SCADA station where the event originated, if applicable
• Description – A description of the event
• Value – For alarms, the value for the TAG
• Status – Current status of the event reported:
• OK – Normal status
• ALM – Active alarm
• Performed by – The user who performed the electronic signature
• Comment – Notes inserted by the operator
An example showing the first and last pages from a PDF of an Audit Report – Select by
Sampling is shown in Figure 8-33 on page 8-36.
• Company logo
• FacilityPro <station name - room name>
• Recipe name – The name of the recipe selected for the report.
• Mode – The mode of the sampling selected for the report:
• Normal Operation
• At Rest
• Custom
• Time the recipe started running – Started at mm/dd/yyyy or dd/mm/yyyy
hh:mm:ss AM or PM
• Custom field 1, if any specified
• Custom field 2, if any specified
• Custom field 3, if any specified
• Custom field 4, if any specified
• Sampling notes – User defined
• Comment text included when the report was created
• Group – name of the login group the logged-in user belongs to
• User – name of the user logged in when the report was generated
• Column headings:
• ID – The event identification number
• Date and Time – The event’s date and time
• Source – SCADA station where the event originated, if applicable
• Description – A description of the event
• Value – For alarms, the value for the TAG
• Status – Current status of the event reported:
• ALM – Active alarm
• OK – No active alarm
• Performed by – The user who performed the electronic signature
• Comment – Notes inserted by the operator
An example showing a PDF of a Data Report – Select by Group is shown in Figure 8-35
on page 8-39.
Figure 8-34 Example Data Report – Select by Group displayed in the Report window
• Company logo
• Report name
• Report range – The date/time span covered in the report
• Data interval
• Comment text included when the report was created
• Printed by – name of the user logged in for printing
• Page n of m – Number of the current page and total number of pages in the report
Figure 8-36 Example Data Report – Select by Samplings displayed in the Report window
• Company logo
• FacilityPro <station name room name>Report name
• Recipe name - The name of the recipe selected for the report.
• Mode - The mode of the sampling selected for the report:
• Normal Operation
• At Rest
• Custom
• Time the recipe started running - Started at mm/dd/yyyy or dd/mm/yyyy
hh:mm:ss AM or PM
• Data Interval (displays if Report Type is By interval)
• Custom field 1, if any specified
• Custom field 2, if any specified
• Custom field 3, if any specified
• Custom field 4, if any specified
• Sampling notes - User defined
• Comment text included when the report was created
• Group - name of the login group the logged-in user belongs to
• User - name of the user logged in when the report was generated
Report body – Data Report – Select by Samplings
• Column headings:
• Date and Time – The event’s date and time
• Measurements – Values of the samples, and with an enhanced font, indicates if
the value exceeded the threshold of alert or alarm.
For PC reports, for each sampler, column headings include:
• S0n: Flow(l/min) – The number of liters sampled per minute, where n is the
number of the sampler
• S0n – Part>0.5um/CF
• S0n – Part>0.5um/CM
• S0n – Part>5.0um/CF
• S0n – Part>5.0um/CM
• S0n – Volume(lt)
Report summary – Data Report – Select by Samplings
Appears on the last page of the report.
• Standard deviation – With reference to the average value of samples in the column
• Alarms count– The number of alarms;
• Alerts count– The number of alerts;
Footer information – Data Report – Select by Samplings
The footer of each report contains:
An example showing a PDF of a Trend Report is shown in Figure 8-38 on page 8-46.
• 3D/2D mode
• Display point value
• Zoom the time axis (number of samples per page for trend)
• Enable or disable hiding of filterable data
• Show or hide alarm labels
• Set a logarithmic scale on left or right axis
The general viewing controls and controls specific to the Trend Report are described
in Table 8-4 General and report-specific controls for changing the view in the Report window
on page 8-27.
• Company logo
• FacilityPro <station name room name>
• Type of report: Recipe name
• Time the recipe started running – Started at mm/dd/yyyy or dd/mm/yyyy
hh:mm:ss AM or PM
• Custom field 1, if any specified
• Custom field 2, if any specified
• Custom field 3, if any specified
• Custom field 4, if any specified
• Comment text included when the report was created
• Sampling notes, if inserted at the start of the sampling
• Group – name of the login group the logged-in user belongs to
• User – name of the user logged in when the report was generated
• Company logo
• Report name
• Report range - The date/time span covered in the report
• Data interval
• Comment text included when the report was created
• Printed by - name of the user logged in for printing
Sampling Report
The Sampling Report is used to provide reports for each recipe that has been started
in a required time period. Generating a Sampling Report retrieves data from database
and arranges the following information in the report:
• Recipe name
• Start date/Start time for each sensor of the recipe
• End date/End time
• Errors and alarms found during the sampling
The objective of this function is to represent significant historical data present in the
database for the sampling to selected recipe events (alarms, start / stop point) of the
system (Audit) recorded in the DB events and alarms for the selected sampling recipe.
5 Click the Execute Report button to type note text you want to include in the
header of the report and generate the report.
See Execute the report on page 8-20.
The system automatically generates the Sampling Report and displays it in the text box
of the Report window under the Sampling Report tab.
After a report has been generated and displayed in the Sampling Report tab, you can:
• Review the report on screen.
See Change the view in report displayed in the Sampling Report window on page 8-49.
• Print the report.
See Print a Sampling Report on page 8-49.
• Save a copy of the report as a PDF file.
See Export a Sampling Report from the Sampling Report Window on page 8-50.
Figure 8-40 FacilityPro Report Generator dialog box showing the path to
the PDF for a report
All flow alarms that occurred before the sampling start are considered out of the
sampling.
All flow alarms that occurred before and after the sampling start are reported in the
Audit Report.
• Start Time – The start time for the sampling, in the format mm/dd/yyyy or dd/mm/
yyyy hh:mm:ss AM or PM
• Stop Time – The end time for the sampling, in the format mm/dd/yyyy or dd/mm/
yyyy hh:mm:ss AM or PM
• Flow (L/min) – Heading for the following columns:
• Average – Average flow in liters/minute in the format nn.nn
• Standard – Standard deviation for the flow in the format nn.nn
• Volume (l) – Number of liters measured in the format nn.nn
• Min. Drop – Minimum line pressure drop in the format nn.nn
• Max. Drop – Maximum line pressure drop in the format nn.nn
Last page
The last page of a report includes some blank lines for the operator to fill in on the
printed report:
User Types
There are two types of users in the FacilityPro Environmental Monitoring System:
• Domain Users
• Local Users
Default Users
After protocol execution, the FacilityPro Environmental Monitoring System will have
the users listed in Table 9-1.
CAUTION
DO NOT delete or change the following users in the iFIX User Manager:
The following users must not be deleted or modified for any reason!
Username
ASCOTEC
SHUTDN
NOBODY
“Nobody” user
The user Nobody is logged in when all others are logged out. The user Nobody has
access to the following FacilityPro windows:
• View Main Page
• View Alarm Pop-ups
User Groups
There are four default user groups:
• Operators
• Supervisor
• Poweruser
• Administrator
Group functions
The functions of the default user groups are itemized in Table 9-2. Administrators can
modify user group functions.
Table 9-2 Default User Groups functions
NOBODY OPERATORS POWERUSERS SUPERVISORS ADMINISTRATORS
Function Group Group Group Group Group
Popup alarms X X X X X
Main X X X X X
View Map X X X X
View Alarms Popup X X X X X
Sensors Manual Start X
Recipes X X X X
Create Recipes X
Edit Recipes X
Delete Recipes X
Sampling X X X X
Insert Samplings X X X X
Edit Samplings X X X X
Abort Samplings X X X X
Delete Samplings X X X X
Edit Sampling
X
Parameters
Alarms X X X X X
ACK Alarms X X X
System X X X X
User manager X
Sensors Editor X X X X
Managing Users
Management of users includes:
• Create a Domain User on page 9-6
• Add Domain Users on page 9-10
• Create a Local User on page 9-14
• Delete a Domain User on page 9-17
• Modify a Domain User on page 9-21
• Modify a Local User on page 9-22
• Delete a Local User on page 9-24
Group Accounts Click this button to open the Group Accounts window where you can
button administer groups. (Create, configure which users are in a group).
Configuration Click this button to open the Configuration window where you can
button define the paths to the Security Path and the Backup Path.
Automatic Login Click this button to open the Automatic Login at Startup window
at Startup button where you can add/change/delete names of the nodes to automatically
login at start-up.
Security Area Click this button to open the Security Area Naming window where you
Naming button can add/change/delete names for security areas.
7 Right-click in the Users area and select New > User from the right-click menu (see
Figure 9-6).
The New Object - User window appears showing Step 1 (see Figure 9-7)
3 Click the User Accounts button icon at the bottom of the Security
Configuration window.
The User Accounts window appears (see Figure 9-11 on page 9-11).
Figure 9-15 iFIX User Profile window showing a Group list for a new user
11 Click the OK button in the Group Membership Selection window to close
it.
12 Click the OK button in the User Profile window to close it.
The new user is listed in the User Accounts window (see Figure 9-16).
3 Click the User Accounts button icon at the bottom of the Security
Configuration window.
The User Accounts window appears (see Figure 9-18 on page 9-15).
3 Click the User Accounts button icon at the bottom of the Security
Configuration window.
The User Accounts window appears (see Figure 9-26 on page 9-20).
3 Click the User Accounts button icon at the bottom of the Security
Configuration window.
The User Accounts window appears (see Figure 9-29 on page 9-23).
3 Click the User Accounts button icon at the bottom of the Security
Configuration window.
The User Accounts window appears (see Figure 9-32 on page 9-25).
F
I
FacilityPro 2-1
alarm descriptions 6-9, 6-10 iFIX
hardware components 1-1 PCs 9-6
log in 2-11 setting (Server/Client)
delete 9-19
overview 1-1 SCADA PC settings 9-10
password Security Configuration window 9-4
default users 9-1 shutdown 7-32
screen components 2-2
user, define 9-10
server
iFIX Security Configuration window 9-4
Proficy Historian Administrator 7-62
start-up 2-1 iFix Security Configuration window 9-10, 9-14,
system overview 1-1 9-19, 9-22, 9-24
system tasks 7-1 iFix User Accounts window 9-11, 9-15, 9-20,
FacilityPro software 9-23, 9-25
as a dedicated desktop 2-1 iFIX User Profile window 9-13
launching 2-1 iFix User Profile window 9-11, 9-12, 9-15, 9-23
logging in 2-11 information about a sampling point 5-1
logging out 2-11 Insert button
screen components 2-2 Sampling Editor window 4-2, 4-5
floorplan
drawing in the Main Page window 2-4 L
room in 2-5
launching FacilityPro application 2-1
Legend button 2-8, 2-9
Limits Editor 7-34
zoom in on
report in Report window 8-27
room in a floorplan 2-5