Pulse 4.

12
SCADA/HMI
User Guide

April 2018
Copyright
The information in this document is subject to change without prior notice
and does not represent a commitment on the part of AFCON Control and
Automation Ltd., AFCON Software and Electronics Division.

No part of this document may be used or reproduced in any manner

whatsoever without written permission from AFCON Control and
Automation Ltd., AFCON Software and Electronics Division.

The software described in this document is furnished under a license

agreement or a non-disclosure agreement.

The software may be used or copied only in accordance with the terms of
the agreement. It is against the law to copy this software on any other
medium for any purpose other than the purchaser's personal use.

© Copyright 2018 AFCON Control and Automation Ltd., AFCON Software

and Electronics Division.

All rights reserved.

Disclaimer
ANTLR Notification and License Agreement (Legal Commitment)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials provided with the
distribution.

Neither the name of the author nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Table of Contents
Introduction to Pulse ................................................................................................................. 1
Pulse Server ........................................................................................................................... 2
Pulse Kernel ........................................................................................................................... 4
Remote Engineering .......................................................................................................... 5
Deployment and Versioning .............................................................................................. 5
Zero Administration........................................................................................................... 5
Flexible Security Models .................................................................................................... 6
Personalization .................................................................................................................. 7
Optimized Data Exchange (Publish/Subscribe) ................................................................. 8
Pulse Management Server .................................................................................................... 9
Generating Alarms ............................................................................................................. 9
Alarm Explorer ................................................................................................................... 9
Project Setup ................................................................................................................... 10
Pulse Configuration Service ............................................................................................. 11
Recipes............................................................................................................................. 11
Reports ............................................................................................................................ 12
Trend Graphs ................................................................................................................... 12
Pulse Client .......................................................................................................................... 14
Developer Workstation ................................................................................................... 15
Displays ............................................................................................................................ 17
Database Blocks ............................................................................................................... 18
Workflows ....................................................................................................................... 19
Aliases .............................................................................................................................. 20
Layers............................................................................................................................... 20
Display Templates ........................................................................................................... 20
Window Layout ............................................................................................................... 21
Toolbars and Context Menus .......................................................................................... 21
Data Scope ....................................................................................................................... 22
Item Explorer ................................................................................................................... 22
Expressions ...................................................................................................................... 22
Resources ........................................................................................................................ 23

Pulse 4.12 User Guide i

 Cells ................................................................................................................................. 23
Themes and Styles ........................................................................................................... 24
Operator Workstation ..................................................................................................... 24
Pulse OPC Communications ................................................................................................ 26
OPC Client ........................................................................................................................ 26
OPC Server ....................................................................................................................... 26
OPC Modules ................................................................................................................... 27
Pulse Licensing ..................................................................................................................... 28
The Registration and License Utility ................................................................................ 30
Installing the Registration and License ............................................................................ 32
Creating a License File ..................................................................................................... 32
Viewing the License Information ..................................................................................... 36
The HASP-SEK Battery Status Indicator ........................................................................... 37
Viewing Tags List ............................................................................................................. 37
Upgrading the SEK License .............................................................................................. 38
Upgrading the HASP4 License ......................................................................................... 38
Upgrading the Sentinel Software License ....................................................................... 39
Upgrading the Sentinel Hardware License ...................................................................... 40
Using the License File .......................................................................................................... 41
Loading the .puf File to a HASP4 Key............................................................................... 41
Loading the Sentinel Hardware License .......................................................................... 42
Loading the Sentinel Software License............................................................................ 43
Transferring the Software License from One Computer to Another .............................. 44
Monitoring Client License Connections ........................................................................... 47
Terminal Server Connection ............................................................................................ 47
Setting Up the Pulse Server ..................................................................................................... 48
System Requirements.......................................................................................................... 49
Hardware Requirements ................................................................................................. 49
Software Requirements ................................................................................................... 51
Additional Software Requirements ................................................................................. 52
Additional Software Requirements for Data Logger and Redundancy ........................... 53
Mandatory Services ......................................................................................................... 53
Installing IIS and MSMQ Services ........................................................................................ 54

Pulse 4.12 User Guide ii

 Installing IIS and MSMQ on Windows 7 .......................................................................... 55
Installing .NET Framework, IIS & MSMQ on Windows 8 ................................................. 56
Installing .NET Framework, IIS & MSMQ on Windows 10 ............................................... 60
Installing IIS and MSMQ on Windows Server 2008 ......................................................... 64
Installing .NET Framework, IIS and MSMQ on Windows Server 2012 ............................ 66
Installing IIS, .NET Framework, and Message Queuing on Windows Server 2016 .......... 76
Installing Pulse ..................................................................................................................... 82
Uninstalling Pulse ................................................................................................................ 90
The Pulse Communication Layer ......................................................................................... 92
Installing Communication Drivers ................................................................................... 92
Setting up Drivers ............................................................................................................ 98
Checking Communication between Pulse and PLCs ...................................................... 107
Starting Pulse ......................................................................................................................... 110
The Pulse Server Program Group ...................................................................................... 111
Using the Server Manager ............................................................................................. 112
The Pulse Services Utility ............................................................................................... 115
Starting Up the Pulse Server.......................................................................................... 117
Starting Up the Pulse Client Automatically ................................................................... 117
Automatic Startup for the Pulse Operator Workstation upon Windows Startup ......... 121
Concurrent Developer Workstation Notification .......................................................... 122
Restarting the Pulse Server ........................................................................................... 122
Downloading the Pulse Client Workstation .................................................................. 123
Deploy to Flash Drive..................................................................................................... 126
The Pulse Workstation ...................................................................................................... 131
Setting up Projects............................................................................................................. 132
Project Design Guidelines .............................................................................................. 135
Project Setup ......................................................................................................................... 136
Creating and Setting a Project ........................................................................................... 136
Changing Project Folder Paths ...................................................................................... 138
Defining the Default Project .......................................................................................... 139
Deleting a Project .......................................................................................................... 140
Configuring Project Setup Settings ................................................................................ 141
Configuring the Pulse Remote Access Security Account ............................................... 240

Pulse 4.12 User Guide iii

 Configuring the Pulse Server Address ........................................................................... 241
Connecting the Pulse Client to the Pulse Server ........................................................... 242
Configuring Project Database Settings .......................................................................... 243
Configuring Services Settings ........................................................................................ 251
Database Utility ............................................................................................................. 252
Backing Up and Restoring Projects ................................................................................ 262
Restoring a Project ........................................................................................................ 279
Saving Pulse Project Data .............................................................................................. 301
Project Migration................................................................................................................... 307
Migrating a P-CIM 7.70 SP4 Project to a Pulse Project ................................................. 308
Migrating a P-CIM Application to Pulse on 64 bit Operating Systems .......................... 309
The Project Migration Wizard ....................................................................................... 310
Project Migration Error and Warning Codes ..................................................................... 314
The Pulse Server .................................................................................................................... 321
Pulse Server Group Modules ............................................................................................. 321
Pulse Server Development Modules ................................................................................. 326
The Datasheet Publisher ............................................................................................... 328
The Email Dispatcher ..................................................................................................... 340
INI File Editor ................................................................................................................. 350
The Maintenance Manager ........................................................................................... 353
The ProGate Editor ........................................................................................................ 365
Pulse OPC Gateway ....................................................................................................... 372
Pulse Redundancy ......................................................................................................... 429
The Report Data Editor .................................................................................................. 472
The Sequence of Events Recorder (SER) ....................................................................... 506
The Alarm Handler......................................................................................................... 511
The Pulse Client ..................................................................................................................... 532
The Pulse Client Developer Workstation........................................................................... 533
Displays .......................................................................................................................... 535
Database Blocks ............................................................................................................. 536
Workflows ..................................................................................................................... 537
Data Scope ..................................................................................................................... 538
Item Explorer ................................................................................................................. 538

Pulse 4.12 User Guide iv

 Resources ...................................................................................................................... 539
Recipes........................................................................................................................... 539
Cells ............................................................................................................................... 540
Themes and Styles ......................................................................................................... 540
Working with Displays, Templates and Cells ................................................................. 541
Pulse Instruments .......................................................................................................... 662
Defining Blocks in the Database Explorer...................................................................... 917
Pulse DDE Server and Client ............................................................................................ 1040
Pulse DDE Server ......................................................................................................... 1040
DDE Commands ........................................................................................................... 1054
Dot Fields ..................................................................................................................... 1059
Dollar Variables ........................................................................................................... 1100
@ Functions ................................................................................................................. 1153
@ Function List ............................................................................................................ 1154
The Generic Lookup Table ........................................................................................... 1188
The Recipe Explorer ..................................................................................................... 1190
Data Logger.................................................................................................................. 1210
The Developer Workstation Interface ......................................................................... 1233
Workstation Management Modules ........................................................................... 1349
Workstation Tools ....................................................................................................... 1753
The Pulse Client Operator Workstation .............................................................................. 1814
Operator Workstation - Description................................................................................ 1816
Quick Access Toolbar (Operator Workstation)................................................................ 1818
Quick Access Toolbar Commands................................................................................ 1819
Opening a Display in the Operator Workstation ............................................................. 1820
The DataScope Module ................................................................................................... 1821
The Item Explorer ............................................................................................................ 1823
Working with the Item Explorer .................................................................................. 1823
Item Explorer Tasks ..................................................................................................... 1825
Entering Text Input .......................................................................................................... 1826
AutoAction ....................................................................................................................... 1827
Operator Workstation AutoActions ............................................................................ 1827
Display AutoActions..................................................................................................... 1828

Pulse 4.12 User Guide v

 Smart Information ........................................................................................................... 1829
Smart Information - Analog Value or Calculation Block Object .................................. 1830
Smart Information - Digital Value or Boolean Block Object ........................................ 1832
Smart Information Display Options ............................................................................. 1834
Changing Smart Information Layout ........................................................................... 1836
Printing Smart Information Reports ............................................................................ 1836
Smart Information - Margin Percent ........................................................................... 1838
Displaying a Graphic Object’s Historical Trend ............................................................... 1840
The Generic Option ..................................................................................................... 1841
Dynamic Trend Graph...................................................................................................... 1842
Dynamic Trend Toolbar ............................................................................................... 1842
Dynamic Trend Table Parameters ............................................................................... 1843
Dynamically Displaying X and Y Values on the Dynamic Trend Graph in Crosshair Mode
..................................................................................................................................... 1844
Displaying Real Time Batch Data for the Historical Batch Trend Graph.......................... 1845
Associating a Dynamic Graphic Object with a Schedule ................................................. 1846
Showing and Hiding Layers .............................................................................................. 1847
Restricting Operator Workstation Open and Close Display Commands ......................... 1848
Configuring Pulse Network .................................................................................................. 1849
Network Structure ........................................................................................................... 1850
Referencing Data from Remote Nodes ....................................................................... 1850
Additional TCP/IP Protocol Settings ............................................................................ 1850
Configuring Network Nodes ............................................................................................ 1851
Removing Nodes from the Network................................................................................ 1857
Setting Up a Multiple Pulse Server Configuration ........................................................... 1857
Configuring the Hosts .................................................................................................. 1859
Deploying Several Pulse Servers via the Ghost Software ................................................ 1867
Pulse Server Address Configuration ............................................................................ 1868
Utilities ................................................................................................................................ 1871
FTP Utility ........................................................................................................................ 1872
Using Command Line Arguments for the FTP Utility ................................................... 1873
History Viewer ................................................................................................................. 1875
Features ....................................................................................................................... 1876

Pulse 4.12 User Guide vi

 Command Line Activation ........................................................................................... 1876
History Viewer Interface.............................................................................................. 1878
Exporting HIS to CSV .................................................................................................... 1881
Compact Daily HIS File ................................................................................................. 1885
Repair .......................................................................................................................... 1886
P-CIM Email Sender ......................................................................................................... 1887
System Requirements for Email .................................................................................. 1887
Using P-CIM Email in Interactive Mode ....................................................................... 1888
Runtime Usage in Interactive Mode ............................................................................ 1888
Using P-CIM Email in Background Mode ..................................................................... 1888
General Examples for Email......................................................................................... 1890
AutoAction Example for Email..................................................................................... 1890
Advanced Alarm Handler Example .............................................................................. 1891
Sending Email Using P-CIM Alarm Pager Notification ................................................. 1892
Debugging Email Sender .............................................................................................. 1893
P-CIM INI .......................................................................................................................... 1894
P-CIM INI Settings ........................................................................................................ 1894
How to Read the INI File .............................................................................................. 1894
How to Change INI Settings ......................................................................................... 1895
Format of the INI File ................................................................................................... 1895
Changing Settings ........................................................................................................ 1896
Managing INI-type Files ............................................................................................... 1897
PCIM.INI Sections and Tokens ..................................................................................... 1898
Pulse Security .................................................................................................................. 1915
Defining Security Policy in the Security Manager ....................................................... 1917
Modules Security ......................................................................................................... 1934
Audit Trail ........................................................................................................................ 1936
Operator Actions ......................................................................................................... 1936
Setting Up Action Log Messages ................................................................................. 1936
Operator and Developer Actions................................................................................. 1940
Filtering the Audit Trail ................................................................................................ 1941
Setting Up Action Log Messages ................................................................................. 1943
I/O Write Security ............................................................................................................ 1947

Pulse 4.12 User Guide vii

 Menu Authorization ........................................................................................................ 1948
Integrated SQL Server...................................................................................................... 1949
User Account ............................................................................................................... 1949
Software ...................................................................................................................... 1950
Remote SQL with 'Windows Integrated Security' Configuration ................................ 1950
Architecture and Modules ........................................................................................... 1951
OPC Gateway Considerations ...................................................................................... 1952
Configuring the Pulse SQL Windows Integrated Security ........................................... 1953
Pulse Disaster Recovery Control (DRC) ........................................................................... 1956
High Level Overview .................................................................................................... 1957
Pulse Server Configuration .......................................................................................... 1959
Report-a-Problem ............................................................................................................ 1973
History Migration............................................................................................................. 1978
Unity Application Generator (UAG) Migration Wizard.................................................... 1982
Basic Server ......................................................................................................................... 1983
Operating the Server ....................................................................................................... 1983
Running Script from Pulse or from the Command Line .............................................. 1984
Using Script Arguments ............................................................................................... 1985
Stopping a Script .......................................................................................................... 1986
Returning Immediate Expression Result to Pulse ....................................................... 1987
Controlling CPU Load ................................................................................................... 1988
Creating BASIC Scripts ................................................................................................. 1989
Debugging BASIC Scripts .............................................................................................. 1991

Pulse 4.12 User Guide viii

Introduction to Pulse
Pulse is an advanced SCADA/HMI environment for integrating the
monitoring and controlling of processes in the industrial, building, and
security sectors. It incorporates technology such as .NET Application
Framework and Client/Server architecture to bring increased efficiency,
superior visualization capabilities, and a highly reliable platform for
supervisory control to manufacturing environments and organizations. The
Pulse model makes SCADA/HMI simpler, more scalable, and more cost-
effective than ever before.

Examples of project locations are an industrial factory, civil defense

infrastructure, an office building, a power station, or an airport.

Pulse employs Client/Server architecture to provide flexibility in

deployment and maintenance. There is no need to install entire SCADA
systems on every client workstation in the network. The core Pulse
programs and project data reside on the Server and can run full-time,
while the operator and developer client workstations log on and off
according to their needs and work schedules. This provides important
flexibility to companies and organizations deploying Pulse. For example,
supervisors may monitor and control the operations over the Internet
from almost anywhere, and Application Engineers can make project
development and configuration changes from different facilities.

This chapter includes the following topics:

 Pulse Server

 Pulse Client

 Pulse Licensing

Pulse 4.12 User Guide 1

Pulse Server
The Pulse Server and kernel modules run as Windows services in the
background with no need for user interaction. As a default setting, they
start automatically when the Pulse Server computer starts up or restarts
(administrators may change this setting). The services management
(automatic start, manual start, stop, disable) is accessible from the
remote Server Manager utility in the AFCON Pulse Program Group.

The list below describes the Pulse Windows services:

Service Description

Server Main Pulse Service - initiates the Pulse kernel and

other internal services

Management Manages (starts, stops, restarts, etc.) all Pulse

Service services

Alarm Publisher Publishes Pulse kernel-generated alarms and events

messages to Pulse clients

Callback Publishes Pulse kernel-generated real-time and

Adaptor historical data to Pulse clients
Publisher

Datasheet Publishes data from OLEDB/ODBC databases and text

Publisher files (XML/INI) to Pulse clients

OPC Adaptor Provides data exchange between OPC DA (Data

Publisher Access) servers and Pulse clients

OPC Gateway Provides data exchange between any OPC DA (Data

Access) client and the Pulse kernel

Scheduler Schedules the automatic functioning of various tasks

and commands according to a predefined time or
event trigger

Simulator Simulates and publishes internal items. It manages a

Publisher few built-in items which frequently change, and can
create automatic items, in accordance with application
requests

Pulse 4.12 User Guide 2

The Pulse Server comprises the following internal services:

Internal Service Manages

Configuration Project Configuration Settings

Project Project files, such as displays, cells, resources,

Components schedule files

Database Database blocks

License License usage and availability

Security Project security policy and user authorizations

Logger System and application message logging

Data Source Item resolving

Message Bus Client/Server communication

Localization Application interface localization and text translation

RemoteExecute Interface to remote kernel utilities for execution of

recipes, basic server scripts, and report generation

Pulse 4.12 User Guide 3

Pulse Kernel
The Pulse Kernel handles the following tasks:

Internal Service Manages

Communication The Pulse Kernel handles communication with the

server PLCs using P-CIM native drivers and/or OPC servers

Alarm generator The Pulse Kernel generates alarms according to alarm

condition definitions defined in database blocks. It
records the alarms into the database and the alarms
queue, from where the Alarm Publisher distributes
them.

Historical data The Pulse Kernel collects the database blocks’ real-
collector and time data and stores them in historical data files,
distributor according to block time frequency and value change
resolution.

Real Time data The Pulse Kernel exchanges real-time data with the
exchange Pulse Callback Adaptor Publisher.

Benefits
Pulse users benefit from the following Pulse capabilities:

 Remote Engineering

 Deployment and Versioning

 Zero Administration

 Flexible Security Models

 Personalization

 Optimized Data Exchange (Publish/Subscribe)

Pulse 4.12 User Guide 4

Remote Engineering
The Pulse Developer Workstation gives Application Engineers the ability to
develop projects on client stations, including modifying project
configuration, graphic display design, advised item settings, and database
blocks definitions. Development may take place on more than one client
station at a time (concurrently). All project files are stored on the server,
making them accessible from any computer on the network, in accordance
with the user's security level and Pulse license.

NOTE It is recommended to limit development work on a specific

project component to one user at a time. If multiple users
work on the same item concurrently, each Save operation
overwrites the modifications being made to the same
component by the other users.

Deployment and Versioning

Pulse takes advantage of Microsoft’s ClickOnce technology to provide a
portal for easy access to client connection and version upgrading. Any
change in the Pulse version on the Pulse server will result in automatic
downloads to the client workstation the next time the client connects to
the Pulse server.

Zero Administration
Expansion of the Pulse network is simple. In a standalone installation, the
Pulse client workstation and server run on the same computer. In a
network configuration, the client/server architecture enables new client
workstations to connect automatically to a running server through a web
browser, eliminating the need for any local installation. The addition of
clients (within your Pulse license allowance) does not require manual
modifications to the project files on the Pulse server.

Pulse 4.12 User Guide 5

Flexible Security Models
The Pulse security mechanisms protect your Pulse projects and their data
from unauthorized access and modifications. This set of mechanisms,
when set up carefully and correctly, helps prevent damage and loss to
projects as a result of intrusions and configuration changes by persons
who are otherwise not allowed to control the system.

A Security Policy must be defined and implemented in order to provide

protection for each Pulse project must be assigned with Security Policy,
which defines the project’s protection level. The Security Policy includes
Simple and Advanced Authorization modes, various User Authentication
modes, Module Security, Menu Authorization, Audit Trails, and I/O Write
Security.

The Security Policy is defined in the Security Manager, which you can
access through the Pulse Administrative Tools program group. For further
details about these mechanisms, see Pulse Security.

You can classify Pulse users as administrators, operators, developers,

managers, etc., or any combination of these roles; by assigning them
authorization level (Access Level in the Simple Authorization Mode or a
Security Key in the Advanced Authorization Mode).

User authorization levels and permitted working modes are set in the User
Manager, which you can access from the Pulse Workstation’s Tools
ribbon. Users may set the authorization configurations of any other users
whose security level is lower than theirs. Administrators (users with level
'0') can manage all other users’ authorization configurations, including
other administrators.

Pulse 4.12 User Guide 6

Personalization
Pulse allows users to work with personalized Operator and Developer
Workstation environments so that they suit their roles and personal
preferences. Whenever a user logs in to a Workstation, that Workstation
opens in accordance to the current user’s personalization settings.

 Operator Personalization

The operators’ personal working environments are composed of

interface elements such as menu ribbons, panels, window styles,
autoactions, and more). The Application Engineer can manage the
personal setting of each operator. The Application Engineer sets the
initial operator personalization definitions in the Operator
Personalization Manager.

An operator (with appropriate user authorization permission) can

modify some of these settings during runtime and save them using
the Save Personalization option. During runtime, the User
Manager tool enables users to set the personalization of any other
users whose security level is lower than theirs.

 Developer Personalization

Application Engineers can personalize their own environments while

working in the Developer Workstation. These environment features
also include panels (Project Navigation, Animation Properties,
Advanced Properties, Graphics Properties, and others) that can be
hidden, shown, positioned in a specific place, or docked to the
Workstation window.

Pulse 4.12 User Guide 7

Optimized Data Exchange
(Publish/Subscribe)
The Pulse Client/Server data exchange algorithm is based on the
Publish/Subscribe model. The Publishers send particular information only
to clients who have specifically requested, or subscribed, to receive that
information. This eliminates the possibility of flooding the network with
unnecessary transmitted data and messages which cause overflows and
activity delays.

A client subscribes to the data by opening 'items' which are present in an

open display, or by requesting an item for monitoring (known in Pulse as
an advised item). The client then receives the requested updated data as
long as the advised item or display remains open or active. The client
unsubscribes by closing the display or deselecting the advised item.

Each Pulse publisher (such as CBAdaptor Publisher, Alarm Publisher, and

OPCDA Publisher) hosts items relevant to its purpose. The item data may
be a numeric/ textual values or a more complex data such as alarms or a
complete data set. When the client workstation subscribes to an item, the
subscription request is directed to the relevant publisher, and it will
deliver the data changes to the clients via the Pulse Message Bus.

Pulse deploys its Message Bus service which serves as a hub for
transporting and filtering messages among the system components
(server, clients). The Message Bus gathers the clients’ requests, informs
the Publishers of started and finished subscriptions, applies filters to the
Publishers’ data, and transfers the data only to clients whose subscriptions
meet the message's filter attributes, reducing network traffic significantly.

Pulse 4.12 User Guide 8

Pulse Management Server
The Pulse Management Server is a Windows application that enables users
(with appropriate security levels) to do the following:

 Connect to Pulse server(s)

 Display, start, restart and shut down the Pulse services

 Start stop, and restart the Pulse server application

 Open the current Project’s Configuration Manager

 Open the User Manager

 View the last message in the Log Viewer.

The Management Server can be run from any PC on the Pulse network. Its
functions are accessible through the icon in the Windows Desktop’s
Notification Area in the bottom right corner.

Generating Alarms
To recognize and publish alarms and messages, the Pulse kernel’s
Database Server (DBSR) compares the database blocks’ actual values with
the defined alarm conditions. If the values meet the attributes defined in
the alarm conditions, the DBSR generates an alarm and inserts it into a
queue (Pulse supports MSMQ - Microsoft Message Queuing). The Alarm
Publisher polls the MSMQ for new alarms and events. If a new alarm
matches any subscription attributes, it is sent to its subscribers via the
Message Bus - otherwise, the alarm is discarded.

The Alarm Publisher supports subscriptions for items that contain alarms
(current or logged), system messages generated by the kernel, numeric
counters and totals per alarm trees branches, and dot fields.

Alarm Explorer
The alarms are presented in the Alarm Explorer, which can be embedded
in a display as an instrument, or opened as a Tool from the Workstation.
In the Alarm Explorer client, an icon next to the tree branch indicates that
active alarms are awaiting the user's attention.

The Alarm System configuration, such as the location of the MSMQ and
the polling interval, is defined in the Pulse Project Setup.

Pulse 4.12 User Guide 9

Project Setup
In Pulse, the models that are built to run, monitor, and control processes
in the workplace are called projects. A project contains all the components
that enable personnel to receive and enter data about the relevant
processes.

A server can run only one active project at a time, which is known as the
default project. The Project Setup Manager can contain configurations for
several projects, but only one project can be defined as the default
project. Switching the default project can be done only when the Pulse
server is shut down. Any clients that are connected when the switch takes
place receive a message instructing them to shut down and restart in
order to connect to the new default project.

In the Project Setup, you can do the following:

 Create projects and define their file locations

 Edit project configuration

 Switch to another default/active project

 Delete projects, including their folders and files

 Export and import the project database

 Start up and shut down Pulse

 Edit the Pulse application configuration (server address, logger

policy, file access security)

The Project Setup Manager is accessible from the Pulse Setup program
group. The Project Setup Manager displays a project tree, which contains
branches for all installed Pulse product versions. The branches contain sub
branches for all projects that were created in the relevant product version.

NOTE Pulse is labeled “P-CIM Software” in the current version's

Project Setup tree.

NOTE To work with a P-CIM 7.xx or lower project in Pulse, you must
first “migrate” the project to the Pulse format. For more
information, see Project Migration.

Pulse 4.12 User Guide 10

Pulse Configuration Service
The client connects to the Master host, which runs the Configuration
Service. The Configuration Service contains the locations of the other
services, which may differ from the Configuration Service location (in case
of a distributed server deployment). The Discovery service, also located
on the Master host, discovers each service’s location and redirects calls
from the workstations to the exact service locations.

The client workstation contains a config file

(AFCON.Pcim.WorkStation.exe.config) in which the configuration and
Discovery services location are specified by the IP address or server PC
name. This referenced server is called the Master Host of this Workstation.

Recipes
A recipe enables operators to perform different tasks, or variations of the
same task, using the same set of addresses. Recipes are typically made
up of groups, or a set of addresses and their corresponding values and
commands, which carry out a specific task. A recipe typically contains
multiple groups, each associated with a different task.

The tasks defined in the recipe may be configured to run automatically

during runtime, or to be triggered by an operator by clicking an action
button. Depending on the task which the operator chooses to carry out,
the Pulse Server loads the recipe’s data items to the PLC. Conversely, the
Server learns data from the PLC. The load/learn results may change
values in the PLC or the recipe file, respectively. As a result of this data
exchange, the chosen task is executed.

Recipe actions (learn, load, compare) are executed by the Pulse Kernel
modules, and therefore apply only to kernel items.

The Recipe Explorer is a Developer Workstation application, in which you

create and edit recipes and save them in Recipe files. Multiple groups from
the same recipe can be saved in the same Recipe file. Recipes can also be
exported/imported in CSV format and opened/modified in spreadsheets
and other database management applications.

Pulse 4.12 User Guide 11

Reports
Pulse provides several options for generating reports which present real-
time and historical data and alarm information collected from multiple
data sources, such as the Pulse Kernel, communication drivers, PLCs and
Controllers, and OPC servers. The tools allow users to produce scheduled
and on-demand reports from the Pulse Client workstation.

 Data Logger Reports collects data using OLEDB connection into

predefined user table schemas; see Data Logger for more
information.

 The Report Editor enables the design of templates for reports in

plain text (TXT), dBase (DBF), and ODBC formats. For more
information, see The Report Data Editor.

 Pulse Supreme Report is a comprehensive reporting and analysis

tool that allows users to design and create reports with rich
formatting and layout features, and then generate them in PDF or
Microsoft Office formats. For more information, see The Supreme
Report.

Trend Graphs
Trend graphs display a set of data values in their order of occurrence over
a period of time. They are a very valuable tool for troubleshooting and
analyzing processes as they occur in real-time (real-time trend), or as
they occurred during past time periods (Historical trend).

Trend graphs can also show several items at once, over varying time
periods and time resolutions.

The available trend types are:

Real Time Trend This trend graph shows the trends of Pulse
items real- time data readings. As the sample
time periods pass, the Real Time Trend Graph
dynamically displays the latest real-time values,
regardless of whether they have changed or
remained constant.

Pulse 4.12 User Guide 12

Historical Trend This trend graph displays the data that was
collected over a selected historical period. The
time span can be either absolute (fixed time
period) or relative to the current time. You can
scroll along the Historical Trend graph to view
previous values. The trend's sample time can be
automatically calculated based on the defined
time span, or set manually. The trend’s
historical data collection continues even when
the display is not active.

Curve Trend The Curve Trend Graph is a dynamic graph that

presents real-time data compared to reference
values over a period of time.

Deviation Meter This trend graph shows the actual data of Pulse
Trend items in comparison to their normal predefined
levels (very low, low, normal, high, or very
high).

Bidirect Deviation The Bidirect Deviation Meter Graph shows the

Meter Trend amount that an advised item’s value deviates
from the normal value, which is the graph’s
baseline. Each advised item is represented by a
bar that grows if the actual value goes farther
away from the baseline value, and shrinks if the
actual value gets closer to the baseline value.

Historical Batch Batch Graphs display historical data over batch-

Trend related time frames. When a block or advised
item refers to a data trend in a specified time
period, Pulse can find and display the relevant
trend as a batch graph.

Application Engineers can embed trend graphs as an instrument object in

a display. In the Operator Workstation, users can dynamically generate
them for objects that contain historical items. Also, the Smart Information
window displays refreshed real-time data and historical trend graphs for
items that receive data from analog value, digital value, Boolean, and
calculation blocks.

Pulse 4.12 User Guide 13

Pulse Client
The Pulse client station is the user’s (operator and/or developer) interface
with their projects. The entire project's files remain stored on the Pulse
server and the remote client user logs into the project over the network.

Multiple client workstations, each connected to a different Pulse server

(Master Host), can run on the same computer.

A client workstation can run from the local host computer’s web browser.
A client workstation can also run from a Flash drive connected to one of
the computer’s USB ports, as long as the master host name or IP address
is configured as the server in the client workstation configuration file.

On the Pulse Client, the project may be accessed through both a

Developer and Operator workstation in one of the following ways:

 Simultaneous operation of both - if one workstation closes, the

other one continues working with its respective Pulse server
independently.

 Toggle operation, in which the user can switch from one

workstation mode to another within one application window. While
the workstation is running in one mode, the other mode stops.

Pulse 4.12 User Guide 14

Developer Workstation
After a project is created, the process of designing project components
(creating displays inserting and defining graphic objects, instruments and
controls), creating and configuring database blocks, alarms and more, is
done in the Developer Workstation. This working mode is named design
time (in contrast to run time mode, when the operators work in the
Operator Workstation).

NOTE Each client that runs the Developer Workstation uses one
Development mode license, see Pulse Licensing.

In the Developer Workstation, users can navigate between the following

modes:

 Graphics - The user populates the display with static and dynamic
objects and configures them in the Graphics mode.

 Database - The user creates and configures data blocks which

include alarms, events, and the conditions that trigger them, as
well as the resulting actions.

 Recipes - The user creates and configures a group of data items

that sends and receives associated values to and from the PLC.
Recipes may be defined to run automatically during runtime, or to
be triggered by an operator by clicking an action button.

 Data Logger – In this mode, any item data is collected and saved
into a compatible user database or to a spreadsheet such as
Microsoft Excel. The data is collected through triggered or time
events.

Pulse 4.12 User Guide 15

In the Developer Workstation, users can manage various project settings
such as:

 Aliases

 Project configuration

 Server autoactions

 Themes and styles

 Windows layout

 Context menus

 Resources

 Operator personalization

 Cells and templates

 Layers

 Workflows

 Toolbars

Pulse 4.12 User Guide 16

Displays
Much of the development work takes place in displays. A display is a work
area that functions as an interactive model of a factory’s or organization’s
facilities (such as a production floor, warehouse, or building lobby).

In the Developer Workstation, Application Engineers can create a

collection of dynamic and/or static objects that represent devices or other
equipment. The objects have defined properties, which affect how the
objects appear and behave according to the data received from the
various data sources.

 A dynamic object represents a device that receives data updates

from the communication drivers or from operator interaction. The
object’s Item properties are linked to the communication address of
the device. As the object receives values, it behaves in accordance
with the assigned properties and the device’s status.

A dynamic object can be a graphic element with animation

properties, a .NET control with dynamic properties, a Pulse
instrument, or an object that displays status or changing data that
is received from the various Publishers.

For example, an object can change color when a specified event

occurs.

 A static object represents a device whose appearance on the screen

remains constant and does not receive data updates or operator
input.

Pulse provides many versatile tools for representing objects in the display:

 Graphic objects

 ClipArt

 ActiveX controls

 Instruments

 .NET components

 Cells

Pulse 4.12 User Guide 17

Database Blocks
A block is a database element used for processing data, including data
exchange and conversion, alarm generation, and history collection. In
Pulse, the maximum total number of blocks of all types is 32,750 (not
counting alarm bits).

The Developer Workstation includes the Database Explorer, in which

Application Engineers can create and modify the blocks, and store them in
the Pulse database.

The block types are:

 Analog Value

 Analog Pointer

 Digital Value

 Digital Pointer

 Calculation

 Boolean

 Alarm

 String Pointer

 SER

 Alarm Bit

 Master Blocks

Pulse 4.12 User Guide 18

Workflows
A workflow is a collection of activities which Pulse executes in a defined
sequence. In the Workflow Manager, the Application Engineer assembles a
workflow by adding Pulse activities and General Windows Workflow
activities.

The Operator Workstation provides several ways to trigger a workflow or a

sequence of activities:

 Activating an object by Action Button Animation

 Activating a Pulse Action Button Instrument

 Executing a workflow from the Workflow Explorer

 Display Startup action

 Display Shutdown action

 Display AutoAction

 Workstation startup action

 Workstation shutdown action

 Workstation on - idle action

 Workstation AutoActions

 Scheduled actions and triggered server actions

 .NET Control dynamic events

 Defined alarm action (if an alarm condition occurs, an alarm is

acknowledged, or alarm returns to normal)

NOTE Running a workflow in runtime may be restricted according to

security level. For example, an Operator who is logged in
under Monitor mode is not permitted to run
workflows/actions.

Pulse 4.12 User Guide 19

Aliases
The Aliases Manager enables you to create and modify aliases for the
current project. Aliases are “free text” names that you use as shortcuts
for addresses, references, and commands. Aliases help you minimize the
usage of repetitive and/ or long text strings. They can also make address
and object reference changes easier to implement - association with an
alias means applying the change only in the Aliases Manager instead of in
several objects around the project.

Pulse has a number of built-in aliases, which can be viewed and selected
in the Item Manager under the Alias category.

In addition to the Aliases Manager, the aliases are saved in the

pfwalias.txt file in the project’s Utilities folder.

Layers
Pulse allows you to assign objects of a display to layers. In both the
Developer Workstation and the Operator Workstation, certain layers may
be shown or hidden.

In the Developer Workstation, Application Engineers can show or hide

each layer, allowing them to manipulate elements in one layer without
affecting the appearance or location of elements which are assigned to
hidden layers.

During runtime in the Operator Workstation, users are able to see and use
those layers which their access levels permit. Each layer has Usability and
Visibility security settings. Runtime users can also expose and hide layers
(if permitted according to the Security policy).

The Developer Workstation includes a Layers Editor, in which you create,

select, modify, rename, and delete layers.

Display Templates
A template is a starting point for building displays in the Developer
Workstation. Application Engineers can populate templates with defined
graphic objects, database blocks, workflows, and so on. When opening a
template in design-time, it includes those predefined elements and their
properties and/or advised items. Building displays from templates saves
lots of time and labor when designing displays for similar production lines
or floor layouts.

Pulse 4.12 User Guide 20

Window Layout
The Pulse Developer Workstation provides Window Layout mode, in which
you can set up a Workstation layout shared by multiple displays, whose
sizes and locations depend on how they appear visually in relation to each
other.

In Window Layout mode, you can resize display windows by dragging their
sides to a specific size, and to drag them to specific locations in the
Workstation’s work area. This eliminates the need to calculate location
and size according to pixel value. Changes made in Window Layout mode
are reflected in the Display Properties Window Style tab. When you save
the display, the new window sizes and/or locations are saved.

NOTE Resizing of displays by dragging the window sides, when not in

Window Layout, are not saved in the Display Properties, and
are discarded when you close the display.

Toolbars and Context Menus

The Toolbars and Context Menus Manager enables you to build customized
toolbars that you can add to a display as instruments, and context menus
(menus that open when you right-click the mouse) that you can then
assign as an animation property for graphic objects.

For example:

A display may contain a toolbar that provides command buttons that are
relevant to the specific processes controlled through the display.

A graphic object may contain a context menu whose commands vary

depending if an alarm condition occurs or returns to normal.

Pulse 4.12 User Guide 21

Data Scope
The Data Scope module is a diagnostic tool which enables users to test
the validity of item values. Users can type the item in 'advised item'
format and immediately receive the current value of the item, and
continue updating the values. The Data Scope automatically updates,
according to data changes, the current value's validity status
(GOOD/BAD), the timestamp of the value, and the access rights (Read
only, Read/Write, Write Only, and Unknown). Additionally, users can also
write values to advised items that include a “write” access attribute.

The Data Scope is available in both the Developer Workstation and the
Operator Workstation. Users may open several Data Scope windows at the
same time.

At any time, the user can save the list of data items in a single window in
a group file, and can conveniently open it during later sessions for
monitoring the same items. There is no limit to the amount of entries that
can be added and saved in a single Data Scope group, and to the number
of groups that can be saved. Additionally, users can add more than one
group items to one Data Scope window.

NOTE The Data Scope group files belong personally to the logged-in
user.

Item Explorer
The Item Explorer presents the various Publisher items in a hierarchic
tree/branch format, allowing users to monitor the status of the Pulse
Host’s items. Item values can be monitored and saved to files and Data
Scope groups.

Expressions
In broad terms, an expression is a mathematical, logical, or textual
formula which is calculated during runtime and whose result is used as
input in an item address or action command.

The Item Manager (accessible while defining an advised item) includes an

Expression Solver that checks the syntax of configuration items, variables,
tags, functions, aliases, and other functions, when a user writes them into
Item addresses.

For more information, see Working with the Item Manager.

Pulse 4.12 User Guide 22

Resources
A Display Resource is a generic object that represents multiple similar
devices or a group of objects. It is a template that allows you to reuse an
existing display multiple times, yet change item addresses, without
needing to recreate similar displays or copy several objects from one
display to another. For example, a resource can be used to represent
separate ingredient containers in a food production line, with each
container object in the display receiving quantity data from its own item
address.

During runtime, the operator clicks on one of the objects and receives the
appropriate data. The operator then clicks on another object in this same
group and receives data from a different data source. The presentations of
the data look the same but the data varies, according to the selected
object in the main display.

As a result, display resources reduce the number of displays that you

need to store in the project, help save time during project development,
and make it easier and more efficient to maintain the project.

Cells
A cell is a collection of static and animated graphic objects and clipart
objects and their properties that are grouped together into one entity and
saved for reuse during design time. The creation of cells can save
Application Engineers the repetitive work required to configure several
sets of similar object groups.

When creating a cell, Application Engineers can either insert graphic

objects or clipart, or copy multiple objects from another display and paste
them into the cell.

After a cell is created, it is considered one object, but the animation

properties that were attached to each of its components remain
associated only with that same component. The Item addresses and
actions of each component become I/Os of this cell - to be adapted to
each particular instance in which this cell is applied. When inserted in a
display, the cell instance then requires a unique name, and if necessary,
modification of its Data Item (I/O).

The individual components of a cell may only be modified in its Cell

window. Any modifications take effect the next time the cell is used. When
a display containing cells is opened in the Developer or Operator
Workstation, the cells are retrieved from the Cells tree, including
modifications made since the last time the display was saved.

Pulse 4.12 User Guide 23

Themes and Styles
A theme is a customized set of display parameters, called styles that can
be applied to a display. A theme can have more than one style.

A style is a collection of defined graphic properties Object Fill, Object Line,

and Text Appearance (includes text, line, fill, font, position, and more).
Applying styles to graphic object allows you to reuse same graphic
properties multiple times without needing to repeatedly define the
properties one at a time.

If a theme is attached to the display, only those styles included in it are

available for use with the display. If a display’s theme is replaced by one
that lacks any of the formerly used styles, the new theme will inherit the
missing styles from the previous theme.

Operator Workstation
The Operator Workstation is the Pulse Client’s runtime operational
interface. It is the environment in which operators view and interact with
objects created in the Developer Workstation, in order to monitor and
control actual real-time processes and/or equipment operation to which
the objects correspond.

Operators can interact by pressing on objects with the mouse pointer, or

by typing on the keyboard. Real-time data can be displayed in text objects
and counters, by graphic object animation, while historical trends can also
be shown in graphs.

The Operator Workstation ribbon contains the runtime programs and

options intended to be used by the operators running the project. The
Operator Workstation Personalization is applied to the Workstation
environment. Furthermore, operator authorization is defined through the
Menu Authorization settings, which controls the enabling and disabling of
menu options.

For example, operator access to the Project Navigator command may be

restricted. This prevents operators from browsing through the Graphics
and Workflows Explorers.

The following tools may be available to operators during runtime,

depending on their security key and the menu authorization settings:

Data Scope Allows users to monitor and change the values

and statuses of data items from one window

Pulse 4.12 User Guide 24

Item Explorer Presents the various Publisher items in a
hierarchic tree/branch format, allowing users to
monitor the status of the Pulse Host’s items. Item
values can be monitored and saved to files and
Data Scope groups.

Alarm Explorer Presents a list and descriptions of alarms that

have been generated by the Alarm Publisher.

Event Management
Center

Supreme Report Allows users to produce graphically rich,

analytical, and secure reports from real-time data
and collected historical data.

Server Manager Manages (start, stop, restart, disable, change

startup type) all Pulse services.

Schedule Manager Allows users to schedule activities and tasks to

start or occur at specific times on specific days,
and if necessary, as recurring actions.

User Manager Enables administrators to create and define user

accounts for all users that need to work with the
Pulse system.

Event Center Handles foreseen contingencies for organizations

Administration that have a Standard Operating Procedure (SOP)
by guiding them through the various steps of the
procedure.

Shift Manager Allows you to assign users to groups, manage,

and track shifts. It enables you to define the
working hours for a user or multiple users via the
Shift Manager Editor.

Logger Window Displays log messages and relevant information

about them, such as time, message severity,
workstation, error code, and more.

Pulse 4.12 User Guide 25

Pulse OPC Communications
The OPC (OLE for Process Control) protocol is a set of interfaces that
enable standardized data exchange between automation/control
applications, field devices and other types of applications, even when the
applications and devices are from different vendors.

In Pulse installations using OPC communication, Pulse can function as

both an OPC Data Adaptor (DA) Server and OPC DA Client, or can be an
OPC client or OPC server only.

NOTE The OPC Standard specification is based on Microsoft

COM/DCOM technologies. To allow connection between OPC
clients and a remote OPC server, you must define certain
DCOM parameters (security reasons).

OPC Client
The OPC Client supports OPC DA versions 1.x, 2.x, 3.x, and XML
protocols.

Pulse’s OPC Data Adaptor Publisher service is an OPC client that connects
to OPC servers and exchanges data with them. The OPC Data Adaptor
explores the OPC Servers that are installed on the server PC (under the
‘Local’ branch), in its neighborhood (under the ‘Network’ branch), and
additional information about its configuration and actual state (for
example, number of connections, advised items, and so on). Direct OPC
items can be used in displays and workflows.

Additionally, users can assign OPC items to kernel database block

addresses (in this case, based on the legacy OPCSRV Callback server
supporting OPC DA versions 1.x and 2.x).

OPC Server
The OPC Server publishes Pulse kernel items, such as database blocks and
direct IO addresses, to OPC clients using the Pulse OPC Gateway service.

NOTE It is not recommended to connect to the Pulse OPC Gateway

from Pulse OPC Clients. For example, when defining data item
addresses using the Item Manager, it is recommended to use
Pulse Kernel items.

Pulse 4.12 User Guide 26

OPC Modules
Pulse has two OPC modules:

 OPC Client - an OPC client that requests information from an OPC

server connected to a PLC. The OPC Client enables bi-directional
communications between Pulse and an OPC server.

 OPC Gateway - The OPC Gateway is an OPC server that receives

data from Pulse servers. Using OPC protocol, the data is translated
and sent to the OPC client that sends it to external devices and
programs.

For more information about OPC technology, visit

www.OPCFoundation.org.

Pulse 4.12 User Guide 27

Pulse Licensing
Pulse system licensing policy is based on the following considerations:

 Number of concurrent PC Pulse workstations logged in at a single

time, distributed according to the following working modes:

• Maximum number of Development clients logged in at one

time from different computers

• Maximum number of Runtime clients logged in at one time

from different computers

• Maximum number of View Only clients logged in at one time

from different computers

• Maximum number of Event Management clients logged in

at one time from different computers

• Maximum number of GIS clients logged in at one time from

different computers

NOTE (*) A Monitor Operator workstation and a Monitor and Control

Operator workstations are considered 'Event Management
workstations' when the pulse window is open. Note that the
user cannot open the Event Center window in Development
mode. The number of EM licenses can be less or equal to the
total number of the Monitor Operator workstation and the
Monitor and Control Operator workstations together.

For each computer logging into Pulse, a single license is used for
each different working mode. Up to three licenses (1 Developer, 1
Runtime, and 1 View Only) may be used at a time on a single
computer (counted by a Pulse server).

NOTE If a Developer user and a Runtime user both log in from the
same computer, Pulse records two licenses used.

The I/O count is cumulative, and counted by the Pulse kernel.

Unadvised items are not subtracted under the license.

NOTE An I/O item is an item whose source is a communication driver

or an OPC server.

Pulse 4.12 User Guide 28

I/O items are counted for licensing purposes with the following
exceptions:

• A database block is not an I/O item, but the address it refers

to is. Two blocks pointing to the same address are counted
as only one I/O item.

• Same I/O items with different Engineering Units (EGU)

Conversion are counted as only one I/O item.

• Same I/O items with different output formats are counted as

only one I/O item

• Direct driver addresses and their bit values are counted as

only one I/O item. As an exception, if a bit on a register is
accessed through an alarm Bit block, it is counted as one
separate I/O item.

• OPC DA Publisher items

NOTE Dollar Variables, configuration items, alarms, and other data

items not originating in a communication driver or OPC driver
are not counted.

Pulse 4.12 User Guide 29

The Registration and License Utility
The Registration and License utility is used as follows:

 To view the current SEK (Security Enabled Key) or Sentinel

parameters

 To save license details to a file

 To update license parameters

 To run the Sentinel HASP Remote Update System (RUS) utility

The Registration and License support the following types of Security

Enabled Keys (SEK): HASP4 and Sentinel.

 SEK Version 4.00 (1100) – supports Pulse 4.1 or previous Pulse

versions

NOTE SEK versions lower than Version 4.00 does not support Pulse
4.0 or higher.

 HASP4 - supports Dart, P-CIM, Pulse versions 1.10, 1.20, 1.50, 2.0,
and 2.1.

The HASP4 can be connected to an LPT or USB port.

 Sentinel - supports Pulse 3.0 or higher

The Sentinel key can be connected to a USB port only.

When updating or upgrading your license, the Registration and License

uses an encrypted file containing the product’s unique License.

For a HASP4 key, create a new .puf file through the Registration and
License utility and send the license file to AFCON at marketing@afcon-
inc.com. AFCON Control and Automation Ltd., AFCON Software and
Electronic Division then provide you an upgraded .puf file that you can use
to upgrade or update your HASP4 key.

For a Sentinel key, create a .C2V (Customer to Vendor) file through the
Registration and License utility and send the file to AFCON at
[email protected]. AFCON Control and Automation Ltd., AFCON
Software and Electronic Division then provides you with a .V2C (Vendor to
Customer) file that you can use to upgrade or update your Sentinel key.

Pulse 4.12 User Guide 30

The .puf and .V2C files can only be accessed from the Registration and
License utility to maintain data integrity. The .C2V file can only be read by
AFCON Control and Automation Ltd., AFCON Software and Electronic
Division. The file’s name contains the key’s unique ID to make sure the
customer uses a license fitting the project’s needs.

The Pulse 2.x license has to be upgraded with a Pulse 4.0 or higher license
if you have Pulse 4.0 or higher installed. Pulse 4.12 can be remotely
updated using C2V and V2C files.

Pulse supports the Sentinel which has the following license types:

 Time limited key (has a built-in time counter)

 Software key support

 Software key support, time limited

 Software key support, time limited, network key

 Hardware key support

 Hardware key support, time limited

 Hardware key support, time limited, network key

Pulse 4.12 User Guide 31

Installing the Registration and
License
Install the Registration and License utility from the AFCON DVD or
download the utility from the AFCON website at www.afcon-inc.com.

To install the Registration and License

1 Locate the Registration and License utility from the AFCON DVD or
download the utility from AFCON website (www.afcon-inc.com).

2 Run the utility program to open the AFCON Registration and License
wizard. Follow the instructions (change the default settings if
required) and click Next on each page. At the end of the wizard,
click Finish to complete the installation process.

3 Restart Windows once the new version is installed for settings to

take effect.

To uninstall the Registration and License

 On your desktop, click Start > Programs > Afcon >

Registration and License > Uninstall.

The Registration and License utility is uninstalled.

Creating a License File

1 Attach your AFCON product’s key to the computer’s LPT or an
available USB port.

2 Run the AFCON Registration and License utility from the

desktop’s Start > AFCON Pulse > Administrative folder.

Pulse 4.12 User Guide 32

 - or –

Pulse 4.12 User Guide 33

 in case you do not have the AFCON Pulse folder, run the AFCON
Registration and License utility from the desktop’s Start >
AFCON > Afcon Registration and License folder.

Pulse 4.12 User Guide 34

 The AFCON Registration and License dialog box is displayed.

3 Fill in the customer information form.

4 Click Save license to file to save the completed form and license.

The Registration and License utility creates a new .puf (for legacy
license keys) or .c2v (for Pulse license keys) file.

5 Send the .puf or .c2v file (for the Sentinel) to the AFCON
marketing department ([email protected]).

Pulse 4.12 User Guide 35

Viewing the License Information
1 Attach your AFCON product’s key to the computer’s LPT or an
available USB port.

2 Run the AFCON Registration and License utility from the

desktop’s Start > AFCON Pulse > Administrative or
Start > AFCON > Registration and License folder.

The AFCON Registration and License dialog box is displayed.

3 Click the SEK INFO link.

Pulse 4.12 User Guide 36

 The license details are displayed.

The HASP-SEK Battery Status

Indicator
The Pulse Registration and License module can detect the status of a
time-limited HASP-SEK key’s battery and displays whether it is low, very
low, or dead. An alarm is also registered in the Database Server and is
indicated in the Event Viewer.

When the battery is low, it is recommended to contact the Pulse Support

personnel.

Furthermore, the $IsHaspBatteryOk variable can be used as a battery

status indicator.

Viewing Tags List

You can view the list of tags that are counted for license purposes by
using advise item |!$ExportPriceTags in Data Scope and then adding
the value ‘1’ to it.

The DbsrPriceTags.txt file is then generated in the project’s Daily Log

folder.

Pulse 4.12 User Guide 37

Upgrading the SEK License
1 Attach your AFCON product’s key to the computer’s LPT or an
available USB port.

2 Verify that the AFCON product key’s LED is lit.

3 Run the AFCON Registration and License utility from the AFCON
application’s Program menu.

The AFCON Registration and License dialog box is displayed.

4 You can upgrade the following key licenses:

• HASP4 license

• Sentinel hardware license

• Sentinel software license

Upgrading the HASP4 License

1 In the AFCON Registration and License dialog box, click the
Read legacy license key button.

2 Click Save license to file to save the completed form and license.

The Registration and License utility creates a new .puf file.

3 Send the .puf file to the AFCON marketing department

([email protected]).

The vendor (AFCON marketing department) sends you the

upgraded .puf file.

4 Update by clicking the Update license from file button and

opening the new .puf file.

5 To upgrade the HASP4 license, see Loading the .puf File to a HASP4
Key.

Pulse 4.12 User Guide 38

Upgrading the Sentinel Software
License
1 In the AFCON Registration and License dialog box, click the
Manage license button.

The RUS window is displayed.

2 Go to the Collect Status Information tab and select the

Installation of new protection key option.

3 Click the Collect Information button.

The Registration and License utility creates a .C2V file.

NOTE A .C2V file is a Customer to Vendor file that is created by

the customer and sent to AFCON in order to obtain a .V2C or
Vendor to Customer file which is used to update a Sentinel
license.

4 Send the .C2V file to the AFCON marketing department

([email protected]).

The vendor (AFCON marketing department) sends you a .V2C file.

5 To upgrade the Sentinel Software license, see Loading the Sentinel

Software License.

Pulse 4.12 User Guide 39

Upgrading the Sentinel Hardware
License
1 In the AFCON Registration and License dialog box, click the
Manage license button.

The RUS window is displayed.

2 Go to the Collect Status Information tab and select the

Installation of new protection key option.

3 Click the Collect Information button.

The Registration and License utility creates a .C2V file.

NOTE A .C2V file is a Customer to Vendor file that is created by

the customer and sent to AFCON in order to obtain a .V2C or
Vendor to Customer file which is used to update a Sentinel
license.

4 Send the .C2V file to the AFCON marketing department

([email protected]).

The vendor (AFCON marketing department) sends you a .V2C file.

5 To upgrade the Sentinel Hardware license, see Loading the Sentinel

Hardware License.

Pulse 4.12 User Guide 40

Using the License File
When receiving a new or updated .puf or .V2C file from AFCON, load the
license file to the attached key. Follow the instructions below to load the
license file.

Loading the .puf File to a HASP4 Key

1 Save the .puf file you received from AFCON.

2 Attach the key to the computer's LPT or an available USB port.

3 Verify that the AFCON product key’s LED is lit.

4 Run the Registration and License utility.

5 Click Update license from file and locate the received .puf file
you received and saved earlier.

6 To load it to the key, click Open.

The AFCON License from File window is displayed.

7 Verify that the license matches your new license order.

8 Click OK to update the key.

On successful completion you receive the following message:

“License was successfully written to your key”.

9 Click Exit to close the Registration and License utility.

Pulse 4.12 User Guide 41

Loading the Sentinel Hardware
License
1 Save the .V2C file you received from AFCON.

2 Attach the key to an available USB port.

3 Verify that the AFCON Sentinel LED is lit.

4 Run the Registration and License utility.

5 In the AFCON Registration and License dialog box, click the

Manage license button.

The RUS window is displayed.

Pulse 4.12 User Guide 42

6 Go to the Apply License File tab and browse for the .V2C file.

NOTE A .V2C file is a Vendor to Customer file that is created by

AFCON for the customer to update a Sentinel license.

7 Click Apply Update.

Loading the Sentinel Software

License
1 Save the .V2C file you received from AFCON.

2 Run the Registration and License utility.

3 In the AFCON Registration and License dialog box, click the

Manage license button.

The RUS window is displayed.

4 Go to the Apply License File tab and browse for the .V2C file.

5 Click Apply Update.

Pulse 4.12 User Guide 43

Transferring the Software License
from One Computer to Another
To transfer (rehost) a license from one computer to another, run the RUS
program on both computers. Do the following steps.

1 On the recipient computer, run the Registration and License

utility.

2 In the AFCON Registration and License dialog box, click the

Manage license button.

The RUS window is displayed.

3 Go to the Transfer License tab and click the button beside the
Save recipient information to field.

The Save recipient information as window is displayed.

4 Enter a filename for the Recipient information file (*.id) and

click Save.

The information about the recipient computer is stored on the file.

NOTE Ensure that the *.id file or a copy of it is accessible on the

computer that currently has the license (i.e., both computers
are connected via the network). If the source and recipient
computers are not connected in any way then copy the *.id
file manually from the source computer (i.e., via a disk-on-
key) into the recipient computer.

5 Back to the RUS window > Transfer License tab, click the Collect
and Save Information button.

6 Generate the license transfer file by going to the computer that

currently contains the license (the “source computer”) and selecting
the license to transfer.

7 Read the recipient information file by browsing for the Recipient

Information (.id) file from the Read the recipient information
file from field.

8 Generate the license transfer file by browsing for the License

transfer (.h2h) file from the Generate the license transfer file
field.

9 Click the Generate License Transfer File button to generate the

license transfer file.

Pulse 4.12 User Guide 44

10 Copy the *.h2h file that was generated into the recipient computer
and access the RUS utility.

11 In the recipient computer, go to the Apply License File tab and

click the button of the Update File field and browse for the
*.h2h file that was copied.

12 Click Apply Update.

Pulse 4.12 User Guide 45

Pulse 4.12 User Guide 46
Monitoring Client License
Connections
An object that displays the names of connected clients can be placed on
the workstation display. From the Item Manager’s Hosts > Licensing
branch, see Item Manager - Hosts, you can assemble an item that calls
the names of all connected Developer clients, Runtime clients, or Viewer
clients and displays them on the workstation. This enables users to keep
track of current Pulse license usage.

Terminal Server Connection

One possible Pulse configuration scenario is the deployment of a terminal
server as a conduit between the Pulse Server(s) and client workstations
(thin clients). The Pulse client program is downloaded to the terminal
server instead of to the thin clients. The terminal server functions as the
Pulse system’s desktop and multiple thin clients can connect to the
terminal server as remote desktop applications. Each Pulse client that
connects to the terminal server uses one Pulse license.

The terminal server configuration is relatively low-maintenance for IT

personnel.

Pulse 4.12 User Guide 47

Setting Up the Pulse Server
This chapter provides instructions for installing and setting up the Pulse
system server and clients. The setup process includes the following topics:

 System Requirements

 Installing IIS and MSMQ Services

 Installing Pulse

 Uninstalling Pulse

Pulse 4.12 User Guide 48

System Requirements
Hardware Requirements
Pulse Standalone Configuration
 3 GHz Core i7 or faster

 Minimum 8 GB RAM (16 GB recommended)

NOTE The RAM size has to be increased as the database size

increases, to ensure optimal performance.

 320 GB of free hard disk space

NOTE The size of the free hard disk space has to be increased as the
size of the database increases, to ensure optimal performance.

 Super VGA 3D display card with a minimum of 512 MB DDR3

memory

 Keyboard and mouse or compatible pointing device

 Network adaptor 100/1000 MB

 USB

 SEK (supplied with Pulse package); without the SEK, Pulse runs in
Demo mode.

Pulse 4.12 User Guide 49

Pulse Server
 2.4 GHz Xeon Quad Core processor 2.4 or faster

 Minimum 16 GB RAM (32 GB recommended)

NOTE The RAM size has to be increased as the database size

increases, to ensure optimal performance.

 Minimum 150 GB free SAS hard disk space

NOTE The size of the free SAS hard disk space has to be increased as
the size of the database increases, to ensure optimal
performance.

 Keyboard and mouse or compatible pointing device

 Network adaptor 100/1000 MB

 USB (for Virtual Machine: USB over TCP adaptor)

 SEK (supplied with Pulse package); without the SEK, Pulse runs in
Demo mode.

Pulse Client
 3 GHz i5 or faster (i7 recommended)

 Minimum 3 GB RAM (4 GB RAM recommended)

 60 GB free hard disk space

 Super VGA 3D display card with a minimum of 512 MB DDR3

memory

 Keyboard and mouse or compatible pointing device

 Network adaptor 100/1000 MB

Deploy to Flash Drive

Pulse Client Running from a USB Flash Drive
 1 GB free disk space

 USB2 or faster port

Pulse 4.12 User Guide 50

Software Requirements
The table below details the operating systems that you can use to run
both Pulse server and client components.

Pulse Components
Operating Systems Pulse Pulse Stand-
Server Client alone

Windows 7 Home No Yes** No

Windows 7 Professional 32-Bit No Yes** Yes*, **

Windows 7 Professional 64-Bit No Yes** Yes**

Windows 7 Enterprise 32-Bit No Yes** Yes*, **

Windows 7 Enterprise 64-Bit No Yes** Yes**

Windows 7 Ultimate 32-Bit No Yes** Yes*, **

Windows 7 Ultimate 64-Bit No Yes** Yes**

Windows 8.1 32-Bit No Yes No

Windows 8.1 64-Bit No Yes No

Windows 8.1 Professional 32-Bit No Yes Yes*

Windows 8.1 Professional 64-Bit No Yes Yes

Windows 10 Professional No Yes Yes

Windows Server 2008 Standard 64-Bit Yes*** Yes*** Yes***

Windows Server 2008 R2 Standard Yes** Yes** Yes**

Windows Server 2012 Standard Yes Yes Yes

Windows Server 2012 R2 Standard Yes Yes Yes

Windows Server 2016 Standard Yes Yes Yes

* Installing Pulse Server/Standalone successfully on a 32-Bit
operating system depends on the application size.
NOTE Pulse 3.0 and higher versions are not supported in Windows
Server 2003 and Windows XP.
** When using Supreme Report, it is required to install the Service
Pack 1 (SP1) of this Windows 7/Windows Server 2008 R2 operating
system version.
*** This OS does not support Supreme Report.

Pulse 4.12 User Guide 51

Additional Software Requirements
The following list describes other third-party software requirements to run
the Pulse Server:

 Microsoft .NET Framework

 Internet Information Service (IIS) installed on server computer

 Microsoft® Message Queuing Service (MSMQ) installed on server

computer

NOTE For IIS and MSMQ installation instructions, see Installing IIS
and MSMQ Services.

NOTE When installing Pulse 4.12 on Microsoft Windows 8/10 or

Microsoft Windows 2012 Server, it is strongly recommended
to follow the .NET, IIS, and MSMQ instructions in this
document, see Installing IIS and MSMQ Services.

 Internet Explorer® 7 or higher

 User Accounts Control (UAC) disabled

For more information, refer to the relevant installation procedures.

The following software is installed by the Pulse Setup:

 Aladdin HASP Device Driver 7.41

 Microsoft® Visual C++ 2010 SP1 Redistributable Package

 Microsoft® .NET Framework 3.5 SP1

 Microsoft® .NET Framework 4.0

 OPC Core Components 3.0

 Windows Installer 4.5

NOTE If you are using ESET NOD 32 Antivirus™, use version 3 or

higher.

Pulse 4.12 User Guide 52

Additional Software Requirements
for Data Logger and Redundancy
 The SQL Server database Standard edition or a higher version
must be installed and used when working with Data Logger.

 The SQL Server database Standard edition or a higher version

must be installed and used when working with either the
Redundancy Central SQL Database connectivity mode or SQL
Server Merge Replication mode.

NOTE To choose between Redundancy Central SQL Database

connectivity mode or SQL Server Merge Replication
mode, refer to the Pulse Redundancy Guide for more details.

Mandatory Services
The following services must be in the “Started” state on the Pulse Server’s
host computer while the Pulse Server is running. Before starting up Pulse,
ensure that the services are started.

 World Wide Web Publishing Service (IIS)

 .Net TCP Port Sharing Service (SMSSVCHost)

 Microsoft® SQL Server services have to be running if the Microsoft

SQL database is used in a Pulse project.

Pulse Database
CAUTION DO NOT exceed using 90% of your disk space on your Pulse
database. Database Administrators should plan the volume of
storage data in advance according to the database storage
capacity. Too much Report and Log files may cause the Pulse
database to overload. When a significant amount, in the
volume of data processed by the Pulse System increases, the
DBA may have to reconfigure the database.

Pulse 4.12 User Guide 53

Installing IIS and MSMQ
Services
The Internet Information Service (IIS) is a Web-based platform that is
required to host the Pulse Server.

The Microsoft Message Queuing (MSMQ) service is required for Pulse to

route alarms and messages from the Pulse kernel to their destination
users.

NOTE IIS and MSMQ are not included with the Pulse installation DVD,
and therefore, must be installed separately.

NOTE You must be a member of the Administrators group on the

local computer to install IIS and MSMQ.

 Installing IIS and MSMQ on Windows 7

 Installing .NET Framework, IIS & MSMQ on Windows 8

 Installing .NET Framework, IIS & MSMQ on Windows 10

 Installing IIS and MSMQ on Windows Server 2008

 Installing .NET Framework, IIS and MSMQ on Windows Server 2012

Pulse 4.12 User Guide 54

Installing IIS and MSMQ on
Windows 7
Installing IIS on Windows 7
1 From the Windows 7 interface, click Start and then click Control
Panel.

2 In the Control Panel, click Programs and then click Turn

Windows features on or off.

3 In the Windows Features dialog box, select all the features and
then click OK.

Installing MSMQ on Windows 7

1 Open the Control Panel.

2 Click Programs, and then under Programs and Features, click

Turn Windows features on or off.

3 Expand Microsoft Message Queue (MSMQ) Server, expand

Microsoft Message Queue (MSMQ) Server Core, and then
select all the checkboxes for the Message Queuing features.

4 Click OK. If you are prompted to restart the computer, click OK to

complete the installation.

Pulse 4.12 User Guide 55

Installing .NET Framework, IIS &
MSMQ on Windows 8
Installing .NET Framework on Windows 8
To enable the .NET Framework 3.5 features:

1 Go to the Control Panel and then click Programs.

2 Under Programs and Features, click Turn Windows features

on or off.

The Windows Features dialog box is displayed.

Pulse 4.12 User Guide 56

If your computer does not have internet connection then do the following:

1 Insert the Windows 8 DVD or mount the ISO image.

2 Open cmd.exe with Administrator privileges.

3 Run the following command:

[‘E:’ the Windows installation media drive letter]: Dism.exe

/online /enable-feature /featurename:NetFX3 /All
/Source:E:\sources\sxs /LimitAccess

4 Click OK.

Installing IIS and MSMQ on Windows 8

If the following message is displayed during the Pulse installation then do
the following steps below:

1 Enable the Internet Information Services (IIS) Windows

feature.

2 Enable the Internet Information Services (IIS) > Web

Management Tools > IIS 6 Management Compatibility > IIS
Metabase and IIS 6 configuration compatibility.

3 Enable the Internet Information Services (IIS) World Wide

Web Services > Application Development Features > ASP
.NET.

Pulse 4.12 User Guide 57

4 Check the checkboxes as shown below.

Pulse 4.12 User Guide 58

5 Continue checking the checkboxes as shown below.

6 Click OK.

The Windows Features window is displayed informing you that

Windows completed the requested changes.

Pulse 4.12 User Guide 59

Installing .NET Framework, IIS &
MSMQ on Windows 10
Installing .NET Framework on Windows 10
When the .NET Framework 3.5 feature is not enabled, the following
message is displayed during Pulse installation.

To enable the .NET Framework 3.5 features:

1 In the Microsoft Windows 10 desktop, right-click on Start and

select Control Panel on the menu.

2 In the Control Panel window, click Programs > Programs (and

Features).

3 Under Programs and Features, click Turn Windows features

on or off.

The Windows Features dialog box is displayed.

or

If your computer does not have internet connection then do the following:

1 Insert the Windows 10 installation media or mount an ISO image.

2 Open cmd.exe with Administrator privilege.

Pulse 4.12 User Guide 60

3 Run the following command:

[E: (the Windows installation media drive letter)]:Dism.exe

/online /enable-feature /featurename:NetFX3 /All
/Source:E:\sources\sxs /LimitAccess

4 Click OK.

The Windows Features dialog box is displayed.

Installing IIS and MSMQ Server on

Windows 10
If the following message is displayed during the Pulse installation then do
the following steps below:

1 Enable the Internet Information Services (IIS) Windows

feature.

2 Enable the Internet Information Services (IIS) > Web

Management Tools > IIS 6 Management Compatibility > IIS
Metabase and IIS 6 configuration compatibility.

3 Enable the Internet Information Services (IIS) World Wide

Web Services > Application Development Features >
ASP.NET 3.5/4.5 or 4.6.

4 Enable the Microsoft Message Queue (MSMQ) Server >

Microsoft Message Queue (MSMQ) Server Core.

Pulse 4.12 User Guide 61

5 Check the checkboxes as shown below.

6 Click OK.

Pulse 4.12 User Guide 62

 The Windows Features window is displayed informing you that
Windows completed the requested changes.

Pulse 4.12 User Guide 63

Installing IIS and MSMQ on
Windows Server 2008
Installing IIS on Windows Server 2008
1 Open the Control Panel, click System and Maintenance, and
then click Administrative Tools.

2 On the right pane, double-click Server Manager.

The Windows Features dialog box is displayed.

3 On the left pane of Server Manager, select the node that represents
the server that you are currently working on.

4 In the right pane, expand the Roles Summary section and then
click Add Roles.

The Add Roles Wizard is displayed.

5 Click Next.

The wizard moves to the Select Server Roles step.

6 Select the Web Server (IIS) checkbox and then click Next.

The next wizard step that appears is information that guides you in
the installation.

7 Click Next.

The wizard moves to the Role Services step. A list of available role
services appears. If you click the name of a role, a short description
of the role is displayed.

8 Select all of the role services and their options and click Next and
verify the role service selections.

9 Click Install to start the IIS and ASP.NET installation process.

10 When the installation is complete, click Close.

11 Open the Internet Information Services (IIS) Manager. From the

Start menu, click All Programs, click Accessories, and then click
Run. In the Open box, type inetmgr and then click OK.

12 In the left pane, expand the Local Computer tree to the Web
Service Extensions folder.

Pulse 4.12 User Guide 64

13 Set the status of ASP.NET Authorization Rules to Allow.

Installing MSMQ on Windows Server 2008

1 Click Start, point to Programs, point to Administrative Tools,
and then click Server Manager to display the Server Manager.

2 Click Add Features to start the Add Features Wizard.

3 Expand MSMQ, expand MSMQ Services, and then select all the
checkboxes for the Message Queuing features.

4 Click Next, and then click Install. If you are prompted to restart
the computer, click OK to complete the installation.

Pulse 4.12 User Guide 65

Installing .NET Framework, IIS and
MSMQ on Windows Server 2012
Deactivating UAC
The User Account Control (UAC) has to be deactivated before installing the
Windows 2012 Server. Pulse fails to function if a service is running with a
user account in Windows 2012.

To deactivate the User Account Control (UAC)

1 Change the following registry key in the Windows Server 2012

when the P-CIM Server service is running under a user account.

Set
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\
CurrentVersion\Policies\System] EnableLUA = 0

2 Restart Windows Server 2012.

NOTE In the Windows Server 2012 User Account Control Settings

dialog box, set the notification settings to Never notify to
partly disable the UAC. It is not required to restart Windows
after setting the UAC.

Pulse 4.12 User Guide 66

Pulse 4.12 User Guide 67
Installing .NET Framework on Windows
Server 2012
If the following message is displayed during the Pulse installation, then
follow the steps below.

1 Go to the Control Panel and then click Programs.

2 Under Programs and Features, click Turn Windows features

on or off.

3 Enable the .NET Framework 3.5 feature in the Control Panel >
Programs > Turn Windows features on or off.

or

If your computer does not have internet connection then do the following:

1 Insert the Windows 2012 DVD or mount the ISO image.

2 Open cmd.exe with Administrator privileges.

3 Run the following command:

[‘E:’ the Windows installation media drive letter]:Dism.exe

/online /enable-feature /featurename:NetFX3 /All
/Source:E:\sources\sxs /LimitAccess

Pulse 4.12 User Guide 68

Installing IIS and MSMQ on Windows Server
2012
If the following message is displayed during the Pulse installation the
follow the steps below.

1 Enable the Roles Summary > Add Roles > Web Server (IIS)
feature and click Next.

2 Enable the Application Development feature.

3 Enable the Management Tools > IIS 6 Management

Compatibility in the Control Panel > Programs and Features >
Turn Windows features on or off.

4 For the Microsoft Message Queuing (MSMQ), enable Features

Summary > Add Features > Message Queuing in the Control
Panel > Programs and Features > Turn Windows on or off.

5 In the Add Roles and Features Wizard window, select the Role-
based feature-based installation option.

Pulse 4.12 User Guide 69

6 Click Next.

Pulse 4.12 User Guide 70

7 In the Add features that are required for Web Server (IIS)
prompt, click to activate the Include Management tools (if
applicable) option and click the Add Features button.

8 In the following window, click Add Features to continue.

Pulse 4.12 User Guide 71

9 Check to select the checkboxes as shown below and click Add
Features to continue.

Pulse 4.12 User Guide 72

10 Check to select the checkboxes as shown below and click Next to
continue.

Pulse 4.12 User Guide 73

11 Check to select the checkboxes as shown below and click Next to
continue.

Pulse 4.12 User Guide 74

12 Click Install to complete the IIS and MSMQ components
installation.

Pulse 4.12 User Guide 75

Installing IIS, .NET Framework, and
Message Queuing on Windows
Server 2016
To install IIS, .NET Framework, and Message Queuing on Windows
Server 2016

1 Open the Control Panel, click Programs and Features.

2 Under Programs and Features, click Turn Windows features

on or off.

The Add Roles and Features Wizard window is displayed.

3 Select the destination server from the Server Selection page then
click Next.

The Select server roles page is displayed.

4 Click to select the Web Server (IIS) checkbox option from the
Roles list.

Pulse 4.12 User Guide 76

 As soon as the Web Server (IIS) checkbox option is selected, the
Add features that are required for Web Server (IIS) window is
displayed.

5 Click Add Features and the Web Server (IIS) option are
selected.

6 Click Next.

The Select features page is displayed.

Pulse 4.12 User Guide 77

7 Select the .NET Framework 3.5 Features checkbox option in the
Features list.

8 Click to select the .NET Framework 4.6 Features checkbox

option.

The following window is displayed.

Pulse 4.12 User Guide 78

9 Click Add Features.

10 Make sure that the .NET Framework 3.5 Features and the .NET
Framework 4.6 Features checkbox options are selected.

Pulse 4.12 User Guide 79

11 On the lower part of the Features list, select the Message
Queuing checkbox option.

12 Click Next, Next and then Next again.

Pulse 4.12 User Guide 80

 The Confirm installation selections page is displayed.

13 Click Install.

14 After installation is completed, click Close and restart your

computer.

Pulse 4.12 User Guide 81

Installing Pulse
NOTE Before installing the Pulse Server, verify that your computer
and network meets the system requirements, see System
Requirements.

NOTE When installing Pulse 4.12 in Windows 10, install Microsoft SQL
Server 2014 Express Edition database.

Pulse 4.12 supports upgrade and full installation. Pulse 4.12 does not
support upgrade installation from Pulse 1.52 or lower versions.

If a previous Pulse 1.52 version is already installed, do the following:

1 Back up all projects (using Backup and Restore Wizard).

2 Uninstall any previous version of Pulse.

3 Install Pulse Version 4.12.

4 Restore the backed-up projects.

==============================================

Follow these steps to install the Pulse server.

1 Close all open programs.

2 Insert the AFCON DVD to the DVD drive. The installation process
starts automatically and you can proceed to the next step. If the
installation does not automatically start, go to your DVD drive and
double-click the Setup.exe file.

Alternatively, if you are installing Pulse from a network location,

select Run from the Start menu and then browse to locate and run
the Setup.exe file.

The Pulse - InstallShield Wizard window is displayed.

Pulse 4.12 User Guide 82

3 Select the language for installation from one of the following drop-
down list options:

• English (United States)

• German

• Spanish

4 Click OK.

NOTE The Pulse - InstallShield Wizard window may be displayed

if one or more software pre-requisites are not installed, see
Additional Software Requirements on how to install the
required software components before installing Pulse.

The Welcome to the InstallShield Wizard for Pulse window is

displayed.

Pulse 4.12 User Guide 83

5 Click Next; the License Agreement window is displayed.

6 Read the license and click on the I accept the terms in the
license agreement option then click Next.

Pulse 4.12 User Guide 84

 The Destination Folder window is displayed.

By default, Pulse is installed in the C:\AFCON\Pulse\ folder.

7 Click Change to change the path of the destination folder,

otherwise click Next.

Pulse 4.12 User Guide 85

 The Custom Setup window is displayed.

8 Select the program features you prefer to install. To install any of

the additional features, click on the feature name to select and
install it.

The installation script only installs two features, Program Files and
Demo Project. Microsoft SQL Server 2008 Express (or Microsoft SQL
Server 2014 Express Edition in Microsoft Windows 10), Supreme
Report and Samples components are not installed by default.

NOTE If the Microsoft SQL Server 2008 Express or Microsoft SQL

Server 2014 Express Edition feature is not installed, the Pulse
Server will utilize the MDB database by default.

9 Click Next.

The Pulse Server Settings window is displayed.

In the Pulse Server Settings window, the server’s external (public)

and internal (private) IP addresses, TCP port and the virtual
directory name are defined (the virtual directory holds the Pulse
client’s files). Use the default settings or define other addresses or
names.

Pulse 4.12 User Guide 86

10 Click Next to continue.

The Ready to Install the Program window is displayed and the

wizard is ready to begin installation.

Pulse 4.12 User Guide 87

11 Click Install to start the installation process.

The Installing Pulse window is displayed. The installation progress is

shown in the Status progress bar.

When the InstallShield Wizard Completed window is displayed, the

installation process is complete.

Pulse 4.12 User Guide 88

12 Click Finish and restart the computer.

NOTE If upgrading from Pulse 1.10

If SQL Server 2005 Express was previously used as your
project database, the Setup program will upgrade it to
Microsoft SQL Server 2008 Express. The installation may pause
and display the following message:

“Microsoft SQL Server 2008 SP1 Installation Failure. To

solve this problem, complete the current Pulse
installation and restart your computer. Run the Pulse
installation again and select the Repair option.”

Follow the instructions to complete the installation

successfully.

Pulse 4.12 User Guide 89

Uninstalling Pulse
1 Close all open programs.

2 From the Pulse icons group, click on Uninstall Pulse or go to

Control Panel > All Control Panel Items > Programs and
Features and right-click Pulse and select Uninstall from the pop-
up menu.

The Programs and Features prompt is displayed.

3 Select Yes.

Pulse displays a message window that states that Windows is

configuring Pulse.

Pulse 4.12 User Guide 90

 After Windows configures Pulse, the Pulse - InstallShield Wizard
window is displayed stating that the Uninstall process finished
successfully.

4 Click OK to complete the process.

Pulse 4.12 User Guide 91

The Pulse Communication Layer
Operating in the background, the communications drivers continuously
transport data from external data sources, such as PLCs. The data is
transferred to the Pulse Database Server for further processing, sent
directly to a display in the Operator Workstation, or to any other DDE
client application referencing it. The drivers include the communication
protocols used in the application.

This section contains the following topics:

 Installing Communication Drivers

 Setting up Drivers

 Checking Communication between Pulse and PLCs

Installing Communication Drivers

Drivers are the communication protocols used in the application. After
installing a driver it can be assigned to a virtual port in the
Communications Setup dialog box.

There are two main types of communication sources:

 Pulse drivers

 OPC clients (outside the scope of this guide)

In Pulse 4.12, the Pulse Driver Setup Wizard simplifies the process of
installing drivers.

Drivers can be installed either from your AFCON Pulse DVD or downloaded
from the AFCON Web site (www.afcon-inc.com). Click the Products link,
and then click Drivers 32 bit to locate and download the relevant driver
zip file to your computer. Additionally, the Install Driver option in the
Communications Setup dialog box enables assigning an installed driver to
a Pulse project. From all of these entry points, the Driver Setup Wizard
will execute the installation.

Pulse 4.12 User Guide 92

To install drivers from the AFCON Pulse DVD

1 Before installing a driver, shut down Pulse.

2 Insert the AFCON DVD into the DVD drive on your computer. Wait
for it to display its contents on your screen.

3 Select Pulse and then select Communication Drivers to open the

Communication Drivers dialog box.

4 Locate and select the required driver. Click the Install button to
run its setup.

The Pulse Driver Setup wizard is displayed.

Pulse 4.12 User Guide 93

5 Click Next. Select a project or install the driver into multiple
projects using the standard Windows selection key combinations
(<SHIFT>+click, <CTRL>+click, <CTRL>+A [for all]).

Pulse 4.12 User Guide 94

6 Click Next. Review the summary information. You may expand the
driver table to see which files the driver setup will install and their
destination folder.

7 Click Install.

The Install Progress page shows you the progress and status of the
driver installation. When the Current Task and Setup Status bars
display “100%”, the installation is done.

As an option, you can generate, store, and print installation

reports:

Report All Generate a report detailing the installation of

the driver files.

Report Errors Generate a report detailing any errors which

may have occurred during the driver
installation.

Pulse 4.12 User Guide 95

8 Click Next. If successful, the wizard notifies that the driver was
successfully installed. If you want to install another driver, click
Install another Driver to start the process again. Otherwise, click
Finish to close the wizard.

Pulse 4.12 User Guide 96

Start Pulse The Pulse Server will start up after you click Finish.
Server After the Server completes startup, the Driver Setup
wizard closes.

Pulse 4.12 User Guide 97

Setting up Drivers
At this stage, define the properties of the driver for each Pulse (logical)
port with which it is associated. The actual set of parameters are specific
to the particular driver and depend, among other things, on the physical
interface(s) used and on the nature of the communications transport
method(s) and protocol(s) used. For details, refer to the driver's
documentation. Driver properties fall in general into the following
categories:

Transport Type The physical interface (RS232, Ethernet TCP/IP,

MBPLUS, Modem, or Packet Data)

Transport Data transport parameters (e.g., Baud rate for serial

Parameters interface)

Scheduling Data update rates, error detection and recovery

timing, polling of specific addresses

Other Protocol-specific additional parameters

This section includes the following topics:

 Adding a Driver

 Defining Driver Properties

 Defining the Polling Configuration

 Syntax for Referencing Driver Addresses

Pulse 4.12 User Guide 98

Adding a Driver
Add the relevant drivers for your installation in the Project
Communication Setup dialog box, which you can access through the
Pulse Setup group.

To add a driver type

1 In the AFCON Pulse folder, click Pulse Setup then click the
Communication icon.

The Project Communication Setup dialog box is displayed.

2 Click New to display the Port Properties dialog box.

Pulse 4.12 User Guide 99

3 Define the following properties:

Port Name This is a virtual port. A virtual port number can

be any number between 1 and 255 and can be
used only once.

Driver Name Select the driver. This list holds the names of
all the drivers installed in the current project. A
driver can be used any number of times.

Bit numbering Define the read bit access used. For example,
system if Octal is used the digits 8, 9 are not available.
Our recommendation is to leave the default
setting (10 decimal).

Lowest bit Select 1 to define that the bit numbering for

number this driver is 1-16 (if 0 is selected, it defines
that the bit numbering for this driver is 0-15).

Emulation Mode Select this option to allow the driver to run in

emulation mode. In emulation mode, the driver
does not communicate with field devices, but
reads/writes internally. This mode is generally
used during development.

4 Click OK to implement the driver settings. Shut down Pulse and

restart it again to implement the new configuration.

Pulse 4.12 User Guide 100

Defining Driver Properties
Each driver has its own proprietary configuration settings, so the Pulse
Configurator dialog box is different for each driver (the figure below
illustrates the Pulse Configurator for MODBUS Driver). Refer to the driver’s
documentation for configuration details that are specific for it.

To define driver properties

1 In the AFCON Pulse folder, click Pulse Setup then click the
Communication icon.

The Project Communication Setup dialog box is displayed.

2 Select the configurator dialog box for the selected driver is

displayed.

Pulse 4.12 User Guide 101

3 Define the driver properties. The following parameters are common
for all compatible drivers.

Pulse Port Displays the port selected in the Project

Communication Setup dialog box, Assigned
Ports field.

Polling Click this button to display the Polling

Configuration Configuration dialog box. Use polling
configurations to define the scan time for
blocks by this driver.

Timeout Specify the time the driver waits for a valid

reply from the PLC. If a reply is not received or
is garbled, it then retries the transaction
according to the number of Max. Retries.

The default value is 1 second, ranging from

0.5 to 50 seconds.

Default Scan Define the default interval at which the driver

Time reads the data from the PLC. The default value
is 0, indicating continually.

Max. Retries Define the number of times the driver

attempts to communicate with the PLC after
the timeout expires, before declaring
communication failure. The default value is 3
retries.

Min. Reconnect Define the minimum amount of time in

minutes that the driver waits before trying to
reconnect to a PLC to which communications
previously failed. The default value is 1
minute.

Default Min. Define the minimum number of digits in the

Address Length default PLC address.

Network Type Choose the transport type and physical

interface used by the driver.

NOTE In case a firewall is used to monitor access into your

enterprise’s networks, the .NET framework sharing
service’s port (TCP port no. 808) must be open.

Pulse 4.12 User Guide 102

 Transport Click this button to display the Transport
Parameters Parameters dialog box, in accordance with
the chosen Network Type.

Station Click this button to display the Station

Parameters Parameters dialog box, in accordance with
the chosen Network Type. Use this function
when the PLC number, in addition to being a
consecutive PLC number in the network, also
represents other functionalities, such as an IP
address.

4 Click OK. Shut down Pulse and restart it again to implement the
new configuration.

Pulse 4.12 User Guide 103

Defining the Polling Configuration
Use polling configurations to define the scan time for groups of addresses
to be scanned at fixed time intervals by this driver. This is useful for
reducing overflow and for defining higher priority addresses.

To change the polling configuration

1 In the Pulse Setup group click the Communication button.

2 Select the driver entry and click Properties.

The Pulse configurator dialog box for the selected driver is

displayed.

3 Click Polling Configuration.

The Polling Configuration dialog box is displayed.

4 Click Add.

The Add Polling Block dialog box is displayed.

Pulse 4.12 User Guide 104

5 Define the polling configuration properties for the selected address
block:

Always OnScan Select this option to enable constant scanning

of this block of addresses, in accordance to the
block’s scan time.

CAUTION Enabling this option can overload

your system resources. Therefore,
only use it when necessary.

PLC Type the number of the PLC

Start Address Type the start address of the block

Quantity Type the number of addresses in the block

Scan Time Specify the scan time of the block - between

0.1 and 255.0 seconds (in steps of 0.1
seconds)

6 To delete a polling block entry, select the entry and click Erase.
To delete all the entries, click Erase All.

7 Click OK.

The Pulse configurator dialog box is active again on your screen.

8 Click OK and shut down Pulse then restart it to implement the new
configuration.

Pulse 4.12 User Guide 105

Syntax for Referencing Driver Addresses
In Pulse, the format for writing communication addresses depends on the
communications driver. Pulse modules can retrieve raw data directly from
communication drivers by calling them through dynamic data addresses
that specify the Server, Topic, and Item as follows:

Server The name of the server is DBSR.

Topic The name of the topic is PCIM.

Item The data item is specified in the generic format

Port:PLC:Address:Bit, where:

 Port number - the communication port

used for exchanging data, as specified in
the Pulse Communication Setup.

 PLC number - The number of the PLC in

the PLC network (syntax is driver
dependent).

 Address - the address of the data

element (syntax is driver dependent).

 Bit number - optional, the number of a

specific bit in a word or register (syntax
is driver dependent).

For example:

• 2:4:40001:2 refers to bit 2 of register #40001 on PLC #4

which is connected to Port #2.

• 1:1:10001 refers to input #10001 on PLC #1 which is

connected to Port #1.

NOTE Leading zeros are significant. When assigning or referencing

data addresses, remember that different quantities of zeros
between the initial letter of the address and its final digit(s)
represent different addresses. For example, A0001 does not
refer to the same address as A001 or A01.

Pulse 4.12 User Guide 106

Checking Communication between
Pulse and PLCs
It is important to check that communications between Pulse server and
the PLCs are constantly normal during project development and runtime.
Therefore, always check that communications are working properly when
you start to develop your project.

This section includes the following topics:

 Using Data Scope to Check Communication Status

 Using the Alarm Summary to Monitor Communication Status

Using Data Scope to Check Communication

Status
Use the Data Scope utility as a diagnostic tool to check for normal
communication between the Pulse server and the PLCs, or between a
Pulse client and a Pulse server.

To open Data Scope

1 From the Workstation’s Tools ribbon, click Data Scope.

2 In the Name column, enter the string specifying the data value to
check, or use immediate alias. This string is usually composed of a
PLC source, port, and an item or alias.

3 In the Value column, enter the value and click OK. To enter an
alias, enclose between ampersands (&alias&).

The result is displayed in the Status column after the Pulse Server
responds.

Pulse 4.12 User Guide 107

Using the Alarm Summary to Monitor
Communication Status
The Alarm Summary window displays alarms and system messages in
chronological order. For example, during startup it displays the
Success/failure status of module initialization, and the communication
status between the Pulse server and the data sources.

To open the Alarm Summary window

1 In the AFCON Pulse Program Group, open the Runtime folder and
click Alarm Handler.

2 From the Alarm Summary’s File menu, click Show Daily Log.

3 Scroll to the top to view all the system messages in the list.

During Pulse startup, the Alarm Summary is refreshed.

Pulse 4.12 User Guide 108

Monitoring Communication Event Messages
During runtime, the driver indicates problems and other events via
messages sent to the Alarm Publisher.

To view system messages from the Developer Workstation

1 In the Developer Workstation, go to the Tools ribbon and click

Alarm Explorer.

The Alarm Explorer window is displayed.

2 In the Alarm Explorer window, click the System Messages icon.

The system messages are displayed in the Alarm Explorer window.

The name of the driver is identified in the message immediately

after the time stamp, followed by a description of the event.

NOTE Check the communication status using the Driver Server.

Pulse 4.12 User Guide 109

Starting Pulse
This section contains the following topics:

 The Pulse Server Program Group

 Using the Server Manager

 The Pulse Services Utility

 Starting Up the Pulse Server

 Starting Up the Pulse Client Automatically

 Restarting the Pulse Server

 Downloading the Pulse Client Workstation

 Deploy to Flash Drive

 The Pulse Workstation

Pulse 4.12 User Guide 110

The Pulse Server Program
Group
To create the Pulse Server Group Shortcut

1 In the Windows Desktop, go to Start > Programs > AFCON

Pulse.

2 Click the AFCON Pulse icon and press the CTRL button.

3 Still pressing the CTRL button, drag the icon to your desktop.

4 Double-click the Pulse Group icon to open the Pulse Server Group
interface.

Pulse 4.12 User Guide 111

Using the Server Manager
The Pulse Server includes a set of Windows Services that run in the
background, carrying out Pulse-related management tasks, allowing the
Pulse server to run unattended. In order to start the Pulse Server, these
Services must already be running on the Pulse Server host computer.

The Server Manager is a client application that allows you to start, stop,
and change the startup type of the Pulse services on both local and
remote Pulse servers. Additionally, the Server Manager utility provides
access for you to configure the Pulse project, edit user’s accounts, and
view logged messages from all connected servers.

You can use more than one instance of the Server Manager concurrently.
The Server Manager is installed on both the Pulse server and client
programs.

NOTE It is recommended to use the Server Manager console to

manage the Pulse server’s services.

In case the services do not start automatically, or need to stop

or restart, you can also view the core services in the Services
console found in the Windows Control Panel >
Administrative Tools group.

To start the Server Manager

1 In the AFCON Pulse Program Group main folder, double-click the

Server Manager icon.

The Server Manager icon is displayed at the bottom right

corner of the screen in the Windows tray.

Pulse 4.12 User Guide 112

NOTE When the server is running, the Server Manager icon
is displayed (two blue cogwheels with a green triangle).

When the server is stopped, the Server Manager icon

is displayed (two blue cogwheels with a red square).

When the server manager is disconnected from the

Management Service, the icon is displayed (a single blue
cogwheel).

2 Right-click the Server Manager icon and select Connect.

3 Type in the server’s name or IP address and click OK. You receive
an indication of a successful or failed connection.

4 To work with the Server Manager, right-click the Server Manager

icon in the Windows tray and select an option from the menu.

Connect... Connects and log in to another Pulse server

(while disconnecting from the current one).

Show Services Opens the Pulse Services window,

see The Pulse Services Utility.

Pulse 4.12 User Guide 113

 Start Pulse Starts all active Pulse services on the current
Server connected server

Restart Pulse Restarts the Pulse server; all active dependent

Server services stop and start again when the server
restarts

Stop Pulse Stops all active Pulse server services, except

Server the Management service

NOTE Only Pulse administrators (Security level = 0) are

allowed to perform the Start, Restart, and Stop Pulse
actions.

Project Opens the current Project Configuration

Configuration window

User Opens the User Manager utility

Management

Log Viewer Displays the last logged message from the

connected Pulse server in the Log Viewer
(LogSrv|Log!$LastLogMessage).

About Displays license and software version

information.

Exit Closes the Server Manager utility.

Pulse 4.12 User Guide 114

The Pulse Services Utility
Use the Pulse Services utility to start, stop, and restart the Pulse services.
Note that the default setting is Automatic to start the services
automatically upon PC startup or reboot.

To access the Pulse Services Utility

1 Right-click the Server Manager icon and select Show Services.

The Pulse Services dialog box is displayed.

NOTE You can also access this dialog box from the Pulse Web Portal.
Open an Internet browser (i.e., Internet Explorer) and type in
the Pulse server’s host name or IP address and the virtual
directory name you provided in the installation process. For
example, http://pulseserver/pulseclient. The Pulse Web Portal
opens. Click the Server Manager link at the bottom of the
page.

2 Select a service and perform any of the required tasks.

NOTE Only Pulse administrators (Security level = 0) are allowed to

perform the Start, Restart, and Stop service actions or change
the service startup type.

Pulse 4.12 User Guide 115

 Status Options

Start Turn the service on. Click Start All to turn all
services on at the same time.

Restart Initiate the service from its startup, even if it’s

currently on. Click Restart All to initiate all
services at the same time.

Stop Turn the service off. Click Stop All to turn all
services off at the same time.

Startup Type

Automatic The service will start during Windows startup

without need for further user action.

Manual The service can only start by user action (for

example, selecting the service in the Service
manager and clicking the Start link).

Disable The service is turned off, and will not start

unless its Startup type is changed to Automatic
or Manual.

Pulse 4.12 User Guide 116

Starting Up the Pulse Server
You can start the Pulse application after the installation process is
complete.

NOTE Verify that the Software Enable Key (SEK) is connected to your
computer. Pulse runs in DEMO mode if no SEK is detected.

To start the Pulse server and services

 In the AFCON Pulse Program Group, double-click Startup.

Pulse initializes, initiates services, and starts the Database Server

and drivers.

Starting Up the Pulse Client

Automatically
The Pulse Operator Workstation can also be configured to start up
automatically when the Pulse Server starts on standalone mode or when
Windows starts on the remote machine.

The Pulse Operator Workstation user can access Pulse Runtime

automatically when the Server or Windows starts without going through
the Pulse Web Portal interface. When the Pulse Server starts up, the Pulse
Client starts up automatically or when Windows starts.

Configuring the Pulse Client to Start Up

Automatically when the Server Starts
There are two methods of defining the Pulse Client to up automatically:

 Through the Server Project Setup window on the server

 Through the Pulse Client Project Configuration Manager on the

Client

Pulse 4.12 User Guide 117

Configuring the Pulse Operator Workstation
to Start Up Automatically through the Project
Setup Window on the Server
1 On the desktop, go to Start > Programs > AFCON Pulse >
Pulse Setup > Project.

The Pulse Project window is displayed.

2 Access the path PCIM-Software > PCIM[xx.xx] > Projects >

Pulse Project > Settings >Workstation.

3 Double-click on the Startup Mode - Start automatically as

Pulse server starts option.

Pulse 4.12 User Guide 118

 The Startup Mode - Start Automatically as Pulse Server starts
window is displayed.

4 Check the Run Workstation on server side upon Pulse startup

checkbox option and click OK to save the setting.

The Startup Mode - Start Automatically as Pulse Server starts value

changes to True.

Configuring the Pulse Operator Workstation

to Start Up Automatically through the Pulse
Client Project Configuration Manager on the
Client
1 In the Pulse Developer Workstation, select the Manage ribbon and
click on the Project Configuration icon.

The Pulse Project Configuration Manager window is displayed.

2 On the Pulse Project Configuration Manager window, access the

path General > Workstation and click Startup Mode - Start
automatically as Pulse server starts.

Pulse 4.12 User Guide 119

3 On the right pane, click the Run Workstation on server side
upon Pulse startup checkbox to select the option.

4 Click Save.

The Startup Mode - Start automatically as Pulse server starts

value changes to True.

This will start up Pulse automatically when Windows starts up.

Pulse 4.12 User Guide 120

Automatic Startup for the Pulse
Operator Workstation upon
Windows Startup
To define automatic startup for the Pulse Operator Workstation
upon Windows Start Up

1 Go to the Pulse Web Portal and right-click on the Operator

Workstation button and select Copy Shortcut from the drop-
down menu.

2 Go to the Windows desktop and click Start.

3 Right-click on the Startup folder and click Open on the pop-up

menu.

The Startup folder is displayed.

4 Right-click within the Startup folder and select Paste from the
pop-up menu options.

The Pulse Operator Workstation automatically starts up the next

time Windows starts up.

Pulse 4.12 User Guide 121

Concurrent Developer Workstation
Notification
A notification on the Pulse Developer Workstation title bar shows the
number of (additional) Developer Workstations presently open.

This feature informs the user the present number of active Pulse
Developer Workstations, in case multiple windows are open.

Restarting the Pulse Server

When required, it is possible to restart the Pulse server by double-clicking
the Restart icon.

To restart the Pulse Server

 In the AFCON Pulse Program Group, double-click Restart.

The Pulse Server shuts down, and then starts up again. The Pulse
Server initializes, initiates services, and starts the Database Server
and drivers.

Pulse 4.12 User Guide 122

Downloading the Pulse Client
Workstation
The Pulse Client workstations (Operator, Developer, and Monitor) are the
main interfaces with your Pulse projects. Through the client computer’s
web browser, you log into the default project over an Internet or Intranet
connection.

NOTE Opening the Pulse Web Portal and accessing a workstation

requires a browser such as Windows Internet Explorer, Mozilla
Firefox, or Google Chrome.

 Operator Workstation - In the Operator Workstation, users

receive information from the data sources, as well as input
information and commands to Programmable Logic Controllers
(PLC), other field devices, or to third-party databases. The data
exchange is based on the engineering performed in the Developer
Workstation.

 Monitor Workstation - In Monitor mode, users can only view

project data, but cannot write input data or change the value or
status of any object.

 Developer Workstation - The process of creating project

components (displays, inserting graphic objects, instruments, and
controls), creating, and configuring database blocks, alarms and
more, is done in the Developer Workstation.

Furthermore, you can customize the Developer Workstation

interface by showing or hiding the docking panels, selecting a skin
or localizing the workstation.

Use the Pulse Web Portal to download and run the Pulse client.

To run a client workstation

1 Open an Internet browser and type in the Pulse server’s host name
or IP address and the virtual directory name you provided in the
installation process.

For example, http://pulseserver/pulseclient

The Pulse Web Portal is displayed.

NOTE Pulse 4.12 supports additional browsers such as the Mozilla

Firefox and the Google Chrome in addition to Internet
Explorer.

Pulse 4.12 User Guide 123

NOTE To open a client workstation on the same computer as the
Pulse Server, enter the AFCON Pulse Program Group in the
Windows desktop and run Launch Workstation.

2 Click the relevant Workstation link to launch the Pulse client

download process.

• Operator Workstation

• Monitor Workstation

• Developer Workstation

3 If this is the first time you are opening Pulse on your computer, or
you have removed a previous version of the Pulse client, you are
prompted whether to download the program. Click Yes to continue
downloading the workstation.

Pulse 4.12 User Guide 124

4 The login dialog box appears at the end of the installation process,
prompting you for a user name and password.

Default User pulse

Name

Default pulse
Password (all lower case letters - password is case-
sensitive)

5 Type the user name and password and click Login to open the
Pulse workstation that you selected in step 2.

The Login command causes the system to switch to an operator

environment based on the user’s defined privileges.

The user can login according to the user’s set privileges.

Pulse 4.12 User Guide 125

Deploy to Flash Drive
Pulse provides flexibility and mobility by enabling the creation of a
portable version of the Pulse Client. The created portable Pulse Client files
can be copied locally and later transferred to a portable media (i.e., CD,
DVD, Flash Drive, etc.) or directly created into an external media. The
portable Pulse Client does not require installation. It is launched simply by
double-clicking the Pulse.Client.Launcher.exe file.

This feature enables connecting to your Pulse server from different

locations, providing the functionality of a client workstation even if the
computer you use does not have a Pulse client downloaded on it. This
feature is very useful for key personnel who need to access their Pulse
projects while traveling.

Running a portable Pulse Client requires the following:

 128 MB free disk space

 .NET framework installed on the host computer

To create a Pulse Client

1 In the AFCON Pulse Program Group’s Administrative Tools

folder, click the Deploy to Flash Disk icon.

The Deploy to Flash Disk dialog box is displayed.

2 In the Select Destination field, browse for the destination folder

where you prefer the Pulse Client files to be or leave the provided
destination value.

Pulse 4.12 User Guide 126

3 You can just create a Pulse Client or you can select one or both
from the following checkbox options:

• Local Network Only – This checkbox option creates a

portable Pulse Client that can access the Pulse server only
from the local network.

• Prompt for server address - This checkbox option creates

a portable Pulse Client that can access the Pulse Server via
its IP address or its URL.

• You can select both the Local Network Only and the
Prompt for server address checkbox options to create a
portable Pulse Client that can access the Pulse server from
the local network and via its IP address or its URL.

4 Click OK.

A progress bar shows the status of the deployment process. When

the progress bar displays “100%”, the deployment is complete and
Pulse prompts you whether you would want to create another
instance of the Pulse client.

5 Click Yes to create another portable Pulse Client or No to exit.

To start the portable Pulse Client

1 Check that the computer where the Pulse Client has to run meets
the minimum requirements, see System Requirements.

2 Go to the deployed Client folder and double-click

Pulse.Client.Launcher.exe.

• If the Local Network Only checkbox option was selected;

the Pulse Client workstation is displayed.

• If the Prompt for server address checkbox option was

selected, the following Pulse Workstation prompt is
displayed.

Pulse 4.12 User Guide 127

 You can enter the Pulse server’s IP address or enter its URL
(Uniform Resource Locator) in the Please enter server
address field. Then select whether to open a Pulse
Operating, Monitoring, or Development client and click
OK.

• If the Local Network Only and the Prompt for server

address checkbox options were selected; the Pulse
Workstation prompt above is displayed.

You can enter the Pulse server’s IP address or enter its URL
(Uniform Resource Locator) in the Please enter server
address field. Then select whether to open a Pulse
Operating, Monitoring, or Development client and click
OK.

Deploying the Pulse Client to a USB Flash

Drive
You can also choose to deploy the Pulse Client onto a USB Flash drive.

Running Pulse client from a flash disk requires the following:

 128 MB free disk space

 USB2 or faster port

 .NET framework installed on the host computer

To deploy the Client to a USB Flash Drive

1 Connect the USB Flash Drive to the Pulse host computer.

2 In the AFCON Pulse Program Group’s Administrative Tools

folder, select Deploy to Flash Disk.

The Deploy to Flash Disk dialog box is displayed.

Pulse 4.12 User Guide 128

3 In the Select Destination field, enter or browse for the destination
location on the USB disk drive for the Client files or use the
provided USB path.

4 Click to select one or both of the following checkbox options:

• Local Network Only

• Prompt for server address

5 Click OK.

A progress bar shows the status of the deployment process. When

the progress bar displays “100%”, the deployment is complete.

NOTE The Pulse application stops functioning when an attempt to

copy a Pulse Client directly to a CD/DVD drive via the Deploy
to Flash Disk is made.

Copying projects directly to a DVD is not supported. The

current version of the Pulse system remains online and an
error message is displayed.

Pulse prompts you whether you would want to create another

instance of the Pulse client.

6 Click Yes to create another portable Pulse Client or No to exit.

To start the client workstation from a USB Flash drive

1 Connect the USB Flash drive containing the Pulse Client deployed
folder to a computer that meets the minimum requirements, see
System Requirements.

2 Go to the Client folder on the USB Flash drive and double-click

Pulse.Client.Launcher.exe.

3 Log in to the Pulse server.

• If the Local Network Only checkbox option was selected;

the Pulse Client workstation is displayed.

Pulse 4.12 User Guide 129

 • If the Prompt for server address checkbox option was
selected, the following Pulse Workstation prompt is
displayed.

You can enter the Pulse server’s IP address or enter its URL
(Uniform Resource Locator) in the Please enter server
address field. Then select whether to open a Pulse
Operating, Monitoring, or Development client and click
OK.

• If the Local Network Only and the Prompt for server

address checkbox options were selected; the Pulse
Workstation prompt is displayed.

You can enter the Pulse server’s IP address or enter its URL
(Uniform Resource Locator) in the Please enter server
address field. Then select whether to open a Pulse
Operating, Monitoring, or Development client and click
OK.

Pulse 4.12 User Guide 130

The Pulse Workstation
By default, the Pulse Client starts up in runtime mode, opening the
Operator Workstation. The developer mode, which runs in the Developer
Workstation, is accessible from the Operator Workstation for those
persons with the applicable security level. The startup mode may be
changed in the Security level configurations.

The process of designing project components (creating displays inserting

and defining graphic objects, instruments, and controls), creating, and
configuring database blocks, alarms and more, is done in the Developer
Workstation.

For more information about the Developer Workstation, see The Pulse
Client Developer Workstation.

For more information about the Operator Workstation, see The Pulse
Client Operator Workstation.

The following figure illustrates the Developer Workstation.

Pulse 4.12 User Guide 131

The following figure illustrates the Operator Workstation.

Setting up Projects
In Pulse, the models that are built to run, monitor, and control processes
in the workplace are called projects. A project contains all the components
that enable personnel to receive and enter data about the relevant
processes. You can keep several projects on the Pulse Server.

A server can run only one active project at a time, which is known as the
default project. During installation of the Pulse server, the first project and
its files are created and defined as the default project. This project will
automatically open during application startup. The name of the Pulse
default project is PulseProject.

The Project Setup Manager can contain configurations for several projects.
Switching the default project can be done only when the Pulse server is
shut down. Any clients that are connected when the switch takes place
receive a message instructing them to shut down and restart in order to
connect to the new default project.

The Project Setup Manager is accessible from the Pulse Setup program
group. The Project Setup Manager displays a project tree, which contains
branches for all installed Pulse product versions. The branches contain
sub-branches for all projects that were created in the relevant product
version.

Pulse 4.12 User Guide 132

In the Project Setup, you can do the following:

 Create projects and define their file locations

 Edit project configuration

 Switch to another default/active project

 Delete projects, including their folders and files

 Start up and shut down Pulse

NOTE Pulse is labeled “P-CIM 10.xx” in the current version’s Project

Setup tree.

NOTE To work with a P-CIM 7.xx or lower project in Pulse, you must
first “migrate” the project to the Pulse format. For more
information, see Project Migration.

NOTE Use the Demo project (if the Demo project creation was
enabled during installation) to get acquainted with Pulse, view
examples and read descriptions about many of Pulse’s
features.

Pulse 4.12 User Guide 133

This section includes the following topics:

 Project Design Guidelines

 Creating and Setting a Project

 Configuring Services Settings

 Configuring Project Setup Settings

 Database Utility

 Exporting and Importing the Database

 Backing Up and Restoring Projects

 Restoring a Project

 Saving Pulse Project Data

 Activating the Data Logger

Pulse 4.12 User Guide 134

Project Design Guidelines
A project is identified by a unique name, and comprises several subjects.
Each project resides in its own folder, which holds the files associated with
a particular kind of subject matter. When designing a project, you have to
assign it a name, the actual disk folder (path) for each subject, and
optionally, a comment for each subject.

It is recommended to follow the following design guidelines for setting up

projects:

 How Many Projects?

As a rule, create a separate project for each application that you

develop and maintain on the application development computer. In
addition, you may want to create additional project snippets, in
which you keep application fragments that you reuse in some or all
the projects you maintain (such as your custom Clipart, Cells, etc.).

 Choosing a Project Name, Path and a Comment for Each Subject

• Do not use any of the reserved folder names under Pcim32,

nor the name PcimPath.

• The path must be no longer than 255 characters.

• Use the default grouping method, where each project has its
own separate folder (named as the project), with all the files
of all the subjects in it.

• Do not mix files of different subjects and/or projects. When

deleting a project, Project Setup deletes an entire folder - but
warns you if it finds that it holds files of more than one
project.

• The comment is just for annotation, and must be no longer

than 255 characters (including spaces).

Pulse 4.12 User Guide 135

Project Setup
Creating and Setting a Project
Follow the procedure below to add a new Pulse project.

To add a Pulse project

1 Right-click in the Project Setup window’s left pane and click New.
-or-
Click the New Project button in the toolbar.

The Add New Project dialog box is displayed.

Pulse 4.12 User Guide 136

2 Enter the following details:

Name Project Name. This name appears at the top of

the project’s branch in the Project Setup
tree.

Description Type a short description about the project.

3 Click OK.

Pulse creates the new project with all its subjects and folders in the
Project Setup tree.

Additionally, a new subfolder for the project is created in the Pulse

server’s folder on the server’s hard drive.

A backup subfolder for the project is created in the Pulse server’s

BackUp subfolder.

This section also includes the following topics:

 Changing Project Folder Paths

 Defining the Default Project

 Deleting a Project

 Configuring the Pulse Remote Access Security

 Configuring the Pulse Server Address

 Connecting the Pulse Client to the Pulse Server

 Configuring Project Database Settings

Pulse 4.12 User Guide 137

Changing Project Folder Paths
By default, project files are saved under the project’s folder under the
subfolders located. To change the subfolder’s path, do the following:

To change project folder paths

1 In the Project Setup window project tree, expand the project’s

Folders subfolder.

2 Double-click a subject in the Folders subfolder.

The folder subject’s Properties dialog box is displayed.

3 If required, change the Folder’s description.

NOTE First shutdown Pulse before modifying folders of a default

project. They cannot be modified while Pulse is running.

4 Type a new path, or browse to select a new path for the folder then
click OK.

5 Repeat steps 2 to 4 to change the path of as many other folders as

you need.

Pulse 4.12 User Guide 138

Defining the Default Project
During startup, Pulse always opens the default project. To open a different
project at startup, you must first shut down the Pulse system and all its
open applications.

To change the default project

1 If the Pulse program is running on the server, shut it down. In the

AFCON Pulse Program Group, select Shutdown.

2 In the Project Setup window project tree, right-click the project

and click Set as Default.

-or-

Select the project and click the Default button from the toolbar.

Click Yes to confirm.

In the Project Setup window, the default project name changes in

the title bar and a check mark appears on the project’s folder.
When you restart Pulse, the new default project is displayed.

Pulse 4.12 User Guide 139

Deleting a Project
Deleting a project removes all of the project’s files from the system and
database. You delete a project in the Project Setup window.

CAUTION Deleting a project deletes the files and folders of the project in
question permanently! This operation requires confirmation to
delete every single folder, and warns you if a folder potentially
contains files from more than one project (that is, the same
path is defined in more than one project).

NOTE Pulse does not allow you to delete the project currently defined
as the default project. To delete the default project, you must
first define a different project as the default. Then, you can
proceed to delete the previous default project.

To delete a project

1 In the Project Setup window project tree, right-click the project

and click Delete.

-or-

Select the project and click the Delete button from the toolbar. The
Project Setup confirmation message box is displayed.

2 Click Yes to confirm.

The Remove directory dialog box is displayed asking if you want

to delete the project’s path. You are prompted for each project
folder.

Pulse 4.12 User Guide 140

3 Click Yes to delete specific folders one at a time, or Yes to All to
delete all the folders at once.

The project is deleted from the Project Setup window and the Pulse
application folder.

Configuring Project Setup Settings

Alarm Publisher
Alarm Acknowledge - Enable Comment Entry
The Alarm Acknowledge - Enable Comment Entry Alarm Publisher
option enables you to enter a comment while acknowledging alarms.

To enable entering a comment while acknowledging alarms

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Alarm Acknowledge - Enable Comment Entry.

The Alarm Acknowledge - Enable Comment Entry window is

displayed.

2 Check the Enable Comments checkbox to enable comments while

acknowledging alarms.

3 Click OK to continue.

Pulse 4.12 User Guide 141

Automatic Actions - Order of Automatic
Activation of Alarm Workflows
The Alarm Publisher’s Automatic Actions - Order of Automatic
Activation of Alarm Workflows option allows you to select the order
the workstations execute the alarm workflows. To execute alarm
workflows, Operator Personalization has to be enabled.

To select the order the Workstations execute alarm workflows

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Automatic Actions - Order of Automatic
Activation of Alarm Workflows.

The Automatic Actions - Order of Automatic Activation of Alarm

Workflows window is displayed.

2 Select one of the following alarm workflow mode from the Alarm
Workflow Mode drop-down list:

• Execute Workflow of the field ‘Always’ as Alarm

Arrives (default)

• Never Execute Alarm Workflow

• Execute Workflow for Alarm with Highest Priority

3 Click OK to continue.

Pulse 4.12 User Guide 142

Log Messages - Maximum Messages per
Snapshot Request
The Alarm Publisher’s Log Messages - Maximum Messages per
Snapshot Request option allows you to set the maximum number of
alarm and event messages sent to the Pulse workstation per snapshot
request.

To set the maximum number of alarm and event messages sent to

the Pulse workstation per snapshot request

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Log Messages - Maximum Messages per
Snapshot Request.

The Alarm Publisher - Log Messages - Maximum Messages per

Snapshot Request window is displayed.

2 Enter the maximum number of alarm and event messages sent to

the Pulse workstation per snapshot request in the Alarm Log
snapshot size (0 – 100000) field, where ‘0’ is the minimum and
‘100000’ is the maximum value.

3 Click OK to continue.

Pulse 4.12 User Guide 143

Manual Actions - Activate Alarm Workflow from
Alarm Explorer
The Manual Actions - Activate Alarm Workflow from Alarm Explorer
option allows you to activate the alarm workflow when double-clicking an
alarm in the Alarm Explorer.

To activate the alarm workflow in the Alarm Explorer

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Manual Actions - Activate Alarm Workflow from
Alarm Explorer.

The Alarm Publisher - Manual Actions - Activate Alarm Workflow

from Alarm Explorer window is displayed.

2 Enter ‘1’ or ‘0’ in the Activate Alarm Command (0 – 1) field:

• Enter 1 to activate the alarm workflow when double-clicking

an alarm in the Alarm Explorer.

• Enter 0 for the alarm workflow to remain inactive when

double-clicking an alarm in the Alarm Explorer.

3 Click OK to continue.

Pulse 4.12 User Guide 144

Operation Mode
The Operation Mode option allows you to select the Alarm Publisher’s
operation mode.

To select the Alarm Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation mode for the Alarm Publisher
from the Operation Mode drop-down list:

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 145

Simulation Repeat
The Simulation Repeat option allows you to set the simulation’s
repeating rate in the Alarm Publisher.

To set the simulation’s repeating rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Simulation Repeat.

The Simulation Repeat window is displayed.

2 Enter the simulation’s repeat rate in the SimulationRepeat (0 –

99999) field, where ‘0’ is the lowest repeat rate and ‘99999’ is the
highest repeat rate.

3 Click OK to continue.

Pulse 4.12 User Guide 146

Simulation Scan Interval
The Alarm Publisher’s Simulation Scan Interval option allows you to set
the scanning time interval for simulation messages.

To set the time scanning time interval for simulation messages

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Simulation Scan Interval.

The Simulation Scan Interval window is displayed.

2 Enter the scan interval in the Simulation Scan Interval (0 –

1440) field, where ‘0’ is the minimum scan interval value and
‘1440’ is the highest.

3 Click OK to continue.

Pulse 4.12 User Guide 147

System Messages - Maximum Messages per
Snapshot Request
The Alarm Publisher System Messages - Maximum Messages per
Snapshot Request option allows you to set the maximum number of
system messages to send to client per snapshot request.

To set the maximum number of system messages to send to client

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > System Messages - Maximum Messages per
Snapshot Request.

The System Messages - Maximum Messages per Snapshot Request

window is displayed.

2 Enter the size of the system messages snapshot in the System

messages snapshot size (0 – 100000) field, where ‘0’ is the
lowest value and ‘100000’ is the highest.

3 Click OK to continue.

Pulse 4.12 User Guide 148

Update Rate - Alarm Counters Update Rate
The Alarm Publisher Update Rate - Alarm Counters Update Rate
option allows you to set the update rate time interval in milliseconds for
sending alarm counters to the Pulse Workstation.

To set the time interval for sending alarm counters to the Pulse
workstation

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Update Rate - Alarm Counters Update Rate.

The Update Rate - Alarm Counters Update Rate window is

displayed.

2 Enter the alarm counters update rate time interval in the Alarm
counters’ updates interval (0 – 60000) field, where ‘0’ is the
minimum update rate time interval and ‘60000’ is the highest.

3 Click OK to continue.

Pulse 4.12 User Guide 149

Update Rate - Alarms and Events Messages
Update Rate
The Alarm Publisher Update Rate - Alarms and Events Messages
Update Rate option allows you to set the time interval in milliseconds for
sending alarm messages to the Pulse workstation.

To set the time interval for sending alarm messages to the Pulse
workstation

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarm
Publisher > Update Rate - Alarms and Events Messages
Update Rate.

The Update Rate - Alarms and Events Messages Update Rate

window is displayed.

2 Enter the time interval for the alarms’ snapshots in the Alarms
snapshots interval (0 – 3600000) field, where ‘0’ is the
minimum and ‘3600000’ is the maximum value.

Set to ‘0’ to send alarm changes only.

3 Click OK to continue.

Pulse 4.12 User Guide 150

Alarms

Alarm Printing – Maximum Lines per Page

The Alarm Printing – Maximum Lines per Page option allows you to
specify the number of alarm and event lines to accumulate before printing
a page on a page printer.

To specify the number of alarm and event lines to print on a page

printer

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Alarm Printing – Maximum Lines per Page.

The Alarm Printing – Maximum Lines per Page window is displayed.

2 Enter the number of the maximum accumulated lines before a page

can be printed on a page printer in the Maximum Accumulated
Lines (0 – 20) field, where the range is ‘0’ (minimum) to ‘20’
(maximum) lines.

3 Click OK to continue.

Pulse 4.12 User Guide 151

Alarms Collection – Collection Enabled
The Alarms Collection – Collection Enabled option allows you to
enable any alarm or event message to be recorded to the alarm database
(current, log, system messages).

To enable any alarm or event message to be recorded to the alarm

database

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Alarms Collection – Collection Enabled.

The Alarms Collection – Collection Enabled window is displayed.

2 Check the Enable Alarms Collection checkbox to enable collecting

alarms.

3 Click OK to continue.

Pulse 4.12 User Guide 152

Alarms Collection – Current Alarm Startup
The Alarms Collection – Current Alarm Startup option gives you the
possibility to display or not to display any alarms found already asserted
when Pulse is started. You can also define the time stamp if you choose to
display the alarms.

To define whether to display/not to display any alarms found

already asserted when Pulse is started

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Alarms Collection – Current Alarm Startup.

The Alarms Collection – Current Alarm Startup window is displayed.

2 Select one of the following from the Current Alarm Startup drop-
down list.

• Alarms not displayed (default) – option not to display any

asserted alarms found upon Pulse startup

• Alarms displayed, with time stamp reflecting present

time - option to display any asserted alarms found with time
stamp upon Pulse startup

3 Click OK to continue.

Pulse 4.12 User Guide 153

Alarms Collection – Enable Collection to Alarm
Log
The Alarms Collection –Enable Collection to Alarm Log option gives
you the possibility to log alarms or events to the Alarms Database. To
enable logging, make sure to activate the global collection of alarms.

To log alarms or events to the Alarms Database

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Alarms Collection – Enable Collection to Alarm Log.

The Alarms Collection – Enable Collection to Alarm Log window is

displayed.

2 Check the Enable Alarms Publisher collection to log checkbox

to enable logging alarms and events to the Alarms Database.

3 Click OK to continue.

Pulse 4.12 User Guide 154

Alarms Collection – Use Computer Time after
AlarmWait
The Alarms Collection –Use Computer Time after AlarmWait option
allows recording ‘1’ (default) generated alarms with AlarmTime that
includes AlarmWait and AlarmValue at the AlarmTime. If the switch is ‘0’
then the alarm’s time stamp reflects the time when the alarm was first
detected.

To use the computer time after AlarmWait

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Alarms Collection – Use Computer Time after AlarmWait.

The Alarms Collection – Use Computer Time after AlarmWait

window is displayed.

2 Check the Use Computer Time after AlarmWait checkbox.

3 Click OK to continue.

Pulse 4.12 User Guide 155

Purging Alarms – Purge all Alarms on Pulse
Startup
The Purging Alarms – Purge all Alarms on Pulse Startup option
enables you to keep or delete all current alarm records from the Alarms
Database upon the Pulse Server startup.

To purge all alarms from the Alarms Database when the Pulse
Server starts up

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> Purging Alarms – Purge all Alarms on Pulse Startup.

The Purging Alarms – Purge all Alarms on Pulse Startup window is

displayed.

2 Check the Purge All Alarms on Pulse Startup checkbox or leave

the checkbox unchecked to keep the alarms in the Alarm Database
when the Pulse Server starts up.

3 Click OK to continue.

Pulse 4.12 User Guide 156

System Messages Collection – Enable Collection
to System Message Log
The System Messages Collection – Enable Collection to System
Message Log option allows you to select whether to log system
messages and events to the system’s Alarms Database. To enable
logging, ensure that the global connection of alarms is enabled.

To enable Alarms Publisher collection to the System log

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Alarms
> System Messages Collection – Enable Collection to System
Message Log.

The System Messages Collection – Enable Collection to System

Message Log window is displayed.

2 Check the Enable Alarms Publisher collection to System Log

checkbox.

3 Click OK to continue.

Pulse 4.12 User Guide 157

Aliases

Aliases Configuration - Alias Delimiter

The Aliases Configuration - Alias Delimiter option allows you to define
the delimiter for aliases.

To define the delimiter for aliases

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Aliases
> Aliases Configuration - Alias Delimiter.

The Aliases Configuration - Alias Delimiter window is displayed.

2 Enter the Alias Delimiter value in the field.

NOTE & is the default value.

3 Click OK to continue.

Pulse 4.12 User Guide 158

Callback Adaptor Publisher

Communication Item Text Format

The Callback Adaptor Publisher’s Communication Item Text Format
option allows you to select whether to enable the Pulse Server to send a
communication item value in text format.

To enable the Pulse Server to send a communication item value in

text format

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Callback Adaptor Publisher > Communication Item Text
Format.

The Communication Item Text Format window is displayed.

2 Check the Enable Communication Item Text Format checkbox.

3 Click OK to continue.

Pulse 4.12 User Guide 159

Operation Mode
The Callback Adaptor Publisher’s Operation Mode option allows you to
select the CB Adaptor Publisher’s operation mode.

To select the CB Adaptor Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Callback Adaptor Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 160

Scan Interval
The Callback Adaptor Publisher’s Scan Interval option allows you to set
the Database Server’s scanning intervals for sending values back to
clients.

To set the Database Server’s scanning intervals

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Callback Adaptor Publisher > Scan Interval.

The Scan Interval window is displayed.

2 Enter the scan interval value in the Scan Interval (0 – 20000)

field. The default scan interval value is ‘10’.

3 Click OK to continue.

Pulse 4.12 User Guide 161

Simulation Repeat
The Simulation Repeat option allows you to set the repeating rate for
the Callback Adaptor Publisher’s simulation.

To set the simulation repeating rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Callback Adaptor Publisher > Simulation Repeat.

The Simulation Repeat window is displayed.

2 Enter the simulation repeat rate for the Callback Adaptor Publisher
in the Simulation Repeat (0 – 99999) field. The default
simulation repeat rate is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 162

Simulation Scan Interval
The Simulation Scan Interval option allows you to set the interval rate
for reading the Callback Adaptor Publisher’s simulation file.

To set the reading interval for the simulation file

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Callback Adaptor Publisher > Simulation Scan Interval.

The Simulation Scan Interval window is displayed.

2 Enter the simulation scan interval rate for the Callback Adaptor
Publisher’s in the Simulation Scan Interval (0 –1440) field. The
default simulation scan interval rate is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 163

Communication

Database Configuration - DbsrNodes

The Database Configuration - DbsrNodes option allows you to define
network nodes.

To define network nodes

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Database Configuration - DbsrNodes.

The Database Configuration - DbsrNodes window is displayed.

2 Specify the network nodes in the Network Nodes field.

3 Click OK to continue.

Pulse 4.12 User Guide 164

Database Configuration – NodeNumber
The Database Configuration - NodeNumber option allows you to
define a node number.

To define a node number

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Database Configuration - NodeNumber.

The Database Configuration – NodeNumber window is displayed.

2 Specify the node number in the Node Number field.

3 Click OK to continue.

Pulse 4.12 User Guide 165

Database Configuration – PortNumber
The Database Configuration - PortNumber option allows you to define
port numbers.

To define a port number

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Database Configuration - PortNumber.

The Database Configuration – PortNumber window is displayed.

2 Specify the port number in the Port Number (0 – 9999) field.

3 Click OK to continue.

Pulse 4.12 User Guide 166

Port Driver Configuration - Pcim Drivers
The Port Driver Configuration - Pcim Drivers option enables you to
define P-CIM drivers.

To define a communication P-CIM driver

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Port Driver Configuration - Pcim Drivers.

The Port Driver Configuration - PcimDrivers window is displayed.

2 Specify the P-CIM communication driver in the Communication

Drivers field.

3 Click OK to continue.

Pulse 4.12 User Guide 167

Subscription Broker - Lease Timeout
The Subscription Broker - Lease Timeout option allows setting the
limit for receiving ‘keep alive’ messages before client disconnection. The
client sends a ‘keep alive’ message on a fixed interval. The value regulates
the maximum time limit for sending the message to the server.

To set the limit for receiving ‘keep alive’ messages

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Lease Timeout.

The Subscription Broker - Lease Timeout window is displayed.

2 Specify the lease timeout value in the Lease Timeout (0 –

600000) field. The default value is ‘60000’.

3 Click OK to continue.

Pulse 4.12 User Guide 168

Subscription Broker - Max Lease Errors
The Subscription Broker - Max Lease Errors option allows you to set
the maximum number of attempts for sending the ‘keep alive’ message.

To set the maximum number of attempts for sending a ‘keep alive’

message

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Max Lease Errors.

The Subscription Broker - Max Lease Errors window is displayed.

2 Specify the maximum lease error value in the Max Lease Errors
(0 – 1000) field. The default value is ‘4’.

3 Click OK to continue.

Pulse 4.12 User Guide 169

Subscription Broker - Maximum Messages per
Batch
The Subscription Broker - Maximum Messages per Batch option
allows you to set the number of Subscribe/Unsubscribe messages per
batch.

To set the number of Subscribe/Unsubscribe messages per batch

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Maximum Messages
per Batch.

The Subscription Broker - Maximum Messages per Batch window is

displayed.

2 Specify the maximum batch size in the Maximum Batch size (0 –

1000) field. The default value is ‘50’.

3 Click OK to continue.

Pulse 4.12 User Guide 170

Subscription Broker - Receive Message Scan
Interval
The Subscription Broker - Receive Message Scan Interval
communication option allows you to specify the frequency of a client
receiving messages from the server, in milliseconds.

To specify the frequency of a client receiving messages from the

server

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Receive Message
Scan Interval.

The Subscription Broker - Receive Message Scan Interval window is

displayed.

2 Specify the frequency of a client receiving messages from the

server in milliseconds in the Messages scan frequency (0 –
60000) field. The default value is ‘10’.

3 Click OK to continue.

Pulse 4.12 User Guide 171

Subscription Broker - Send Messages Scan
Interval
The Subscription Broker - Send Messages Scan Interval
communication option allows you to specify the frequency of a server
sending messages to a client, in milliseconds.

To specify the frequency of a server sending messages to a client

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Send Messages Scan
Interval.

The Subscription Broker - Send Messages Scan Interval window is

displayed.

2 Specify the frequency of a server sending messages to a client, in

milliseconds, in the Messages sending interval (0 – 60000)
field. The default value is ‘10’.

3 Click OK to continue.

Pulse 4.12 User Guide 172

Subscription Broker - Subscribe/Unsubscribe
Interval
The Subscription Broker - Subscribe/Unsubscribe Interval
communication option allows you to define the interval to subscribing or
unsubscribing a batch from a client to the message bus to publishers, in
milliseconds.

To define the interval to subscribe/unsubscribe a batch from a

client to the message bus to publishers

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker -
Subscribe/Unsubscribe Interval.

The Subscription Broker - Subscribe/Unsubscribe Interval window is

displayed.

2 Specify the interval of subscribing or unsubscribing a batch from a

client to the message bus to publishers, in milliseconds, in the
Used for subscribe/unsubscribe batch (0 – 60000) field. The
default value is ‘75’.

3 Click OK to continue.

Pulse 4.12 User Guide 173

Subscription Broker - Verify Connections Policy
The Subscription Broker - Verify Connections Policy communication
option enables communication state verification using the ‘keep alive’
mechanism.

To enable communication state verification via ‘keep alive’

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Communication > Subscription Broker - Verify Connections
Policy.

The Subscription Broker - Verify Connections Policy window is

displayed.

2 Check the Verify Connection Policy checkbox option to enable

communication state verification using the ‘keep alive’ mechanism.

3 Click OK to continue.

Pulse 4.12 User Guide 174

Configuration Publisher

Operation Mode
The Operation Mode option allows you to select the Configuration
Publisher’s operation mode.

To select the Configuration Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Configuration Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 175

Scan Interval
The Scan Interval option allows you to set the Configuration Publisher’s
scanning interval.

To set the scanning interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Configuration Publisher > Scan Interval.

The Scan Interval window is displayed.

2 Enter the scan interval value in the Scan Interval (0 – 20000)

field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 176

Simulation Repeat
The Simulation Repeat option allows you to set the Configuration
Publisher’s simulation repeat.

To set the simulation repeat

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Configuration Publisher > Simulation Repeat.

The Simulation Repeat window is displayed.

2 Enter the simulation repeat rate in the Simulation Repeat (0 –

99999) field. The default scan interval value is ‘1’.

3 Click OK to continue.

Pulse 4.12 User Guide 177

Simulation Scan Interval
The Simulation Scan Interval option allows you to set the Configuration
Publisher’s simulation scan interval.

To set the simulation scan interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Configuration Publisher > Simulation Scan Interval.

The Simulation Scan Interval window is displayed.

2 Enter the simulation scan interval rate in the Simulation Scan

Interval (0 – 1440) field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 178

Database Server

Alarm Ack Status - Preserver Ack State when

Return to Normal
The Alarm Ack Status - Preserver Ack State when Return to Normal
option enables you to specify whether to retain or discard the alarms’
acknowledge status in the Alarm Database when it returns to normal.

To specify whether to retain the alarms’ acknowledge status

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Database Server > Alarm Ack Status - Preserver Ack State
when Return to Normal.

The Alarm Ack Status - Preserver Ack State when Return to Normal
window is displayed.

2 Check the Retain alarm’s Ack status when returning to

normal checkbox to keep the alarms’ acknowledge status in the
Alarm Database when the alarms return to normal.

3 Click OK to continue.

Pulse 4.12 User Guide 179

Database Configuration - Enable Network
The Database Configuration - Enable Network option allows you to
enable the network.

To enable the network

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Database Server > Database Configuration - Enable
Network.

The Database Configuration - Enable Network window is displayed.

2 Check the Enable Network checkbox option to enable the

network.

3 Click OK to continue.

Pulse 4.12 User Guide 180

Real Number Precision - Digits after Decimal
Point
The Real Number Precision - Digits after Decimal Point option allows
you to define the precise number of digits after the decimal point in which
the Database Server renders numbers over the DDE to a client application
in text clipboard format.

To define the digits after the decimal point the Database Server
renders numbers over the DDE to a client application

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Database Server > Real Number Precision - Digits after
Decimal Point.

The Real Number Precision - Digits after Decimal Point window is

displayed.

2 Specify the precise number of digits in the Digits after the

decimal point (0 – 6) field. The default value is ‘2’.

3 Click OK to continue.

Pulse 4.12 User Guide 181

Real Number Precision - Number of Digits
The Real Number Precision - Number of Digits option allows you to
define the precise real number of digits in which the Database Server
renders a number over the DDE to a client application in text clipboard
format.

To define the maximum real number of digits the Database Server

renders a number over the DDE to a client application

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Database Server > Real Number Precision - Number of
Digits.

The Real Number Precision - Number of Digits window is displayed.

2 Specify the precise real maximum number of digits in the

Maximum number of digits (3 – 15) field. The default value is
‘8’.

3 Click OK to continue.

Pulse 4.12 User Guide 182

Datasheet Publisher

Operation Mode
The Operation Mode option allows you to select the Datasheet
Publisher’s operation mode.

To select the Datasheet Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Datasheet Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 183

Scan Interval
The Scan Interval option allows you to set the Datasheet Publisher’s
scanning interval.

To set the scanning interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Datasheet Publisher > Scan Interval.

The Scan Interval window is displayed.

2 Enter the scan interval value in the Scan Interval (0 – 20000)

field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 184

Debug

Debug Log - Enable

The Debug Log - Enable option allows you to enable or disable
debugging the system.

NOTE Debugging affects system performance and uses up system

resources in Windows.

To enable/disable system debugging

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Debug
> Debug Log - Enable.

The Debug Log - Enable window is displayed.

2 Select one of the following debugging options from the Enter

Debug logging drop-down list:

• Disable (default)

• Enable File Debug

• Enable On-Line Debug Window

3 Click OK to continue.

Pulse 4.12 User Guide 185

Email

Sent Email - Default 'From' Email Address

The Sent Email - Default 'From' Email Address option allows you to
define the default sender’s (‘From’) email address.

To specify the default sender’s email address

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - Default 'From' Email Address.

The Sent Email - Default 'From' Email Address window is displayed.

2 Specify the default sender’s (‘From’) email address in the eMail

Address field.

3 Click OK to continue.

Pulse 4.12 User Guide 186

Sent Email - Enable SSL
The Sent Email - Enable SSL option allows you to enable or disable SSL
for secured SMTP servers.

To enable SSL for secured SMTP servers

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - Enable SSL.

The Sent Email - Enable SSL window is displayed.

2 Check the Enable SSL checkbox option to enable SSL for secured
SMTP servers. Leave the checkbox unchecked if you prefer to leave
SSL disabled.

3 Click OK to continue.

Pulse 4.12 User Guide 187

Sent Email - SMTP Password
The Sent Email - SMTP Password option allows you to define the
password for the secured SMTP server.

To set the secured SMTP server password

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - SMTP Password.

The Sent Email - SMTP Password window is displayed.

2 Specify the password for the secured SMTP server in the SMTP
Password field.

3 Click OK to continue.

Pulse 4.12 User Guide 188

Sent Email - SMTP Server Name or IP address
The Sent Email - SMTP Server Name or IP address option allows you
to define the SMTP server.

To define the SMTP server

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - SMTP Name or IP address.

The Sent Email - SMTP Name or IP address window is displayed.

2 Specify the SMTP server in the SMTP Password field. The default
value is ‘localhost’.

3 Click OK to continue.

Pulse 4.12 User Guide 189

Sent Email - SMTP Server Port
The Sent Email - SMTP Server Port option allows you to define the
SMTP server’s port number.

To define the SMTP server’s port number

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - SMTP Server Port.

The Sent Email - SMTP Server Port window is displayed.

2 Specify the SMTP server’s port number in the Port (0 – 99999)

field. The default value is ‘25’.

3 Click OK to continue.

Pulse 4.12 User Guide 190

Sent Email - SMTP User Name
The Sent Email - SMTP User Name option allows you to define the user
name of the secured SMTP server.

To define the secured SMTP server’s user name

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Email
> Sent Email - SMTP User Name.

The Sent Email - SMTP User Name window is displayed.

2 Specify the secured SMTP server’s user name in the SMTP User
Name field.

3 Click OK to continue.

Pulse 4.12 User Guide 191

Historical Data

Historical Data - Enable Collection

For more information about Historical Data - Enable Collection,
see Activating the Data Logger.

Historical Data - Find Historical Data on

Alternative Path
The Historical Data - Find Historical Data on Alternative Path option
allows you to define the directory path for archived Historical (.his) files.

To define the directory path for archived Historical (.his) files

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Historical Data > Historical Data - Find Historical Data on
Alternative Path.

The Historical Data - Find Historical Data on Alternative Path

window is displayed.

2 Browse for the path of the archived Historical (.his) files directory
by clicking the button next to the field.

3 Click OK to continue.

Pulse 4.12 User Guide 192

Historical Data over Servers Network - Enable
TCP/IP
The Historical Data over Servers Network - Enable TCP/IP option
enables servers to exchange historical data over TCP/IP. The option to
receive history data over TCP/IP prevents you from setting write sharing
permission for the P-CIM History folder.

To specify servers to exchange historical data over TCP/IP

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Historical Data > Historical Data over Servers Network -
Enable TCP/IP.

The Historical Data over Servers Network - Enable TCP/IP window is

displayed.

2 Check the Receive History Data using TCP/IP checkbox option

to enable servers to exchange historical data over TCP/IP.

3 Click OK to continue.

Pulse 4.12 User Guide 193

Kernel Startup

Startup Modules - Sorted List

The Startup Modules - Sorted List option enables you to add, delete, or
change a list of programs that are started when Pulse starts up. You can
use a unique Program ID and set the startup mode and arguments for
each of the program. You can also edit a program’s name, its arguments,
and its mode.

To add a program to start upon Pulse startup

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Kernel
Startup > Startup Modules - Sorted List.

The Startup Modules - Sorted List window is displayed.

2 Enter the program identifier in the Program ID field.

Pulse 4.12 User Guide 194

3 Specify the Program Name by clicking the corresponding Browse
button to browse for the program.

4 Enter any argument(s), if any.

5 Select one of the modes for the program from the Mode drop-down
list:

• <run as> (default)

• Max

• Min

• Normal

6 Click the Add button.

7 Click Save.

The program is added to the Pulse startup list.

To delete a program from the Pulse startup list

1 In the Startup Modules - Sorted List window, select the program

to delete from the table.

2 Click the Delete selected button.

3 Click Save.

The program is added to the Pulse startup list.

To edit a program from the Pulse startup list

1 In the Startup Modules - Sorted List window, select the program

to edit from the table.

The Change selected button is activated and its details are

displayed under the Program Parameters area.

2 Click the Change selected button.

3 Edit the selected program’s parameter(s) as necessary.

4 Click Save.

The program is edited.

Pulse 4.12 User Guide 195

Startup Modules- Supreme Report
The Startup Modules- Supreme Report option allows you
enable/disable Supreme Report when Pulse starts up.

To enable/disable Supreme Report when Pulse starts up

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Kernel
Startup > Startup Modules- Supreme Report.

The Startup Modules- Supreme Report window is displayed.

2 Select one of the following from the Run Supreme Report project
on startup drop-down list:

• Enabled

• Disabled

3 Click OK to continue.

Pulse 4.12 User Guide 196

Licensing Publisher

Operation Mode
The Operation Mode option allows you to select the Licensing Publisher’s
operation mode.

To select the Licensing Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Licensing Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 197

Scan Interval
The Scan Interval option allows you to set the Licensing Publisher’s
scanning interval.

To set the scanning interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Licensing Publisher > Scan Interval.

The Scan Interval window is displayed.

2 Enter the scan interval value in the Scan Interval (0 – 20000)

field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 198

Simulation Repeat
The Simulation Repeat option allows you to set the Licensing Publisher’s
simulation repeat rate.

To set the simulation repeat rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Licensing Publisher > Simulation Repeat.

The Simulation Repeat window is displayed.

2 Enter the simulation repeat rate in the Simulation Repeat (0 –

99999) field. The default scan interval value is ‘1’.

3 Click OK to continue.

Pulse 4.12 User Guide 199

Simulation Scan Interval
The Simulation Scan Interval option allows you to set the Licensing
Publisher’s simulation scan interval rate.

To set the simulation scan interval rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Licensing Publisher > Simulation Scan Interval.

The Simulation Scan Interval window is displayed.

2 Enter the simulation scan interval rate in the Simulation Scan

Interval (0 – 1440) field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 200

Localization

Localization Configuration - Use Cache

The Localization Configuration - Use Cache option enables/disables
Localization to use the cache.

To enable/disable Localization to use the cache

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Localization > Localization Configuration - Use Cache.

The Localization Configuration - Use Cache window is displayed.

2 Check the Use Cache checkbox option to enable Localization to use

the cache.

When the Use Cache checkbox is unchecked, Localization is unable

to use the cache.

3 Click OK to continue.

Pulse 4.12 User Guide 201

Numbers Format - Enable Kernel Support for
Regional Settings
The Numbers Format - Enable Kernel Support for Regional Settings
option enables/disables the Pulse Kernel to support numbers that are
formatted according to the Windows Regional Settings defined for the
system account.

To enable/disable the Pulse Kernel to support Regional Settings

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Localization > Numbers Format - Enable Kernel Support for
Regional Settings.

The Numbers Format - Enable Kernel Support for Regional Settings

window is displayed.

2 Check the Enable Kernel Support for Regional Settings

checkbox option to enable the Pulse kernel to support the Windows
Regional Settings.

When the Enable Kernel Support for Regional Settings

checkbox is unchecked, the Windows Regional Settings is not
supported by the Pulse kernel.

3 Click OK to continue.

Pulse 4.12 User Guide 202

OPC Adaptor Publisher

OPC Server - Default Communication Test

Attempts
The OPC Server - Default Communication Test Attempts option
allows you to set the numbers of communication attempts.

To set the numbers of communication attempts

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Communication
Test Attempts.

The OPC Server - Default Communication Test Attempts window is

displayed.

2 Specify the OPC server’s default number of communication test

attempts in the Default Communication Attempts (0 – 20000)
field. The default value is ‘3’.

3 Click OK to continue.

Pulse 4.12 User Guide 203

OPC Server - Default Communication Test
Interval
The OPC Server - Default Communication Test Interval option allows
you to set the time interval rate between communication attempts in the
OPC server.

To set the time interval between communication attempts

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Communication
Test Interval.

The OPC Server - Default Communication Test Interval window is

displayed.

2 Specify the OPC server’s default time interval between

communication attempts in the Default Communication
Attempts (0 – 20000) field. The default value is ‘60’.

3 Click OK to continue.

Pulse 4.12 User Guide 204

OPC Server - Default Group Deadband
The OPC Server - Default Group Deadband option allows you to set
the default group deadband in the OPC server.

To set the default group deadband

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Group Deadband.

The OPC Server - Default Group Deadband window is displayed.

2 Specify the OPC server’s default group deadband in the Default

Group Deadband (0 – 20000) field. The default value is ‘0’.

3 Click OK to continue.

Pulse 4.12 User Guide 205

OPC Server - Default Group Name
The OPC Server - Default Group Name option allows you to set the
default group name in the OPC server.

To set the default group name

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Group Name.

The OPC Server - Default Group Name window is displayed.

2 Specify the OPC server’s default group name in the Default Group
Name field. The default value is ‘Root’.

3 Click OK to continue.

Pulse 4.12 User Guide 206

OPC Server - Default Group Time Bias
The OPC Server - Default Group Time Bias option allows you to set the
default group time bias in the OPC server.

To set the default group time bias

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Group Time Bias.

The OPC Server - Default Group Time Bias window is displayed.

2 Specify the OPC server’s default group time bias in the Default
Group Time Bias (0 – 20000) field. The default value is ‘0’.

3 Click OK to continue.

Pulse 4.12 User Guide 207

OPC Server - Default Group Update Rate
The OPC Server - Default Group Update Rate option allows you to set
the default group update rate.

To set the default group update rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Group Update
Rate.

The OPC Server - Default Group Update Rate window is displayed.

2 Specify the OPC server’s default group update rate in the Default
Group Update Rate (0 – 20000) field. The default value is ‘500’.

3 Click OK to continue.

Pulse 4.12 User Guide 208

OPC Server - Default SyncRead Interval
The OPC Server - Default SyncRead Interval option allows you to set
the default synchronous read time interval.

To set the default synchronous read interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default SyncRead Interval.

The OPC Server - Default SyncRead Interval window is displayed.

2 Specify the OPC server’s default synchronous read time interval in

the Default Sync Read Interval (0 – 20000) field. The default
value is ‘1000’.

3 Click OK to continue.

Pulse 4.12 User Guide 209

OPC Server - Default Time between Reconnect
Attempts
The OPC Server - Default Time between Reconnect Attempts option
allows you to set the default time interval between reconnection attempts.

To set the default time interval between reconnection attempts

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > OPC Server - Default Time between
Reconnect Attempts.

The OPC Server - Default Time between Reconnect Attempts

window is displayed.

2 Specify the OPC server’s default time interval between reconnection

attempts in the Default Time between Reconnect Attempts (0
– 20000) field. The default value is ‘60’.

3 Click OK to continue.

Pulse 4.12 User Guide 210

Operation Mode
The Operation Mode option allows you to select the OPC DA Adaptor
Publisher’s operation mode.

To select the OPC DA Adaptor Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > OPC
Adaptor Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 211

Schedule Service

Start/Stop Schedule - Automatic Verification

Interval
The Start/Stop Schedule - Automatic Verification Interval option
allows you to set the automatic verification interval. The automatic
verification interval defines the time interval (in minutes) to activate the
automatic start/stop schedule verification mechanism.

To set the interval for the automatic schedule verification

mechanism

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Schedule Service > Start/Stop Schedule - Automatic
Verification Interval.

The Start/Stop Schedule - Automatic Verification Interval window is

displayed.

2 Specify the interval for the automatic start/stop schedule

verification mechanism in the Automatic Verification Interval
(1 – 999999) field. The default value is ‘60’.

3 Click OK to continue.

Pulse 4.12 User Guide 212

Start/Stop Schedule - Enable Automatic
Verification
The Start/Stop Schedule - Enable Automatic Verification option
allows you to enable the automatic verification mechanism.

To enable the automatic verification mechanism

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Schedule Service > Start/Stop Schedule - Enable Automatic
Verification.

The Start/Stop Schedule - Enable Automatic Verification window is

displayed.

2 Check the Enable Automatic Verification checkbox.

3 Click OK to continue.

Pulse 4.12 User Guide 213

Simulator Publisher

Operation Mode
The Operation Mode option allows you to select the Simulator Publisher’s
operation mode.

To select the Simulator Publisher’s operation mode

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Simulator Publisher > Operation Mode.

The Operation Mode window is displayed.

2 Select one of the following operation modes from the Operation

Mode drop-down list.

• Normal (default)

• Emulation

• Simulation

3 Click OK to continue.

Pulse 4.12 User Guide 214

Simulation Repeat
The Simulation Repeat option allows you to set the Simulator Publisher’s
simulation repeat rate.

To set the simulation repeat rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Simulator Publisher > Simulation Repeat.

The Simulation Repeat window is displayed.

2 Enter the simulation repeat rate in the Simulation Repeat (0 –

99999) field. The default scan interval value is ‘1’.

3 Click OK to continue.

Pulse 4.12 User Guide 215

Simulation Scan Interval
The Simulation Scan Interval option allows you to set the Simulator
Publisher’s simulation scan interval rate.

To set the simulation scan interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Simulator Publisher > Simulation Scan Interval.

The Simulation Scan Interval window is displayed.

2 Enter the simulation scan interval rate in the Simulation Scan

Interval (0 – 1440) field. The default scan interval value is ‘5’.

3 Click OK to continue.

Pulse 4.12 User Guide 216

Simulator Interval
The Simulator Interval option allows you to set the Simulator
Publisher’s simulator interval.

To set the simulator interval

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Simulator Publisher > Simulator Interval.

The Simulator Interval window is displayed.

2 Enter the simulator interval value in the Simulator Interval (0 –

1440) field. The default simulator interval value is ‘100’.

3 Click OK to continue.

Pulse 4.12 User Guide 217

Special Characters

Expression Syntax - Expression Item End

The Expression Syntax - Expression Item End allows you to define the
character for the Expression End character.

To define the character for Expression End character

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Special
Characters > Expression Syntax - Expression Item End.

The Expression Syntax - Expression Item End window is displayed.

2 Specify the character for the Expression Item End in the

Expression End Character field.

3 Click OK to continue.

Pulse 4.12 User Guide 218

Expression Syntax - Expression Item Start
The Expression Syntax - Expression Item Start allows you to define
the character for the Expression Item Start.

To define the character for Expression Item Start

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Special
Characters > Expression Syntax - Expression Item Start.

The Expression Syntax - Expression Item Start window is displayed.

2 Specify the character for the Expression Item Start character in the
Expression Start Character field.

3 Click OK to continue.

Pulse 4.12 User Guide 219

Multiple Actions Syntax - Actions Delimiter
Character
The Multiple Actions Syntax - Actions Delimiter Character allows you
to specify a delimiter character for an Action/Command delimiter.

To specify a delimiter character

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Special
Characters > Multiple Actions Syntax - Actions Delimiter
Character.

The Multiple Actions Syntax - Actions Delimiter Character window is

displayed.

2 Enter the character in the Actions Delimiter Character field, for

example ‘;’.

3 Click OK to continue.

Pulse 4.12 User Guide 220

Text File Server

DBF Links Data - Automatic Refresh

The DBF Links Data - Automatic Refresh option allows you to enable
auto refreshing the links to a DBF file once written to.

To enable DBF auto refresh

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Text
File Server > DBF Links Data - Automatic Refresh.

The DBF Links Data - Automatic Refresh window is displayed.

2 Check the Enable DBF Auto Refresh checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 221

ODBC Links Data - Automatic Refresh
The ODBC Links Data - Automatic Refresh option allows you to enable
auto refreshing the links to an ODBC source once written to.

To enable ODBC auto refresh

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Text
File Server > ODBC Links Data - Automatic Refresh.

The ODBC Links Data - Automatic Refresh window is displayed.

2 Check the Enable ODBC Auto Refresh checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 222

TXT/INI Links Data - Automatic Refresh
The TXT/INI Links Data - Automatic Refresh option allows you to
enable auto refreshing all the links from a TXT/INI file after one file is
written to.

To enable TXT/INI auto refresh

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings > Text
File Server > TXT/INI Links Data - Automatic Refresh.

The TXT/INI Links Data - Automatic Refresh window is displayed.

2 Check the Enable TXT/INI Auto Refresh checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 223

Workstation

Development Mode - Undo Level

The Development Mode - Undo Level option allows you to specify the
number of ‘undo’ operations in the Developer workstation.

To specify the number of ‘undo’ operations

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Development Mode - Undo Level.

The Development Mode - Undo Level window is displayed.

2 Enter the number of ‘undo’ actions in the Undo Level (1 – 20)

field. The default value is ‘30’.

3 Click OK to continue.

Pulse 4.12 User Guide 224

Operating Mode - Hide Statics during Load
The Operating Mode - Hide Statics during Load option allows you to
define the operating mode of Hide Statics when Pulse is loading.

The ‘Hide Statics during Load’ values are:

 0 (default) – Do not hide statics

 1 – Sensitive to visibility animation

 2 - Sensitive to any animation

 3 – Do not hide at all, show all statics and animations when loading

NOTE Save the displays after the setting is changed.

To define the Hide Statics operating mode when loading

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Hide Statics during Load.

The Operating Mode - Hide Statics during Load window is displayed.

2 Enter the Hide Statics operating mode when loading in the Hide
Statics during Load (0 – 3) field. The default value is ‘0’.

3 Click OK to continue.

Pulse 4.12 User Guide 225

Operating Mode - Hover Border Color
The Operating Mode - Hover Border Color option allows you to select
the border color of the object when the mouse hovers over the object.

To specify the border color of the object

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Hover Border Color.

The Operating Mode - Hover Border Color window is displayed.

2 Specify the color of the border by selecting one of the following

colors from the Border Color drop-down list.

• Orange (default)

• Transparent

• Black

• Blue

• Brown

• Cyan

• Gray

• Green

• Indigo

• Magenta

• Olive

Pulse 4.12 User Guide 226

 • Pink

• Purple

• Red

• Silver

• Steel Blue

• Violet

• White

• Yellow

3 Click OK to continue.

Operating Mode - Hover Border Width

The Operating Mode - Hover Border Width option allows you to set the
border width of the object when the mouse hovers over the object.

To set the border width of the object

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Hover Border Width.

The Operating Mode - Hover Border Width window is displayed.

2 Enter the border width of the object in the Border Width (0 – 20)
field. The default value is ‘1’.

3 Click OK to continue.

Pulse 4.12 User Guide 227

Operating Mode - Popup Alarm Explorer on
Alarm
The Operating Mode - Popup Alarm Explorer on Alarm option allows
you to enable displaying an Alarm Explorer pop-up when any new alarm
occurs in the Pulse Operator workstation.

To enable displaying an Alarm Explorer pop-up on any new alarm

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Popup Alarm Explorer on
Alarm.

The Operating Mode - Popup Alarm Explorer on Alarm window is

displayed.

2 Check the Enable pop up of Alarm Explorer on any new Alarm

checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 228

Operating Mode - Prompt Timeout
The Operating Mode - Prompt Timeout option allows you to set the
prompt animation timeout in milliseconds.

To set the prompt animation timeout in milliseconds

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Prompt Timeout.

The Operating Mode - Prompt Timeout window is displayed.

2 Enter the animation timeout for the prompt in milliseconds in the

Prompt Animation Timeout (0 – 60000) field. The default value
is ‘3000’.

3 Click OK to continue.

Pulse 4.12 User Guide 229

Operating Mode - Selected Object Border Color
The Operating Mode - Selected Object Border Color option allows you
to select the color of the border for the selected object.

To select the border color of the selected object

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Selected Object Border
Color.

The Operating Mode - Selected Object Border Color window is

displayed.

2 Specify the color of the border for the selected object by selecting
one of the following colors from the Border Color drop-down list.

• Red (default)

• Transparent

• Black

• Blue

• Brown

• Cyan

• Gray

• Green

• Indigo

• Magenta

• Olive

Pulse 4.12 User Guide 230

 • Orange

• Pink

• Purple

• Silver

• Steel Blue

• Violet

• White

• Yellow

3 Click OK to continue.

Operating Mode - Selected Object Border Width

The Operating Mode - Selected Object Border Width option allows
you to set the border width of the selected object.

To set the border width of the selected object

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Selected Object Border
Width.

The Operating Mode - Selected Object Border Width window is

displayed.

2 Enter the border width of the selected object in the Border Width
(0 – 20) field. The default value is ‘2’.

3 Click OK to continue.

Pulse 4.12 User Guide 231

Operating Mode - Show Item in Text Animation
Prompt
The Operating Mode - Show Item in Text Animation Prompt option
allows you to show a Text Animation item in a Text Animation prompt,
when the prompt is empty.

To show an Item in Text Animation prompt

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Show Item in Text
Animation Prompt.

The Operating Mode - Show Item in Text Animation Prompt window

is displayed.

2 Click to select the Show Item in Text Animation Prompt

checkbox option to show a Text Animation item in a Text Animation
prompt, when the prompt is empty.

3 Click OK to continue.

Pulse 4.12 User Guide 232

Operating Mode – Show Workstation Scrollbars
The Operating Mode - Show Workstation Scrollbars option allows you
to display the workstation scrollbars.

To display the workstation scrollbars

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Show Workstation
Scrollbars.

The Operating Mode - Show Workstation Scrollbars window is

displayed.

2 Click to select the Show Workstation Scrollbars checkbox option

to display the workstation scrollbars.

3 Click OK to continue.

Pulse 4.12 User Guide 233

Operating Mode - Truncate Decimals
The Operating Mode - Truncate Decimals option allows you to truncate
decimal numbers.

To truncate decimal numbers

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode - Truncate Decimals.

The Operating Mode - Truncate Decimals window is displayed.

2 Click to select the Truncate Decimals checkbox option to truncate

decimal numbers.

3 Click OK to continue.

Pulse 4.12 User Guide 234

Operating Mode Visualization - Refresh Rate
The Operating Mode Visualization - Refresh Rate option allows you to
set the Operator workstation’s visualization refresh rate.

To set the Operator workstation’s visualization refresh rate

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Operating Mode Visualization - Refresh Rate.

The Operating Mode Visualization - Refresh Rate window is

displayed.

2 Specify the Operator workstation’s visualization refresh rate in the

Refresh Rate (100 – 3000) field. The default value is ‘150’.

3 Click OK to continue.

Pulse 4.12 User Guide 235

Performance Options - Use Visual Styles on
Windows and Buttons
The Performance Options - Use Visual Styles on Windows and
Buttons option allows you to control the performance of the user’s
operations on graphic controls by enabling the visual styles on Windows
and buttons.

To use visual styles on Windows and buttons

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Performance Options - Use Visual Styles on
Windows and Buttons.

The Performance Options - Use Visual Styles on Windows and

Buttons window is displayed.

2 Select one of the following performance options from the Use

Visual Styles on Windows and Buttons drop-down list.

• Never – to disable visual styles on Windows and buttons

therefore increasing performance

• Always (default) - to enable visual styles on Windows and

buttons

3 Click OK to continue.

Pulse 4.12 User Guide 236

Smart Information - Trend Margin Percent
The Smart Information - Trend Margin Percent option allows you to
calculate the minimum and maximum of the Smart Information Trend
Margin Percent (whole area) according to ± margin (% of the scale).

To calculate the Smart Information Trend Margin Percent

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Smart Information - Trend Margin Percent.

The Smart Information - Trend Margin Percent window is displayed.

2 Specify the Trend Margin percent in the Smart Information Trend

Margin Percent (0 -100) field. The default value is ‘0’.

3 Click OK to continue.

Pulse 4.12 User Guide 237

Startup Mode - Start Automatically as Pulse
Server Starts
The Startup Mode - Start Automatically as Pulse Server Starts
option allows you to run the Pulse workstation on the server side when
the Pulse server starts up.

To run the Pulse workstation on the server side when the Pulse
server starts up

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Startup Mode - Start Automatically as Pulse
Server Starts.

The Startup Mode - Start Automatically as Pulse Server Starts

window is displayed.

2 Click to select the Run Workstation on the server side upon

Pulse Startup checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 238

Working Mode - Use Single Instance
The Working Mode - Use Single Instance option allows you to enable a
single instance when the Developer workstation switches to Runtime in
the same instance.

NOTE When a single interface is enabled, switching to Developer

mode stops the workstation’s Runtime activities.

To enable a single instance

1 In the Project Setup window, click PCIM-Software >

PCIM[x.xx] > Projects > [ProjectName] > Settings >
Workstation > Working Mode - Use Single Instance.

The Working Mode - Use Single Instance window is displayed.

2 Click to select the Enables Single Instance checkbox option.

3 Click OK to continue.

Pulse 4.12 User Guide 239

Configuring the Pulse Remote
Access Security Account
An authorized user is required in order to copy data from remote shared
files for Pulse replication in Pulse redundancy.

To configure the Pulse remote access security account

1 In the Project Setup window, click the Configure Remote

Access Security icon on the toolbar.

The Pulse Remote Access Account Settings dialog box is displayed.

2 Enter the User name and Password for a single specific user that
will have access to the project’s setup.

-or-

Select The system account to restrict access to the server PC’s

Windows Login account.

3 Click OK.

Pulse 4.12 User Guide 240

Configuring the Pulse Server
Address
The Pulse Server Address is required for accessing your Pulse system’s
projects and services.

To configure the Pulse Server address

1 In the Project Setup window, go to the File menu and select

Configure Server Address,

-or-

Click the Configure Server Address icon on the toolbar, or go to

the left pane of the window and right-click the Pulse application
name (PCIM[10.00]) and click Configure Server Address.

The Pulse Server Address Configuration dialog box is displayed.

2 Configure the Server Address parameters as follows:

External Enter the name of the computer, IP address, or

Address URL of the Pulse Server, and its TCP port
connection.

Internal Address Enter the name of the computer or local IP

address of the Pulse Server, and its TCP port
connection.

Apply to all This address configuration is used by all of the

services Pulse application services.

Pulse 4.12 User Guide 241

 Apply to all This address configuration is used by all of
projects your Pulse application’s projects.

Require server When the checkbox is checked, the Pulse Client

verification and Pulse Help URLs are defined with Secure
(https:) Hypertext Transfer Protocol (https) instead of
just Hypertext Transfer Protocol (http).

HTTP Port Specify the http port number of the IIS in the
Http Port text box.

NOTE If you check the Require server

verification (https:) checkbox
option, the Http Port default value,
which is ‘443’, is displayed.

Connecting the Pulse Client to the

Pulse Server
There are instances where the Pulse client cannot connect to the Pulse
server since the External IP address is unavailable.

The local Operator Workstation (the client that is running on the same
network LAN/VLAN as the server) can still be used if the client files are
created on the local hard drive by using the “Deploy to Flash Drive”
feature and given a local path, for more details, see Deploy to Flash Drive.

To access the Pulse application from the World Wide Web, change the
Pulse Server's External IP Address on the Project Setup with an available
IP address and select the Apply to all services and Apply to all
projects options and click the OK button to apply the changes.

Pulse 4.12 User Guide 242

Configuring Project Database
Settings
In the Database Configuration dialog box, set up the configuration of the
primary Pulse database for the collection, display, and storage of alarms
and historical records.

By default, Pulse database definitions are stored in Pulse proprietary SQL

database. However, Pulse supports usage of OLE databases (OLEDB),
which provide increased capabilities in terms of scalability, storage
capacity, search, and querying options, project backup and restores
options and disaster recovery.

To configure the Pulse project database

1 In the Project Setup window’s left pane, right-click the Pulse

project name (i.e., PulseProject) and click Configure Database
Settings.

The Database Configuration dialog box is displayed.

Pulse 4.12 User Guide 243

2 Define the properties, go to all the tabs if necessary to complete
the database configuration.

3 Click OK to save the configuration changes and close the Database

Configuration dialog box.

For explanations about all the properties, click the links below.

• Connections

• Dummy Variables

• Alarms Archive

• Data Logger

• Pulse MSMQ

Connections

Pulse 4.12 User Guide 244

Set Database Configuration OLEDB Connections parameters as follows:

Provider Click this button to display the Data Link

Properties Properties dialog box where you can select an
OLEDB provider as the primary Pulse project
database and set up its configuration on the server
computer. For additional information, refer to the
Window’s Data Link Properties Help.

Connect Timeout Specify the period for attempting connection to the

database, before the attempt times out.

Command Specify the period for attempting to send commands

Timeout to the database, before the attempt times out.

Use selected Data currently in the newly selected OLEDB database

database content will remain in it.

Empty selected All data currently in the newly selected database will
database be deleted. The new database will not contain any
values initially.

Copy and Remove all data in the newly selected OLEDB

overwrite the database and replace with data from the previous
selected Pulse database.
database with
the current
database content

Add current Add the data from the previous Pulse database to
database content the data content of the newly selected OLEDB
to the selected database.
database

Select Default Click to display the Database Default Provider

Provider dialog box where you can select one of the following
as your default database:

 SQL

 Access (MDB)

Pulse 4.12 User Guide 245

Dummy Variables

Dummy variables are general purpose internal variables that can be

referenced instead of real PLC addresses (analog or digital). In the
Dummy Variables tab, you can change the maximum number of dummy
variables that users are permitted to reference (for each type).

For example, ; , and so on

Set the following Dummy Variables values:

 Analog Dummy - By default, up to 1000 analog dummy variables

(A:1, A:2, ... A:1000) are permitted.

 Digital Dummy - For digital dummy variables (D:1, D:2, ...

D:1024), up to 1024 are permitted.

 String Dummy - By default, 10 string dummy variables are

permitted.

 Float Dummy - By default, 100 float dummy variables are

permitted.

 Long Dummy - By default, 100 long dummy variables are

permitted.

Pulse 4.12 User Guide 246

Alarms Archive
In the Alarms Archive tab, configure how the Alarm Explorer manages
the display, alarms archive and system messages.

Set Database Configuration Alarms parameters as follows:

Once a day

Archive alarms Select this option to enable Pulse to archive alarm

older than __ data that has been listed online for the specified
day(s) number of days (between 1 and 99).

Archive alarms at Choose the time of day when to archive the alarm
data.

Pulse 4.12 User Guide 247

Once an hour

Limit records Select this option to limit the number of alarm

number to __ per entries that can appear in the database table.
table

Upon Pulse startup

Immediately Select this option to archive alarms immediately

Archive on next upon Pulse startup.
Pulse startup

Mode

Delete old Select this option to delete alarms when they reach
records the age specified in the Archive Alarms Older
than __ day(s) parameter.

Move old records Select this option to move old recorded alarms to
to CSV files CSV files when the alarms reach the age specified in
the Archive Alarms Older than __ day(s)
parameter.

CSV Settings

Destination Click the button to specify the path where the

folder CSV file is to be located.

Maximum By default, the maximum records per alarm log CSV

records per file is 10000.
Alarm Log CSV
file

Maximum events By default, the maximum events per Events

per Event Management CSV file are 1000.
Management CSV
file

Pulse 4.12 User Guide 248

Data Logger
In the Data Logger tab, configure how the Data Logger should log the
archived historical data.

Connection string

Select Provider Click this button to display the Data Link

Properties dialog box where you can set your
connection properties to the Pulse Data Logger
database. For additional information, refer to the
Window’s Data Link Properties Help.

Archive historical data

Archive history Specify the period the historical data should be

older than __ archived to the database then select whether the
archive period should be in days, months or years
(from the drop-down list).

Pulse 4.12 User Guide 249

Pulse MSMQ
In the Pulse MSMQ tab, configure the storage locations for alarms and
messages on the Microsoft Message Queuing Server (MSMQ).

Set Database Configuration Alarms parameters as follows:

MSMQ Settings

Alarms Temporary storage location for Pulse alarms

System Messages Temporary storage location for system messages

Admin Messages Temporary storage location for administration

messages

Event Temporary storage location for Event Management

Management logs

Pulse 4.12 User Guide 250

Configuring Services Settings
In the Service Settings dialog box, you can change the external and/or
internal address of the services used by your Pulse project’s server.

To configure the Pulse Service location

1 In the Project Setup window’s left pane, right-click the project

name and click Configure Services Settings.

The Service Settings dialog box is displayed.

2 If necessary, change the location of the Pulse services as follows:

External The public IP address, or server name, of the

Address/Port Pulse server.
Internal The private IP address, or server name, of the
Address/Port Pulse server. If the Pulse server is located in a
virtual private network, this address may differ
from the external address.
Active Select to turn the services on.

3 Click Apply to All to apply the configuration to all the services.

Pulse 4.12 User Guide 251

Database Utility
Exporting and Importing the Database
If you prefer to define and edit the block and/or alarm data in a table
format, the Project Setup provides utilities for exporting and importing
block and alarm condition data.

From the Project Setup, you can export the entire Pulse database to TSV
(Tab Separated Value) or MDB (Microsoft Access Database) format, or
export specific block types to TSV. You can then view, edit, or delete
existing data in these files in a table inside an external spreadsheet
program, such as Microsoft Excel, see Opening TSV Files in an External
Program.

Following modifications, you can import the TSV or MDB data back into
Pulse. If other database files were created or edited in an external
program, you can also import them into your Pulse database.

The Project Setup provides the following utilities for exporting and
importing TSV and MDB files:

 Database Utility - In this tool, you can export/import specific

block-type and alarm condition data to/from TSV format, or export
and import the entire Pulse database to/from TSV format.
Additionally, you must use the Database Utility if you want to
prevent modified TSV files from overwriting existing data.

 Export Database - This tool enables you to export the complete

contents of the Pulse database to TSV or MDB format.

 Import Database - This tool enables you to import the complete

contents of the database from TSV or MDB format to Pulse. Note
that you cannot overwrite changes to existing blocks when using
this tool (to overwrite existing blocks, use the Database Utility).

Pulse 4.12 User Guide 252

The TSV files listed below can be created by exporting the entire
database, or separately through the Database Utility, see Exporting
Database Data to TSV Format Using the Database Utility. The resulting
TSV files correspond to the various block types and conditions that can be
created in Pulse’s Database Explorer. These files contain all of the
parameters and configured values:

AV.TSV Analog Value blocks

AV_CONDITIONS.TSV Analog Value block alarm conditions

AP.TSV Analog Pointer blocks

DV.TSV Digital Value blocks

DV_CONDITIONS.TSV Digital Value block alarm conditions

DP.TSV Digital Pointer blocks

CL.TSV Calculation blocks

CL_CONDITIONS.TSV Calculation block alarm conditions

BL.TSV Boolean blocks

BL_CONDITIONS.TSV Boolean block alarm conditions

SP.TSV String Pointer blocks

AL.TSV Alarm blocks

BIT.TSV Alarm bits

BIT_CONDITIONS.TSV Alarm bit alarm conditions

This section includes the following topics:

 Exporting Database Data to TSV Format Using the Database Utility

 Importing Database Data from TSV Format Using Database Utility

 Exporting the Entire Database to TSV or MDB Format

 Importing the Entire Database from TSV or MDB Format

 Exporting TSV Files through the Server AutoActions Manager

 Importing TSV Files through the Server AutoActions Manager

 Opening TSV Files in an External Program

Pulse 4.12 User Guide 253

Exporting Database Data to TSV Format Using
the Database Utility
The Database Utility is a tool that enables you to export and import
Database blocks and alarm conditions data to TSV (Tab Separated Value)
format.

The Database Utility converts the existing project database data into TSV
(Tab Separated Values) format. These files can then be opened in a
spreadsheet program such as Microsoft Excel, where you can modify, add,
and delete data, and create new files. When you are finished, you can
import the TSV files back to your project database, see Importing
Database Data from TSV Format Using Database Utility.

You may export the entire database into TSV files in one step or you can
limit the export only to specific block types and/or alarm condition types.

To export database data to TSV format using Database Utility

1 In the Project Setup toolbar, click the Open Database TSV

Utility... icon.

The Database Utility window is displayed.

2 From the Export menu, choose to export the entire database

(Export Database) or a specific block type (Export AV, Export
AP, and so on).

3 Browse to choose the location to store the exported TSV files (for
example, in a folder under the project’s root folder).

4 Click OK.

Pulse executes the export and generates a log in the Database

Utility.

Pulse 4.12 User Guide 254

Pulse 4.12 User Guide 255
Importing Database Data from TSV Format
Using Database Utility
The Database Utility is a tool that enables you to export and import
Database blocks and alarm conditions data to TSV (Tab Separated Value)
format.

Following creation or modification of TSV files in a spreadsheet program

such as Microsoft Excel, the Database Utility enables you to import the
new or modified TSV files back to your project database.

You may import the entire database in one step or you can limit the
import to specific block types and/or alarm condition types that were
created or edited.

NOTE To import and overwrite existing blocks and alarm conditions,

enable the Overwrite Existing Blocks option. If this option is
not enabled, Pulse does not import the blocks that already
exist in the database, and generates relevant error messages
in the import log (in the Import Database utility, preventing
the overwriting is not available).

To import database data from TSV format using Database Utility

1 In the Project Setup toolbar, click the Open Database Database

Utility icon.

The Database Utility window is displayed.

2 If required, click on the Import menu and turn on Overwrite

Existing Blocks.

3 From the Import menu, choose to import the entire database

(Import Database) or a specific block table type file (Import AV,
Import AP, and so on).

4 Browse to choose the location of the relevant TSV files.

5 Click OK.

Pulse executes the import and generates a log in the Database

Utility.

Pulse 4.12 User Guide 256

Pulse 4.12 User Guide 257
Exporting the Entire Database to TSV or MDB
Format
From the Project Setup, perform one of the following procedures to
export the entire database to TSV or MDB format in a simple procedure.

To export the entire database to TSV format

1 In the Project Setup toolbar, click the Export Database icon and
click Export to TSV Files.

2 Define the name and destination location of the database file.

Browse to select a destination folder and click OK.

Pulse executes the database export. A log file (with .txt extension)
detailing the export is displayed on the screen.

To export the entire database to MDB format

1 In the Project Setup toolbar, click the Export Database icon and
click Export to MDB File (OLEDB).

The Export to MDB database file dialog box is displayed.

2 Type or browse to select the path and filename of the destination

database file and click Export.

The Export operation may take a few minutes. A message notifies

when the process is completed.

Pulse 4.12 User Guide 258

Importing the Entire Database from TSV or
MDB Format
From the Project Setup, perform one of the following procedures to
import the entire database from TSV or MDB format in a simple
procedure. Note that this utility overwrites all previous data in the Pulse
database.

To import the entire database from TSV format

1 In the Project Setup toolbar, click the Export Database icon and
click Import from TSV Files.

2 Browse to select the source folder of the TSV files and click OK.

Pulse executes the database import. A log file (with .txt extension)
detailing the import appears on the screen.

Pulse 4.12 User Guide 259

To import the entire database from MDB format

1 In the Project Setup toolbar, click the Import Database icon and
click Import from MDB File (OLEDB).

The Import from MDB Database File dialog box is displayed.

2 Type or browse to select the path and filename of the source

database file.

To remove all data from the current MDB database before importing
the MDB file, select Empty Current Database.

3 Click Import.

If identical blocks are already in the project database, the import

process does not add or overwrite them. Click Save as File to list
these blocks in a plain text file.

The Import operation may take a few minutes. A message notifies

when the process finishes.

Pulse 4.12 User Guide 260

Opening TSV Files in an External Program
You can then view, edit, or delete a TSV file’s data in an external
spreadsheet program, such as Microsoft Excel. For descriptions of the
various parameters, refer to the respective block’s or condition’s topic
section in this User Guide or see Defining Blocks in the Database Explorer.

To work with the TSV file in a spreadsheet program

1 Open the TSV file in a spreadsheet program (such as Excel). The

following figure shows a sample DV.TSV file in Excel.

2 Make any required changes or additions or deletions, then save and

close the file.

You can now import the TSV file data back into your Pulse
database.

Pulse 4.12 User Guide 261

Backing Up and Restoring Projects
You can create and configure a project backup and restore through the
Backup or Restore Wizard or run it through a command line.

Backing up Projects
You can back up a project that can be restored later on the host Server or
on any other PC. Use the backup and restore operations to:

 Protect against losing data in a damaged project or files.

 Store stages of a product during development.

 Transfer the project to another computer.

You can back up all the components of a project, or only specific folders.
Additionally, you can change the backup/restore configuration in the
Backup or Restore Wizard or through a command line and save the
settings for future backups.

NOTE Make sure there is sufficient disk space on the computer's hard
drive before backing up the project.

To back up a project through the Backup or Restore Wizard

1 Make sure all Pulse applications are shut down.

2 Go to the Start menu and select AFCON Pulse > Tools > Backup
or Restore Wizard.

The Pulse Project Backup or Restore Wizard is displayed.

Pulse 4.12 User Guide 262

3 Select Backup Pulse Project and click Next.

4 Select a project and click Next.

Pulse 4.12 User Guide 263

5 Provide the full path of the backup location in the Type in the full
path of the backup file field.

6 Provide the name of the backup file in the Backup file name field.

7 Select one of the volume size for the backup media:

• AutoDetect (default)

• 1,475,664 – 3.5” – for 3.5” floppy disks

• 98,078k – ZIP-100 – for zipped files

• 650m – CD-650M – for 650M CDROMs

• 700m – CD-700M – for 700M CDROMs

• 4.7GB – DVD-4.7GB – for 4.7 BG DVDs

• Custom – Provide the file’s volume size and select the unit
of the file size (MB or GB ) from the drop-down list.

8 Check the Password Protected checkbox option in order to

restrict access to the backup file otherwise leave the checkbox
empty.

Pulse 4.12 User Guide 264

 If you select the Password Protected checkbox option,
provide a password in the Enter Password field and reenter
the same password in the Confirm Password field.

9 Click Next.

The Custom Backup Settings window is displayed.

Pulse 4.12 User Guide 265

10 Check the Backup all nodes checkbox option to back up all the
nodes

or

Select only specific nodes from the Backup all nodes drop-down
list and leave the checkbox unchecked to backup only the nodes
you consider essential to preserve.

11 Click Next to continue.

The Ready to Backup window is displayed.

Pulse 4.12 User Guide 266

12 Check that the backup configuration settings are correct. To save
this configuration for reuse, click to select the Save Backup
Settings checkbox option and specify a Name and Description for
the “backup settings” file. Then, click Backup.

Pulse 4.12 User Guide 267

13 Monitor the progress of the backup until the process is completed.
Select Report All from the Report list at the bottom of the page to
generate a report on the complete backup operation or select
Report Errors to generate an error report.

14 Click Next.

The Finish Project Backup or Restore Wizard window is displayed.

15 To back up another project or restore one, click Backup or

Restore another Project.

To restart the Pulse server when you close the wizard, click to
select the Start Pulse Server checkbox option.

Click Close to exit the Pulse Project Backup or Restore Wizard

window.

Pulse 4.12 User Guide 268

Backing Up a Project Using a Command Line
To back up a project using a command line

You can also backup a project through a command line with the following
arguments:

[drive name]:\AFCON\Pulse\Afcon.Pcim.Project.
BackupRestoreWizard.exe -B:{BackupSettingsName}
[O] [H]

This option backups a project according to the settings and saves a result
report to the backup folder (e.g., C:\AFCON\pulse.bak\projectname\yyyy-
mm-dd\BackupRestoreReport.htm).

The following are the supported parameters:

 -B:{BackupSettingsName} - runs the backup process according

to the Project Backup Settings Name

 [-O] - overrides the last backup file (optional parameter)

 [-H] - hides the backup progress (optional parameter)

The Backup and Restore command line arguments that the user can
perform are listed below.

Example:

 C:\AFCON\Pulse\Afcon.Pcim.Project.BackupRestoreWizard.
exe -B:bkup1

This command runs the backup process according to the Project

Backup Settings Name

 C:\AFCON\Pulse\Afcon.Pcim.Project.BackupRestoreWizard.
exe -B:bkup1 –H

This command runs the backup process according to the Project

Backup Settings Name and hides the backup progress.

 C:\AFCON\Pulse\Afcon.Pcim.Project.BackupRestoreWizard.
exe -B:bkup1 -H -O

This command runs the backup process according to the Project

Backup Settings Name, hides the backup progress, and overrides
the last backup file.

Pulse 4.12 User Guide 269

Creating Custom Backup Project
To create a custom backup project through the Backup or Restore
Wizard

1 Make sure all Pulse applications are shut down.

2 In the AFCON Pulse Program Group, select Tools > Backup or

Restore Wizard.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Backup Pulse Project and click Next.

The Backup a Pulse Project window is displayed.

4 Select a project and click Next.

The Select the Backup File Path window is displayed.

5 Provide the full path of the backup location in the Type in the full
path of the backup file field.

6 Provide the name of the backup file in the Backup file name field.

7 Select one of the volume size for the backup media:

• AutoDetect (default)

• 1,475,664 – 3.5” – for 3.5” floppy disks

• 98,078k – ZIP-100 – for zipped files

• 650m – CD-650M – for 650M CDROMs

• 700m – CD-700M – for 700M CDROMs

• 4.7GB – DVD-4.7GB – for 4.7 BG DVDs

• Custom – Provide the file’s volume size and select the unit
of the file size (MB or GB ) from the drop-down list.

8 Check the Password Protected checkbox option in order to

restrict access to the backup file otherwise leave the checkbox
empty.

If you select the Password Protected checkbox option, provide a

password in the Enter Password field and reenter the same
password in the Confirm Password field.

Pulse 4.12 User Guide 270

9 Click Next.

The Custom Backup Settings window is displayed.

10 Check the Backup all nodes checkbox option to back up all the
nodes

or

Select only specific nodes from the Backup all nodes drop-down
list and leave the checkbox unchecked to backup only the nodes
you consider essential to preserve.

11 Click the Include/Exclude button to specify which files and folders

you want to backup.

The Include/Exclude Rule Editor window is displayed.

Pulse 4.12 User Guide 271

12 Define the Custom Backup project by including/excluding the
backup rules.

• To include rules, click on Include Rule and select one of the

following:

 Add Files... - displays the Open window where you

can select the files to include in the backup settings.

 Add Folder... - displays the Browse for Folder

window where you can select the folders to include in
the backup settings.

 Add DSN... - displays the Data Source Selection

dialog box where you can select the Data Source Name
to include in the backup settings from the drop-down
list.

Pulse 4.12 User Guide 272

  Add Extension... - displays the Enter Extension
dialog box where you can enter a single extension to
include in the backup settings (i.e., exe, doc, txt, etc.).
Check the Include sub-folders checkbox option if
you have to include the sub-folder(s) of the extension
you provided to include in the backup settings and
click OK to continue.

• To exclude rules, click on Exclude Rule and select one of the

following:

 Add Files... - displays the Open window where you

can select the files to exclude in the backup settings.

 Add Folder... - displays the Browse for Folder

window where you can select the folders to exclude in
the backup settings.

 Add Extension... - displays the Enter Extension

dialog box where you can enter a single extension to
exclude in the backup settings (i.e., exe, doc, txt,
etc.). Check the Include sub-folders checkbox option
if you have to exclude the sub-folder(s) of the
extension you provided to exclude in the backup
settings and click OK to continue.

• To remove a rule, click on Remove Rule; the Delete rule

message window is displayed. Click OK to delete the rule.

Pulse 4.12 User Guide 273

13 In the Custom Backup Settings window click Next to continue.

The Ready to Backup Settings window is displayed.

14 Check that the backup configuration settings are correct. To save

this configuration for reuse, select Save Backup Settings and
specify a Name and Description for the “backup settings” file.

15 Click Backup to start the custom backup.

Project Backup Settings

To use a defined custom backup:

1 Make sure all Pulse applications are shut down.

2 In the AFCON Pulse Program Group, select Tools > Backup or

Restore Wizard.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Backup Pulse Project and click Next.

The Backup a Pulse Project window is displayed.

4 Click on the Select the project backup settings option and select
a project backup settings from the drop-down list.

Pulse 4.12 User Guide 274

5 Click Next.

The Select the Backup file path window is displayed.

Pulse 4.12 User Guide 275

6 Provide the full path of the backup location in the Type in the full
path of the backup file field.

7 Provide the name of the backup file in the Backup file name field.

8 Select one of the volume size for the backup media:

• AutoDetect (default)

• 1,475,664 – 3.5” – for 3.5” floppy disks

• 98,078k – ZIP-100 – for zipped files

• 650m – CD-650M – for 650M CDROMs

• 700m – CD-700M – for 700M CDROMs

• 4.7GB – DVD-4.7GB – for 4.7 BG DVDs

• Custom – Provide the file’s volume size and select the unit
of the file size (MB or GB ) from the drop-down list.

9 Check the Password Protected checkbox option in order to

restrict access to the backup file otherwise leave the checkbox
empty.

If you select the Password Protected checkbox option, provide a

password in the Enter Password field and reenter the same
password in the Confirm Password field.

10 Click Next.

The Custom Backup Settings window is displayed.

11 Check the Backup all nodes checkbox option to back up all the
nodes

or

Select only specific nodes from the Backup all nodes drop-down
list and leave the checkbox unchecked to backup only the nodes
you consider essential to preserve.

12 Click Next to continue.

The Ready to Backup window is displayed.

Pulse 4.12 User Guide 276

13 Check that the backup configuration settings are correct. To save
this configuration for reuse, click to select the Save Backup
Settings checkbox option and specify a Name and Description for
the “backup settings” file. Then, click Backup.

Pulse 4.12 User Guide 277

14 Monitor the progress of the backup until the process is completed.
Select Report All from the Report list at the bottom of the page to
generate a report on the complete backup operation or select
Report Errors to generate an error report.

15 Click Next.

The Finish Project Backup or Restore Wizard window is displayed.

16 To back up another project or restore one, click Backup or

Restore another Project.

To restart the Pulse server when you close the wizard, click to
select the Start Pulse Server checkbox option.

Click Close to exit the Pulse Project Backup or Restore Wizard

window.

Pulse 4.12 User Guide 278

Restoring a Project
You can create and configure and run project restore in the Backup or
Restore Wizard.

You can restore a backed up project via the following options:

 Update existing folder – This option allows you to restore a

project with the same name on the target system (the default).
This is the normal way to recover a project from its backup. In
addition, you might use this option to update one computer with
changes made to the project on another.

 Replace existing folder – This option allows you to restore a

project but all the previous files are deleted before the restoration
process.

 Restore as new project – This option allows you to restore a

project as a new project on the target system. This is the normal
way to load a project for the first time from the computer on which
it was developed to the computer where it will run.

In addition, you might use this option to update one computer with
changes made to the project on another - first bring the other
version to the same computer as a new project, then reconcile the
differences manually.

NOTE Make sure there is sufficient disk space on the computer's hard
drive before backing up the project.

Pulse 4.12 User Guide 279

Restoring a Project by Updating an Existing
Folder
You can restore a project with the same name on the target system by
selecting the Update existing folder option. This is the default method
of recovering a project from its backup. This option replaces the existing
folder by deleting and replacing only files in the current folder that have
the same name in the backed up project and adds all other files in the
backed up file. A file in the current folder remains if it does not have an
identically named counterpart in the backed up project. In addition, you
might use this option to update one computer with changes made to the
project on another.

To restore a project using the “Update existing folder” option

1 Make sure all Pulse applications are shut down.

2 In the AFCON Pulse program group, select Tools > Backup or

Restore Wizard.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Restore Pulse Project and click Next.

Pulse 4.12 User Guide 280

 The Select the Backup File to Restore window is displayed.

4 Specify the full path of the backup file and the backup file itself
(*.pbf) to restore.

5 Type a password, if required.

6 Click Next.

The Restore a Pulse Project window is displayed.

Pulse 4.12 User Guide 281

7 Select the Update existing folder option.

In this option, the files in the existing folder having the same name
as the files in the folder you are restoring will be replaced.

8 Click Next.

The Custom Restore Settings window is displayed.

Pulse 4.12 User Guide 282

9 Scroll down to the Alarm Database category type. Validate the
restored connection string by clicking the Alarm Database path
button.

The Data Link Properties window - Connection tab is displayed

where you can validate the restored connection string.

10 If required, change the locations for the restored project files by

changing them in the Path column, or keep the currently
configured locations.

Pulse 4.12 User Guide 283

11 To retain the project’s security configuration, select Restore
Security Policies.

12 Click Next to continue.

A confirmation message is displayed.

13 Select one of the following options to update the existing folder:

• Add backed up database content to the selected

database

This option adds the block properties of the new database

into the selected database.

• Skip selected database content overwrite

This option skips and ignores data from the backed up

project and just assigns the new connection string to the
selected database.

14 Click Yes to continue.

The Ready to Restore window is displayed.

Pulse 4.12 User Guide 284

15 Check that the restore configuration settings are correct. Click
Restore.

The Restore Progress window is displayed.

Pulse 4.12 User Guide 285

16 Monitor the restore progress until the process is complete.

17 Select Report All from the Report list at the bottom of the page to
generate a report on the complete backup operation or select
Report Errors to generate an error report.

18 Click Next.

The Finish Project Backup or Restore Wizard window is displayed.

19 To restore another project or back up one, click Backup or

Restore another Project.

To set the restored project as the default project, select Set as

Default Project.

To restart the Pulse server when you close the wizard, select Start
Pulse Server.

20 Click Finish to exit the Pulse Project Backup or Restore

Wizard.

Pulse 4.12 User Guide 286

Replacing an Existing Folder
You can restore a project by replacing an existing folder. This restore
option deletes ALL files in the current folder before restoring files from the
backed up project.

To restore a project using the “Replace an existing folder” option

1 Make sure all Pulse applications are shut down.

2 In the AFCON Pulse program group, select Tools > Backup or

Restore Wizard.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Restore Pulse Project and click Next.

The Select the Backup File to Restore window is displayed.

Pulse 4.12 User Guide 287

4 Specify the full path of the backup file and the backup file itself
(*.pbf) to restore.

5 Type a password, if required.

6 Click Next.

The Restore a Pulse Project window is displayed.

Pulse 4.12 User Guide 288

7 Select the Replace existing folder option.

In this option, all the files are going to be deleted before the file
restoration process starts.

8 Click Next.

The Custom Restore Settings window is displayed.

Pulse 4.12 User Guide 289

9 Scroll down to the Alarm Database category type. Validate the
restored connection string by clicking the Alarm Database path
button.

The Data Link Properties window - Connection tab is displayed

where you can validate the restored connection string.

10 If required, change the locations for the restored project files by

changing them in the Path column, or keep the currently
configured locations.

Pulse 4.12 User Guide 290

11 To retain the project’s security configuration, select Restore
Security Policies.

12 Click Next to continue.

A confirmation message is displayed.

13 Select one of the following option to update the existing folder:

• Add backed up database content to the selected

database

This option adds the block properties of the new database

into the selected database.

• Overwrites the selected database with the backed up

database content

This option deletes all existing tables and recreates the tables
with the backed up data.

14 Click Yes to continue.

The Ready to Restore window is displayed.

Pulse 4.12 User Guide 291

15 Check that the restore configuration settings are correct. Click
Restore.

The Restore Progress window is displayed.

Pulse 4.12 User Guide 292

16 Monitor the restore progress until the process is complete.

17 Select Report All from the Report list at the bottom of the page to
generate a report on the complete backup operation or select
Report Errors to generate an error report.

18 Click Next.

The Finish Project Backup or Restore Wizard window is displayed.

19 To restore another project or back up one, click Backup or

Restore another Project.

To set the restored project as the default project, select Set as

Default Project.

To restart the Pulse server when you close the wizard, select Start
Pulse Server.

20 Click Finish to exit the Pulse Project Backup or Restore

Wizard.

Pulse 4.12 User Guide 293

Restoring as a New Project
You can restore a project as a new project. The Restore as New Project
Name option restores the selected project as a completely new project
with a new name in a target location (which you will specify later in the
wizard).

To restore a project as a new project

1 Make sure all Pulse applications are shut down.

2 In the AFCON Pulse program group, select Tools > Backup or

Restore Wizard.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Restore Pulse Project and click Next.

The Select the Backup File to Restore window is displayed.

Pulse 4.12 User Guide 294

4 Specify the full path of the backup file and the backup file itself
(*.pbf) to restore.

5 Type a password, if required.

6 Click Next.

The Restore a Pulse Project window is displayed.

Pulse 4.12 User Guide 295

7 Select the Restore as new project option.

In this option, the backup project file is going to be restored as a

new project.

8 Click Next.

The Custom Restore Settings window is displayed.

Pulse 4.12 User Guide 296

9 Scroll down to the Alarm Database category type. Validate the
restored connection string by clicking the Alarm Database path
button.

The Data Link Properties window - Connection tab is displayed

where you can validate the restored connection string.

10 If required, change the locations for the restored project files by

changing them in the Path column, or keep the currently
configured locations.

Pulse 4.12 User Guide 297

11 To retain the project’s security configuration, select Restore
Security Policies.

12 Click Next to continue.

The Ready to Restore window is displayed.

13 Check that the restore configuration settings are correct. Click

Restore.

The Restore Progress window is displayed.

Pulse 4.12 User Guide 298

14 Monitor the restore progress until the process is complete.

15 Select Report All from the Report list at the bottom of the page to
generate a report on the complete backup operation or select
Report Errors to generate an error report.

16 Click Next.

The Finish Project Backup or Restore Wizard window is displayed.

Pulse 4.12 User Guide 299

17 To restore another project or back up one, click Backup or
Restore another Project.

To set the restored project as the default project, select Set as

Default Project.

To restart the Pulse server when you close the wizard, select Start
Pulse Server.

18 Click Finish to exit the Pulse Project Backup or Restore

Wizard.

Pulse 4.12 User Guide 300

Saving Pulse Project Data
Pulse provides several ways to save project work area files, such as
displays, templates, cells, and smart cells:

 Save the work area in which you are working (active display,
template, cell or smart cell), whether it is new or if it previously
existed.

 Save a copy of the active work area with a different name (for
example, creating a new display) or in a different location.

 Save all open displays, templates, cells, or smart cells at the same
time.

 Save the active display as a template, in which you can store

elements for reuse when necessary. You can use templates as
starting points, and they include all objects/cells on the display’s
work area and their properties, as well as any themes, styles,
layers, and other elements which have been configured in that
display. When you save as a template, the active display becomes
an open template which you can continue editing.

 Export displays, templates and cells from Pulse to an external

graphical program for editing and import them back in to Pulse
when done.

Pulse 4.12 User Guide 301

Saving a Display/Cell in the Project
The following procedures describe how to save displays, templates, and
cells.

To save a new display/cell

1 With a previously unsaved display or cell open, enter the File

ribbon, click the Save down arrow, and then click Save As.

The Save as Displays/Cells dialog box is displayed.

2 Enter a name for the display/cell and click OK, making it part of the
project.

To save a display/template/cell/smart cell as you work

Use the technique you are most comfortable with:

 In the File ribbon, click Save.

-or-
In the work area, right-click and choose Save.
-or-
In the Graphics panel, right-click the Display/Cell name, click Save
and then click Save in the submenu.
-or-
Press <CTRL>+<S> on the keyboard

Pulse 4.12 User Guide 302

To save all open displays/cells

 In the File ribbon, click the Save down arrow and then click All.

Opening and Saving Templates

A template is a starting point for building displays in the Developer
Workstation. When you open or start a template, a “blank” display opens
in the workstation. However, it can contain some pre-configured elements
such as graphic objects, database blocks, workflows, and so on.

To create a template

1 In the Graphics panel, enter the Templates tab.

2 In the File ribbon, click New.

A display template opens in the workstation work area.

3 In the File ribbon, click the Save down arrow and then click Save
As.

4 Enter a name for the template and click OK.

Pulse 4.12 User Guide 303

Exporting Project Data
You can export displays, templates, and cells from Pulse to an external
graphical program for editing and import them back in to Pulse when
done.

To export the active display/template/cell

1 In the File ribbon, click Export.

The Save As dialog box is displayed.

2 Enter a filename and choose the location to export the file. The
exported file has a one of the following extensions:

• Display file - DSFX

• Template file - DSTFX

• Cell file - CELX

3 Click Save.

To export a different display/template/cell /smart cells than the

active one

1 In the File ribbon, click the Export arrow and select Export... .

The Export All Views dialog box is displayed.

2 Select the files to export from the list. The dialog box’s Status bar
shows the number of files you selected.

Pulse 4.12 User Guide 304

3 Click OK.

The Save As dialog box is displayed.

4 Enter filenames for all the files you want to save and choose the
location to export them. The exported files have the following
extensions:

• Display file - DSFX

• Template file - DSTFX

• Cell file - CELX

5 Click Save.

To export all the saved files in the system

 In the File ribbon, click the Export arrow and select All.

Deleting Old Alarms from the Project Setup

Activate the Purge All Alarm on Pulse Startup switch from Project
Setup to delete alarms. The switch is not activated by default.

To purge all alarms on Pulse startup:

1 Go to the Project Setup window by clicking Start > Programs >

AFCON Pulse > Pulse Setup > Project.

2 In the Project Setup window access the path PCIM-Software >

PCIM[10.xx] > Projects > PulseProject > Settings > Alarms
and double-click Purging Alarms - Purge All Alarms on Pulse
Startup.

Pulse 4.12 User Guide 305

 The Purge Alarms - Purge All Alarms on Pulse Startup window is
displayed.

3 Click to select the Purge All Alarms on Pulse Startup checkbox

option and click OK.

The Value changes to ‘1’ (true).

4 Restart Pulse.

The switch is activated on startup.

5 Go back to Project Setup and access the PCIM-Software >

PCIM[10.xx] > Projects > PulseProject > Settings > Alarms
and click Purging Alarms - Purge All Alarms on Pulse Startup
path.

The Purge Alarms - Purge All Alarms on Pulse Startup window is

displayed.

6 Unselect the Purge All Alarms on Pulse Startup checkbox option

and click OK.

The Value changes to ‘0’ (false).

Pulse 4.12 User Guide 306

Project Migration
In Pulse, you can work in projects that were created and stored in any
version from P-CIM 7.70 SP4. The migration process includes the
following topics:

 Migrating a P-CIM 7.70 SP4 Project to a Pulse Project

 The Project Migration Wizard

Important Notes
 If your P-CIM project includes dBASE (dbf) data, perform the
following steps before starting to back up the project in P-CIM.

• Make sure that the following files are located in the P-CIM
project’s Dailylog folder (if not, copy and paste them there):

ALARMDAT.DBF, ALARMDAT.MDX, ALARMMAP.DBF,

ALARMMAP.MDX, ALARMCMD.DBF (in some cases),
pfwaldef.ini

• In the pfwaldef.ini file, go to the [AlarmWinDBF] section’s

DbfCollectionPathName parameter and remove the path
value (you can do this in the INI File Editor).

 Cells from P-CIM do not retain their cell definitions after the
migration. Instead, the cell’s objects are converted independently
with their individual properties.

 Graphic text objects from P-CIM do not retain their Background

properties after the migration.

 Graphic path objects may become misshaped during the migration.

 Migrated projects and display names may not be larger than eight
characters. When migrating a P-CIM 7.70 project to Pulse, the
project name and the display names cannot be longer than eight
characters. After the project has been restored to Pulse format, you
can assign or modify project and display names with more than
eight characters.

 P-CIM Cell is not migrated to Pulse as a single unit.

Cells from P-CIM do not retain their cell definitions after the
migration to Pulse. Instead, the cell’s objects are converted
independently with their individual properties.

Pulse 4.12 User Guide 307

 To migrate from P-CIM to Pulse on 64 bit operating systems, see
Migrating a P-CIM Application to Pulse on 64 bit Operating Systems.

 The drivers used in the project should be updated to the latest

available version after migrating from P-CIM to Pulse.
After migrating from P-CIM to Pulse, it is highly recommended to
update the drivers used in the project.

Check for the latest available version of the drivers from the AFCON
DVD or from the AFCON website.

Migrating a P-CIM 7.70 SP4 Project

to a Pulse Project
Before starting the migration process, you must back up the P-CIM
project.

1 With P-CIM running, open the P-CIM Setup and click Backup
Project.

2 Select the project and the target backup folder and then click
Create Backup.

3 After completing the backup operation, shut down P-CIM.

4 From the AFCON Pulse group menu, point to Pulse Setup and then
click Project. After the Project Setup is displayed, close the window
(this changes the active AFCON application on the computer to
Pulse).

5 To restore the backed up file to Pulse, browse to the backup folder

created in step 2 and click setup.exe.

6 The following message states the P-CIM product source version

7.70 SP4 and the Pulse product target version (8.00 and higher).
Click Yes to continue.

Pulse 4.12 User Guide 308

7 A message may ask if you want to set the restored project as the
default project in Pulse. If you do, click Yes. Otherwise, click No.

8 If the project already exists in the Pulse target version, select

whether to replace the existing project or to restore the project as a
new one in Pulse.

The restore process finishes.

9 Now, continue the Migration process by running the Migration

Wizard, see The Project Migration Wizard.

Migrating a P-CIM Application to

Pulse on 64 bit Operating Systems
A migration failure occurs when a P-CIM application migrates to Pulse on
64 bit operating systems.

To migrate a P-CIM application to Pulse on 64 bit operating

systems

1 First migrate the P-CIM application on a 32 bit operating system.

2 Backup the project in Pulse.

3 Restore the project in Pulse on a 64 bit operating system.

Pulse 4.12 User Guide 309

The Project Migration Wizard
The Project Migration Wizard guides you through the process of migrating
a P-CIM v7.70 SP4 project into a Pulse project.

NOTE A project that was saved in Pulse format cannot be opened in

P-CIM.

To migrate a P-CIM project to Pulse format

1 In the AFCON Pulse Program Group’s Tools folder, double-click

the Project Migration Wizard icon to open the Project
Migration Wizard.

NOTE At any time, click Migrate to start the migration process at

that point, without further configuration.

2 Click Next to start configuring the migration.

3 To preserve the project’s P-CIM files, save the backed up project

before performing the conversion to Pulse. Enter a location to save
the backed-up files. If you select No, the Migration utility creates
project files in Pulse format but discards the backed-up P-CIM files.
Click Next to continue.

Pulse 4.12 User Guide 310

4 Select displays and configuration items to remain in the project as
it migrates. By default, all items are selected. Click Next to
continue.

Pulse 4.12 User Guide 311

5 Review the summary of the pending migration process. To change
something, click Previous to return to previous pages. Click
Migrate to continue.

The Wizard displays the progress of the migration.

When the migration is complete, a report appears in the Wizard.

The report shows if the items converted successfully into a Pulse
project, and if errors occurred.

Pulse 4.12 User Guide 312

6 Perform the following options, if your migration process requires.
Then, click Finish to close the Pulse Project Migration Wizard.

Start All During the migration process, some of the

Services Pulse services started, but not all of them.
Select this option to start the rest of all Pulse
services and start the Pulse Server
automatically.

If you do not select this option (default), you

must start the Pulse Server using the AFCON
Pulse Startup command.

Export to HTML Generate the Migration report to HTML format,

which enables you to view and print it from a
browser such as Internet Explorer.

Pulse 4.12 User Guide 313

Project Migration Error and
Warning Codes
The following table lists the migration error codes with their descriptions.

Table 1: Error Codes

Description Error
Code

The ActiveX property element [SymbolName] is missing its -1

properties.

The ActiveX property element [SymbolName] has an -2

exception message.

LoadAlarmClassActionData exception message -3

UpdateAlarmClassDBTable exception message -4

ConvertCommandsToWorkflows exception message -5

ConvertActionToWorkflow exception message -6

The display conversion StartUpAction failed. -7

The display conversion ShutdownAction failed. -8

DisplayConverter.Convert exception message -9

An exception message about the conversion of Trend groups -10

to resource failure

An exception message about the Trend Group parsing failure -11

An exception message about the conversion of Trend group -12

display failure

An exception message about the conversion of the group file -13

[filePath] to the resource key [keyName] value [groupValue]
failure

An exception message about the conversion failure of display -14

groups

An exception message about the failure to create the default -15

resource for a display

Pulse 4.12 User Guide 314

Description Error
Code

The list box item has the wrong number of parameters -16

ConvertToSelectionBox exception message -17

CreateSelectionBoxDisplay exception message -18

The conversion of the workstation startup action failed. -19

The conversion of the workstation shutDownAction failed. -20

The conversion of the workstation idleAction failed. -21

The duplicate AutoAction [keyName] was removed. -22

WorkStationTriggerConverter.Convert exception message -23

ActiveX could not be loaded. -24

The TrendPropertyConverter failed to save the curve file. -25

The TrendPropertyConverter has an invalid TrendPen P-CIM -26

item.

The TrendPropertyConverter has an invalid AxisX P-CIM -27

item.

The Element [ElementName] ‘@’ contains ‘\’ in the -28

expression or in aliases. A parsing failure is possible.
Use ‘\\’ or GetAlias() to overcome the error.

The DBFTagConvertor.ConvertDataSheetTag ElementName -29

failed to create a new DBF user DSN.

The DBFTagConvertor.ConvertDataSheetTag ElementName -30

has an invalid topic format or an invalid number of
parameters.

The DBFTagConvertor.ConvertDataSheetTag ElementName -31

has a query range with invalid DBF range functions.

The DBFTagConvertor.ConvertDataSheetTag ElementName -32

failed to create a new DBF user DSN.

The DBFTagConvertor.ConvertDataSheetTag ElementName -33

failed to save the new Datasheet Tag item.

DBFTagConvertor.ConvertDataSheetTag ElementName -34

[ElementName] exception message

Pulse 4.12 User Guide 315

Description Error
Code

The INITagConvertor.ConvertDataSheetTag ElementName -35

has an invalid topic format or an invalid number of
parameters.

The INITagConvertor.ConvertDataSheetTag ElementName -36

failed to save the new Datasheet Tag item.

The ODBCTagConvertor.ConvertDataSheetTag ElementName -37

has an invalid topic format or an invalid number of
parameters.

The ODBCTagConvertor.ConvertDataSheetTag ElementName -38

has an external SQL query file not in INI format that cannot
be converted.

The ODBCTagConvertor.ConvertDataSheetTag ElementName -39

failed to save the new Datasheet Tag item.

ODBCTagConvertor.ConvertDataSheetTag ElementName -40

[ElementName] exception message

The TXTTagConvertor.ConvertDataSheetTag ElementName -41

has an invalid topic format or an invalid number of
parameters.

The TXTTagConvertor.ConvertDataSheetTag ElementName -42

failed to save the new Datasheet Tag item.

TXTTagConvertor.ConvertDataSheetTag ElementName -43

[ElementName] exception message

The Save action failed. The user did not allow overriding the -44
existing display on the server.

The server is not running. The migration process was -45

aborted.

The Save operation failed; the operation was cancelled by -46

the user.

The Save operation failed; reading the UPD file failed. -47

DisplayMigration.ConvertDisplay exception message -48

The Save [saveResult] ToString() failed. -49

Converting of {0} failed [result] exception message -50

Pulse 4.12 User Guide 316

Description Error
Code

AddExtendedPropertyToElement [type.Name] exception -51

message

Invalid UPD file -52

OldDisplay.Parse exception message -53

ReadAnimation exception message -54

The conversion from [oldDisplayVersion] version to Version -55

7.5 timeout [messOut] expired.

The conversion of the display in compact mode to Version -56

7.5 failed with code.

The conversion from [oldDisplayVersion] version to Version -57

7.5 failed with code.

The [Environment.NewLine] allFile files could not be moved. -58

The database conversion process failed. -59

The Pulse services failed to start. The migration process -60

cannot be initialized.

The alarm class actions in the database failed to migrate. -61

The conversion of alarm conditions to workflows failed. -62

MigrationEngineProccess exception message -62

The ActiveX [ObjName] static properties were not converted. -63

The DBFTagConvertor.ConvertDataSheetTag ElementName - -64

{0} DBF file path is invalid.

An AlarmConverter.ConvertAlarm ElementName -65

[ElementName] exception message

UpdateProjectLocalization exception message -66

The DBFTagConvertor.ConvertDataSheetTag ElementName -67

[ElementName] query range has invalid DBF range functions.

Pulse 4.12 User Guide 317

The following table lists the migration warning codes with their
descriptions.

Table 2: Warning Codes

Description Warning
Code

The object [oldObject.GetName] contains both slider and 1

position animations. The definitions of the Slider and/or
Position offsets may need manual corrections.

The object named [objectName] Flip or Rotate properties will 2

not be migrated properly.

The object named [objectName] Flip properties will not be 3

migrated properly.

The INITagConvertor.ConvertDataSheetTag ElementName - 4

{0} dynamic parameters ({1}) were added to
DisplayOpenAction.

The DisplayMigration.ConvertDisplay old display name 5

[displayName] will be converted to [newDisplayName].

The Color Animation Digital Alarm Property of the Object 6

[newObjectName] was converted to a Digital value.
For the Color Animation Alarm type, the item must be a
Database Block.

The AlarmConverter.ConvertAlarm ElementName 7

[ElementName] has an invalid item format.

The display [newDisplay.DisplayName] with a ‘Single Border’ 8

frame type is migrated to Border Style ‘None’.

The display [newDisplay.DisplayName] with frame type 9

‘Double Border’ is migrated to Border Style ‘None’.

The TrendPropertyConverter [trend.GetType().ToString()] 10

[trendProperty.SymbolName] has an invalid BatchProperty
P-CIM item.

The Group composite cannot be in a negative location and 11

be larger than the display.

xxx was renamed due to an illegal or duplicate name. 12

Pulse 4.12 User Guide 318

Description Warning
Code

The AlarmConverter.ConvertAlarm ElementName 13

[ElementName] could not find the new branch index by old
branch levels.

The ODBCTagConvertor.ConvertDataSheetTag ElementName 14

[ElementName] dynamic parameters [dynamicActions] were
added to DisplayOpenAction.

P-CIM AutoActions were converted to Server AutoActions. Go 15

to the Server AutoActions Manager and go to Operator
Personalization AutoAction and remove irrelevant actions.

The Object [symbolID] with line ends might need slight 16

repositioning.

The TXTTagConvertor.ConvertDataSheetTag ElementName 17

[ElementName] dynamic parameters [dynamicActions] were
added to DisplayOpenAction.

The element with Symbol ID [ElementName] Login Null Null 18

was converted to Login null null.

The element with Symbol ID [ElementName] ‘@’ with the 19

internal path C:\PCIM32 was converted to alias
‘&PcimPath&’. Verify that the complete path is correct.

The background color of the label named '{0}' was lost 20

during conversion.

The Path object [newPath.Name] might need a slight 21

repositioning.

The Pie object [newPie.Name] might need a slight 22

repositioning.

The Extended properties Height Slider property will override 23

the Height Position property.

The EndDot line cap type is not supported by the Pulse 24

graphical engine and will be converted to RoundAnchor.

The EndOpenDelta line cap type is not supported by the 25

Pulse graphical engine and will be converted to
SquareAnchor.

The EndDelta line cap type is not supported by the Pulse 26

graphical engine and will be converted to SquareAnchor.

Pulse 4.12 User Guide 319

Description Warning
Code

The EndTick line cap type is not supported by the Pulse 27

graphical engine and will be converted to SquareAnchor.

The Cell {0} definitions were removed. The Cell content was 28
saved and embedded in a display as objects.

The DBFTagConvertor.ConvertDataSheetTag element name 29

[ElementName] dynamic parameters [dynamicActions] were
added to DisplayOpenAction.

The EndArrowStop line cap type is not supported by the 30

Pulse graphical engine and will be converted to
ArrowAnchor.

The EndSquareDot line cap type is not supported by the 31

Pulse graphical engine and will be converted to
SquareAnchor.

The EndSquare line cap type is not supported by the Pulse 32

graphical engine and will be converted to SquareAnchor.

The [oldObject.GetName] object contains both slider and 33

position animations. The definitions of the Slider and/or
Position offsets may need manual corrections.

The element with Symbol ID [ElementName] |!$login was 34

converted to GDisplay|Pcim!Username.

The Advised item Gdisplay|Pcim!RecipeBusy is dismissed. 35

The Advised item Gdisplay|Pcim!ToolBar and the Pulse 36

Action toolbar [toolbar-name] are not supported.

The Advised item Gdisplay|Pcim!StatusF4 is not supported. 37

The Advised item Gdisplay|Pcim!ReportBusy is dismissed. 38

The Extended properties WidthSliderProperty will override 39

the WidthPositionProperty.

The object [oldObject.GetName] Orientation Animation pivot 40

location cannot be properly migrated and it requires manual
correction.

Pulse 4.12 User Guide 320

The Pulse Server
The Pulse Server handles the data exchange between Pulse client
workstations and data sources such as PLCs and controllers. The Server
executes its functions through various services, publishers, and program
modules. For a complete description of the Server and its functions,
see Pulse Server.

Pulse Server Group Modules

Server side interactive modules are accessible from the Windows Desktop
Start menu, via the following menus:

 AFCON Pulse (main menu)

 Administrative Tools

 Development

 Pulse Setup

 Runtime

 Tools

Icon Module Name Description

Main AFCON Pulse Group

Launch Opens the Pulse web portal, from where

Workstation users can access a workstation

Pulse Help Opens the Pulse Help utility

Restart This module restarts Pulse.

Server Use this module to manage both local

Manager and remote Pulse servers, manage
users’ accounts, project configuration
and more.

Pulse 4.12 User Guide 321

Icon Module Name Description

Shutdown This module stops Pulse and its running

services.

Startup This module starts Pulse and the

applicable services.

Uninstall Pulse Use this module to uninstall Pulse.

Administrative Tools

Deploy to Flash A utility used to download the Pulse

Disk application to a USB Flash drive.

HASP Install A utility used to install the HASP

protection key driver.

HASP Remove A utility used to uninstall the HASP

protection key driver.

Registration Use this utility to register your copy of

and License Pulse.

Security Use this program to set and manage the

Manager Pulse security policy.

Development

Datasheet Tags The Datasheet Tags Manager provides

Manager facilities to obtain and/or modify data
from a variety of external data sources
(XML, OLEDB, TEXT, etc.). Use this
program to add or edit Datasheet tags
from these data files.

Email Use this module to define the message

Dispatcher format for automatically sending email
Configuration messages containing information about
alarms according to predefined
definitions.

Pulse 4.12 User Guide 322

Icon Module Name Description

INI File Editor Use this utility to edit Windows INI-type

files.

Maintenance Use this module to measure and record

Manager the activity-related information of the
Configurator monitored devices or areas.

OPC Browser The OPC Browser is used for

bidirectional communications between a
Pulse project and an OPC server. It can
also be used to check communications
and to check an item’s value.

OPC Gateway The OPC Gateway module provides data

Editor exchange between OPC clients and the
Pulse OPC server. Use this utility to add,
edit, and delete OPC Gateway tags.

Progate Editor ProGate (Protocol Gateway) is a

gateway protocol that enables data
exchange between PLCs and other
devices according to triggered events
and user-defined filtering conditions.
Use this utility to configure and set up
the various Progate settings.

Redundancy This module defines the system’s hot

Editor backup system, which runs during
network and/or computer failures.

Report Editor Use this program to create and edit

templates of plain text (TXT) reports
and dBASE (DBF) files.

Supreme Use this program to design the

Report Studio templates and layouts for the reports
that the Supreme Report Runtime
module later generates.

Pulse Setup

Communication Use this program to install, configure,

and uninstall Pulse communication
drivers.

Pulse 4.12 User Guide 323

Icon Module Name Description

Network Use this module to set up the

connections between the Pulse Server
nodes in the network.

Project Use the Project Configuration to setup

and configure the Pulse projects
settings.

Runtime

Alarm Handler This module displays system and alarm

messages. It has two windows: Current
Alarm and Alarm Summary.

Email Use this module to define the message

Dispatcher format for automatically sending email
messages containing information about
alarms according to predefined
definitions.

Maintenance This module acts as a follow-up

Manager database for the plant’s equipment.

OPC Gateway This module provides data exchange

between OPC clients and the Pulse OPC
server. The OPC Gateway receives data
from Pulse OPC server, and then using
OPC protocol, translates the data and
sends it to the OPC client, which then
sends it to an external device.

Tools

Audit Trail This utility displays changes that were

Viewer made to various modules, as well as
actions done by Pulse users.

Backup or Run this wizard to back up and restore

Restore Wizard Pulse projects.

DRC Settings The Pulse DRC configuration wizard is

Wizard used for Disaster Recovery Control
(DRC). The wizard helps you configure
the DRC of Pulse servers.

Pulse 4.12 User Guide 324

Icon Module Name Description

E-mail Sender Use this module to send email

messages.

FTP Utility Use this utility to transfer files between

the Pulse web Client and the Pulse web
server.

History This wizard utility helps you configure

Migration DRC settings of Pulse servers.
Wizard

History Viewer This module displays history files in list

format. The History Viewer can also
convert history files into CSV format.
These files can be opened and modified
in Microsoft Excel.

Log Window Use this utility to view the Pulse log

files.

OPC Browser The OPC Browser is used for

bidirectional communications between a
Pulse project and an OPC server. It can
also be used to check communications
and to check an item’s value.

Project Run this wizard to convert an existing

Migration P-CIM 7.70 project into a Pulse project.
Wizard

Report A The Pulse Project Report a Problem

Problem wizard enables the user to report a
problem. The wizard then collects and
packages the Pulse project log files.

Supreme Run this program to produce graphically

Report rich, analytical, and secure reports from
Generator real-time data and collected historical
data.

UAG Migration Run this tool to back up projects by

Wizard saving a copy of the project in its
current version.

Pulse 4.12 User Guide 325

Pulse Server Development
Modules
The Pulse Server Group in the Windows Desktop Program menu contains
commands for running the various development modules and editors:

Pulse 4.12 User Guide 326

This section includes the following topics:

 The Datasheet Publisher

 The Email Dispatcher

 INI File Editor

 The Maintenance Manager

 The ProGate Editor

 Pulse OPC Gateway

 OPC Browser

 Pulse Redundancy

 The Report Data Editor

 SER (Sequence of Events Recorder)

Pulse 4.12 User Guide 327

The Datasheet Publisher
The Datasheet module maintains a list of Datasheet Tags (DST). DST is a
unique name the user assigns to a data source. The data source can be
one of the following types:

 INI

 Text

 ODBC DSN

 OLEDB

 XML

The Datasheet Publisher provides the user with facilities to obtain and/or
modify data from a variety of data sources available to the Pulse server.
The Pulse Datasheet Manager is used to add new data sheet tags while
the Datasheet Instrument is the client-side tool used to by the operator to
view, read, and write to tags.

The Datasheet Publisher can be operated in one of the following modes,

set by the value of the Operation Mode configuration switch:

Normal The Datasheet Publisher responds to user's requests.

Emulation The Datasheet Publisher responds to user's requests

with pre-determined values received from various
sources.

Simulation The Datasheet Publisher activates a preset scenario

of the user's actions. The simulation uses an XML
simulation file found in the Database folder.

Use the simulation mode to test-run a series of

actions in the lab and not in the field.

Additionally, the simulation mode enables you to

record a set of actions and replay them at will.

The data sources are selected by the user from a list of available data
sources connected to the Pulse server. The Pulse DST list is stored in XML
format in DST files in the project's directory under the Database folder.
Files are code-generated and can only be viewed by the Datasheet
Manager.

Pulse 4.12 User Guide 328

The Datasheet Publisher receives requests for reading, subscribing or
writing (provided the data source is marked with read/write access rights)
data from/to any data sources.

This section includes the following topics:

 Adding/Editing Datasheet Tags

 Adding/Editing an OLEDB DataSheet Tag

 Adding/Editing an XML DataSheet Tag

 Adding/Editing an ODBC Datasheet Tag

 Adding/Editing an INI Datasheet Tag

 Adding/Editing a TEXT Datasheet Tag

 Setting the Datasheet Tag Properties

Adding/Editing Datasheet Tags

In the Datasheet Tags Manager Wizard, you can add new database tags
and edit existing ones. The Wizard displays all currently configured tags
and their properties, including name, type, access rights, data type, and
description.

Pulse 4.12 User Guide 329

To add, edit, or delete a Datasheet Tag

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Datasheets Tag Manager icon to open the
Datasheet Tag Manager Wizard.

2 Do one of the following and then click Next:

Add a DataSheet Select this option to add a new tag.

Tag

Edit a DataSheet Select a tag entry in the list and then select
Tag this option to modify the selected tag.

Delete Tag Select a tag entry in the list and then click this
button to delete the tag from the database.
Click Yes to confirm.

• If you are adding a tag, you have to choose a data source

type. Proceed to step 3.

• If you are editing a tag, jump to step 4.

3 Select the tag data source type and click Next.

The data source contains the information that will be displayed in

the Data Sheet instrument.

Pulse 4.12 User Guide 330

4 Define or modify the tag according to the data source you selected.

• OLEDB

• XML

• ODBC

• INI

• Text

5 When you reach the end of the Wizard, it will inform you if the tag
is successfully saved.

• To exit the Data Sheet Manager, click Finish.

• To return and modify the data sheet tag before saving it,
click Previous.

• To add another data sheet tag, click Add DataSheet Tag.

Pulse 4.12 User Guide 331

Adding/Editing an OLEDB DataSheet Tag
The Datasheet Manager reads data from and saves data to an OLE
database. The procedure below describes how to define an OLEDB
programmed SQL query in a datasheet tag.

To define an OLEDB tag

1 If you chose to add/edit an OLEDB tag, the Add/Edit an OLEDB

DataSheet Tag page is displayed in the Wizard.

2 Define the tag’s properties as follows:

Connection A string that specifies how to connect to ODBC

String data. Click New Connection or Edit
Connection to add or modify this string (in
the Windows Data Link Properties Wizard).
Select the OLEDB database source from the
Provider tab and set the connection settings
in the Connection tab. This information is
provider-specific. For more information, see
the Data Link Properties Help.
Connection Specify the time to wait while trying to
Timeout establish a connection to OLEDB data before
stopping the attempt and sending an error
message.

Pulse 4.12 User Guide 332

 Command Specify the time to wait before stopping an
Timeout attempt to execute a command and sending an
error message.

3 Click Next.

The Edit an SQL Query page is displayed in the Wizard.

4 Enter a query string (or keep the one displayed) or click Query
Builder to create and/or edit one. This query is saved with this
OLEDB datasheet tag configuration. Click Next.

5 In the Set the Data Sheet Tag Properties page, define the rest
of the tag’s configuration, see Setting the Datasheet Tag Properties.

6 Click Next to finish and save the new datasheet tag.

Pulse 4.12 User Guide 333

Adding/Editing an XML DataSheet Tag
The Datasheet Manager collects data from and writes data to an XML file.
The procedure below describes how to define an XML file tag in a
datasheet tag.

To define an XML tag

1 If you chose to add/edit an XML tag, the Add/Edit an XML

DataSheet Tag page is displayed in the Wizard.

2 Enter the path and name of the XML source file.

The file's hierarchy appears in the XML Tree pane.

3 To filter the data for retrieval, specify filter attributes in the Filter
By section then click Next.

4 In the Set the Data Sheet Tag Properties page, define the rest
of the tag’s configuration, see Setting the Datasheet Tag Properties.

5 Click Next to finish and save the new datasheet tag.

Pulse 4.12 User Guide 334

Adding/Editing an ODBC Datasheet Tag
The Datasheet Manager reads data (such as DBF format data) from and
writes data to an OLE database. The procedure below describes how to
define an ODBC connection in a datasheet tag.

To define an ODBC tag

1 If you chose to add/edit an ODBC tag, the Add/Edit an ODBC

DataSheet Tag page is displayed in the wizard.

2 Define the tag’s properties as follows:

Select DSN Data Enter the name of the ODBC DSN data
Connection connection. To create a new one, click New
DSN to create a new ODBC data source
(Access, SQL server and more) in the Windows
Create New Data Source Wizard.

User Name Type the user name required to log into the
ODBC database.

Password Type the password required to log into the

ODBC database.

Pulse 4.12 User Guide 335

 Connection Specify the time to wait while trying to
Timeout establish a connection to ODBC data before
stopping the attempt and sending an error
message.

Command Specify the time to wait before stopping an

Timeout attempt to execute a command and sending an
error message.

3 Click Next.

The Edit an SQL Query page is displayed in the Wizard.

4 Enter a query string (or keep the one displayed) or click Query
Builder to create and/or edit one. This query is saved with this
ODBC datasheet tag configuration. Click Next.

5 In the Set the Data Sheet Tag Properties page, define the rest
of the tag’s configuration, see Setting the Datasheet Tag Properties.

6 Click Next to finish and save the new datasheet tag.

Pulse 4.12 User Guide 336

Adding/Editing an INI Datasheet Tag
The Datasheet Manager reads and writes data (including Section and
Token) from/to an INI file. The procedure below describes how to refer to
a specific value from a project INI file in a datasheet tag.

To define an INI Datasheet tag

1 If you chose to add/edit an INI tag, the Add/Edit an INI

Datasheet Tag page is displayed in the Wizard.

2 Enter the path and name of the INI data source file. The contents of
the selected INI file are displayed in the three windows below.

3 Specify the Section, Token and Default Value (if applicable) to

be retrieved.

4 In the Set the Data Sheet Tag Properties page, define the rest
of the tag’s configuration, see Setting the Datasheet Tag Properties.

5 Click Next to finish and save the new datasheet tag.

Pulse 4.12 User Guide 337

Adding/Editing a TEXT Datasheet Tag
The Datasheet Manager collects data from and writes data to a TEXT file.
The procedure below describes how to access text file data in a datasheet
tag.

To define a TEXT DataSheet tag

1 If you chose to add/edit an INI tag, the Add/Edit a Text

DataSheet Tag page is displayed in the Wizard.

2 Enter the path and name of the text data source file.

3 Specify the row, column, and length of the text object to retrieve.
Click Preview to see how the string looks like.

4 Select the write mode to define the text object’s orientation (Left or
Right Justified, Padded or not Padded).

5 In the Set the Data Sheet Tag Properties page, define the rest
of the tag’s configuration, see Setting the Datasheet Tag Properties.

6 Click Next to finish and save the new datasheet tag.

Pulse 4.12 User Guide 338

Setting the Datasheet Tag Properties
In the Set the Datasheet Tag Properties page, define the last part of
the tag’s configuration.

1 Define the properties as follows:

Tag Access Select whether the datasheet tag has read-

Rights only or read/ write permission.

Tag Data Type Choose the tag type (OLEDB, XML, ODBC,
INI, Text).

Tag Description Type an optional description of the tag and its

use or function.

Tag Name Type a name for the tag.

Save as New Select this option to create a new tag using the
Tag defined parameters.

2 Click Next when finished.

The tag is saved.

Pulse 4.12 User Guide 339

The Email Dispatcher
Alarm-enabled blocks can be configured to dispatch regularly-scheduled
email messages that contain a summary of the alarms that were
generated during specific intervals.

This feature requires a Database block to be Alarm Enabled (the Enable

Alarms option in the Alarm Tab is selected – and the Email option for
Alarm Actions, Acknowledgements, and/or Return to Normal, must be
selected.

When an alarm occurs, an alarm message is written to the system

variable $DispatchAlarm. The alarm message is comprised of the following
fields:

Node# The node number of the Pulse client station

originating the alarm

Date The date of the alarm formatted using the Windows

regional setting

Time The time of the alarm formatted using the Windows

regional setting

Tag-Name The name of the Pulse database block

Alarm-Type Type of alarm (HIGH, LOW, ROC, etc.)

Tag-Value EGU The value of the block causing the alarm followed by
the EGU notation as specified in the block.

Tag-Description The description of the block as specified in the

database.

Each message is buffered in an ODBC database table. From this database,

the alarm data is retrieved and formatted and subsequently dispatched as
email.

Pulse provides the Email Dispatcher-Configurator for configuring recipient

and message parameters, formatting the alarm data, and for scheduling
the time intervals for dispatch.

After the message, format, and schedules are configured and the
database block is enabled (Enable Alarms) for dispatch – by enabling one
or both of the Pager options – at every Send Rate period, the Email
Dispatcher retrieves the alarm data, formats the email message, and
sends it to the target recipient(s). No further user input is required.

Pulse 4.12 User Guide 340

Perform the following steps to set up your Pulse system to send
alarm notifications by email

1 Enable alarms and notifications in the Database blocks

configurations.

2 Configure the ODBC Data Source.

3 Configure the Email Dispatcher configuration (i.e., Send Rate,

recipients, scheduling, message format, etc.).

This section contains the following topics:

 Enabling Alarms

 Configuring the ODBC Data Source for Email

 Defining the Email Dispatcher Configuration

Enabling Alarms
For every database block that is to generate alarms for transmission, you
need to set its configuration for sending the alarm data to the ODBC
buffer.

To enable alarm generation for a database block

1 In the Developer Workstation Database tree, enter the block’s

alarm configuration, see Defining Blocks in the Database Explorer.

2 In the Alarms tab, select Enable Alarms.

3 Create an Alarm Condition or enter an existing Alarm Condition.

4 Select the Email option for Active, Acknowledge, and/or Return to

Normal conditions.

5 Click Save.

Pulse 4.12 User Guide 341

Configuring the ODBC Data Source for Email
The ODBC data source is the destination database format in which the
ODBC Server converts the data (*.mdb and SQL). The file location must
also be defined in the data source definition.

To define an ODBC data source

1 From the Windows Start menu, open Control Panel >

Administrative Tools > Data Sources ODBC.

2 Enter the System DSN tab and click Add.

The Create New Data Source dialog box is displayed.

3 Select the driver (for MS Access, select Microsoft Access Driver

[*.mdb]; for SQL select SQL Server, etc.). Click Finish.

4 Click Configure. In the ODBC Microsoft Access Setup dialog

box, click Create.

5 In the New Database dialog box, specify a name and path for the
data source.

6 Click OK.

The new data source appears in the ODBC main window. This is the
data source which you will choose later in the Email Dispatcher
Queue Preferences, see Queue Preferences.

Pulse 4.12 User Guide 342

Defining the Email Dispatcher Configuration
Pulse supports sending Email messages to both Microsoft Outlook and
Microsoft Outlook Express. You need to set the default mail application in
the Email Sender configuration (accessible from the Pulse Tools folder).

To define the Email Dispatcher configuration

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Email Dispatcher icon.

The Email Dispatcher Configurator is displayed.

2 Define the configuration parameters according to your needs and

specifications. The Email Dispatcher configuration includes the
following tabs of parameters:

• Queue Preferences

• Email Scheduler

• Message Settings

3 At any time while editing the configuration, click Save.

4 Click Close to close the dialog box.

Pulse 4.12 User Guide 343

Queue Preferences
The Queue Preferences tab contains parameters that define frequency,
intervals, and format of the messages.

OBDC Data The data source is the destination database format

Source in which the ODBC Server will convert the data (i.e.,
*.dbf, *.mdb, SQL, etc.). The file location must also
be defined in the data source definition.

Dispatcher Settings

Send Rate The frequency of handling a new alarm.

Max Retries The maximum number of sending retries to carry out

if an attempt to send an alarm on time fails.

Time Out The maximum time (in milliseconds) to wait for an

alarm sending operation to finish.

Time Out The time (in milliseconds) to pause before the next
Interval sending retry.

Pulse 4.12 User Guide 344

Sender Settings

Max Retries The number of retries that Email-Sender carries out

if an attempt to send an alarm on time fails

Wait Before Exit The time that Email-Sender waits before it exits, in
order to complete the sending process.

Message Format

The following parameters are applicable to users who receive email

notifications to a mobile phone.

Reverse Text Select to enable use of right-to-left or bi-directional

languages (such as Hebrew, Arabic, Chinese, etc.).

Break the text Select to enable long text strings to appear in

into rows multiple rows.

Characters per Specify the maximum number of text characters to

row fit into each row.

Pulse 4.12 User Guide 345

Email Scheduler
By default all recipients receive email at all times. In the Email
Scheduler tab, designate time periods for ceasing e-mail notifications for
each recipient.

To add a recipient

1 In the upper text box, enter a recipient’s email address to choose

the recipient (or group) from the computer’s default address book.

2 Click Add; the recipient appears in the lower list box. When at least
one entry is in the list, the Mute Settings table appears.

3 In the Mute Settings table, select days and specify times in which
email notifications will NOT be sent to the recipient.

4 Repeat the procedure for as many recipients as necessary.

Pulse 4.12 User Guide 346

To change a recipient’s schedule settings

1 In the lower list box, select the recipient; the entry appears in the
upper text box.

2 In the Mute Settings table, select and deselect days and/or

change times accordingly.

To change a recipient’s email address

1 In the lower list box, select the recipient; the entry appears in the
upper text box.

2 In the upper text box, change the email address as required.

3 Click Change; the modified recipient address appears in the lower

list box.

To remove a recipient

1 In the lower list box, select the recipient.

The entry appears in the upper text box.

2 Click Delete.

The recipient disappears from the schedule list.

Pulse 4.12 User Guide 347

Message Settings
In the Message Settings tab, configure a customized message format for
each recipient. The Message Sample displays the order that information
appears in the alarm message.

Compose the customized message format as follows:

Names List of recipients. Choose the recipient for which the

customized settings will apply.

Available Parameters in the Message box will appear in the

Field/Message alarm message. Parameters in the Available Field
are not included in the message.

Select a parameter and click the Add/Remove

button to define the message format.

Select a parameter and click Move Up or Move

Down button to change the order of the fields in the
message format. Click Reset to revert to the default
order.

Pulse 4.12 User Guide 348

Message Options

Importance Set an urgency level for the message: select Low,

Normal, or High importance from the drop-down
list.

Profile Enter the profile that handles the mail services. If

this field is blank, the E-Mail Dispatcher calls the
default profile.

Read receipt Select to send a notification when the recipient

request opens the email notification.

Delivery receipt Select to send a notification when the email

request notification arrives at the recipient’s address.

Message Format

The following parameters are applicable to users who receive email

notifications to a mobile phone.

Reverse Text Select to enable use of right-to-left or bi-directional

languages (such as Hebrew, Arabic, Chinese, etc.).

Break the text Select to enable long text strings to appear in

into rows multiple rows.

Characters per Specify the maximum number of text characters to

row fit into each row.

Pulse 4.12 User Guide 349

INI File Editor
Pulse initialization (INI) files contain information that defines your Pulse
environment. Pulse applications use the information stored in these files
to configure themselves to meet your needs and preferences. There are
several Pulse initialization files, respectively described in the following
topics.

You can edit INI files either by opening the file in a text editor (such as
Windows Notepad), or by using the INI File Editor utility supplied by Pulse.
For most changes, it is recommended to use the INI File Editor because it
reduces the chances of making a costly error.

CAUTION Always back up the current INI file before you make changes
so that you can restore the original file in case you accidentally
damage the INI file or make changes that cause problems
when running Pulse. It is recommended that you do not
change any settings that are not described in Pulse
documentation or help, or clearly marked "DO NOT CHANGE".

Be careful when using a text editor to edit an INI file. Incorrect

changes to INI files can cause unexpected results when you
run Pulse. Do not use a formatting editor (such as Microsoft
Word) to edit the INI file, which may corrupt the INI file and
make it unusable.

INI File Structure

The INI-type file contains several sections, each of which consists of a
group of related settings. The sections and settings are listed in the INI
file in the following format:

[section name]

token_name=value

In this example, [section name] is the name of a section. The enclosing

brackets ([ ]) are required, and the left bracket must be in the leftmost
column.

The token_name=value statement defines the value of each setting. A

token_name is the name of a setting. It can consist of any combination of
up to 32 letters and digits in uppercase or lowercase, and it must be
followed immediately by an equal sign (=). Token names are not case
sensitive. Each token name is (and must be) unique in the section. The
value can be an integer, a string, or a quoted string, depending on the
setting.

Pulse 4.12 User Guide 350

Each row is terminated by CR-LF (carriage return - line feed) (evident in a
Text Editor).

NOTE You can include comments in initialization files, by placing a

semicolon (;) at the beginning of the comment line.

To open the INI File Editor

1 In the AFCON Pulse Program Group’s Development folder,

double-click the INI File Editor icon.

The INI File Editor is displayed.

2 Use the INI File Editor as follows:

Top button Displays the path and name of the currently

open file. Click this button to open a different
INI file.
Section Choose this section to edit, delete, or enter the
name of a section you want to add.
Add section If you entered the name of a new section in
the Section field, click this button.

Pulse 4.12 User Guide 351

 Delete section Click to delete the section selected in the
Section field.

Token Enter or edit the currently selected token

(parameter) that requires editing, as selected
in the Settings field.

String The value of the current token; enter or edit

the string to change the value.

Settings Displays the tokens and strings in the current

section, in alphabetical order. Choose the
tokens you wish to edit from this list.

Add Adds the current Token-string pair as a new

setting

Delete Deletes the current token-string pair from the

INI file

Change If you changed the token name or string value,

click this button to implement the change.

Sort Select this option to sort the settings in

alphabetical order (especially if you changed
the token name).
NOTE Use this option with caution, depending
on whether the file in question is a standard
INI file, or a file that has the INI-type internal
structure but is not necessarily used as an
initialization file:
 The order of settings in a section of a
standard INI file is not important, so
that you may or may not sort at will.
 The order of settings in a section of an
INI-type file may be important, so that
you are advised not to sort.

Copy Choose to copy the currently selected token

name to the Clipboard. This is useful for
inserting an alias.

Save Save the changes made to the currently open

INI file.

Close Close the INI File Editor. If any changes were

made, a message asks you whether or not to
save the data change.

Help Click to access Pulse INI File Editor help

details.

Pulse 4.12 User Guide 352

The Maintenance Manager
Use the Maintenance Manager to measure and record the activity-
related information of equipment on the plant floor. Each device is
assigned a Maintenance Tag (MT), consisting of up to three, previously
defined database blocks. Values are recorded when the equipment is On,
Off or in a state of malfunction (indicating that it requires servicing).
Based on a user-defined interval, Pulse polls the equipment for values and
writes data into a standard database file (DBF, MDB, and SQL).

The Maintenance Manager collects and analyzes data concerning the

day-to-day operation of the monitored equipment. For each monitored
piece of equipment you assign a Maintenance Tag containing up to three
indicators. The first two indicators show the working status of the
equipment and the third indicator functions as an alarm status indicator.

Combined, these indicators provide you with a detailed picture of the

status of each piece of equipment. Information collected by the
Maintenance Manager is stored in a database and may be used in several
ways, such as:

 View it in the Maintenance Viewer

 Present the data to the user visually through the Operator

Workstation during Pulse runtime

 Export it to third-party software, such as Microsoft Excel, Access, or

SQL server.

Alarm Condition Rules

An alarm condition is identified by the Maintenance Manager based on
pre-defined rules. If a state matching any of the below-mentioned rules
occurs, the Maintenance Manager recognizes the state as an alarm. The
scenarios described below present the four possible cases, which based
upon the data received, constitute an alarm condition:

Pulse 4.12 User Guide 353

Active Duration (DUR_ON) Scenarios
Scenario No. Scenario

1  Operation Indicator (Blocks) 1 or 2 - OK and

ON_SCAN

 Alarm Indicator (Block) ON_SCAN and NO

alarm status identified

2  Operation Indicator (Block) 1 or 2 - OK and

ON_SCAN

 Alarm Indicator (Block) ON_SCAN and

indicates alarm and the Handling Alarm
Situation option is checked

Alarm Duration (DUR_ALM) Scenarios

Scenario No. Scenario

1  Operation Indicator (Blocks) 1 or 2 ON_SCAN.

 Alarm Indicator (Block) ON_SCAN and alarm
state identified.

2  Operation Indicator (Blocks) 1 or 2

OFF_SCAN.
 Alarm Indicator (Blocks) OFF_SCAN and
Handling Offscan Situation option is checked.

The terms DUR_ON and DUR_ALARM refer to the two states the
Maintenance Manager uses to recognize and catalogs data. DUR_ON
(duration on) is the time period the equipment is in use. DUR_ALM
indicates the period of time when an alarm state, or alarm condition, was
identified and recognized by the program.

ON_SCAN The indicator (block) is frequently scanned for

changes.

OFF_SCAN The indicator (block) is not scanned.

OK The indicator's (block) status is based on the last

scanning.

Dummy When Operation Indicator 2 is not used, the program

refers to the block as a dummy block and assigns it
a permanently OK value. The program ignores all
values that correlate to this block.

Pulse 4.12 User Guide 354

Minimum Requirements
To use the Maintenance Manager, make sure to meet the prerequisites
detailed below:

 Runtime and Development Security Enabled Key (SEK) version 8.00

and up

 Security Enabled Key (SEK) license: no I/O limit enforced

 Pulse Database Server must be activated before activating the

Maintenance Manager.

Pulse 4.12 User Guide 355

Accessing the Maintenance Manager
To open the Maintenance Manager

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Maintenance Manager Configurator icon.

The Maintenance Manager dialog box is displayed.

If you are opening the Maintenance Manager Configurator for

the first time, the program does not display data.

A Maintenance Manager icon appears in the Show Hide icons group

on the lower-right hand corner of the screen. If the Maintenance
Manager Configurator window is minimized and you want easy access
to the Maintenance Manager Configurator dialog box, right-click on
the icon within the Show Hide icons group to open its menu.

This section includes the following topics:

 Adding and Editing Maintenance Tags

 Defining the Data Collection Configuration

 Viewing Information Collected By Maintenance Tags

 Presenting Maintenance Tag Data in the Operator Workstation

 Resetting Maintenance Manager System Counters

Pulse 4.12 User Guide 356

Adding and Editing Maintenance Tags
Maintenance Tags provide you with a detailed picture of specific
equipment’s working and alarm status. In the Maintenance Manager
Configurator, you can create and edit Maintenance Tags. Each tag
contains up to three indicators. The first two indicators show the working
status of the equipment and the third indicator functions as an alarm
status indicator.

To add or edit a Maintenance Tag

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Maintenance Manager Configurator icon.

The Maintenance Manager dialog box is displayed.

2 Define Maintenance Tag properties as follows:

Name Click New and type a name of a new tag (if

creating a new tag) or choose a name from the
drop-down list (if editing an existing tag).

Description Type a textual description for the tag

Operation Select a database block to indicate working

Indicator 1 status.

Operation Select a database block to indicate working

Indicator 2 status.

Alarm Indicator Select a database block to indicate alarm

status.

Pulse 4.12 User Guide 357

 New Click this button to clear the Name box so that
you can type a new tag name.

Delete Click to delete the selected tag.

Save Click to store the selected tag configuration.

Alarm Type Select this option to trigger an alarm condition

“OFF” when the block's status changes from ON to
OFF.

Handling Alarm Select this option to indicate that although the

Situation tag’s alarm condition exists, based on the
block's settings, this is the normal operational
status of the equipment. The alarm condition is
therefore ignored.

Handling Select this option to instruct Maintenance

Offscan Manager to verify that the block's state is set
Situation to OnScan before polling it.

Reset Tag Click to reset the current tag counters. This

Section deletes all data collected by the tag since the
Counters latest up time.

Reset Tag Total Click to reset all data collected by the tag. This
Sections deletes all data previously stored in the tag's
Counters counters.

Pulse 4.12 User Guide 358

Defining the Data Collection Configuration
In the Configuration dialog box, define the configuration for the
Maintenance Manager’s data collection.

To set the data collection configuration

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Maintenance Manager Configurator icon.

The Maintenance Manager Configurator dialog box is displayed.

2 From the Tools menu, click Configuration.

The Configuration dialog box is displayed.

3 Define the data collection properties as follows:

Data Source

Log to DBF Select this option to use a DBF database for

storing all data. Type the full path of the file's
location.

The default is the current project’s path.

Log to ODBC Select this option to use an ODBC database.

Choose the database from the drop-down list.

Pulse 4.12 User Guide 359

 NT Applicable only when using an ODBC database.
Authentication
Select this option to use Windows user
accounts to control access to the database.

User ID Applicable only when using an ODBC database.

Type a user name for accessing the database.

Password Applicable only when using an ODBC database.

Type a password for accessing the database

Scan Interval Set the between database blocks scans. The

interval range is 60 - 999 seconds. The default
is 60 seconds.

Update Database Select this option to instruct Maintenance

every scan Manager to update the database on every
interval scan.

Dead Time Handling

The selected option instructs Maintenance Manager how to handle

data when polling fails.

Accumulate Select this option to accumulate blocks' data

according to based on the last known status.
Last Status

Do not Select this option to ignore data during the

Accumulate down time period.

Accumulate as Select this option to indicate if an alarm

Alarm condition existed while Maintenance Manager
was unable to poll for changes.

4 Click OK to implement the changes and close the dialog box.

Pulse 4.12 User Guide 360

Viewing Information Collected By Maintenance
Tags
In the Maintenance Viewer, you can view a record of the information
collected by each tag.

To view the collected data

1 In the AFCON Pulse Program Group’s Development folder,

double-click the Maintenance Manager Configurator icon.

The Maintenance Manager dialog box is displayed.

2 From the File menu, click View.

The Maintenance Viewer window is displayed.

The Maintenance Viewer displays the following information:

Name Name of the tag

Description Textual description of the tag

Operation Monitored database block

Indicator 1

Operation Monitored database block

Indicator 2

Alarm Indicator Monitored database block

Pulse 4.12 User Guide 361

 Last Update at Date and time of the tag’s last update

Status A 16-bit log register presenting the last stored

tag status.

Low Bits - holding calculation options:

 00 - Bit0HandlingOffScanSituation

 01 - Bit1HandlingAlarm Situation

 02 - Reserved

 03 - Bit3isAlarmCondition

 04 - Reserved

 05 - Reserved

 06 - Reserved

 07 - Reserved

 08 – Reserved

High Bits - holding current status of tag:

 08 - If block 1 is OK, bit 8 set to 1

 09 - If block 2 is OK, bit 8 set to 1

 10 - Reserved

 11 - If block alarm indicates alarms, bit

11 set to 1

 12 - If block 1 is OffScan, bit 12 set to 1

 13 - If block 2 is OffScan, bit 13 set to 1

 14 - Reserved

 15 - If block alarm is OffScan, bit 15 is

set to 1

Start Counting The time when the DUR_ON counter started

DUR_ON collecting data.

Stopped The time when the DUR_ON counter stopped

Counting collecting data.
DUR_ON

Pulse 4.12 User Guide 362

 Stopped The time when the DUR_ALM counter stopped
Counting collecting data.
DUR_ALM

Section OK The elapsed time between start and stop time

duration of data collection.

Section OK The elapsed times (cycles) that the tag's

cycles DUR_ON counter collected data.

Total Sections The total elapsed up time of all counters.

OK durations

Total Sections The number of times (cycles) that the tag's

OK cycles DUR_ON counter collected data.

Start Counting The time when the DUR_ALM counter started

DUR_ALM collecting data.

Section ALARM The elapsed time since the DUR_ALARM

duration counter started collecting data.

Section ALARM Indicates the number of times (cycles) that the

cycles tag's DUR_ALM counter collected data.

Total Sections The total elapsed collection time for all alarm
ALARM counters.
durations

Total Sections The total number of times that the tag's

ALARM DUR_ALM counter collected alarm data.

3 To present the most recent values stored in the database, click

Refresh from File.

To present the most recent values stored in system memory, click

Refresh from Memory.

To print the presented data, click Print.

4 Click Close to exit the Maintenance Viewer.

Pulse 4.12 User Guide 363

Presenting Maintenance Tag Data in the
Operator Workstation
Use the following DDE Server syntax to present data collected by the
Maintenance Manager in a display in the Operator Workstation.

Server: MNTSRV
Topic: P-CIM
Item: REFRESH (R/W)

Tag Name R/W

REFRESH R
L_STATUS R
TIME_ON R
TIME_FF R
TIME_ALL R
TIME_OK R
DUR_ON R
QTY_ON R
DUR_AL R
QTY_AL R
T_DUR_ON R
T_QTY_ON R
T_DUR_AL R
T_QTY_AL R
SectionReset W
TotalSectionsReset W
MNTStart R+W
MNTStop R+W
MNTResetAll W
MNTStarted 0 or 1 (R+W)

Resetting Maintenance Manager System

Counters
To reset counters for all maintenance tags in the system

1 From the Tools menu, click Reset All System Counters.

2 Click Yes to confirm.

Pulse 4.12 User Guide 364

The ProGate Editor
ProGate (Protocol Gateway) is a gateway protocol that enables data
exchange between PLCs and other devices according to triggered events
and user-defined filtering conditions.

A ProGate project is built of groups, where each group can have unique
settings. Each group is divided into tasks. A task is a combination of:

 Source element, which can be any ProGate (Pulse) element such as

blocks and/ or direct addresses.

 Target element, which can be any ProGate (Pulse) element such as

blocks and/ or direct addresses.

 Trigger conditions causing the data exchange.

During data transfer, ProGate sends data from the source into the target
according to defined trigger conditions.

Groups can be enabled, whereby at runtime they are connected to the

ProGate engine and data is transferred to and from the runtime module
(or disabled where no data is transferred).

A ProGate project is saved in TSV format in the Project PcimAct path. TSV
files can be opened in other programs, for example, Microsoft Excel and
be modified.

Installation
ProGate 8.0 is included in the installation of Pulse and does not require a
separate installation.

Pulse 4.12 User Guide 365

Using the ProGate Editor
The ProGate Editor is used to create ProGate Groups.

To open the ProGate Editor

 In the AFCON Pulse Program Group’s Development folder,

double-click the ProGate Editor icon.

The ProGate Editor window is displayed.

The ProGate Editor interface has two panes:

 Left pane, containing the ProGate tree and its groups.

 Right pane that displays a table of the selected group’s data. The
columns in this pane are defined during group creation.

NOTE To add many items to the table, press the <CTRL> key, select
an item, and then drag the item down for as many lines as
required.

To add a new group

 From the File menu, click New Group, or click the New group
icon from the toolbar.

A table for the group is displayed on the right pane.

Pulse 4.12 User Guide 366

To define group properties

1 Right-click on a group and select Properties, or click Properties

icon in the toolbar.

The Group Properties dialog box is displayed.

2 Define general information about the group.

Enable on load Select this option to start running the group

during startup.

Tasks Force

Every Select this option to run a communication

communication check, such as a “valueok” item, when
reconnection communication between the Pulse Server and
the data source is restored. Following the
communication check, Progate runs the
group’s tasks.

In the edit box, enter the item.

For example:

1:1:40001.valueok

Every __ Select this option to run the group’s tasks at

Minutes the specified interval.

Pulse 4.12 User Guide 367

 Trigger

Skip first trigger Click to select this checkbox option to cause

data Pulse to ignore the very first trigger data,
therefore not executing the data for the first
task.

Logger

Enable logging Click to select this checkbox option to enable

of data source logging the data source values.
values

3 Click OK to continue.

You are back in the ProgateEditor window.

4 From the File menu, click Save Group, or click the Save Group
icon from the toolbar to save the new group.

Pulse 4.12 User Guide 368

Defining Task Properties
The Task Properties dialog box displays the information of the task in a
form.

To add a task or edit an existing task

1 In the ProGate Editor’s left pane, select the group.

2 In the right pane, double-click the number of a free row to add, or

of an existing entry to edit.

The Task Properties dialog box is displayed.

Pulse 4.12 User Guide 369

3 Define the task’s properties as follows:

Name The name of the task. This name is mandatory

and must be unique.

Trigger

The Trigger fields contain the components which trigger the data
exchange from the source to the target.

Server The server type.

For example: Database Server (DBSR)

Topic The topic name.

For example: Pulse

Item The item, specified in the generic format:

Port:PLC:Address:Bit

in which:

 Port number indicates the assigned

Pulse port used for the data, as specified
in the Pulse Communication Setup
dialog box.

 PLC number indicates the number of the

PLC in the PLC network (syntax is driver
dependent).

 Address indicates the address of the

data element (syntax is driver
dependent).

 Bit number indicates the number of a

specific bit in a word or register (syntax
is driver dependent).

Dead Band Specify the minimum value considered as a

value change for updating data values.

Pulse 4.12 User Guide 370

 Mode Choose the trigger for initiating the data
transfer:

 Any change

 From any to non-zero

 From non-zero to zero

 From zero to any

Source

The source fields indicate the address from which the data is read.
For Server/ Topic/Item field definitions, see above.

Target

The target fields indicate the targeted address to which data is

written. For Server/Topic/Item field definitions, see above.

4 Click OK to save the task configuration and close the dialog box.

ProGate Expressions
Expressions can be used both in source and trigger elements and can be
added to group tasks in the Task Properties dialog box Triggers/Source
field. ProGate expressions are handled by the BasicServer. They use the
following syntax:

Server: BasicServer Topic: PCIM Item: valid basicserver expression

For example:

BasicSrv|pcim!dde%(|!A:1) indicates a value of A:1

NOTE For further information about Expressions read the “Syntax for
Expressions” document which can be downloaded from the
AFCON Software and Electronics Product Documentation page
at www.afcon-inc.com.

Pulse 4.12 User Guide 371

Pulse OPC Gateway
The Pulse OPC Gateway is a Pulse OPC server service that runs in Pulse. It
can be connected to any OPC client.

The function of the OPC Gateway is to send data from Pulse servers to
external OPC client programs via OPC protocol. Once an OPC client is
connected to the OPC Gateway, the Gateway runs automatically, bringing
data from the following Pulse servers:

 BasicSrv

 DBSR

 PfwAlarm

 PFWDrvr

 TxtSrv

The diagram below illustrates how data is received from Pulse servers,
translated by callback protocol and sent to the OPC Gateway.

The data is then translated by OPC protocol and sent to external OPC
clients. This is a bidirectional process.

Pulse 4.12 User Guide 372

Connecting to a Remote OPC Server
When the Pulse Server and Client are located on two different computers,
the OPC Client has to connect to the OPC Server remotely. For a remote
OPC connection, the DCOM configuration properties are to be set.

To configure DCOM configuration properties to connect to a

remote OPC server

1 Go to your desktop, click Start > Run.

The Run dialog box is displayed.

2 Enter dcomcnfg in the Open field and click OK.

The Component Services dialog box is displayed.

3 Click Console Root > Component Services > Computers > My

Computer > DCOM Config.

Pulse 4.12 User Guide 373

4 From the DCOM Config list, right-click PfwOPCGateway and
select Properties from the pop-up menu.

The PfwOPCGateway Properties dialog box is displayed.

5 Click the Identify tab and select the interactive user and The
system account options and click Apply.

Pulse 4.12 User Guide 374

6 Click the Security tab.

7 On the Launch and Activation Permissions area, select

Customize and click Edit.

The Launch and Activation Permission window is displayed.

Pulse 4.12 User Guide 375

8 In the Launch and Activation Permission window, click Add.

The Select Users, Computers, or Groups window is displayed.

9 Enter the object names to select the user/group that has to access
the OPC server and click OK.

Pulse 4.12 User Guide 376

10 Define the permissions for the user/group and click OK to return to
the Security tab.

11 Go to the Access Permissions area, select the Customize option,

and click Edit.

The Access Permission window is displayed.

12 In the Access Permission window, click the Add button.

The Select Users, Computers, or Groups window is displayed.

13 Enter the object names to select the user/group that has to launch
the OPC server and click OK.

14 Define the permissions for the user/group and click OK to return to

the Security tab.

15 Go to the Configuration Permissions area, select the Customize

option, and click the Edit button.

The Change Configuration Permission window is displayed.

16 Select the user/group for administrator permission to the OPC

server.

17 Select Allow for the Full Control permission.

18 Click OK to return to the Security tab.

19 Click OK again to save these definitions and to exit the Properties

dialog box.

Pulse 4.12 User Guide 377

Adding a User to a Group
When users are assigned to groups, they receive the group’s authorization
privileges.

1 Go to the Control Panel and double-click Administrative Tools >

Computer Management.

The Computer Management window is displayed.

2 Click Computer Management > Local User and Groups >

Groups.

The group’s users are displayed.

3 Double-click Users to display the Users Properties dialog box.

Pulse 4.12 User Guide 378

4 Select a user and then click the Add button to open the Select
Users, Computers, or Groups window.

5 Enter the name of the user and then click the Check Names button
to add the user’s details.

The user’s name is added to the list.

Pulse 4.12 User Guide 379

Connecting to a Remote OPC Gateway in a
Workgroup Configuration
In order to connect to a remote OPC gateway in a workgroup network
configuration, a peer-to-peer connection must be established between the
client and server computers.

Perform the following changes to the Local Security Policy (on

Windows 2003 Server and Windows XP Service Pack 2 only):

1 Go to the Control Panel and double-click Administrative Tools.

2 Double-click the Local Security Policy icon.

The Local Security Settings window is displayed.

3 Click Security Settings > Local Policies > Security Options.

4 On the right-hand pane, double-click the Network Access: Let

Everyone Permissions Apply to Anonymous Users entry.

5 Select the Enabled option and click OK to apply the new settings.

6 To enable sharing folders between computers in the workgroup,

locate the Network Access: Sharing and Security model for
Local Accounts entry in the Local Security Settings window.

7 Double-click the entry to change the current policy.

8 From the drop-down list, select the Classic - local users

authenticate as themselves option and click OK to apply the
change.

Pulse 4.12 User Guide 380

Running the OPC Gateway
During runtime, when an OPC client is connected, the OPC Gateway runs
automatically and the OPC Gateway service is started.

NOTE In Windows XP, when the OPC Gateway service is started, an

icon is also displayed.

OPC item settings can be updated during runtime. If you wish to define
new items or settings before the OPC client runs, open the Gateway
manually.

To open the Gateway manually

 From the Pulse Runtime icon group, double-click the OPC

Gateway icon.

Pulse 4.12 User Guide 381

The OPC Gateway Editor
The Pulse OPC Gateway Editor enables definition of:

 Address names and settings

 An item’s Read/Write/Read and Write access permission.

 An item’s data type

To access OPC Gateway Editor dialog box

1 In the AFCON Pulse Program Group’s Development folder,

double-click the OPC Gateway Editor icon.

The OPC Gateway Editor window is displayed.

The OPC Gateway Editor dialog box has the following fields:

Group The group where the new item is defined

Name Where the name of a new item is defined

Pulse 4.12 User Guide 382

Server Indicates the type of Pulse server used, which can
be: BasicSrv, DBSR, PfwAlarm, PfwDrvr or TxtSrv

NOTE The BasicSrv, PfwDrvr, and TxtSrv.servers items can only be

assigned to OPC items in the Pulse OPC Gateway Editor
dialog box.

Topic Indicates the name of the DDE format topic, which is

always PCIM

Item Indicates the item’s address in DDE format

Data type Indicates the type of data block. The following block
types are available: Boolean, byte, double, float,
long, short and string

Access Indicates whether the item is Read, Write or Read

and Write in the OPC client

Table Lists all item addresses and their settings

Add When clicked adds a new item to the Items table

Delete When clicked deletes a selected item from the Items

table

Change When clicked updates a modified item in the Items

table

Save When clicked saves the settings in the OPC Gateway

Close When clicked shuts down the OPC Gateway Editor

Example – Defining an OPC Item in the OPC Gateway Editor

• Group USER

• Name Item 1

• Server DBSR

• Topic Pulse

• Item D:1

• Data type Boolean

• Access Read

Pulse 4.12 User Guide 383

2 Complete the OPC Gateway Editor dialog box parameters using
the information in the example above.

3 Click Add to add the new item in the OPC Gateway Editor list of
items.

4 Click the Save button to confirm these settings.

5 To view/read/write the OPC item, connect the OPC client to the OPC
Gateway.

NOTE If the OPC client is already connected it may need refreshing

manually when new items are added. Other OPC clients are
automatically updated.

Pulse 4.12 User Guide 384

Viewing OPC Items in a Client Interface
In the OPC client Connect field, select and enter the
PfwOPCGateway.Server key to connect between the client and the OPC
server.

OPC items are displayed in an Items tree such as the one below:

PfwOPCGateway.Server Indicates which OPC key is used to reference

the OPC server. This name is automatically
displayed in the Servers List in the client.

DBSR This branch holds Pulse Database Server

items.

PfwAlarm This branch holds Pulse Alarm Server items

The PfwAlarm branch is only displayed when

the Advanced Alarm Handler module is open
and if items have been defined in it.

User This branch is a container for the OPC items

defined in the OPC Gateway Editor.

Pulse 4.12 User Guide 385

OPC Client
The OPC Client supports OPC DA versions 1.x, 2.x, 3.x, and XML
protocols.

Pulse’s OPC Data Adaptor Publisher service is an OPC client that connects
to OPC servers and exchanges data with them. The OPC Data Adaptor
explores the OPC Servers that are installed on the server PC (under the
‘Local’ branch), in its neighborhood (under the ‘Network’ branch), and
additional information about its configuration and actual state (for
example, number of connections, advised items, and so on). Direct OPC
items can be used in displays and workflows.

Additionally, users can assign OPC items to kernel database block

addresses (in this case, based on the legacy OPCSRV Callback server
supporting OPC DA versions 1.x and 2.x).

OPC technology enables the following actions:

 Connection/disconnection/reconnection between the OPC client to

more than one OPC server both locally and remotely

 Adding groups and adding items to groups

 Reading/ writing item values

 Monitoring advised items

 Checking advised item’s status

 Checking communications

NOTE The protocol used by the PLC must match the protocol used by
the OPC server.

During runtime, the OPC client receives data from the PLC after it has
been processed by the OPC server software, and then the OPC client
sends the information to the Pulse project.

The following diagram displays how the OPC client can be used in a Pulse
project.

Pulse 4.12 User Guide 386

OPC Adaptor Publisher
Pulse’s OPC Data Adaptor Publisher service is an OPC client that connects
to OPC servers and exchanges data with them. The OPC Data Adaptor
explores the OPC Servers that are installed on the server PC (under the
local and remote computers), in its neighborhood, and additional
information about its configuration and actual state (for example, number
of connections, advised items, and so on).

The OPC Adaptor Publisher is the interface for accessing the OPC
Communications information and for enabling bidirectional
communications between the OPC Data Adaptor Publisher service and an
OPC server.

The OPC Adaptor Publisher provides bidirectional data exchange between

OPC DA servers (using OPC protocols 1, 2, 3, XML) and Pulse WCF clients.

The OPC Adaptor Publisher module is used to access process data from an
OPC server in a Pulse project.

OPC Browser
The OPC Browser is the interface for accessing the OPC Communications
information and for enabling bidirectional communications between the
OPC Data Browser and an OPC server.

Data, received from the data sources (PLCs, controllers, etc.) is translated
using OPC protocol, and sent to the OPC Browser. From there, the data is
sent to PULSE servers using callback protocol.

The OPC Browser provides bidirectional data exchange between OPC DA

servers (using OPC protocols 1 and 2) and Pulse callback clients.

The OPC Browser module is used to access process data from an OPC
server in a Pulse project.

Pulse 4.12 User Guide 387

Using the OPC Adaptor Publisher in a Pulse
Project
When developing a project, an object whose data is processed through the
OPC must have syntax assigned. The syntax used in the OPC Adaptor
Publisher is built from Server|Topic!Item elements, where:

 Server = OPCSrv

 Topic = OPC server name

 Item = Itemname

The OPC server items can be directly accessed through the Item Manager
on the Client Workstation.

To Access the OPC Adaptor Publisher Items

1 On the Developer Workstation, click the Manage ribbon and select

Items.

The Item Manager window is displayed.

2 On the Item Manager window and expand the tree structure

Hosts > [Hostname] > Masterhost >OPC > Local > [OPC
Server Name] > DBSR > PCIM and select an Item from the
group.

The tree structure represents the host, server name, group name,
sub-group name. The items that can be added to the group appear
on the Items Names pane.

The address bar displays the full name and address of the OPC
Adapter Publisher item currently selected on the tree structure.

Pulse 4.12 User Guide 388

To set an OPC Group

 On the Item Manager, double-click on the group listed on the

Feature Names pane.

The OPC Group Manager window is displayed.

Pulse 4.12 User Guide 389

 The OPC Group Editor has the following configuration properties:

Group Name The name of the OPC group

Dead Band Specifies the required percentage of change in

the scale defined for the item in the OPC server
before notifying the OPC client of the data
changes.

Default = 0%

Time Bias Indicates the time difference (i.e., different

time zones) between the server and the local
client.

Default = 0 minutes

Update Rate Indicates the frequency that notifications of

data changes in the group may be sent.

Default = 500 milliseconds

To view a specific Item through Data Scope

1 Double-click on the OPC item.

The Data Scope window is displayed with syntax and its status.

2 Enter a value and click Enter.

The relevant status is displayed.

3 Click the Show Items icon to display an additional column called

Item; the Item column translates the alias.

Pulse 4.12 User Guide 390

To explore all items and their properties

1 On the Operator Workstation, click the Tools ribbon and select

Item Manager.

2 On the Item Manager window, expand the tree structure Hosts >
Masterhost > OPC > Local > PfwOPCGateway.Server.1 >
DBSR > PCIM.

All the relevant details of the OPC Publisher item are displayed.

The Items list is displayed with the following columns:

Item name Displays the full name and location of the item

Value Displays the value of the item in the OPC

server

Time Stamp Displays the time of the last update of the item
by the OPC Adaptor Publisher

Pulse 4.12 User Guide 391

 Status Each OPC item value has a status indication
known as the OPC Item Quality. The quality of
an item is based on whether or not the physical
device has provided a value for the Item

Quality status can be:

 Good, indicating that a value has been

sent by the physical device for the OPC
item.

 Bad, indicating that a value has not yet

been received for the OPC item and the
value is unknown.

Access Rights Defines if this item is read only or read and

write

NOTE When the Monitoring option is selected, data is transferred

between the OPC Adaptor Publisher and the OPC server.
Advised items and their details are displayed in the window.
This process uses extensive CPU memory resources. AFCON
recommends using this option only when necessary.

OPC Browser - Workflow

The following workflow can be used for working with the OPC Browser:

NOTE The OPC Browser can be opened without starting up Pulse.

However, Pulse must be running to enable connection to
servers.

Pulse 4.12 User Guide 392

Accessing the OPC Browser

 From the AFCON Pulse Program Group’s Development folder,

double-click the OPC Browser icon.

The OPC Browser dialog box is displayed.

Connecting the OPC Browser to an OPC Server

1 In the OPC Browser window, go to the menu and click Server >
Connect or click the Connect icon from the toolbar.

The Connect window is displayed.

2 Double-click an OPC server, or select an OPC server and then

click the Connect button the Connect window.

Pulse 4.12 User Guide 393

NOTE The OPC Server Key field is automatically filled after an OPC
server is selected from the list.

The OPC Browser is connected to the OPC server and the OPC
Browser interface is displayed.

Pulse 4.12 User Guide 394

Connecting the Network OPC Browser to an OPC Server

1 Open the Connect dialog box and from the OPC Browser interface,
click the Connect icon,

or, from the Server menu click the Connect option.

2 Click the Network OPC Servers button and browse for the
computer where the remote OPC server is installed.

3 Click OK to make the connection between the servers. The OPC

servers available on the remote computer are added to the list of
OPC servers in the Connect dialog box, and the name of the
remote computer is added to the Network Computer field.

NOTE The computer names of remote OPC servers have backslashes

\\ as prefixes.

When making remote OPC server connections, check that you have the
appropriate authorization. Both local and remote computers must be
defined on the same domain or in the same workgroup.

4 Select a remote OPC server and then click the Connect button to
connect between the selected OPC server and the OPC Browser.

NOTE The INI file name of the remote OPC server has the following
format:

OPC_NetworkComputerName_OPCServerName.ini

Pulse 4.12 User Guide 395

OPC Browser Interface

When first accessed the OPC Browser has the following sections:

 Menu bar - see Menu/Toolbar

 Toolbar - see Menu/Toolbar

 Address bar - displays the full name and address of the item
currently selected in the OPC Browser.

 Server window - displays the OPC server group tree structure.

When expanded the tree has the following structure:

Server name, Group name, Sub-group name

 Group window - displays the properties of a selected OPC Browser

group:

• Group name, which is the name identifying the group.

• Update rate, which specifies the frequency (in milliseconds)

that the OPC server sends updated data.

• Percent deadband, specifying the percent change of the scale

required before notifying the OPC Browser of the data
changes. The percent deadband is defined for the item in the
OPC server Deadband default = 0.

 Items window - displays the items of the selected group or sub-

group in the Server window from which items can be added into the
list of advised items.

 Advised items window - displays selected items from the Items

list. When monitoring is defined, these items are scanned according
to predefined conditions.

Pulse 4.12 User Guide 396

Menu/Toolbar
The OPC Browser menu bar is dynamic, after a connection has been made
to an OPC server, additional menus and options are available. An asterisk
* next to a menu/option indicates that it is available both when the OPC
Browser is online or offline.

Table 3: OPC Browser Menu/Toolbar

Menu Icon Option Description

File Save Saves the OPC Browser groups

and items.

Hide OPC Hides the OPC Server from the

Browser desktop

*Exit Exits the OPC Browser module

Server *Connect Opens the OPC servers

Connect dialog box where the
connection between the OPC
Browser and a selected OPC
server are made.

Disconnect Ends communications between

the OPC Browser and the
selected OPC server.

Reconnect Reconnects the OPC Browser

to the OPC server after
communication failure. This
option is only available when
automatic reconnection is
disabled in the Keep Alive
dialog box.

Pulse 4.12 User Guide 397

Menu Icon Option Description

Server Refresh When clicked, the OPC

Browser reads the items from
the tree of the selected OPC
server again and updates the
OPC Browser window.

Disconnect Disconnects all open servers

All Servers and displays the OPC
Browser window with the
basic menu bar options and
toolbar Connect icon.

Show Items When connected to an OPC

server, select this option to
expand the items tree.

Server Shows the OPC Server

Properties properties. Server specific
settings are modified from this
location

*Item Add Group Opens the Group Parameters

dialog box. OPC Browser
groups and their properties are
displayed in the Group Window
of the OPC Browser interface,
see Groups.

Remove Removes a selected group

Group from the Group Window.

Group Displays the Group

Properties Properties dialog box where
the group properties are
shown and can be modified
and updated.

Add Item Opens the Add Item dialog box

where items that require
constant monitoring are
defined.

Remove Removes a selected item from

Item the Advised Items list.

Pulse 4.12 User Guide 398

Menu Icon Option Description

Write Item Opens the Writing dialog box

where you can modify the
selected advised item’s value.

Add Multiple Opens the Multiple Advise

Items dialog box where you can
define batches of items that
require constant monitoring.

An advised item is an item

that is constantly monitored by
the Pulse client modules. For
example, Operator
Workstation.

View *Status bar Toggles the Status bar where

the total number of advised
items and the total number of
items in a selected group are
displayed.

Address bar Toggles the address bar. The

information in the address bar
can be copied and added to
objects during project
development.

Options Monitoring When activated, displays

updated values of advised
items.

PCIM Item When activated, displays the

Syntax Server| Topic| defined for the
item in the OPC server Item
syntax of a selected item (or
advised item) in the interface’s
Address bar.

*OPC Opens the Browser

Browser Configuration dialog box
configuration where connection settings can
be defined.

NOTE When the Monitoring option is selected, data is transferred

between the OPC Browser and the OPC server. Advised items
and their details are displayed in the Advised Items window.
This process requires extensive CPU memory resources. We
recommend using this option only when absolutely required.

Pulse 4.12 User Guide 399

NOTE The OPC browser is capable of supporting EGU conversion
functions: bcd, byte, nib, and alarm. To use these functions
add the character d before each function. For example: dbcd,
dbyte.

Disconnecting/Reconnecting/Refreshing
Connections
 Disconnecting

• Disconnecting a single OPC server: select the OPC server

from the Server window and from the toolbar click the
Disconnect icon or from the Server menu select the
Disconnect option.

• Disconnect all OPC servers connected to the OPC Browser:

select the Disconnect All option from the Server menu.

 Reconnecting

• To reconnect to the OPC server that was last disconnected,

click the Reconnect icon from the toolbar or from the
Server menu select the Reconnect option.

 Refreshing

• The OPC Browser with items and their values that were
added/ removed to/ from the selected OPC server, click the
Refresh icon or from the Server menu select the Refresh
option.

NOTE An OPC server that has items that are advised (by the
Operator Workstation, DBSR or other modules), cannot be
disconnected until their items become unadvised.

If the OPC server has advised items and you wish to

disconnect; shutdown Pulse and then restart the application.

NOTE All connected OPC servers are automatically disconnected

when Pulse is shutdown.

Pulse 4.12 User Guide 400

OPC Server Properties
Open the OPC Browser and from the Server menu select the
PfwOPCGateway Server Properties option.

 General tab

Settings

Synchronous When enabled, the OPC Browser polls the OPC

Read Gateway for advised items every 60 seconds
using synchronous read.

Synchronous When checked enables the OPC Browser to

Write write advised items values in synchronous
connection

Case Sensitive To enable usage of the case sensitive function,

select the Case Sensitive checkbox. The OPC
server has to be reconnected for the change to
take effect.

Pulse 4.12 User Guide 401

 Keep Alive tab

Communication Defines the time interval between each

test interval communication test

Default = 30 seconds

Range: 10-36000 seconds

Communication Defines the number of communication

test attempt attempts that will be made by the OPC
Browser

Default = 3 attempts

Range: 1-100

Time between Time interval between reconnection attempts

reconnect
attempts Default = 60 seconds

When Pulse is not running, it is automatically started up if the OPC

Gateway icon is double clicked in the Pulse Group. Right-clicking the OPC
Gateway tray bar icon displays three options:

 About - when clicked displays details about Pulse and the OPC
Gateway.

 Edit - when clicked displays the Pulse OPC Gateway Editor.

 Shutdown - when clicked shuts down the OPC Gateway server.

Pulse 4.12 User Guide 402

Groups
Groups with any number of items can be created where each group has
global parameters specific to the group. This option increases efficiency in
a Pulse project.

An advised item is processed in the OPC Browser, after it has been added,
and results are displayed in the Advised Items window.

A list of all OPC Browser groups is displayed in the Groups window.

 Adding a new group

Groups are created/ modified in the Group dialog box. To open this dialog
box either right-click in the Servers window or from the Items menu,
select the Add Group option.

The Group Properties dialog box has the following fields:

 Name - the group name

 Update Rate - indicates the frequency that the group of advised

items is scanned.

For example, if 1000 msec is defined the group is scanned every

1000 msec.

 Deadband - specifies the required percentage of change in the

scale defined for the item in the OPC server before notifying the
OPC Browser of the data changes.
Deadband default = 0

 Time Bias - indicates the time zone where the data was collected.
Time Bias indicates the time difference between the server and the
client. By default= -120

Pulse 4.12 User Guide 403

Removing groups from the Groups window

Select the group and then either right-click and select Remove Group or,
from the Items menu select the Remove Group option.

NOTE The OPC Browser has a default group named Root that cannot
be deleted.

Modifying group properties

Group properties are defined in the Group Properties dialog box.

 To open the Group Properties dialog box, select a group and then
right-click and select Group Properties or, from the Items menu
select Group Properties.

Items
Items can be advised and added to groups. All items that are defined in
the application are displayed in the OPC Items window. When an item is
added to a group it becomes an advised item and is displayed in the
Advised Items window.

NOTE Since the OPC Browser is used for test purposes, not all OPC
items need to be added to the Advised window.

Adding an Item to a Group

On first connection to the OPC server, the items tree is not visible.

1 To display the items list, right-click the OPC Server name and
choose Show Items from the menu.

2 In the Server window tree, select a branch and then select a group.

3 Select an item from the OPC Items window and then right click on
the item and select the Add Item option or from the Items menu
double-click on the item and select the Add Item option.

Pulse 4.12 User Guide 404

Adding an Item Manually

This option is used to add an item that does not appear in the OPC Items
window, but is supported by the OPC server.

1 In the Server window tree, select a branch and then select a group.

2 Go to the menu and select Item >Add Item.

The Add Item dialog box is displayed.

3 Complete the Item field:

• If you know the item Name and Path select the Name button
and then type in this information.

• If you do not know the full path, type in the name of the item
and then check the Full path option to complete the
location.

4 Click the Add Item button to add the selected item to the Advised
Items window.

5 The Copy button can be used to copy the item and its path into
another location.

NOTE You can also select an item from the OPC Items List window
and right-click on the item and select Add Item from the pop-
up menu to an item.

Pulse 4.12 User Guide 405

Removing an Item from a Group

1 From the Group window, select a group.

2 From the Advised Items window select the advised item.

• On your keyboard, press the Delete button.

• Right click and select the Remove Item option.

• From the Items menu, select the Remove option.

Removing an Advised Item Used in another Pulse Module

Used to remove an advised item used in Operator Workstation or another

Pulse module.

NOTE Data blocks must first be deleted from the Database Editor
before they are removed from the OPC Browser.

1 In the other module, change the status of the selected item to not
advised (for example, by closing the display).

2 Remove the advised item from the OPC Browser.

Writing a New Value to an Advised Item

This option is used to manually update values at runtime.

1 From the Groups window, select a group and from the Server
window select an advised item.

2 Right-click on the item and select the Write Value option from the
pop-up menu or go to the menu and select Item > Write Item.

The Write Value dialog box is displayed.

3 Define the value in the New Value field.

4 Click OK to confirm the new definitions and to exit this dialog box.

NOTE Values can also be updated manually in the Operator

Workstation module.

Pulse 4.12 User Guide 406

Advising Multiple Items
This option enables advising items in bulk quantity of up to 3000 items
per batch.

Multiple items can be added to the monitored list in one of the following
ways:

To add items from a specific location in a set quantity

1 From the Items window select the relevant items.

2 On your keyboard, press the Shift button.

3 Double-click to add the items to the monitored list or right click and
select the Add Items option.

The items are added to the monitored list.

To add a Sequential List

1 From the Groups window, select a group and then in the OPC
Items window select the first item from which to create multiple
advised items.

2 From the Item menu select the Add Multiple Items.

The Add Multiple Items dialog box is displayed, and the From field
displays the name of the selected item.

3 Type in the number of items into the Amount field.

If, for example, 70 is entered, the selected item and 70 items after
it are added to the Advised Items window.

4 Click OK to save this definition and to exit the Add Multiple Items
dialog box.

Pulse 4.12 User Guide 407

Options Menu
This menu has the following options:

 Monitoring

 Pulse item syntax

 OPC Browser Configuration

Monitoring, Displaying Advised Items

1 From the Options menu select the Monitoring option or in the
toolbar click the Monitoring button.

The Advised Items list is displayed with the following columns:

 Item name - displays the full name and location of the item.

 Value - displays the value of the item in the OPC server.

 Data type - displays the item’s data type as defined in the OPC
server. For example, word, double word.

 Time Stamp - displays the time of the last update of the item by
the OPC Browser.

Pulse 4.12 User Guide 408

 Quality - each OPC item value has a quality indication known as
the OPC Item Quality.

The quality of an item is based on whether or not the physical

device has provided a value for the Item ID.

Quality status can be:

• Good, indicating that a value has been sent by the physical

device for the OPC item.

• Bad, indicating that a value has not yet been received for the
OPC item and the value is unknown.

 Access - defines if this item is read only or read and write.

NOTE When the Monitoring option is selected, data is transferred

between the OPC Browser and the OPC server. Advised items
and their details are displayed in the Advised Items window.
This process uses extensive CPU memory resources. AFCON
recommends using this option only when necessary.

Displaying Item Syntax

 In the Options menu select the PCIM Item Syntax option.

The full Server|Topic!Item syntax of the item is displayed in the

Address bar.

Pulse 4.12 User Guide 409

Configuring the OPC Browser

This option is used to define the OPC Browser settings.

1 From the Options menu, select OPC Browser Configuration.

The OPC Browser Configuration dialog box’s General tab is

displayed.

The OPC Browser Configuration dialog box has the following fields:

 Connection Settings

• Timeout - defines the maximum/minimum amount of time

waited to connect to the OPC server and to receive a list of
items from it.

• Call Back Data Change Rate - defines the interval for

scanning updated OPC server advised items.

 Logging Options

• Log advised items in Alarm Handler - when checked,

indicates that advised items from the callback server are
written to and displayed in the Alarm Handler.

Pulse 4.12 User Guide 410

 • Log data changes…(0-2) - indicates whether (or not) the
advised item is logged:

0 = not logged

1 = logged

2 = internal use only

2 Click the Keep Alive tab.

The OPC Browser Configuration dialog box’s Keep Alive tab is used to
define the continual communication of OPC servers connected to the OPC
Browser.

The OPC Browser Configuration dialog box’s Keep Alive tab has the
following fields:

 Settings

• Communication test interval (10-36000) - indicates the

time interval between each communication test.

• Communication test attempts(1-100) - indicates the

number of communication test attempts.

Pulse 4.12 User Guide 411

 • Time between reconnect attempts - indicates the number
of seconds between each reconnect communication attempt.

When 0 is defined this indicates that reconnection to an OPC

server can be made manually by clicking the Reconnect
button.

OPC Browser Alarm Explorer

Activity in the OPC Browser is viewed in the Alarm Explorer window.
Messages can be generated for:

 Successful/failed OPC server connection

 OPC server disconnection/reconnection from the OPC Browser.

 Success/failure to advise items

 OPC Browser loaded successfully.

 OPC Browser receives a request to close.

 OPC Browser successfully closed

Pulse 4.12 User Guide 412

Connecting to a Remote OPC
It is possible to configure your PC to connect to a remote OPC.

To Connect to a Remote OPC

1 Turn off the Windows firewall.

In order to work with a remote OPC Server, turn off the Windows
firewall on the PC that runs the OPC Server and the PC that is
supposed to connect to the OPC Server.

2 Configure DCOM by first going to the Windows desktop and click

Start > Run.

DCOM has to be configured on the PC that runs the OPC Server and
the PC that will be connected to the OPC Server).

Start the DCOM Configuration utility manually. It does not have an

icon.

3 Type DCOMCNFG and press the Enter key.

The Component Services window is displayed.

4 Click Console Root > Components Services.

5 Go to the middle pane and double-click on the Computers folder.

Pulse 4.12 User Guide 413

6 Right-click on the My Computer icon and select Properties from
the pop-up menu.

The My Computer Properties window is displayed.

7 Click the COM Security tab and click the Edit Limits... button on
the Access Permission area.

The Access Permission window is displayed.

8 Check that the following are listed on the Group or user names
list under the Security Limits tab:

• Everyone

• Anonymous Logon

• Domain User

Pulse 4.12 User Guide 414

9 Verify that all have allowed Remote Access and Local Access
permissions and click OK.

The My Computer Properties window is displayed.

Pulse 4.12 User Guide 415

10 Click on the Edit Default... button on the Access Permission
area.

The Access Permission window is displayed.

11 On the Default Security tab, verify that all added users or groups
have allowed Remote Access and Local Access permissions and
click OK.

The My Computer Properties window is displayed again.

12 Repeat Steps 7-11 for Launch and Activation Permissions on

the My Computer Properties window COM Security tab and click
the OK button to save and close the window.

13 On the Components Services window, navigate to Console Root

> Component Services > Computers > My Computer > DCOM
Config.

Pulse 4.12 User Guide 416

 All DCOM settings are displayed.

14 Select OpcEnum and right-click on it.

15 Select Properties from the pop-up menu.

The OpcEnum Properties window is displayed.

16 Click the Identity tab and check if the The system account
(services only) option is selected.

Pulse 4.12 User Guide 417

17 Go to the General tab and verify that OpcEnum runs as a service.

Pulse 4.12 User Guide 418

18 Go to the Security tab and select the Customize option on the
Launch and Activation Permissions area.

Pulse 4.12 User Guide 419

19 Click the Edit button.

The Launch and Activation Permission window is displayed.

Pulse 4.12 User Guide 420

20 Check that the following are listed on the Group or user names
list under the Security tab:

• Everyone

• Anonymous Logon

• Domain User

• Domains users

• Interactive

21 Verify that all selected users and groups have the required
permissions.

22 Repeat this action for every permission (Access and Configuration

permissions).

23 Click OK then OK again.

The Component Services window is displayed.

Pulse 4.12 User Guide 421

24 Right-click on PfwOPCGateway under the DCOM Config folder
and select Properties from the pop-up menu.

25 Go to the General tab and verify that PfwOPCGateway runs as a

service.

26 Click on the Identity tab and verify that the The system account
(services only) option is selected.

27 Click OK and then OK again.

The Component Services window is displayed.

28 Right-click on the OPC Server installed on your PC (i.e., KEPware

Enhanced OPC/DDE Server) located under the DCOM Config
folder and select Properties from the pop-up menu.

29 Go to the General tab and verify that the OPC Server runs as a
service.

Pulse 4.12 User Guide 422

30 Click on the Identity tab and verify that the The system account
(services only) option is selected and click OK.

31 Click the Security tab and select Customize under the Launch
and Activation Permissions area.

The Launch and Activation Permission window is displayed.

32 Check that every user or group has all the required permissions and
click OK.

33 This time select the Customize option under the Access

Permissions area on the Security tab.

The Access Permission window is displayed.

34 Check that every user or group has all the required permissions and
click OK then OK again.

Pulse 4.12 User Guide 423

35 On the Windows desktop, click Start > Control Panel >
Administrative Tools > Services.

The Services window is displayed.

36 Verify that P-CIM OPC Adaptor Publisher runs as a user from the
domain (user account and not the system).

The OPC Server should run as a service.

Pulse 4.12 User Guide 424

37 Right-click on P-CIM OPC Adaptor Publisher and select
Properties from the pop-up menu.

The P-CIM OPC Adaptor Publisher Properties window is displayed.

38 Click on the Log On tab and select the This account option.

39 Enter the domain on the This account field.

40 Enter the password on the Password and Confirm Password

fields and click OK.

41 Start up the Pulse Server and open a Client.

42 Verify that all Pulse services are up (should run as system) by going
to Start > Control Panel > Administrative Tools > Services.

43 Select the Tools ribbon and click Data Scope.

The Data Scope window is displayed.

44 Click on the Name column.

Pulse 4.12 User Guide 425

 The Item Manager window is displayed.

45 Navigate to Hosts > MasterHost > OPC > Network > Microsoft
Windows Network > P-CIM and select a computer name and
OPC Server.

46 Select an item under the Item Names list and double-click on the
item.

47 Click on the button.

The Data Scope window is displayed with the

\\Masterhost\OPCSRV|\\YURI-
STATION\KEPware.KEPServerEx.V4!Channel1.Device1.400001 (in
this example) value appearing on the Name column.

Pulse 4.12 User Guide 426

Problems with Remote Connections
If you have problems with remote connection, check the OPC server’s
DCOM settings. During server startup the DCOM settings may be
overwritten.

AFCON recommends that you contact the manufacturer of the server.

Troubleshooting the OPC Browser

The OPC Browser fails to advise items

Possible Cause: Upper Case Sensitivity in OPC Servers

This situation could occur because the OPC server is case sensitive. The
following definitions must be set when working with an OPC server that is
case sensitive:

File: OPC server name Section: General Token: Uppercase = 0

NOTE The file name is the name of the OPC server.

The OPC Browser fails to connect to the OPC server, or connects

but does not display the OPC tree.

Possible Cause: Single Thread Connections to OPC Servers

The OPC server is connected via a single-thread connection (and not via
multi-thread connections).

The following definitions must be set when connecting to an OPC server in

a single-thread connection:

File: OPCSRV.INI Section:[MainThreadConnection]NameSrvN= Token:

OPCserver name

NOTE To date, this is a problem only for an Rslinx OPC on a local PC.

Pulse 4.12 User Guide 427

Connection Failure Error Message
A connection failure error message may be displayed when the OPC
Browser connects to an OPC server, even though the connection is
successful.

To avoid this message the following definitions must be set:

File: OPCSRV.INI Section:[IgnoreConnectError]NameSrvN= Token:

OPCserver name

NOTE To date, this is a problem only for an Rslinx OPC on a local PC.

NO-SEK Stations
Pulse No-SEK station is able to connect to a remote OPC server only if the
Pulse Master node is equipped with a site License and Unlimited IO SEK
support.

From a NO-SEK node, the OPC Browser will only be able to connect to a
remote OPC server which resides on the Pulse-Master station.

Message Description

Pulse OPC Browser cannot The OPC Browser cannot connect to the
connect to local OPC server local OPC server(s) while running on a
when no SEK is attached Non-SEK station

Pulse OPC Browser cannot OPC Browser cannot connect to remote

connect to remote OPC OPC servers when the remote Master is a
server - Master SEK is IO limited IO SEK.
limited.

Pulse OPC Browser cannot OPC Browser is unable connect to remote

connect to remote OPC OPC servers when the Master nodes
server - Master sites threshold has been reached. The Connect
limitation. dialog box the Network OPC Servers
button is disabled.

Pulse OPC Browser cannot The network OPC gateway is not reachable
connect to remote OPC or the IP address is incorrect.
server – remote IP address is
not equal to Pulse Master IP

Pulse OPC Browser cannot An incorrect Pulse Master IP or it does not

connect to remote OPC exist.
server – invalid IP address
syntax

Pulse 4.12 User Guide 428

Pulse Redundancy
Pulse Redundancy ensures a continuous and uninterrupted Pulse client–
server operation even when the server fails.

Pulse Redundancy consists of two identical Pulse servers running on two

separate computers. Both servers are on-line simultaneously; each
running an identical copy of the Pulse project. Pulse clients are connected
to one server (the active server), while the other server (the passive
server) is hidden from Pulse clients.

In case the active server fails, the passive server becomes the active
server. Pulse clients automatically connect to this new active server.

Pulse Redundancy Terminology

The following are the terminologies used in Pulse Redundancy.

Active Server The Pulse server to which Pulse clients are

connected

Passive Server The Pulse server, which monitors the active

server, ready to take over in case the active
server fails

Virtual IP (VIP) An IP address, which is not used by any

Address computer on the intranet/domain and is
assigned to Pulse Redundancy only

Pulse Project Folder(s) containing files (display files,

configuration files, etc.) and SQL database
tables

Pulse Project A process where project files are copied by the

Replication passive server from the active server. This
ensures that both servers are up-to-date and
are running identical projects

SQL Replication The project’s SQL database tables are

synchronized by the SQL engine on both
servers. This ensures that both servers are up-
to-date and are running identical projects

Pulse 4.12 User Guide 429

Servers’ Role in Pulse Redundancy
At any given moment, either server may function as the active server,
allowing Pulse clients to connect while the other server becomes the
passive server. During startup, one of the servers assumes the active
server role, while the other server assumes the passive role.

Redundancy Modes
Pulse Redundancy supports two working modes:

 Virtual IP (VIP)

 Dual IP (DIP)

Virtual IP
In Virtual IP (VIP) mode, a Virtual IP is assigned to a server. In this
mode, the active server attaches a Virtual IP address so Pulse clients may
connect to the server using the attached Virtual IP address. When servers
switch from active to passive or vice-versa, Pulse clients connect to the
active server automatically without user intervention.

NOTE Some security policies may restrict attaching an IP address at

runtime due to security breach, and may block the Pulse
server from attaching an IP address.

Dual IP
In Dual IP mode, there are two assigned static IP addresses. Pulse clients
connect to the active server using its static IP address, while the passive
server refuses all clients’ connections. When failure occurs, the passive
server becomes the active server, allowing Pulse clients to connect.

Dual IP mode does not have a Virtual IP address. In this mode, no Virtual
IP address is assigned to Pulse Redundancy. The servers assume their
roles during startup; one server assumes the role as the active server
allowing clients to connect, while the other server becomes the passive
server, which does not allow any connections. Pulse clients connect to the
active server using the server’s static IP address.

When servers switch roles, clients connect to the active server as follows:

 Since the Pulse client is not aware which server is the active server,
the user should launch the Pulse Operator Workstation (OWS) using
server no. 1’s static IP address. If the connection fails then the
user should launch the Pulse Operator Workstation using server
no. 2’s static IP address.

Pulse 4.12 User Guide 430

 If the active server fails when the Pulse client already launched the
OWS, the client is automatically connected to the active server,
without user intervention.

Redundancy Configurations
The following are recommended Pulse Redundancy configurations.

Hot Redundancy
You can use two types of Hot Redundancy modes:

 Dual IP mode, for example, when the IT Administrator does not

allow using another IP address other than the static IP address.

 Virtual IP mode, when a third party program (i.e., Pulse Mobile)

has to access the Pulse server via an IP address, then a static IP
address is required to access the Pulse server.

Database Synchronization
Pulse Redundancy supports the following database synchronizations:

 Central database – Apply when the database in the organization

is maintained by a professional DBA. Use the central database
option when SQL is installed on a third computer and is used by
both servers.

 Pulse replication - use when each server has its own SQL copy.

 SQL replication – Can be applied when each server has its own
copy of SQL. SQL replication is done by MS SQL tools.

When the project processes more than 10,00 records of alarms a

day and the project database is edited on a daily basis, see the SQL
Replication option.

NOTE When the Data Logger, EM Publisher, or Audit Trail option is

used, you cannot use Pulse replication.

Communication
In case the drivers cannot communicate with both servers simultaneously,
then the Enable communication on passive server checkbox option in
the Redundancy Editor has to be unchecked.

Otherwise, the Enable communication on passive server checkbox

option in the Redundancy Editor has to be checked.

Pulse 4.12 User Guide 431

Replication Cable
When both servers have an alternative network adaptor card that can be
linked together and served as a replication line, use the network adaptor
card IP address for the Project File Synchronization.

Otherwise, use the same IP address for the server TCP/IP communication
and for the Project File Synchronization.

Using the same IP address for server communication and file

synchronization is another option.

Data Collection, Recording, Synchronization

and Publishing
The active server collects data from various data sources (i.e., PLCs, OPC
servers, DDE servers) and publishes it to Pulse clients and to the passive
server, if it is configured. Data is recorded to project files and to SQL
tables by the active server.

The passive server may be configured to collect data from the same data
sources or from the active server. Data is recorded by the passive server
to project files and to SQL tables. It does not publish the data to any Pulse
clients.

Data, which is recorded to SQL database, must be synchronized between

the servers. The following are the synchronization options:

 Pulse project replication

 Central database

 SQL replication engine

NOTE The SQL replication or Central Database must be used when

the Pulse Data Logger, the Pulse Event Management, or the
Pulse Audit Trail is used.

Pulse 4.12 User Guide 432

Pulse Redundancy Configurations
SQL Database
Pulse Redundancy supports the following SQL configurations:

 Each server has a copy of its own SQL database, which may be
installed locally on the server or on a remote computer. SQL tables
must be synchronized in one of the options listed above.

 Both servers use the same SQL database, which is installed on a

third computer. To ensure data survivability, the SQL Database
must be managed by a third party. Otherwise, data may be lost in
case the third computer fails. Central database synchronization is
one option. For more information, consult with the SQL DBA.

For more information, see https://msdn.microsoft.com/en-

us/library/ff877884.aspx.

Project Development, Modification and

Synchronization
Project development and modification is performed on the active server
only.

Periodically, the passive server retrieves the project files from the active
server and updates its own files.

During startup, each server retrieves the project files from the other
server.

Project definitions, which are stored in SQL tables, must be synchronized

in one of the options listed above.

Pulse 4.12 User Guide 433

Monitoring Pulse Redundancy
The following Pulse tags show the Pulse Redundancy behavior:

Tag Meaning

|!$RedundancyStatus Returns “Server is active since …”

or “No Redundancy”

|! $ServerStatus Returns “Active” or “Passive”

|! $ServerActive
Returns “1” if active; “0” if passive
|! $IsGreen

|! $ServerRole Returns “Primary”, “Secondary” or “None”

|! $ComputerName
Returns the active server’s computer name
|! $ActiveServerName

|! $IPPrimary
Returns the active server’s static IP address
|! $IPAddrStr

|! $IPSecondary Returns the passive server’s static IP address

|!$IsPassiveRunning Returns “1” if the passive server is running

|!$ReleaseVIP Use this variable only for maintenance

purposes.

|!$ReleaseVIP is used to command the local

host Pulse server to release its Virtual IP so
the Virtual IP can be used by another server.

Write “1” to release the Virtual IP.

Pulse 4.12 User Guide 434

System Requirements
Minimum System Requirements
 Operating System: Windows Server 2008 Standard Edition, 64-Bit

 For both server stations: Pulse License version 4.00 (1100)

 Both servers require the same Pulse License features.

Pulse Redundancy Prerequisites

Before setting-up the Pulse Redundancy, make sure:

 Both computers are properly configured for Windows networking:

• The unique IP addresses for all network cards are specified in

the TCP/IP Properties dialog box.

• Unused network cards are disabled and network cables are

connected to all the network cards in use.

• Network speed is at least 100 Mbps.

 The same version of Pulse is installed on both computers.

 P-CIM Network is enabled and both servers have the same node
number. The Node number must be in the range of 1-255. Use the
P-CIM Network Setup wizard to set the node number.

 Both computers have the necessary Pulse licenses (SEK).

 The project’s folders are shared (Read privileges only) so that

project files may replicate between both servers.

 Remote File Access Privileges - In order for the passive server to

copy data from the active server, it requires a User account with
Read privileges form the other server. You may set the user
account using one of the following methods:

• Set the Pulse Server Service with a User account instead of

the default System account. Use the Services window
> P-CIM Server Properties > Log On tab.

• Define the User account in the Pulse Project Setup wizard.

Click on the Configure Remote Access Security icon
or click File > Configure remote access account settings
from the menu to display the Pulse Remote Access
account settings dialog box to fill the user’s details.

Pulse 4.12 User Guide 435

 For Virtual IP mode, you have a Virtual IP address, which is not
used by any computer. Most company's intranet uses a specific
range of IP addresses. Choose any unused IP address from that
range.

 When SQL is installed locally on each server, make sure that the
Data Source token in the connection string does not include the
computer name (e.g., it should be Data Source= for SQL or
Data Source=.\PULSESQLEXPRESS for SQL Express.

 When SQL is installed on a third computer, make sure that the

Data Source token in the connection string includes the computer
name (e.g., it should be Data Source=ThirdPcName for SQL or
Data Source= ThirdPcName\PULSESQLEXPRESS for SQL
Express.

 If a firewall is installed, make sure it is correctly set up,

see Pulse Redundancy – Firewall Configuration.

 If SQL Replication is used, make sure it is correctly set up,

see SQL Server Configuration.

Pulse 4.12 User Guide 436

Setting up Pulse Redundancy
Virtual IP Address
The following process explains how to enable the Pulse Server to attach
the Virtual IP address.

NOTE The following is recommended if the Pulse Server service is

running in Windows 2012 and the Pulse Hot Redundancy
mode is configured with a Virtual IP.

a In Windows Server 2012, set the slider to Never notify in

the User Account Control Settings dialog box to partly
disable the UAC and click OK. Windows restart is not
required.

b In Windows Server 2012, the following registry key should be

modified.

c Access the Windows 2012 registry by typing regedit on the

Start > command field.

d On the Registry Editor window, click

HKEY_LOCAL_MACHINE > SOFTWARE > Microsoft >
Windows > CurrentVersion > Policies > System.

Pulse 4.12 User Guide 437

 e Double-click EnableLUA.

The Edit DWORD dialog box is displayed.

f Enter ‘0’ in the Value data field and click OK.

g Restart Windows Server 2012.

Pulse 4.12 User Guide 438

Defining Pulse Redundancy
Use the Redundancy Editor to define the Pulse Redundancy
configuration, which comprises the following sets of parameters:

 General Redundancy parameters

 Redundancy Project Synchronization parameters

To define the Redundancy Configuration

1 In the AFCON Pulse Program Group’s Development folder, double-

click the Pulse Redundancy icon.

The Pulse Redundancy Editor is displayed.

2 Select the Enable Hot Redundancy checkbox to display the fields

for Redundancy settings.

Pulse 4.12 User Guide 439

3 Define the General Redundancy parameters.

4 Define the Redundancy Project Synchronization parameters.

5 Click Save to save the redundancy configuration.

NOTE Some warnings and errors may appear on the lower part of the
Pulse Redundancy Editor dialog box. Correct all errors for
the Pulse Redundancy to run.

Pulse 4.12 User Guide 440

General Redundancy Parameters
In the General tab, configure the Redundancy options and IP addresses
for Redundancy.

Define the General Redundancy parameters as follows:

General Settings

Enable Hot Select this checkbox option to enable Pulse

Redundancy Redundancy.

Enable Selected by default

Communication
on Passive Server This option enables the passive server to
communicate with the project’s data servers: PLCs,
OPC and DDE servers. Deselect this option in case
PLCs cannot communicate with both servers at the
same time. Communication is always enabled on the
active server.

Pulse 4.12 User Guide 441

Enable the Selected by default.
Passive Server to
write to PLC This option enables the passive server to modify the
PLC’s registers. If enabled, make sure that no
contradiction occurs between both servers modifying
the same PLC’s registers at the same time.

Enable Editor Checkbox option unselected by default.

Logging
Select this checkbox option to record redundancy
activities in the Redundancy log. There are two
redundancy logs; one for each server. New log files
are created daily.

Both logs are saved in the Pulse project Alarms

folder as: YYMMDD_computer name_Redun.Log.
For example, the log file for “September 8, 2013”
shows “130908_computer-name_Redun.Log”.

Redundancy Virtual IP

Enable the active Checkbox option selected by default

server to attach
the Virtual IP to This option selects the redundancy mode:
its network card
 Virtual IP mode – the checkbox is checked

 Dual IP mode – the checkbox is unchecked

IP address The virtual IP address

Subnet Mask The subnet mask for your network.

The default subnet mask is 255.255.0.0.

Pulse servers are Select this option if the Pulse installations are on
running in Web Web servers. If so, the Virtual IP address has to be
Configuration assigned to a NAT Router. Contact your System
Administrator for information.

Set IP address Server #1, Server #2 - The static IP addresses for

used for TCP/IP each server. Clicking the icon displays a list of static
Communication IP addresses that are assigned for each server.

Pulse 4.12 User Guide 442

Set IP address When synchronizing the project files between the
used for Project servers, the files on Server #1 are the source files
files used to synchronize the project files on Server #2.
synchronization You may allocate a separate network card for the
synchronization to boost the performance.

However, it is also possible for the project files’

synchronization IP addresses to have the same IP
addresses as that of the TCP/IP communication.

Redundancy Project Synchronization Parameters

In the Project Synchronization tab, define project replication and
synchronization between the servers.

Pulse 4.12 User Guide 443

Define the Project Synchronization parameters as follows:

Synchronize This checkbox defines how the project’s SQL

project’s database is synchronized. By default, this checkbox
database is unchecked.

Pulse Redundancy supports the following project

synchronizations:

 Pulse replication – The checkbox is checked.

The Pulse replication option has to be applied
only when each server has its own SQL copy.

 Central database – The checkbox is

unchecked. This option has to be applied when
SQL is installed on a third computer and is
used by both servers.

 SQL replication – The checkbox is

unchecked. The SQL replication has to be
applied only in case each server has its own
copy of SQL. The SQL replication is done by
MS SQL tools.

This mode is recommended. Further settings is

required, see SQL Server Configuration.

NOTE When the Data Logger, EM Publisher, or

Audit Trail option is enabled in the
project, Pulse Replication cannot be
applied.

Synchronize Specify the interval for running synchronization

every __ polling scans on the project’s files.
seconds

Pulse project’s You must enable sharing on the Pulse project

share name on folder(s) in order to apply synchronization. Enter the
the other server project’s share name as UNC path on the server,
e.g., \\ReplicationIP\<ProjectSharedName>.

To locate the project, click the Browse button.

Synchronize This option is selected as default.

project’s path
and directories This option enables synchronization of the entire
Pulse project's files and sub-folders. Deselect it to
specify paths and files for synchronization (making
the following fields available).

Pulse 4.12 User Guide 444

Project’s paths Choose the project’s shared name.
to synchronize

Synchronize files Specify the file types (extensions) to synchronize.

of type *.* denotes all files.

Share name of Enter the project’s share name on the server.

the other server

Add/update path Click this button to enter the synchronization

parameters into the table.

NOTE Parameters that are not displayed in the

table are not synchronized.

Remove path Click this button to remove the synchronization

parameters from the table.

The table in the dialog box shows the synchronization information.

Pulse Redundancy – Firewall Configuration

When a firewall is configured for any of the servers in Pulse Redundancy;
the Windows Firewall and Advanced Security’s Inbound and
Outbound Rules have to be set.

Pulse Redundancy requires some ports to be available:

 Port 4000 should be open since it is the default port used by Pulse
Redundancy.

 Port 4000 + the Node Number of the servers should also be

open.

For example, when the server’s Node number is ‘1’, then port 4001
must be open.

The port and node number are configured by the P-CIM Network Setup
wizard.

Pulse 4.12 User Guide 445

Setting the Windows Firewall Inbound Rules
1 On your desktop, click Start > Control Panel > Windows
Firewall > Advanced Settings.

The Firewall with Advanced Security window is displayed.

2 Click Inbound Rules.

The Inbound Rules are displayed on the middle pane of the Firewall
with Advanced Security window.

3 Go to the right-most pane and click New Rule… in the Actions

list.

The New Inbound Rule Wizard – Rule Type window is displayed.

Pulse 4.12 User Guide 446

4 Select Port as the rule to create and click Next.

The New Inbound Rule Wizard – Protocol and Ports window is

displayed.

Pulse 4.12 User Guide 447

5 Select the Specific local ports option and enter the ports (i.e.,
4000 and 4000+’Server’s Node Number’), then click Next.

The New Inbound Rule Wizard – Action window is displayed.

6 Select the Allow the connection option and click Next.

The New Inbound Rule Wizard – Profile window is displayed.

Pulse 4.12 User Guide 448

7 Select Domain, Private, and/or Public to specify where to apply
the Inbound Rules and click Next.

The New Inbound Rule Wizard – Name window is displayed.

Pulse 4.12 User Guide 449

8 Enter a name for the Firewall’s Inbound Rules in the Name field.

9 Provide a description in the Description field (optional) then click

Finish.

The new firewall inbound rule is listed in the Actions pane of the
Windows Firewall and Advanced Settings window.

The new firewall inbound rule opens the selected ports for Pulse
inbound communication.

Setting the Windows Firewall Outbound Rules

1 On your desktop, click Start > Control Panel > Windows
Firewall > Advanced Settings.

The Firewall with Advanced Security window is displayed.

2 Click Outbound Rules.

The Outbound Rules are displayed on the middle pane of the

Firewall with Advanced Security window.

3 Go to the right-most pane and click New Rule… in the Actions

list.

The New Outbound Rule Wizard – Rule Type window is displayed.

Pulse 4.12 User Guide 450

4 Select Port as the rule to create and click Next.

The New Outbound Rule Wizard – Protocol and Ports window is

displayed.

5 Select the Specific remote ports option and enter the ports (i.e.,
4000 and 4000+’Server’s Node Number’), then click Next.

The New Outbound Rule Wizard – Action window is displayed.

6 Select the Allow the connection option and click Next.

The New Inbound Rule Wizard – Profile window is displayed.

7 Select Domain, Private, and/or Public to specify where to apply

the Outbound Rules and click Next.

The New Outbound Rule Wizard – Name window is displayed.

8 Enter a name for the Firewall’s Outbound Rules in the Name field.

9 Provide a description in the Description field (optional) then click

Finish.

The new firewall outbound rule is listed in the Actions pane of the
Windows Firewall and Advanced Settings window.

The new firewall inbound rule opens the selected ports for Pulse
outbound communication.

Pulse 4.12 User Guide 451

SQL Server Configuration
When replicating with two SQL database servers, the SQL Agent Publisher
Settings and the SQL Agent Subscription Settings must be configured.

SQL Server Agent Publisher Settings

General Preparations
1 Verify that there is enough free space in the hard disk.

One Terabyte of disk space is recommended for the SQL Agent

Publisher.

2 Select one of the servers to be the SQL Publisher.

3 On the SQL Server you selected as the SQL Publisher, verify that
the SQL Server Agent is running.

4 On this SQL Server, make sure that the relevant databases to be

replicated exist.

NOTE A simple recovery model is recommended for the database to

use up minimal storage disk space.

The Recovery mode can be edited by right-clicking on the

database and selecting Properties > Options.

5 If the New Distributor is not configured yet, right-click the

Replication folder on the SQL Object Explorer, and then click
Configure Distribution and follow the wizard.

6 Use the SQL management tool to shrink the database.

7 Backup the database. The database backup is needed if smoothing

fails and restoration is needed. Rename the backup since a new one
is created in the process.

Pulse 4.12 User Guide 452

Adding Rowguid with SQL Script
1 In the SQL Studio, select the database and open it.

2 Copy the following script (change the USE [My DB Name] to the
real DB name and run it). This action may take a while to
complete.

---------------------------------------------------------
use[weizmann]

DECLARE @tableName nvarchar(30)

DECLARE MY_DB_CURSOR CURSOR FOR select table_name from
INFORMATION_SCHEMA.TABLES order by table_name

OPEN MY_DB_CURSOR
FETCH NEXT FROM MY_DB_CURSOR INTO @tableName

WHILE @@FETCH_STATUS = 0
BEGIN
exec('alter table '+@tableName+' Add [rowguid]
[uniqueidentifier] ROWGUIDCOL NOT NULL CONSTRAINT
[DF_'+@tableName+'_rowguid] DEFAULT (newsequentialid())' )
FETCH NEXT FROM MY_DB_CURSOR INTO @tableName
END

close MY_DB_CURSOR
deallocate MY_DB_CURSOR
---------------------------------------------------------

It took about 14 minutes on a database with 110 million records in

LoggerValues tables.

This action added a rowguid column to each table and filled it with
unique IDs.

Configuring the Publication

1 On the SQL Server Object Explorer tree, click Replication and
right-click on the Local Publications folder then select New
Publication from the pop-up menu.

Pulse 4.12 User Guide 453

 The New Publication Wizard window is displayed.

2 Click Next to display the Distributor window.

Pulse 4.12 User Guide 454

3 Select the local server to be its own Distributor and click Next, see
image above.

The SQL Server Agent Start window is displayed.

4 Select the Yes, configure the SQL Server Agent to start

automatically option and click Next.

Pulse 4.12 User Guide 455

 The Snapshot Folder window is displayed.

5 Set the path for Snapshot folder, which will be the location for the
replication scripts.

6 Click Next.

7 Define the Sharing and Security properties for the folder.

8 Go to the snapshot folder (in this case, 'C:\Program Files\

Microsoft SQL Server\MSSQL10.MSSQLSERVER\MSSQL\
ReplData') and right-click Properties.

9 Share the folder as follows:

• Everyone as Read Only

• NT SERVICE/SQLSERVERAGENT as Full Control

10 Go to the Security tab and add the NT SERVICE/

SQLSERVERAGENT group with Full Control access rights.

Pulse 4.12 User Guide 456

11 Choose the database to replicate from the Publication Database
window then click Next.

12 In the Publication Type window, select the Merge publication

option as the Publication type.

Pulse 4.12 User Guide 457

13 Click Next to display the Subscriber Types window.

14 In the Subscriber Types window, leave the default value if both

the SQL Servers’ version is 2008 and click Next.

15 In the Articles window, check the All Tables checkbox option in

the Objects to publish area to replicate all tables.

For Pulse, uncheck the AlarmArc table.

Pulse 4.12 User Guide 458

NOTE When Subscriber inserts are replicated back to the Publisher,
identity columns must be managed to avoid assigning the
same identity value for both the Subscriber and the Publisher.
By default, automatic identity range management is enabled.
Otherwise set it to be automatic.

You can reduce the possibility for PK Identity key collision by

changing the Identity range size for the articles containing
Identity column.

Optional:

 Change the Identity range size by selecting a table and

selecting Set Properties of Highlighted of Table
Article.

Pulse 4.12 User Guide 459

  In the Identity Range Management, set automatically
manage identity ranges to Automatic.

 Increase the Publisher range size to 1000000.

 Increase the Subscription range size to 10000.

 Repeat this action for all tables containing identity

columns that are changing all the time. In Pulse, the
actions are AlarmLog, AlarmSys, EM_EVENTLOG,
and PcimAudit.

Pulse 4.12 User Guide 460

  For more information, see:

http://technet.microsoft.com/en-
us/library/ms152543.aspx

http://technet.microsoft.com/en-
us/library/ms146907.aspx

16 Uncheck the Schedule the Snapshot Agent to run at the

following times checkbox option.

17 Set the Security settings for the Snapshot agent.

Pulse 4.12 User Guide 461

18 Set Replication Name and click Finish.

Pulse 4.12 User Guide 462

19 Wait for the Publication to complete, see the following figure.

20 Wait for the Publication to be ready, refer to the image below.

It may take several minutes on a big database and it can be

monitored in the Replication monitor (View Snapshot Agent status).

21 When the Publication is active, create a full database backup, and

copy it to the subscriber.

Pulse 4.12 User Guide 463

SQL Server Subscription Settings
General Preparations
1 Select the second server to be the SQL Subscription.

2 Delete the database, if any already exist.

3 Restore the database backup, the one created after the Publication
succeeded.

4 Verify that the KEEP_REPLICATION option is not specified, see

https://technet.microsoft.com/en-
us/library/ms152488(d=printer,v=sql.105).aspx

Configuring the Subscription

1 Create the subscription in the second SQL server.

2 Choose the Publisher, the one created on the first SQL server.

Pulse 4.12 User Guide 464

3 In the Merge Agent Location window, select the Run all agents
at the Distributor. XXX (push subscriptions) option (default)
and click Next.

4 On the Subscribers window, select the empty database created on

the subscriber side.

Pulse 4.12 User Guide 465

5 Set the Merge Agent Security.

Pulse 4.12 User Guide 466

6 In the Synchronization Schedule window, set New Define
Schedule… to every 1 minute and click OK.

7 On the Initialize Subscriptions window, uncheck the Initialize

and click Next.

Pulse 4.12 User Guide 467

8 Continue with default options on the following windows and
complete the settings.

9 Use the monitor in the following figure for the subscription watch
list to see when the subscription initialization is completed.

Although Initiate is disabled, it still has some initiation to do.

10 Reduce the cleanup jobs frequency from 10 minutes to once every

few hours.

For more information, see https://technet.microsoft.com/en-

us/library/ms152488(d=printer,v=sql.105).aspx.

Pulse 4.12 User Guide 468

Troubleshooting Pulse Redundancy
The following are general guidelines on common issues which may occur
in Pulse Redundancy:

Problem Possible Cause Action

Pulse clients Virtual IP (VIP) is not  Make sure that the

cannot connect attached to any server. Virtual IP is not used
with the active by any other computer
server This can be seen using on the intranet.
the Windows ‘Network
Connection Details’ or  Make sure that unused
by using the ‘Ping’ network card(s) are
command. disabled and the
network cable is
plugged to the cards
that are used.

 Make sure that the

Afcon Server Service is
running with the User
account, not the
System account.

 Verify that the

Windows Registry
settings allow the user
to attach the Virtual IP,
as described above.

Virtual IP (VIP) is  Make sure that you

attached to the active have the correct
server settings in the
PfwRedunun.ini file in
project’s
Configuration folder,
DbsrRedundancy
section:

• The
PingReTries
token should be
set to ‘3’.

Pulse 4.12 User Guide 469

Problem Possible Cause Action

• The
PingTimeoutEx
token should be
set to ‘300’.

Project Project synchronization  Make sure that the

modifications failed. project replication
are lost after settings are correct, as
servers switch This can be seen in the described above.
from active to Redundancy log file(s),
passive or located under the  Make sure that the
vice-versa. DailyLog folder of the Afcon Server Service is
project. running with the User
account, not the
System account.

 Make sure that the

shared names used are
accessible by the User
account under the
Afcon Server Service
that is running.

 When the SQL engine

replication is used,
verify that the settings
are correct - as
described above.

The Project’s The Pulse Alarm  When SQL engine

alarms status Publisher displays replication is used,
do not match different alarm views verify that the settings
after servers when the Pulse client are correct - as
switch from connects to the new described above.
active to active server.
passive or  When SQL engine
vice-versa. replication is not used,
consider allowing
communication to PLCs
on both servers at the
same time.

Pulse 4.12 User Guide 470

Problem Possible Cause Action

Servers are not The  Verify Firewall settings,

communicating ‘!|$IsPassiveRunning’ see Pulse Redundancy
with each other tag shows ‘0’ but the – Firewall
passive server is up and Configuration. Make
running. sure to open the same
ports for Inbound and
Outbound
communications.

 Verify P-CIM Network

Settings by using the
P-CIM Network wizard.
Make sure that both
servers have the same
non-zero node number.

 Verify that the servers’

static IPs are correct.

Pulse 4.12 User Guide 471

The Report Data Editor
In the Report Data Editor, you can create and edit templates for text
(TXT), dBASE (DBF) and ODBC reports. You can keep a template of each
type under one name (i.e., in a single template file). To produce a report
of any type, you need to configure report operations, how to use the
system’s reporting and printing commands, see Reporting and Printing
Commands.

Starting Report Data Editor

 In the AFCON Pulse Program Group’s Development folder, double-
click the Report Editor icon or on your desktop click Start > All
Programs > AFCON Pulse > Development > Report Editor.

The Report Editor is displayed by default in the DBF Report Mode.

Pulse 4.12 User Guide 472

This section describes the report generation environment, and includes
the following topics:

 Opening and Saving Templates

 Configuring the TXT Template

 Creating and Managing TXT Templates

 Configuring the dBASE (DBF) Template

 Creating and Managing dBASE (DBF) Templates

 Defining the dBASE Index

 Designing the dBASE Index Sort and Range Expressions

 Configuring the ODBC Template

 Creating and Managing ODBC Templates

 Defining the ODBC Index

 Customizing the Report Data Editor’s Tools Menu

 Reporting and Printing Commands

Opening and Saving Templates

To work on a template, you must first open the file and choose the TXT,
DBF, or ODBC template. You can then operate on the template as
applicable:

 Add and edit text and fields

 Change the appearance of the template

 Annotate and change key parameters

 Print

To preserve your work, you must save it to store the version of the
template you see on your screen in a file on a disk.

Pulse 4.12 User Guide 473

Opening
When you start Report Data Editor, a blank form is displayed in the
window; you have to first create a new template or open one stored on
disk.

To continue work on a template stored on a disk, you open the template

using the File > Open command. If you have recently worked on the
template, you may be able to open it again by choosing it from the File
menu’s Recall list, where Report Data Editor lists the nine templates you
most recently opened.

The Report Data Editor can, under a single filename, hold a text (TXT)
template, a dBASE (DBF) template, and an ODBC template, and switch
among the template types as you work. When you execute the File >
New or Open command, the editor presents you the type you edited last.
To change to the other type, open the Report menu and choose the
respective report type.

NOTE Run the Preview command in the File menu to see a replica
of the runtime result.

To open a template

1 In the File menu, choose Open.

The Open file dialog box is displayed.

2 Enter the file name of a report template (with a .REP extension)

and click OK.

Pulse 4.12 User Guide 474

Saving
When you open an existing template, Report Data Editor copies it from
the disk where it is stored and displays the copy in a template window. As
you work, you are actually making changes to the copy of the template.
To keep your latest work safely on the disk, you should frequently save
your template.

Each time you save a template, the template remains open on your screen
so you can continue working on it.

To save the template

 From the File menu, click Save (or press <CTRL>+<S>).

To save the template as a different file

1 From the File menu, click Save As.

2 In the Save as File dialog box, enter the File Name to save the
template to, and click OK.

Deleting
When you no longer need a template, you can use the Windows Explorer’s
Delete command to delete it.

Pulse 4.12 User Guide 475

Configuring the TXT Template
In the TXT template configuration, you can add a description to the
template, change some of the options, and configure parameters for
runtime tracking.

To configure the TXT template’s global parameters

1 In the Report Data Editor, click Text in the Report menu to open a
TXT template page.

2 From the Report menu, click Configure.

The Configure TXT dialog box is displayed.

Pulse 4.12 User Guide 476

3 Define the TXT template parameters as follows:

Description Type a free text description for the template.

Time Out Specify the timeout (1 to 60 seconds) allowed

while waiting to establish DDE links to the
referenced variables. The operation proceeds
as soon as all the links are successfully
established.

Conversely, the operation fails if all the links

were not established within the time out
interval. In this case, the "DDE Item not found
character" is used to indicate the values of the
DDE item.

IO Wait The time delay (in seconds) between

establishing the DDE links, and reading the
values from the server. The purpose is to allow
the communication driver time to acquire
updated values from the PLC. If no data is
returned by the server by the end of this time,
the “No Data character” is used to indicate the
values of the DDE item.

Enter a value between 1 and 60.

NOTE If you change the following two parameters, inform the

Pulse user to facilitate report output interpretation.

No Data The character that you want to use during

character runtime for formatting a value which has no
data.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
data was obtained).

DDE Item Not The character that you want to use during
Found character runtime for formatting a value when the DDE
reference specified is not found.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
the reference was available, and the data was
obtained).

Pulse 4.12 User Guide 477

 Field Structure

The following characters are used when denoting a field in the

report text.

NOTE If you choose to change the following parameters, keep

a record to facilitate product and application support in
the future.

Start character The character that indicates the start of a field.

Separator string The character(s) that indicate a space between

commands and/or values within the field.

End character The character that indicates the end of a field.

Special

The following characters may also be used when designing the

report.

No Line Break The character(s) that indicate that the “words”

String immediately preceding and following these
characters must appear together on the same
line.

Form Feed The character(s) that force a new page at that

point.

Action On

Success Select the action to occur to indicate if the

report operation is successful.

Fail Select the action to occur to indicate if the

report action failed.

Timeout Select the action to occur to indicate if the

timeout period passed before the report data is
acquired.

4 Click OK to apply the TXT template configuration.

Pulse 4.12 User Guide 478

Creating and Managing TXT Templates
In the Report Data Editor, you can configure plain text report templates.
The editor is similar to a plain text editor, such as Notepad, with special
features which assist report template design. The special features are:

No Line Break The next line is placed at the end of the current line.

Form Feed A form feed character is inserted in this place when

the text is printed (with the command RepData and
the flag -P) - the printer starts a new page at this
point (the form feed character is not inserted in the
text file)

Field The actual value of the DDE item is inserted in this

place, formatted as specified.

Pulse 4.12 User Guide 479

Typing and Editing Text
You can type up to 255 characters and spaces in each line.

To move through text to select and to edit text, use the standard Windows
text navigation, selection, and editing features.

Formatting the Page

Use the formatting features to control page layout during runtime.

To format the runtime page

1 Place the cursor at the insertion point.

2 Do one of the following:

To obtain at runtime Enter

Append the next line to the end No Line Break mark (ALT+B)
of the current line

Force a page break at the end of Form Feed mark (ALT+M)

the current line when the text is
printed (with the command
RepData and the flag -P)

NOTE Any characters following the Form Feed mark in the same line
are ignored during runtime.

NOTE During runtime, any characters appearing after the No Line

Break will lose any special meaning and be interpreted as plain
text.

Pulse 4.12 User Guide 480

Inserting Fields
Insert fields to designate variable data to be inserted during runtime.

To insert a field

1 Place the cursor at the insertion point.

2 From the Edit menu, click Insert Field.

The Insert Field dialog box is displayed (already filled with the DDE
and Format specifications entered in the previous field).

3 Edit the field as follows:

DDE Edit the DDE reference: server|topic!item

Format Edit the format string. The number of

characters of the formatting string is shown on
the right.

4 Click OK.

To insert a pre-specified date or time field

1 Click Date or Time

2 Edit the field according to your preferences.

To insert again the field you last specified

1 Click Default Field.

2 Edit the new field according to your preferences.

Pulse 4.12 User Guide 481

Deleting Text and Fields
To delete a field

 Select the field and press the Delete key.

Previewing the Template

Use the Preview command in the File menu to see a replica of the
runtime result. In this view, plain text is shown as entered, and the
special elements are respectively illustrated as:

Field as its formatting string

Form Feed as \$ Followed by a row of dots

No Line Break The respective lines are concatenated

To preview the template

1 From the File menu, click Preview.

2 Do any of the following:

• To scroll the display, click the respective scroll bar or press

the relevant arrow key.

Additionally, press <CTRL>+<Home> and <CTRL>+<End>

to reach the top and bottom of the template, respectively.

• To find the exact location of a place in the text, press the

mouse button and observe the Line and Col indications at the
Report Data Editor’s bottom right corner.

• To print the preview, click Print.

3 To close the preview, click Close.

Pulse 4.12 User Guide 482

Configuring the dBASE (DBF) Template
In the dBASE (DBF) template configuration, you can add a description to
the template, change some of the options, and configure parameters for
runtime tracking.

To configure the DBF template’s global parameters

1 In the Report Data Editor, click dBase in the Report menu to open
a DBF template page.

2 From the Report menu, click Configure.

The Configure DBF dialog box is displayed.

3 Define the DBF template parameters as follows:

Description Type a free text description for the template.

Time Out Specify the timeout (1 to 60 seconds) allowed

while waiting to establish DDE links to the
referenced variables. The operation proceeds
as soon as all the links are successfully
established.

Conversely, the operation fails if all the links

were not established within the time out
interval. In this case, the "DDE Item not found
character" is used to indicate the values of the
DDE item.

Pulse 4.12 User Guide 483

 IO Wait The time delay (in seconds) between
establishing the DDE links, and reading the
values from the server. The purpose is to allow
the communication driver time to acquire
updated values from the PLC. If no data is
returned by the server by the end of this time,
the “No Data character” is used to indicate the
values of the DDE item.

Enter a value between 1 and 60.

Auto Indexing Select this option to update the index file

during runtime after each change in the DBF
file.

NOTE If you change the following two parameters, inform the

Pulse user to facilitate report output interpretation.

No Data The character that you want to use during

character runtime for formatting a value which has no
data.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
data was obtained).

DDE Item Not The character that you want to use during
Found character runtime for formatting a value when the DDE
reference specified is not found.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
the reference was available, and the data was
obtained).

Action On

Success Select the action to occur to indicate if the

report operation is successful.

Fail Select the action to occur to indicate if the

report action failed.

Timeout Select the action to occur to indicate if the

timeout period passed before the report data is
acquired.

4 Click OK to apply the DBF template configuration.

Pulse 4.12 User Guide 484

Creating and Managing dBASE (DBF)
Templates
In the Report Data Editor, you can configure dBASE (DBF) report
templates. The editor is used to define the structure of the dBASE file (the
fields in the typical record), and from where (Server, Topic, Item) the
data comes to each field.

Pulse 4.12 User Guide 485

Adding Fields
Add fields to define the structure of the dBASE record.

To add a field

1 In the table, select the field, after which you want to add a new
field.

2 Enter field parameters as follows:

DDE Enter the DDE reference of the data source.

Field Name Enter the dBASE name of the field.

Type Choose the field type: Character, Date,

Logical, or Numeric.

Width Enter the field width (number of characters).

Decimal Enter the maximum number of decimals in the

field.

3 Click Add.

The new field appears in the table.

Editing Fields
To edit a field

1 In the table, select the field you want to edit.

2 Change the field parameters as required. See the previous

procedure for parameter descriptions.

3 Click Change.

The changes appear in the table.

Pulse 4.12 User Guide 486

Moving Fields
You can change a field’s position in the list by moving it up or down.

To move a field

1 In the table, select the field you want to move.

2 To move the field up, click Move Up.

-or-

To move the field down, click Move Down.

Each time you click Move Up or Move Down, the field moves up
or down one row, respectively.

Deleting Fields
To delete a field

 Select the field and click Delete.

Pulse 4.12 User Guide 487

Defining the dBASE Index
Pulse supports up to 47 index keys per dBASE file. Each key is specified as
follows:

Key Name Unique name of up to 10 characters, no spaces

Sort expr Indicates the fields on which this key is indexed

Filter expr Defines the range of records selected (blank means

“all records”)

Unique This option is not currently used.

Descending Select this option to sort the index in descending

order.

Deselect this option to sort the index in ascending

order.

NOTE Only the non-unique indexing mode is supported.

For design guidelines, see Designing the dBASE Index Sort and Range
Expressions.

You can enable Automatic Indexing by selecting the Auto Indexing

option in the DBF Configuration. The index is refreshed each time a record
is added to the DBF file (alternatively, you can add the command
RepReIndex to a control in order to refresh the index separately).

To add a dBASE index key

NOTE Define the keys in their intended order: the primary key first,
and so on.

1 In the Report Data Editor, click Index.

The Index dialog box is displayed.

Pulse 4.12 User Guide 488

2 In the Settings box, select the key, after which you want to add
the new key.

3 Compose the key as follows:

Key Name Unique name of up to 10 characters, no spaces

Sort expr Indicates the fields on which this key is

indexed

If the Check button is enabled (black), the

sort expression is incorrect - click this button
to display the applicable error message.

Filter expr Defines the range of records to display (blank

means "all records").

If the Check button is enabled (black), the

filter expression is incorrect - click this button
to display the applicable error message.

Descending Select this option to sort the index in

descending order.

Deselect this option to sort the index in

ascending order.

4 Click Add.

5 Click OK to save the index.

Pulse 4.12 User Guide 489

To change a key

1 In the Report Data Editor, click Index.

The Index dialog box is displayed.

2 In the Settings box, select the key that you want to change.

The parameters are displayed in the respective boxes.

3 Change any applicable parameter. For descriptions of the

parameters, see the previous procedure.

4 Click Change.

5 Click OK to save the index.

To delete a key

1 In the Report Data Editor, click Index.

The Index dialog box is displayed.

2 In the Settings box, select the key that you want to delete.

3 Click Delete.

4 Click OK to save the index.

Pulse 4.12 User Guide 490

Designing the dBASE Index Sort and Range
Expressions
You can specify the following dBASE indexing expressions and options:

Key Name An arbitrary name of up to 10 characters (no

spaces)

Sort expr. An expression (max. 256 characters and spaces

long) whose value is evaluated for each record and
the result is sorted to create this key:

For example, "REAC_NUM + MAT_COD", where

"REAC_NUM" and "MAT_COD" are names of
character-type fields, and the result is a
concatenation of the two.

Descending A flag that defines whether to list the sort

expression’s result in descending or ascending order.

Filter expr. A logical expression (max. 256 characters and

spaces) that defines the record selection, e.g.,
"MAT_WGT>300". Default = “all records”.

Unique A flag that defines whether the key index is unique

or not - affects only the subsequent processing of
the dBASE file (e.g., when linking several databases
- a unique index produces an inner join)

NOTE A unique index is normally used with manual data entry, where
the operator is positively prevented by the data entry program
from adding a record with a non- unique key. In the Pulse
system, there is no interaction with an operator when records
are added, so Pulse ignores the unique specification. During
runtime, it adds non-unique records to a dBASE file with a
unique index specification.

Pulse 4.12 User Guide 491

Sort Expression
An index sort expression is a dBASE expression that determines the index
key for each record. A sort expression must be one of the following types:
Numeric, Character, or Date.

Observer the following guidelines for designing the Sort and Range
expressions for a dBASE index:

You can index a dBASE file in one of the following ways:

 On a single field

 On several compounded fields of the same data type

 On several compounded fields of different data types

Indexing on a Single Field Name

The most commonly used index sort expression is a field name - the
resulting index is sorted by that field. For example, to index a database by
the field "REAC_ID" (Reactor Number), create a key named "REAC_TAG"
(the name is arbitrary), and specify the sort expression "REAC_ID" (the
name of the data field).

Indexing on Several Fields of the Same Data

Type
Other common index expression use tags generated based on more than
one field. This is known as a Compound Index Key. The result is an index
key consisting of the sort expression.

Compound Numeric Indexing

Assume, for example, that you want to index a set of telephone numbers
contained in a telephone directory. Each number consists of a 3-digit Area
Code, contained in the "AR_COD" field, and a 7-digit number, contained in
the "PHO_NUM" field. You want the sort expression to produce a
"compound" 10-digit number. The index expression to order by area code
and number would be:

(AR_COD * 10 000 000) + PHO_NUM

For example, if an area code is 367, and a number was 1234567, the
result of the index would be:

(367 * 10 000 000) + 1234567 = 3671234567.

Pulse 4.12 User Guide 492

NOTE If some of the telephone numbers are only 6 digits (or less),
the "compound" number will have zeros in the missing digit
position(s). For example, for area code 367 and telephone
number 12345 (only 5 digits), the sort expression will result
in: 3670012345.

Compound Character Indexing

Using the telephone directory example again, assume that you again want
to index the entries, but this time by name.

Each name consists of a surname, contained in the "L_NAME" field, and a

first name contained in the "F_NAME" field. Each character field is seven
characters long, with any extra space being filled with spaces after the
data.

dBASE does this automatically. There are two methods of compound

indexing character fields (the symbol "" represents a space). For both
these examples the L_NAME field contains the data "SMITH", and the
F_NAME field contains the data “JOHN”.

Using this expression The result is:

L_NAME + F_NAME SMITHJOHN i.e., with the spaces kept

with their original field data.

L_NAME - F_NAME SMITHJOHN i.e., with all the spaces

moved to the end of the key.

Pulse 4.12 User Guide 493

Indexing on Several Fields of Different Data
Types
In this example, the numbers in the telephone directory consist of a three
digit area code in the numeric "AR_COD" field, and either a six or seven
digit number in the seven character "PHO_NUM" field (for a six digit
number, the space will be the last character in the field). To index the
records, you must first decide on the data type for the result to appear as,
numeric, or character.

To index with a final numeric field type

 Enter the expression:

AR_COD * 10 000 000 + VAL(PHO_NUM)

The VAL function converts the char_value (assumed in decimal

notation and according to the Pulse International Number Format
(e.g., United States: "1234.56", France: "1234,56", etc.) into a
dBASE number value.

NOTE The 1000 separator is displayed where applicable, but not

supported for data entry. Do not enter numbers with a 1000
separator (for example, enter 1234.56 or 1234,56 - not
1,234.56 or 1.234,56).

• For an area code of 367, and a telephone number of 123456,

the end result will be: 3670123456.

• For an area code of 367, and a telephone number of

1234567, the end result will be: 3671234567.

This ensures the index is in the correct order.

Pulse 4.12 User Guide 494

To index with a final character field type

 Enter the expression

STR(AR_COD) + PHO_NUM)

The STR function converts a numeric value into a string value - the length
is the total number of characters in the string, decimals is the number of
decimals, and LeadZero is an optional flag (1) to pad with leading zeros
instead of spaces. The function returns asterisks (*) if the value is too
large to represent within the allotted length.

• For an area code of 367, and a telephone number of 123456,

the end result is: 367123456.

• For an area code of 367, and a telephone number of

1234567, the end result is: 3671234567.

The use of the “-” concatenation operator does not make any difference in
this case.

Filter Expressions
A filter expression is a dBASE expression that returns a logical result, and
is used as a tag filter. This filter is evaluated for each record. If the result
of the evaluation is true, an entry for that record is included in the index.
If it is false, that recorded is ignored.

Pulse 4.12 User Guide 495

Configuring the ODBC Template
When you create your first ODBC template, the Configure ODBC dialog
box is displayed first, in which you configure the global parameters of the
ODBC template. You must specify at least the Data Source - without this
specification, Report Data Editor cannot proceed to specify the template
itself.

To configure the ODBC template’s global parameters

1 From the Report menu, click Configure.

The Configure ODBC dialog box is displayed.

NOTE If this is your first ODBC template, clicking ODBC in the

Report menu displays the Configure ODBC dialog box first.

2 Define the ODBC template parameters as follows:

Data Source Choose the data source (DSN) from the list of
all applicable DSNs.

Description Type a free text description for the template.

Pulse 4.12 User Guide 496

 Integrated Select this option to use Windows login
Security credentials to log into the ODBC database (as
long as the database supports the Windows
authentication feature).

NOTE If Integrated Security is enabled, the following User

Name and Password parameters are disabled. If this
option is disabled, you can use the database server’s
standard authentication.

User Name/ Database-specific login credentials for

Password accessing the ODBC database.

Time Out Specify the timeout (1 to 60 seconds) allowed

while waiting to establish DDE links to the
referenced variables. The operation proceeds
as soon as all the links are successfully
established.

Conversely, the operation fails if all the links

were not established within the time out
interval. In this case, the "DDE Item not found
character" is used to indicate the values of the
DDE item.

IO Wait The time delay (in seconds) between

establishing the DDE links, and reading the
values from the server. The purpose is to allow
the communication driver time to acquire
updated values from the PLC. If no data is
returned by the server by the end of this time,
the "No Data character" is used to indicate the
values of the DDE item.

Enter a value between 1 and 60.

Auto Indexing Select this option to update the index file

during runtime after each change in the ODBC
file.

NOTE If you change the following two parameters, inform the

Pulse user to facilitate report output interpretation.

Pulse 4.12 User Guide 497

 No Data The character that you want to use during
character runtime for formatting a value which has no
data.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
data was obtained).

DDE Item Not The character that you want to use during
Found character runtime for formatting a value when the DDE
reference specified is not found.

For example, if using the default character [?],

a value with the format ###.## will show as
???.?? (instead of, for example - 123.45 - if
the reference was available, and the data was
obtained).

Action On

The Operator Workstation can execute an action each time it

executes a RepData command (acquiring report data) with this
template, according to the result of the command: Success, Fail, or
Timeout.

Success Select the action to occur to indicate if the

RepData action is successful.

Fail Select the action to occur to indicate if the

RepData action fails.

Timeout Select the action to occur to indicate if the

timeout period passed before the report data is
acquired.

3 Click OK to apply the ODBC template configuration.

Pulse 4.12 User Guide 498

Creating and Managing ODBC Templates
In the Report Data Editor, you can configure ODBC report templates. The
editor is used to define the record fields of the ODBC data source table,
and from where (Server, Topic Item) the data comes to each field.

Pulse 4.12 User Guide 499

Adding Fields
Add fields to define the structure of the ODBC record.

To add a field

1 In the table, select the field, after which you want to add a new
field.

2 Enter field parameters as follows:

DDE Enter the DDE reference of the data source.

Field Name Enter the ODBC name of the field.

Type Choose the field type: Character, Date,

Logical, or Numeric.

Precision For a numeric field type, specify the maximum

number of digits in the field.

For a non-numeric field type, specify the

maximum length for the field.

Scale This parameter is only applicable for numeric

field types.

Specify the maximum number of digits to the

right of the decimal point. For floating point
values, the scale is undefined because the
number of digits to the right of the decimal
point is not fixed.

3 Click Add.

The new field is displayed on the table.

Pulse 4.12 User Guide 500

Editing Fields
To edit a field

1 In the table, select the field you want to edit.

2 Change the field parameters as required, see the previous

procedure for parameter descriptions.

3 Click Change.

The changes are displayed on the table.

Moving Fields
You can change a field’s position in the list by moving it up or down.

To move a field

1 In the table, select the field you want to move.

2 To move the field up, click Move Up.

-or-

To move the field down, click Move Down.

Each time you click Move Up or Move Down, the field moves up
or down one row, respectively.

Deleting Fields
To delete a field

 Select the field and click Delete.

Pulse 4.12 User Guide 501

Defining the ODBC Index
Pulse supports up to 47 index keys per ODBC file or table. Each key is
specified as follows:

Key Name Unique name of up to 10 characters, no spaces.

Sort expr Enter the Sort order expression, which indicates the
key fields, field sort precedence, and sort direction
per field, on which this key is indexed.

Unique This option is not currently used.

NOTE Only the non-unique indexing mode is supported.

You can enable Automatic Indexing by selecting the Auto Indexing

option in the ODBC Configuration. The index is refreshed each time a
record is added to the ODBC file.

To add an ODBC index key

NOTE Define the keys in their intended order: the primary key first,
and so on.

1 In the Report Data Editor, click Index.

The Index ODBC dialog box is displayed.

2 In the Settings box, select the key, after which you want to add
the new key.

Pulse 4.12 User Guide 502

3 Compose the key as follows:

Key Name Unique name of up to 10 characters, no spaces

Sort expr Indicates the fields on which this key is indexed

If the Check button is enabled (black), the sort

expression is incorrect - click this button to
display the applicable error message.

4 Click Add.

5 Click OK to save the index.

To change a key

1 In the Report Data Editor, click Index.

The Index dialog box is displayed.

2 In the Settings box, select the key that you want to change.

The parameters are displayed in the respective boxes.

3 Change any applicable parameter. For descriptions of the

parameters, see the previous procedure.

4 Click Change.

5 Click OK to save the index.

To delete a key

1 In the Report Data Editor, click Index.

The Index dialog box is displayed.

2 In the Settings box, select the key that you want to delete.

3 Click Delete.

4 Click OK to save the index.

Pulse 4.12 User Guide 503

Customizing the Report Data Editor’s Tools
Menu
The Report Data Editor’s Tools menu contains predefined links to various
Pulse Development, Runtime, and Setup applications. Additionally, you
can add links to additional applications which you need to access while
working in the Report Data Editor (or other commands).

To add commands to the Tools menu

1 From the Options menu, click Tools.

The Tools dialog box is displayed.

2 Click Add and browse to locate and select the application to add to
the Tools menu.

The application details appear in the Tools dialog box:

Menu Contents List of user-defined commands that have been

to the Tools menu.

Path Name The location of the application file.

Menu Text The text string that appears in the Tools Menu.
To assign a keyboard combination
(<ALT>+<key>), type “&” after the label
name and then the letter or number.

Arguments Type any required arguments required for the

application’s command line.

3 Click OK to add the user-defined commands to the Tools menu.

Pulse 4.12 User Guide 504

To delete user-defined commands from the Tools menu

1 From the Options menu, click Tools.

The Tools dialog box is displayed.

2 In the Menu Contents list, select the name of the application and
then click Delete.

The application name and details disappear from the Tools dialog
box. No confirmation is requested.

3 Click OK.

The application has been removed from the Tools menu.

To change the location of a user-defined command in the Tools

menu

1 From the Options menu, click Tools.

The Tools dialog box is displayed.

2 In the Menu Contents list, select the name of the application and
then click either Move Up or Move Down.

Each time you click one of the buttons, the command moves one
line up or down, respectively, in the Menu Contents list.

3 When the command is at the required location, click OK.

Reporting and Printing Commands

The following commands control the collection of data for reports, and
their display.

PrintDisp Prints the specified Operator Workstation display

RepData Acquires data to the report file using the

specified template

RepDataStop Unloads the specified template from memory

ReportTrend Produces tabular report of trended data

RepReIndex Creates/updates the index file (MDX) associated

with a DBF file.

Pulse 4.12 User Guide 505

The Sequence of Events Recorder
(SER)
The SER can now be accessed through the Database tree within the Pulse
Developer Workstation.

The SER has a graphical user interface (GUI). It is based on a new block
type called SER. The SER block contains fields for the PLC registers for the
alarm data (time, value, and event ID).

Each event ID (PLC register) is attached with an alarm condition value.

The value (PLC value register) is inserted to the ALM_VALUE field in the
Alarm log table. The Event ID is the alarm condition name.

Pulse can use unlimited SER Blocks in the application but SER is limited to
the database capacity of 32000 blocks.

SER logic only supports one mode, which shows events in the Alarm
Explorer log, uses Pulse blocks and alarm conditions.

To create a SER block (new GUI)

1 On the Database Explorer Database tree, right-click on the Ser

block and select New Block from the pop-up menu.

The Create New (Ser) dialog box is displayed.

Pulse 4.12 User Guide 506

2 Provide a unique block name in the Block Name field; the block
name will be associated with the event.

3 In the General tab, provide the following parameters:

General tab

Enable Select this checkbox option to enable the

functionality for the selected SER section.
Deselect this option to disable it.

Description Enter the SER block description or select an

available description from the drop-down list
(if any).

Security Set the security level of the SER block

providing it with its level of authorization
from 0 to 99.

Event ID Address The address of the event identification

number.

Enter the address of the event identification

number.

For example, Event ID = 3:1:40202, A:1

It is recommended to set the Semaphore

and the Event ID to the same address. In
this case, Event ID = 0 means that there are
no events.

Show Event ID Check this checkbox option to display the

Event ID.

Value Address Define the address of the value of the event.

Pulse 4.12 User Guide 507

 Enable Value Check this checkbox option to enable the
defined value.

Semaphore Enter the address of the semaphore such as

Address SEM=3:1:402001.

MMDD Address The default is empty. If typed-in, the event

ID is displayed in the message in square
brackets, such as [EventID].

HHMM Address Enter the address of the Hours and Minutes

part of the event presentation time stamp,
such as HHMM=3:1:402003.

SSMS Address Define the address of the Seconds and

Milliseconds event time stamp register. The
interpretation is governed by the Sub-second
Resolution setting.

Target Block Target blocks are database blocks which

receive data values from other initiating
blocks.

The destination within the target block (and

the effect) of the data values sent from the
initiating block are specified in the initiating
block’s Targetlogic.

Select the target SER block from the drop-

down list. The available target blocks(s) are
the SER blocks that were already created
and appear under the Ser tree.

4 Click Save and go to the Events tab.

Pulse 4.12 User Guide 508

5 In the Events tab, provide the following parameters:

Events Prefix

Description Enter a description of the event.

Align Select Left or Right from the drop-down list

options.

Event ID The Event ID sequential number.

Description Enter a description for the event.

Name The event number, i.e., Event:1, Event:2,

etc.

Location Enter the location of the alarm or select from

the drop-down list.

Functional Specifies if the event's alarm bit is

Functional or otherwise

Category Displays the category of the alarm, the

default is 'Category 0'

6 Click Save, Save As or Close to continue.

Viewing SER Events in the Alarm Handler

The Alarm Handler presents SER events only in the Bloc Types\Ser alarm
summary window, in their specified zone. The following is the Block
Types\Ser window, where SER alarms are displayed.

Pulse 4.12 User Guide 509

The following are the Block Types\Ser window parameter details:

Alarms

The columns that show the alarms associated with the event. When
clicking the + sign in the Alarms column; the alarm's details are
displayed.

Alarm Name The name of the alarm

Alarm A description of the alarm

Description

Low Range The low range value

High Range The high range value

Condition Type The type of condition

Active Action Define an action when the alarm is active.

Return to Normal Define an action when the alarm returns to normal.

Action

Ack. Action Define an Acknowledge action item from the Action

Selector window.

On Double Click Define an action item that is triggered when double-

Action clicking the mouse.

Other Block/SER window parameters:

Block Type The type of block, in this case it is Ser.

Block Name The block name associated with the event, (the
association is configured in the PCIMUSER.INI file,
section [PCIMSER].

Address The item address

Scan Time The specified period to scan the Ser block.

Block Description The block description (configured in the Database

Explorer).

Alarm Enable Click to select this checkbox option to enable the

alarm.

Security The security level of the SER block, the level of

authorization from 0 to 99.

Pulse 4.12 User Guide 510

The Alarm Handler
The Alarm Handler is a tool for monitoring and acknowledging alarms and
event messages. During runtime, it allows users to monitor and respond
to status changes in the monitored locations and equipment, and
variables.

The main Alarm Handler windows display:

Alarm Summary Alarm and system messages in chronological order

(up to the last 1000)

Current Alarm Active alarm messages (up to the last 1000)

Daily Log All alarm and system messages for a given day. This
window is accessible from the File menu of both the
Alarm Summary and the Current Alarm windows.

Starting Alarm Handler

NOTE For effective application testing, it is recommended to start
Alarm Handler immediately after starting up the Pulse Server
and services, so that you can monitor potential system
problems.

To open the Alarm Handler module

1 In the Pulse Program Group’s Runtime folder, double-click the

Alarm Handler icon.

The Current Alarm and Alarm Summary windows are displayed.

Pulse 4.12 User Guide 511

This section includes the following topics:

 Alarm Handler Configuration

 The Alarm Summary Window

 The Current Alarm Window

 The Daily Log Window

Pulse 4.12 User Guide 512

Alarm Handler Configuration
The following sections describe how to set up the Alarm Handler for your
requirements:

 Setting Alarm and Event Capacity

 Setting Alarm Handler Colors

 Setting Message Font in Alarm Handler Windows

 Setting the Alarm Sound

 Setting Alarm Handler Window Style

 Setting Zone Names

 Setting Up Printing from Alarm Handler

 Setting the Current Alarm Window to Pop Up on Alarm

 Setting the Current Alarm Window to Display Old Alarms

 Showing and Hiding Zones in Alarm Handler

 Setting Acknowledge Options in Alarm Handler

 Configuring Alarm Transport

Pulse 4.12 User Guide 513

Setting Alarm and Event Capacity
By default, the Alarm Handler can handle up to 256 alarm and event
messages in the Alarm Summary window, and up to 256 current alarms in
the Current Alarm window.

NOTE You can increase this capacity to up to 1000. In the project’s

pcimuser.ini file, go to the [PCIMAlmH] section and change
the MaxEvents parameter to the new capacity.

Consider the following when setting capacity:

Alarm Handler Can accept up to that number of alarm and event

messages at one time (normally generated by
Database Solver in one database scan - excess is
discarded and will not show in the Daily log).

Alarm Summary Displays up to the maximum number of most recent

messages (older messages are discarded - but will
show in Daily Log).

Current Alarm Displays up to the maximum number of current

alarms (the excess is not shown).

Setting Alarm Handler Colors

You can customize the colors in which messages are presented in Alarm
Handler windows. The colors are set in the project’s pcimuser.ini file,
section [PCIMAlmH], settings REDCOLOR, BLUECOLOR,
BLACKCOLOR, GRAYCOLOR and WHITECOLOR, as their respective
red-green-blue (RGB) components. R, G, and B can each be set in a range
from 0-255.

 Active alarm color (default red - 255,0,0,0)

 Acknowledged alarm color (default blue - 0,0,255,0)

 System message color (default black - 0,0,0,0)

 Alarm no longer in alarm condition color (default gray -

128,128,128,0)

 Message background color (default white - 255,255,255,0)

Pulse 4.12 User Guide 514

Setting Message Font in Alarm Handler Windows
You can change the typeface (font, style, size, and horizontal spacing)
that Alarm Handler uses to display the alarm and event messages in its
various windows. The change affects all Alarm Handler windows.

To change the font

1 From the Options menu, choose Font.

2 In the Font dialog box, select the font, style, and size.

3 Click OK.

If the selected font is a proportionally spaced font, the messages will not
be aligned vertically in their respective columns. You can force a
proportionally spaced font to display the content in monospacing, which
forces fixed alignment of all characters and columns.

NOTE It is not recommended to use very large fonts.

To force monospacing

1 From the Options menu, choose View Monospaced. Observe the

display in the open Alarm Handler windows.

2 To change the monospaced character spacing, choose

Monospaced Width from the Options menu.

3 In the Monospaced Width dialog box, do one of the following:

• To force the monospacing to a different pitch, change the

value in the Width box.

• To return the monospacing to the default pitch of the current

font, enter -1 in the Width box.

4 Click OK to change the setting for the current session only.

-or-

Click Save Settings to change the setting for the current session
and subsequent sessions.

Pulse 4.12 User Guide 515

Setting the Alarm Sound
To turn on an alarm sound in the Current Alarm window

 In the Current Alarm window’s Options menu, choose Beep.

This option is a toggle, alternately turning the Beep sound on and

off each time you click the command

When you first enable the alarm sound using the Beep command in the
Options menu of the Current Alarm window, the Windows’ Default
Beep event, associated with the DING.WAV file, is installed. Thereafter,
Pulse invokes that sound on every alarm occurrence.

Install a Windows sound device in order to use this function. Without a

sound device, you get a short "beep" on the computer speaker, which
may be difficult to hear.

Use the first procedure below to manually install the Windows

BeepOnAlarm event and its sound.

Use the second procedure below to change the sound (wave file)
associated with the Windows BeepOnAlarm event.

To manually install the Windows Default Alarm sound

1 Open the win.ini file in an editor (such as Notepad).

2 In the [sounds] section, add the following line:

BeepOnAlarm=ding.wav,,

3 Save the file.

To change the alarm sound

1 Open the Windows Control Panel.

2 Open the Sound devices properties.

3 Choose Default Beep from the Events list.

4 From the Sounds list, choose a wav file. Browse to another drive
and folder if necessary.

5 Click OK.

Pulse 4.12 User Guide 516

Setting Alarm Handler Window Style
Use the Window Style command of the Options menu of the Alarm
Summary window to set the window style features of Alarm Handler
windows.

Your choices can be made effective for the current session only, and can
also be recorded as respective window style settings in the project’s
pcimuser.ini file, to be used in subsequent sessions.

To set window style

1 From the Options menu, choose Window Style.

The Window Style dialog box is displayed.

2 To enable a feature, select its respective checkbox, and deselect

the checkbox to disable it:

MinMax Show/hide the window Minimize and

Maximize/Restore buttons

Title Show/hide the Alarm Summary and Current

Alarm title bars

Frame Show/hide the window frame

System Menu Show/hide the window System Menu box

Menu Show/hide the window menu bar

Move Enable/disable the window move operation

Size Enable/disable the window resize operation

Close Enable/disable the Alarm Summary window

close operation

Always On Top Enable/disable the Always On Top feature of all

Alarm Handler windows

Use Title Setting Use the same Title setting for the Daily Log and
on Dailylog and Zones windows
Zones

3 To set the window position and size, enter the required pixel
coordinates in the Left, Top, Width and Height boxes.

For automatic sizing according to the chosen Font, enter -1 in all

four boxes.

Pulse 4.12 User Guide 517

4 To apply the settings to the current session, click OK.

To apply the settings to the current session and save them for
subsequent sessions, click Save Settings.

Setting Zone Names

Zone Names are similar to the Branches that you configure in the Pulse
Database Explorer, see Branch. They represent the various zones that are
being monitored and/or controlled in your organization’s facilities. It is
recommended to use the same names that were defined in the
Functional, Locational, and Category trees of the Database Explorer.

To set the Zone Names for the Alarm Handler

1 In the project’s pcimuser.ini file, section [PCIMZones], change the

value for each relevant zone parameter. For example:

Zone01=Reception

Zone02=Warehouse

Zone03=Extrusion

2 Save the pcimuser.ini file.

In the Alarm Summary and the Current Alarm windows, the

Zone menu displays the names that you defined above.

NOTE For proper presentation in the Zone menu of the Alarm

Summary and the Current Alarm windows, consider the
following:

• The names are not long (70 characters maximum, 20-40

recommended).

• Place the "&" character in front of the character that will be

the shortcut accelerator (will appear underlined in the menu,
indicating that Alt+Z+[chosen character] will open the zone
window).

Pulse 4.12 User Guide 518

Setting Up Printing from Alarm Handler
Alarm Handler can automatically print all the alarm and event messages
as they occur chronologically). In addition, the operator can print the
entire daily log, or the daily log of a particular zone to the Windows
default printer.

To set the type of printing (page printer, line printer)

1 From the Alarm Summary’s Print menu, choose Line Printer

Settings.

The Line Printer Settings dialog box is displayed.

2 Set the following parameters:

Line Printer Select this option to print one line at a time to

a line printer (such as a dot matrix printer).

Deselect this option to print page by page to a

standard page printer (default)

LPT Specify the printer port.

3 Click OK.

Setting the Current Alarm Window to Pop Up on

Alarm
When not on top of other windows, the Alarm Handler draws the attention
of the operator to the occurrence of a new alarm by flashing the title bars
and icons of all its open windows.

In addition, the Current Alarm window can pop up in the foreground.

To pop up the Current Alarm window when a new alarm occurs

 In the Current Alarm window’s Options menu, choose Pop Up.

This command is a toggle - if a check mark appears next it, the

command is already turned on.

NOTE This setting is carried over to the next session.

Pulse 4.12 User Guide 519

Setting the Current Alarm Window to Display Old
Alarms
You can configure whether and how the Current Alarm window displays all
the alarms that occurred when Pulse system was off.

To define how to display alarms that occurred before system

startup

 In the project’s pcimuser.ini file, section [PcimDBSR], change the

value of the NewStartUpCurrAlmMethod parameter to:

0 Do not display the alarms that occurred while

the Pulse system was off.

1 Display the alarms with a "??:??:??" (unknown)

time stamp.

3 Display the alarms with the time stamp for the

time of Alarm Handler startup.

Showing and Hiding Zones in Alarm Handler

The Show Zones command lets you define which zones - of the 11
supported - to display in the Alarm Summary and Current Alarm
windows.

To define which zones to show

1 In the Alarm Summary window’s Options menu, choose Show

Zones.

The Show Zone dialog box is displayed.

2 By default, all zones are enabled. Deselect the zones that you want
to hide and keep selected the zones that you want to display.

3 To apply the settings to the current session, click OK.

4 To apply the settings to the current session and save them for
subsequent sessions, click Save Settings.

Pulse 4.12 User Guide 520

Setting Acknowledge Options in Alarm Handler
You can define whether Alarm Handler produces an event message for
every alarm acknowledged, and to which zone such messages are sent.

To configure acknowledge options

1 In the Current Alarm window’s Acknowledge menu, choose Ack.

Messages.

The Ack. Messages dialog box is displayed.

2 Set the following Acknowledge parameters:

Enable Ack Select this option to produce a message

Messages whenever an alarm is acknowledged.

Ack. Message Choose the zone to which the system sends

Zone the Acknowledge messages.

Choose Per Alarm Zone to send the messages

to the same zones in which the alarms
originated.

3 Click OK.

Pulse 4.12 User Guide 521

Configuring Alarm Transport
You can use Alarm Handler for sending the alarm, event, and
acknowledgement messages from Alarm Handler to the Pulse Server
nodes on which the Alarm Publisher Service is running.

Pulse executes the Alarm transport according to the Pulse Network Setup,
see Configuring Network Nodes.

The relevant settings are detailed below:

General Parameters

NodeName/NodeNumber Enter the name and number of the Pulse

Server on which the Alarm Publisher Service
is running.

DBSR Nodes

ShowAliveMessage Use the default value - 0

ShowMaintMsg Use the default value - 1

RefuseUnlisted Use the default value - 0

ConnectUnlisted Use the default value - 1

AliveMsgTimer Use the default value - 5000

DGramTimer Use the default value - 2000

ReconnectTimer Use the default value - 5000

PortOffset Use the default value - 4000

DGramIdentification Use the default value - 0

NumberOfDGrams Use the default value - 10

IPADDRxxx Indicates the node number and the IP

address of the Pulse Server on which the
Alarm Publisher service is running.

Pulse 4.12 User Guide 522

The Alarm Summary Window
In the Alarm Summary window, you can view the most recent alarm and
system messages in chronological order (up to the last 1000).

This section includes the following topics:

 Viewing Messages in the Alarm Summary Window

 Printing from the Alarm Summary

 Producing Log Text Files

 Accessing other Windows from the Alarm Summary Window

 Using the Zone Alarm Summary Window

Viewing Messages in the Alarm Summary

Window
The different colors of messages indicate:

Red Active alarms

Gray Alarms no longer in alarm condition

Blue Acknowledged alarms

Black System messages

To see the most recent messages when the list is not full yet, scroll down.

Printing from the Alarm Summary

In the Alarm Summary window, you can globally start or stop the online
printing function, and, if started, select which kinds of messages are
printed.

To turn on the online printing from the Alarm Summary

 In the Print menu, click Start.

To turn off the online printing from the Alarm Summary

 In the Print menu, click Stop.

Pulse 4.12 User Guide 523

To print various types of messages and included data

 In the Print menu, click the relevant command:

Print Events Prints event messages

Print Alarms Prints alarm messages

Print Node Prints the node number of the server from

which the message originated

Print Date Prints the date next to the time stamp of the
message

NOTE To control the frequency that the date is printed (date printed
every n number of lines), you can set it in the project’s
pcimuser.ini file, section [PCIMAlmH]. Set PrintDateStr to
the required n number of lines (for example, PrintDateStr=10
will print the date every 10 lines).

Producing Log Text Files

Convert a daily log file to text to use it in another application (such as an
editor).

To convert any daily log file to text format

1 From the Alarm Summary’s File menu, choose Log File to Txt
File.

The Log to Txt: Select File dialog box is displayed.

2 Open the log file that you need. The files are named using the
following format:

YYMMDDxxx.log

Pulse 4.12 User Guide 524

Accessing other Windows from the Alarm
Summary Window
The Alarm Summary window provides easy access to other windows of
Alarm Handler.

The Current Alarm window initially overlaps the Alarm Summary

window.

The Daily Log window initially displays the file of today.

To access another window

 From the File menu, choose the respective command:

• Current Alarm

• Show Daily Log

To open a zone window

 From the Zone menu, choose the name of the zone (check marks
indicate zone windows that are currently open).

Using the Zone Alarm Summary Window

Use the Zone Alarm Summary window to view the most recent alarm
and system messages of the specified zone in chronological order. The
zone is identified in the window’s title bar.

Message Colors

The different colors of messages indicate:

Red Active alarms

Gray Alarms no longer in alarm condition

Blue Acknowledged alarms

To see the most recent messages when the list is not full yet, scroll down.

In the System Zone window:

Black System messages

Pulse 4.12 User Guide 525

To access another window

 From the Zone window’s File menu, choose the respective

command:

• Current Alarm

• Show Daily Log

The Current Alarm Window

Use the Current Alarm window to view active alarm messages in
chronological order (up to the last 1000).

This section includes the following topics:

 Working in the Main or Zone Current Alarm Window

 Accessing other Windows from the Current Alarm Window

Working in the Main or Zone Current Alarm

Window
Message Colors

The different colors of messages indicate:

Red Unacknowledged alarms

Blue Acknowledged alarms

Black Selected alarms (for subsequent acknowledging)

background

Pulse 4.12 User Guide 526

Pop Up Current Alarm Window on Alarm
When an alarm occurs, the Current Alarm window can pop up in the
foreground.

To pop up the Current Alarm window when a new alarm occurs

 In the Current Alarm window’s Options menu, choose Pop Up.

This command is a toggle - if a check mark appears next it, the

command is already turned on.

NOTE This setting is carried over to the next session.

Acknowledge Alarms
You can acknowledge any unacknowledged alarm (indicated in red) one by
one, or several at a time.

To acknowledge one alarm

1 Select the alarm.

2 From the Acknowledge menu, choose Ack Alarm.

The alarm message turns blue.

To acknowledge several alarms

1 Select the alarm.

2 From the Acknowledge menu, choose Mark.

3 Repeat step 1 and 2 for other alarms.

4 From the Acknowledge menu, choose Ack Alarm.

The alarm messages turn blue.

To clear an alarm marked for acknowledging

1 Select the alarm.

2 From the Acknowledge menu, choose Clear.

Pulse 4.12 User Guide 527

To clear all alarms marked for acknowledging

1 Select the alarm.

3 From the Acknowledge menu, choose Clear All.

Accessing other Windows from the Current

Alarm Window
The Current Alarm window provides easy access to other windows of
Alarm Handler.

The Current Alarm window initially overlaps the Alarm Summary

window.

The Daily Log window initially displays the file of today.

To access another window

 From the File menu, choose the respective command:

• Alarm Summary

• Show Daily Log

To open a zone window

 From the Zone menu, choose the name of the zone (check marks
indicate zone windows that are currently open).

Pulse 4.12 User Guide 528

The Daily Log Window

In the Daily Log window, you can view all the alarm and system
messages for a given day.

To open the Daily Log window

 From the Alarm Summary or Current Alarm’s File menu, choose

Show Daily Log.

Message Colors

The different colors of messages indicate:

Gray Alarm messages

Black Event messages

To open a different Daily Log file

1 From the Daily Log’s File menu, choose Open.

The Daily Log: Select File dialog box is displayed.

2 Open the log file that you need.

The files are named using the following format:

YYMMDDxxx.log

To print the Daily Log on the default Windows printer

 From the Daily Log’s File menu, choose Print.

Pulse 4.12 User Guide 529

To print a filtered version of the Daily Log

1 From the Daily Log’s File menu, choose Selective Print.

The Print dialog box is displayed.

2 Filter the content to print as follows:

Nodes Enter the specific node number(s) from where

to print. All indicates printing from all Pulse
server nodes.

Zones Enter the specific zone number(s) from where

to print. All indicates printing from all of the
project’s zones.

Start Time Specify the earliest time from which to print

log entries.

End Time Specify the latest time from which to print log
entries.

Alarms Select this option to print alarm message

entries.

System Select this option to print system message

Messages entries.

3 Click OK to send the filtered log to the printer.

To access another window

 From the File menu, choose the respective command:

• Alarm Summary

• Current Alarm

Pulse 4.12 User Guide 530

Daily Log Zone Window
Using the Zone Daily Log Window

In the Daily Log Zone window, you can view all the alarm and system
messages in the zone for a given day.

To open a zone log window

 From the Daily Log’s Zone menu, choose the name of the zone
(check marks indicate zone windows that are currently open).

Message Colors

The different colors of messages indicate:

Gray Alarm messages

Black Event messages

To print the zone’s Daily Log on the default Windows printer

 From the zone Daily Log’s File menu, choose Print.

Pulse 4.12 User Guide 531

The Pulse Client
The Pulse client station is the user’s (operator and/or developer) interface
with their projects. The entire project's files remain stored on the Pulse
server and the remote client user logs into the project over the network.

A client workstation can run from a computer’s web browser. A client

workstation can also run from a Flash drive connected to one of the
computer’s USB ports, as long as the master host name or IP address is
configured as the server in the client workstation configuration file.

On the Pulse Client, the project may be accessed through both a

Developer and Operator workstation in one of the following ways:

 Simultaneous operation of both - if one workstation closes, the

other one continues working with its respective Pulse server
independently.

To use this mode, define Project Setup > Settings >

Workstation > Working Mode > Use Single Instance to False.

 Toggle operation, in which the user can switch from one

workstation mode to another within one application window. While
the workstation is running in one mode, the other mode stops.

To use this mode, define Project Setup > Settings >

Workstation > Working Mode > Use Single Instance to True.

This section includes the following topics:

 The Pulse Client Developer Workstation

 The Pulse Client Operator Workstation

Pulse 4.12 User Guide 532

The Pulse Client Developer
Workstation
The process of designing project components (creating displays, inserting
and defining graphic objects, instruments and controls), creating and
configuring database blocks, alarms and more, is done in the Developer
Workstation.

In the Developer Workstation, users can navigate between the following

modes:

 Graphics - The user populates the display with static and dynamic
objects and configures them in the Graphics mode.

 Database - The user creates and configures data blocks which

include alarms, events, and the conditions that trigger them, as
well as the resulting actions.

 Recipes - The user creates and configures a group of data items

that sends and receives associated values to and from the PLC.
Recipes may be defined to run automatically during runtime, or to
be triggered by an operator by clicking an action button.

 Data Logger – In this mode, any item data is collected and saved
into a compatible user database or to a spreadsheet such as
Microsoft Excel. The data is collected through triggered or time
events.

The Developer Workstation is accessible for those persons with the

applicable security level. The startup mode may be changed in the
Security level configurations.

For a detailed description of the Developer Workstation,

see Developer Workstation.

Pulse 4.12 User Guide 533

The following figure illustrates the Developer Workstation.

NOTE Each client that runs the Developer Workstation uses one
Development mode license, see Pulse Licensing.

Pulse 4.12 User Guide 534

Displays
Much of the development work takes place in displays. A display is a work
area that functions as an interactive model of a factory’s or organization’s
facilities (such as a production floor, warehouse, or building lobby). In the
Developer Workstation, application engineers can create a collection of
dynamic and/or static objects that represent devices or other equipment.
The objects have defined properties, which affect how the objects appear
and behave according to the data received from the various data sources.

 A dynamic object represents a device that receives data updates

from the communication drivers or from operator interaction. The
object’s Item properties are linked to the communication address of
the device. As the object receives values, it behaves in accordance
with the assigned properties and the device’s status.

A dynamic object can be a graphic element with animation

properties, a .NET control with dynamic properties, a Pulse
instrument, or an object that displays status or changing data that
is received from the various Publishers.

For example, an object can change color when a specified event

occurs.

 A static object represents a device whose appearance on the screen

remains constant and does not receive data updates or operator
input.

Pulse provides many versatile tools for representing objects in the display:

 Graphic objects

 Instruments

 ClipArt

 .NET components

 ActiveX controls

 Cells

Pulse 4.12 User Guide 535

Database Blocks
A block is a database element used for processing data, including data
exchange and conversion, alarm generation, and history collection. In
Pulse, the maximum total number of blocks of all types is 32,000 (not
counting alarm bits).

The Developer Workstation includes the Database Explorer, in which

application engineers can create and modify the blocks, and store them in
the Pulse database.

The block types are:

 Analog Value

 Analog Pointer

 Digital Value

 Digital Pointer

 Calculation

 Boolean

 Alarm

 String Pointer

 SER

 Alarm Bit

 Master Blocks

Pulse 4.12 User Guide 536

Workflows
A workflow is a collection of activities which Pulse executes in a defined
sequence. In the Workflow Manager, the application engineer assembles a
workflow by adding Pulse activities and General Windows Workflow
activities.

The Operator Workstation provides several ways to trigger a workflow or a

sequence of activities:

 Activating an object by Action Button Animation

 Activating a Pulse Action Button Instrument

 Executing a workflow from the Workflow Explorer

 Display Startup action

 Display Shutdown action

 Display AutoAction

 Workstation startup action

 Workstation shutdown action

 Workstation on - idle action

 Workstation AutoActions

 Scheduled actions and triggered server actions

 .NET Control dynamic events

 Defined alarm action (if an alarm condition occurs, an alarm is

acknowledged, or alarm returns to normal)

NOTE Running a workflow at runtime may be restricted according to

security level. For example, an Operator who is logged in
under Monitor mode is not permitted to run workflows or
actions.

Pulse 4.12 User Guide 537

Data Scope
The Data Scope module is a diagnostic tool which enables users to test
the validity of item values. Users can type the item in 'advised item'
format and immediately receive the current value of the item, and
continue updating the values. The Data Scope automatically updates,
according to data changes, the current value's validity status
(GOOD/BAD), the timestamp of the value, and the access rights (Read
only, Read/Write, Write Only, and Unknown). Additionally, users can also
write values to advised items that include a “write” access attribute.

The Data Scope is available in both the Developer Workstation and the
Operator Workstation. Users may open several Data Scope windows at the
same time.

At any time, the user can save the list of data items in a single window in
a group file, and can conveniently open it during later sessions for
monitoring the same items. There is no limit to the amount of entries that
can be added and saved in a single Data Scope group, and to the number
of groups that can be saved. Additionally, users can add more than one
group items to one Data Scope window.

NOTE The Data Scope group files belong personally to the logged-in
user.

Item Explorer
The Item Explorer presents the various Publisher items in a hierarchic
tree/branch format, allowing users to monitor the status of the Pulse
Host’s items, such as functions and arguments. In the Item Explorer, the
data is accessed through the Host tree with various functions represented
by branches in the tree, and presented in tables for each function group.
Item values can be monitored and saved to files and Data Scope groups.

Pulse 4.12 User Guide 538

Resources
A Display Resource is a generic object that represents multiple similar
devices or a group of objects. It is a template that allows you to reuse an
existing display multiple times, yet change various properties such as the
item address, without needing to recreate similar displays or copy several
objects from one display to another. For example, a resource can be used
to represent separate ingredient containers in a food production line, with
each container object in the display receiving quantity data from its own
item address.

During runtime, the operator clicks on one of the objects and receives the
appropriate data. The operator then clicks on another object in this same
group and receives data from a different data source. The presentations of
the data look the same but the data varies, according to the selected
object in the main display.

As a result, display resources reduce the number of displays that you

need to store in the project, help save time during project development,
and make it easier and more efficient to maintain the project.

Recipes
A recipe is a group of data items that sends and receives associated
values to and from the PLC. Recipes may be defined to run automatically
during runtime, or to be triggered by an operator by clicking an action
button. The recipes are loaded to or learned from the PLC, and their
results may change values in the PLC.

A recipe is held in a recipe file and contains groups of addresses and

different sets of values. Each set of values holds different instructions. The
same group of addresses can receive many sets of values to perform
different tasks.

The recipe system can store multiple versions (called groups) of the same
recipe in a single recipe file.

Pulse 4.12 User Guide 539

Cells
A cell is a collection of static and animated graphic objects and clipart
objects and their properties that are grouped together into one entity and
saved for reuse during design time. The creation of cells can save
application engineers the repetitive work required to configure several
sets of similar object groups.

When creating a cell, application engineers can either insert graphic

objects or clipart, or copy multiple objects from another display and paste
them into the cell.

After a cell is created, it is considered one object, but the properties that
were attached to each of its components remain associated only with that
same component. The Item addresses and actions of each component
become I/Os of this cell - to be adapted to each particular instance in
which this cell is applied. When inserted in a display, the cell instance then
requires a unique name, and if necessary, modification of its Data Item
(I/O).

The individual components of a cell may only be modified in its Cell

window. The modifications will take effect in subsequent uses of the cell.

Themes and Styles

A theme is a customized set of display parameters, called styles that can
be applied multiple times to graphic objects in a display. The styles are
composed of the graphical properties Object Fill, Object Line, and Text
Appearance (includes text, line, fill, font, position). You can save an
object’s graphical properties as a style, assign it to a theme, and then
apply the theme to define the properties of the objects included therein.

A theme can have more than one style. However, if a theme is attached to
the display, only those styles assigned to it are available for use with the
display. If a display’s theme is replaced by one that lacks any of the
formerly used styles, the new theme will inherit the missing styles from
the previous theme.

Pulse 4.12 User Guide 540

Working with Displays, Templates
and Cells
The Graphics windows in the Developer Workstation may contain
Displays, Templates, Cells, and Smart Cells.

Displays A collection of objects which are used for showing

data and receiving operator input. The displays are
the project’s main interfaces between Pulse users
and the controlled work area of a factory, building,
etc.

In the Operator Workstation, operators work in

various displays during runtime. In the Developer
Workstation, authorized users create and modify the
displays.

Templates A starting point for creating a display, based on

existing objects/cells on the display’s work area and
their properties, as well as any themes, styles,
layers, and other elements which have been
configured in that display. When you save as a
template, the active display becomes an open
template which you can continue editing.

Cells A cell is made up of a collection of static and

animated objects. All the graphic and animation
characteristics of the various components are
included in the cell. The DDE addresses and actions
of its animated objects become the I/O of this cell -
to be adapted to each particular instance this cell
prototype is used (applied).

A cell is handy for setting up complex combinations

of graphic objects that may be used multiple times in
your project.

Smart Cells A cell with multiple Arguments (parameters) where

only the argument’s value are replaced in each cell
instance, (Unlike Cells where the complete advised
item/expression advised item is replaced during
instantiation).

The extension of the Smart Cell is 'scel' and the files

are located in the 'Afcon\Pulse\[Project]\Gallery'
folder.

Pulse 4.12 User Guide 541

This section contains the following topics:

 Opening a Graphics Window

 Reverting a Graphic Window to the Latest Saved Version

 Closing a Graphics Window

 Working with Displays

Opening a Graphics Window

NOTE Displays, Templates, Cells, and Smart Cells are tools available
to users in the Developer Workstation mode. In the Operator
Workstation, users may only open saved displays (if their
security levels allow).

To open an existing Display, Template, Cell, or Smart Cell from your

current project, run the Open command from the File menu. You may
open and work on as many graphic files as you and your computer can
handle.

To open an existing display, template, cell or smart cell

1 From the File ribbon’s Open group, click Open.

The Open Displays dialog box is displayed showing the Project

Directory, Project Name, and a list of all the display files associated
with your current project.

2 Select a graphic display and click OK.

Pulse 4.12 User Guide 542

3 In the Developer Workstation, you can choose to show and open
templates and cells.

To open a recently opened graphic window

1 From the File ribbon’s Open group, click Recent.

2 Click the name of the graphic window from the pop-up options.

To open all displays, templates, cells or smart cells in a project

1 In the left pane’s Graphics tree, right-click the top of the tree.

2 Point to Open and then click Open All.

To open all displays in a branch

1 In the left pane’s Graphics tree, right-click an entry which has

displays in sub-entries.

2 Point to Open and then click All in Branch.

Pulse 4.12 User Guide 543

Reverting a Graphic Window to the Latest
Saved Version
The Revert to Saved command closes the current graphic window and
immediately reopens the last saved version of the file. In the Developer
Workstation, running this command discards all changes that were made
since the last time the graphic file was saved.

To revert to the latest saved version of the current graphic

window

1 From the File ribbon’s Open group, click Revert to Saved.

2 In the Developer Workstation, a message asks whether you want to

save any changes that were made since the file was opened. Click
No.

The graphic window reopens from the point at which it was last
saved.

Pulse 4.12 User Guide 544

Closing a Graphics Window
Use the Close command to close one or more of the currently open
Graphics windows.

To close the current Graphics window

1 From the File ribbon’s Close group, click Close.

2 In the Developer Workstation, a message asks whether you want to

save any changes that were made since the file was opened. Click
Yes or No accordingly.

To close more than one Graphics window or a Graphics window

other than the currently active (top) one

1 From the File ribbon’s Close group, click Close and then Close
from the submenu.

The Close All Views dialog box is displayed.

2 Select the file(s) to delete and click OK.

If any changes were made to open graphic windows in the

Developer Workstation, a prompt asks whether to save changes.
Click Yes to save the changes in the currently active window (on
top). Select Apply to All and then Yes if you want to save changes
made in all open windows.

Pulse 4.12 User Guide 545

To close all open graphic windows

 From the File ribbon’s Close group, click Close and then All from
the submenu.

-or-

From the Window ribbon’s Window Options group, click Close

All Windows.

If any changes were made to open graphic windows in the

Developer Workstation, a prompt asks whether to save changes.
Click Yes to save the changes in the currently active window (on
top). Select Apply to All and then Yes if you want to save changes
made in all open windows.

Working with Displays

Much of the development work takes place in displays. A display is a work
area that functions as an interactive model of a factory’s or organization’s
facilities (such as a production floor, warehouse, or building lobby). In the
Developer Workstation, you can create a collection of dynamic and/or
static objects that represent devices or other equipment. The objects have
defined properties, which affect how the objects appear and behave
according to the data received from the various data sources.

Pulse provides many versatile tools for representing objects in the display:

 Graphic objects

 .NET components

 ClipArt

 Cells

 ActiveX controls

 Smart Cells

 Instruments

Pulse 4.12 User Guide 546

This section includes the following topics:

 Inserting and Defining Graphic Objects

 Defining Graphic Object's Properties

 Changing the Pulse Display Layout and Size

 Lock Mode

 Display Report

Pulse 4.12 User Guide 547

Inserting and Defining Graphic Objects
A graphic object is a shape that you insert into the display, which will
represent an indicator or a control. You can create graphic objects that
use animation to supply information to the operator or as a means of
executing commands from the operator workstation.

To insert graphic objects (such as rectangles, ellipses, line, polyline,

spline, text objects and more) into a display, cell, or a template, you can
use any of the following methods:

 Select the object from the Graphic Objects area of the Insert
ribbon

 Select the object from the Toolbox docking panel, if open in the
workstation.

After inserting the graphic objects, you may reshape, reposition, resize,
rotate, or convert them to spline for finer editing. Additionally, you can
define physical properties (fill and line) for the objects and text content.

You also need to define each graphic object’s animation properties, which
include the communication address (Item) from which it receives data,
and other parameters which affect the objects’ appearances and behavior.

After you have created and edited the object, you can group several
objects together and assign them with identical animation properties,
order the objects, duplicate them, assign a theme and style, associate
objects to layers, convert it to a path object (spline), and more.

To insert a graphic object into a display, cell or template

1 Select the object from either the Graphic Objects area in the
Insert ribbon, the Insert button in the Home ribbon, or from the
Toolbox docking panel by clicking on the object you wish to insert,
for example, a rectangle.

2 In the display, notice that the mouse pointer changes to indicate

that the object is selected. Hold down the left mouse button and
drag the pointer until you release it. The object is inserted over the
area you dragged.

3 Continue to insert as many objects as you need. When finished,

either hit the Esc (Escape) key or, click on the mouse pointer icon.

NOTE A Pulse instrument or .NET control that has a rectangular

background hides all other objects that share the same
location on a display. Since the rectangular background is a
bitmap, the Background>Transparent property has no effect.

Pulse 4.12 User Guide 548

 Bring to Front and Send to Back attributes takes effect only
when the overlapping objects are of the same type
(instrument/control over instrument/ control, graphic object
over graphic object, etc.). If the objects are of different types,
the Bring to Front and Send to Back attributes have no
effect.

This section includes the following topics:

 Graphic Object Command Options

 Resizing an Object

 Formatting Objects

 Aligning Objects

 Duplicating Objects by Changing Item Names

 Grouping and Ungrouping Objects

 Duct and Pipe Graphic Object

Pulse 4.12 User Guide 549

Graphic Object Command Options
The following are the pop-up menu commands when right-clicking an
object in a display.

Set Auto Shape When this option is selected, all the graphic objects
Default that are created after this object inherit its graphic
properties.

Pulse 4.12 User Guide 550

Save as Style Displays the Save Style on Theme dialog box.

Enter the Style Name and Style Description and

save a style.

Animations

Select one of the following animation options:

Appearance Displays the Animation panel where the properties

of the object’s appearance can be defined. For more
information, see Animation Properties - Appearance.

Size Displays the Animation panel where the properties

of the object’s size can be defined. For more
information, see Setting Shape Animation for
Graphic Objects.

Visibility Displays the Animation panel where the properties

of the object’s visibility can be defined. For more
information, see Animation Properties - Visibility.

Orientation Displays the Animation panel where the properties

of the object’s orientation can be defined. For more
information, see Animation Properties - Orientation.

Fluid Fill Displays the Animation panel where the properties

of the object’s fluid fill can be defined. For more
information, see Animation Properties - Fluid Fill.

Fluid Flow Displays the Animation panel where the properties

of the object’s fluid flow can be defined. For more
information, see Animation Properties - Fluid Flow.

Position Displays the Animation panel where the properties

of the object’s position can be defined. For more
information, see Animation Properties - Position.

Text Displays the Animation panel where the properties

of the object’s text can be defined. For more
information, see Animation Properties - Text.

Slider Displays the Animation panel where the properties

of the object’s slider can be defined. For more
information, see Animation Properties - Slider.

Action Button Displays the Animation panel where the properties

of the object’s Action button can be defined. For
more information, see Animation Properties - Action
Button.

Pulse 4.12 User Guide 551

Context Menu Displays the Animation panel where the properties
of the object’s context menu can be defined. For
more information, see Setting a Static Context
Menu.

Tooltip Displays the Animation panel where the properties

of the object’s Tooltip Animation can be defined.

Graphics

Used to set the graphic properties of the object. The following are the
object properties that can be set:

Object Fill Displays the Graphics (Object Fill) panel where

the graphic Object Fill properties can be defined. For
more information, see Setting Object Fill Properties.

Object Line Displays the Graphics (Object Line) panel where the
graphic Object Line properties can be defined. For
more information, see Setting Object Line
Properties.

Text Fill Displays the Graphics (Text Fill) panel where the
Text Fill properties can be defined. For more
information, see Setting Text Fill Properties.

Text Line Displays the Graphics (Text Line) panel where the
Text Line properties can be defined. For more
information, see Setting Text Line Properties.

Text Appearance Displays the Graphics (Text Properties) panel where

the Text properties can be defined. For more
information, see Setting Text Appearance
Properties.

Edit Text

Displays the Edit Text dialog box. Enter the text you want to insert into
the graphic figure.

Create a Cell

Displays the Save Cells dialog box. Enter the cell’s name in the Name
field and click OK to save. The new cell is created and you can view it
under Cells tree.

Pulse 4.12 User Guide 552

Create a Smart Cell

Displays the Save Smart Cells dialog box. You can provide a smart cell
name in the Name field and click OK. The new smart cell is then added
and appears in the Smart Cells tree.

Advanced Properties

Displays the Advanced Properties pane where the advanced properties

of the object can be defined.

Lock

This option locks the selected object. The Lock Mode enables you to
prevent unintended modifications to graphic objects, instruments, and
.NET controls while working in the Developer Workstation.

Edit Name

Displays the Edit Name dialog box. Edit the name shown in the Name
field and click OK.

Center

Centers the object in the display in one of the following positions:

Center Vertically Select this option to position the selected object

vertically in the center of the display.

Center Select this option to position the selected object

Horizontally horizontally in the center of the display.

Center in Display Select this option to position the selected object in

the center of the display.

Order

Positions the object in one of the following positions:

Bring to Front Brings the object to the front of the display - in front
of all the other objects in the display.

Send to Back Brings the object to the back of the display - behind
all the other objects.

Send Backward Brings the object at the back of the object behind it.

Bring Forward Brings the object to the front of the object in front
of it.

Pulse 4.12 User Guide 553

Rotate

NOTE The user can also access the Rotate commands from the Edit
ribbon’s Format group.

Rotates the object to one of the following positions:

Rotate Clockwise Rotates the object clockwise (to the right)

Rotate Rotates the object counterclockwise (to the left)

Counterclockwise

Custom Rotate Custom rotates the angle of an object by defining

the Custom Rotate parameter. The object can be
rotated at any angle from 0 to 360 degrees from the
Custom Rotate dialog box.

Selecting the Custom Rotate option from either the

Edit ribbon or through the pop-up menu displays
the Custom Rotate dialog box.

Specify the angle the object should rotate (0 - 360)

and click the Rotate Counter Clockwise checkbox
option to move the object counterclockwise at the
angle specified or leave the checkbox option empty
to rotate the object on a clockwise direction at the
angle specified.

Convert to Spline

Transforms the object into a spline.

Pulse 4.12 User Guide 554

Flip

Flip the object to one of the following directions:

Flip Horizontal Flips the object horizontally

Flip Vertical Flips the object vertically

Set Style

Sets the object’s style properties from one of the available styles on the
pop-up menu:

Cosmopolitan, Simple, Hobbit, WhiteStyle

Set Layer

Designates the display with its object(s) to the layer you select

0: Default layer The default layer; the only available layer before
another layer is defined.

Cut

Copies and deletes the object

Copy

Copies the object without deleting it

Paste

Pastes or reproduces the object that was copied or cut

Duplicate

Select one of the following duplication options:

Duplicate Object Copies an object with its properties.

Duplicate Object Copies an object with its animation properties

with Animation

Delete

Deletes the selected object(s) from the display

Brush

Copies the properties of an object to another object

Pulse 4.12 User Guide 555

Display

Select one of the following Display commands:

Save Saves the display

Save As Saves the display as another display or file

Close Closed the display

Revert to Saved Undoes the Save action

Preview Shows a preview of the display

Restore Window Restores the window to its former size

Redraw Redraws the display

System

Activates one of the following:

Data Scope Opens the Data Scope window

Alarm Explorer Opens the Alarm Explorer window

Switch to Opens or switches to the Operator Workstation

Operating window

Menu Bar Displays/hides the Menu bar

Menu Disables the Menu Authorization for the Operator

Authorization Workstation

Save Saves the Personalization settings

Personalization

Exit Exits the display

Pulse 4.12 User Guide 556

Resizing an Object
To resize an object

1 Click the object once.

The selected object is clearly marked.

2 To resize the object, position the mouse pointer on any of the

object's resizing rectangles and hold down the left mouse button.
Drag to change the object’s size. Release the mouse button when
finished.

Formatting Objects
To format an object, to set the order of the object relative to other object
in the display, group and up group the object with other objects and
more, use the Format menu from the Edit tab. The Edit tab contains
object specific options to help you edit the object's graphics and animation
properties, use clipboard tools, and format the object.

Pulse 4.12 User Guide 557

Aligning Objects
Align objects relatively to other objects in the display. Do so by first
selecting the object to align and then selecting the aligned object. Once
the two objects are selected, you can select the alignment options to
apply for the object. You may select more than two objects in which to
apply the alignment options.

To align objects

1 Clicking on the object.

2 Hold down the CTRL key and select the other object(s) to align with
the first object.

NOTE Although it is possible to resize and reposition the two objects,

the objects are not grouped. When grouping objects, the
objects' properties are removed and assigned with common
properties, whereas in this case, each object retains its own
properties.

Pulse 4.12 User Guide 558

3 In the Edit ribbon’s Format area, click the Align button to select
an option.

4 Check the result.

Pulse 4.12 User Guide 559

Duplicating Objects by Changing Item Names
You can duplicate an object or a group of objects and rename the new
object(s) without having to do it through the Animation panel.

Duplicating objects by changing Item names makes it easier for the user
to copy an object or multiple objects quickly.

To copy an object or objects:

1 Select the object or a group of objects to copy.

2 Press the ALT key and simultaneously drag the object(s) and
release it anywhere on the display.

The Edit Name dialog box is displayed. The name of the source
object is displayed by default.

3 Enter a new name on the Name field for the duplicated object and
click OK.

The object is duplicated with a new name.

In case multiple objects were copied for duplication, a new Edit

Name dialog box is displayed again. This will be displayed until all
the new objects are renamed.

Pulse 4.12 User Guide 560

Grouping and Ungrouping Objects
Use the Group menu to create a new object from more than one
individual objects. The objects included in the group all share the same
graphics and animation properties - individual object’s graphics and
animation properties are removed.

When breaking a group of objects, the group's properties are removed

and each object can be attributed with individual properties.

Creating a group

1 Hold down the CTRL key and select the object(s).

2 In the Edit ribbon’s Format area, click the Grouping button and
then click Create Group.

Grouped objects are marked by a single line the way single objects
are marked.

Breaking a Group

1 Click on the group.

2 In the Edit ribbon’s Format area, click the Grouping button and
then click Break Group.

The objects return to single mode and can now be selected

individually but not as a group.

Pulse 4.12 User Guide 561

Duct and Pipe Graphic Object

The Duct and Pipe Graphic Object options help the user create duct and
pipe drawings easily.

Use the Duct and Pipe’s Animation properties to show movements

within the object.

Pipe

Use Pipe to design a piping system in the display. A piping system

can illustrate the transport of fluid or gases from one point to another.

To create a pipe

1 From the Insert ribbon, click the Pipe object in the Graphic
Objects group.

The Pipe Settings dialog box is displayed.

Pulse 4.12 User Guide 562

2 Define the following Pipe Settings:

• Pipe Width - Specify the width of the pipe; the default width
is 15.00.

• Pipe Color - Select the pipe’s color from the drop-down list;
the default color is Black.

• Straight Angle, Start Type, and End Type - Define the

Pipe object by selecting an illustrated option for the parts of
the pipe.

• Show when new Pipe created - when this checkbox option

is selected, the Pipe Settings dialog box is displayed.

NOTE When the Show when new Pipe created

checkbox option is NOT selected then the Pipe
Settings dialog box is not displayed. To display
the Pipe Settings dialog box again, right-click
on the Duct object and select Settings from the
pop-up menu.

NOTE Press the Shift key and click to move the Duct object by 90
degrees angle.

3 Press the Esc key to finish drawing the duct.

To edit a Pipe

1 The points of a Pipe can be edited by selecting the Pipe and right-
clicking on it to display the pop-up menu.

2 Select one of the following editing actions from the pop-up menu to
activate the editing state:

• Edit Points – You can edit or change the actual shape or

appearance of the pipe by dragging its graphic points
(vertexes) or handles.

• Reverse Points – Use this option to reverse the pipe ends

or put the start and end points of the pipe in the opposite
directions.

• Set All Angles Straight – Use this option to set all the
curved angles of the pipe into straight angles.

Pulse 4.12 User Guide 563

3 While in editing state, you can do the following editing actions:

• Add a new pipe segment by clicking on the point and then clicking
anywhere on the display.

• Change a specific point by selecting a point and moving it.

• Add a new point between two points by selecting the first

point between the two points and then clicking anywhere on
the display.

• Remove a specific point by selecting the point and pressing

the Delete key.

Pulse 4.12 User Guide 564

Duct

Use Duct to design a polyline with a duct appearance that can be

connected between angles. Duct objects help the user design and create
ducts for heating, ventilation, and air-conditioning objects.

To create a duct

1 From the Insert ribbon, click the Duct object in the Graphic
Objects group.

The Duct Settings dialog box is displayed.

2 Define the following Duct Settings:

• Duct Width - Specify the width of the pipe; the default

width is 30.00.

• Duct Color - Select the pipe’s color from the drop-down list;
the default color is Gray.

• Start Type, End Type - Define the Duct object by selecting

an illustrated option for the start and end parts of the duct.

Pulse 4.12 User Guide 565

 • Show when new duct created - when adding an object
and this checkbox option is selected, the Duct Settings
dialog box is displayed.

NOTE When the Show when new duct created checkbox

option is NOT selected then the Duct Settings dialog
box is not displayed. To display the Duct Settings
dialog box again, right-click on the Duct object and
select Settings from the pop-up menu.

3 Click and drag to draw the duct on the display.

NOTE Press the Shift key and click to move the Duct object by 90
degrees angle.

4 Press the Esc key to finish drawing the duct.

To edit a Duct

1 The points of a Duct can be edited by selecting the Duct and right-
clicking on the object.

2 Select one of the following editing actions from the pop-up menu to
activate the editing state:

• Edit Points – You can edit or change the actual shape or

appearance of the duct by dragging its graphic points
(vertexes) or handles.

• Reverse Points – Use this option to reverse the duct ends

or put the start and end points of the duct in the opposite
directions.

• Set All Angles Straight – Use this option to set all the
curved angles of the duct into straight angles.

3 While in editing state, you can do the following editing actions:

• Add a new duct segment by clicking on the point and then

clicking anywhere on the display.

• Change a specific point by selecting a point and moving it.

• Add a new point between two points by selecting the first

point between the two points and then clicking anywhere on
the display.

• Remove a specific point by selecting the point and pressing

the Delete key.

Pulse 4.12 User Guide 566

Selecting and Editing Individual Objects within a
Group
In the Developer Workstation, individual graphical objects that are
grouped together in a display cannot be selected to edit their graphic
properties by clicking directly on them. The individual object may be
selected using the Advanced Properties pane.

1 Select an object and right-click on the object.

A pop-up menu is displayed.

2 Select Advanced Properties.

The Advanced Properties pane is displayed.

3 In the Advanced Properties pane, select and expand the group

entry.

4 Select the individual object in the tree.

Now the individual object is ready for editing.

5 Go to the Graphics dialog box and edit the object.

6 Click OK.

After the Advanced Properties pane is closed, the item appears as a

group again in the display.

Pulse 4.12 User Guide 567

Changing Display Title and Display Properties Title
You can change the Display Title and the Display Properties Title for
displays at runtime while keeping its original Display Name in the
Graphics tree.

Configuring the Display Name from the Advanced Properties pane

1 In the Developer workstation, right-click on the display and select

Display Properties from the pop-up menu.

The Display Properties pane is displayed.

2 Go to Title and change the name of the Display then save it.

At runtime, the Display Name of the display changes while the

display name in the caption is retained.

Pulse 4.12 User Guide 568

Defining Dynamic Properties/Events via the
Display’s Advanced Properties Pane
You can define the characteristics of the Dynamic Properties parameter
in the display’s Advanced Properties pane via the Dynamic Properties
parameter.

The Dynamic Properties window can be accessed by clicking the

button to the right of the Dynamic Properties field on the Advanced
Properties pane.

Pulse 4.12 User Guide 569

Importing AutoCAD Files
The AutoCAD importer allows you to import AutoCAD files into the Pulse
application as Displays with full Pulse functionality. Pulse displays the
AutoCAD objects as Pulse graphics objects.

The AutoCAD files are imported from the CadLib 4.0 .NET Library in
*.svg format and the *.svg file is imported to Pulse as a Pulse graphics
object. In general, the Pulse user only imports AutoCAD file (*.dxf or
*.dwg) files and Pulse displays the files as a Pulse graphics object.

To import an AutoCAD file:

1 In the Developer workstation, go to the File ribbon and click

Import.

The Open dialog box is displayed.

2 Select AutoCad files (*.dxf, *.dwg) as the file type.

3 Click Open to display the AutoCAD object as a Pulse graphic object.

Pulse 4.12 User Guide 570

If the imported AutoCAD object was a layered object then Pulse will
import the object(s) as a group and the Pulse object will have "children"
or related layers.

The import process converts the AutoCAD layers and creates

corresponding layers in Pulse.

Pulse 4.12 User Guide 571

Defining Graphic Object's Properties
Use the Graphics Properties panel to define the physical appearance of
a graphic object. You can set a graphic or text object's fill and line colors
as well as the text's appearance, or you can assign the object with a style.

The graphics properties panel is a WYSIWYG (What You See Is What You
Get) tool. This means that the same graphics properties assigned to an
object during the development stage of the project, are the ones you will
see during run-time.

You can define the following sets of physical properties:

 Setting Object Fill Properties

 Setting Object Line Properties

 Setting Text Fill Properties

 Setting Text Line Properties

 Setting Text Appearance Properties

To define graphic object properties

1 Select the graphic object. In the Edit ribbon’s Graphics area, click
one of the property choices.

-or-

Right-click the object, point to Graphics and click one of the

property choices.

2 In the Graphics dialog box, make the required changes to the

parameters. At the same time you make the changes, the physical
appearance of the graphic object changes accordingly.

Name Name of the selected graphic. You can switch

to and select a different graphic on the display
by choosing its name from this list.

Style You can choose a predefined style which

already contains the fill properties you need.

Otherwise, you can save the current settings in

the dialog box and save it to a style. Click the
Save icon.

Layer Choose the layer on which these graphic

properties reside.

Pulse 4.12 User Guide 572

3 To define another set of object properties, click the appropriate icon
in the Graphics dialog box’s toolbar.

Pulse 4.12 User Guide 573

Setting Object Fill Properties
Follow this procedure to define the graphic object’s fill color or pattern.

To define the graphic object’s fill properties

 Right-click the object, point to Graphics and click Object Fill.

Fill Type Choose the type of fill pattern for the object.

 None - Object is transparent - anything

residing under the object remains visible.

 Solid - Object is filled consistently with

the selected color.

 Hatch - Object is filled with a solid

background and a pattern (grid, lines) in
the foreground.

Pulse 4.12 User Guide 574

  Image - Object is filled with an image.
Select an image file to fit inside the
object’s contour.

 Gradient - Object is filled with the effect

of one color running into another.

Colors - RGB, Choose a base color by selecting a color range in

HSB the spectrum bar (rainbow) and then selecting a
spot in the color plane. A preview of your
selection appears above the parameters. Below
the color plane, the previous selection appears
on the left and the current selection appears on
the right.

Depending upon your Fill Type choice, the dialog

box provides additional type-specific
parameters.

Opacity Choose the level of opacity and transparency for

the object. At 100% opacity, the object’s
background color hides anything residing under
the object. At 0% opacity, the object is
“transparent”, with anything residing under the
object remaining visible.

Pulse 4.12 User Guide 575

Setting Object Line Properties
Follow this procedure to define the graphic object’s outline color or
pattern.

To define the graphic object’s line properties

1 Right-click the object, point to Graphics and click Object Line.

Fill Type Choose the type of pattern for the object’s

outline.

 None - Outline is invisible

 Solid - Outline is one solid line

 Hatch - Outline has a dotted-line effect

Pulse 4.12 User Guide 576

  Image - Outline is composed from an
image. Select an image file to fit along the
object’s contour.

 Gradient - Outline has the effect of one

color running into another.

Colors - RGB, Choose a base color by selecting a color range in

HSB the spectrum bar (rainbow) and then selecting a
spot in the color plane. A preview of your
selection appears above the parameters. Below
the color plane, the previous selection appears
on the left and the current selection appears on
the right.

Depending upon your Fill Type choice, the

dialog box provides additional type-specific
parameters.

Opacity Choose the level of opacity and transparency for

the outline.

At 100% opacity, the outline is fully visible,

hiding anything residing under the outline. At
0% opacity, the outline is invisible.

2 Click on the Advanced Line Properties to add additional

elements, such as caps and more, to the line.

Pulse 4.12 User Guide 577

Setting Text Fill Properties
Follow this procedure to define the graphic object’s text’s color or pattern.

To define the graphic object’s text fill properties

 Right-click the object, point to Graphics and click Text Fill.

Fill Type Choose the type of pattern for the text.

 None - Text is invisible

 Solid - Text is displayed in one solid

consistent color

 Hatch - A grid or pattern overlays the

text.

Pulse 4.12 User Guide 578

  Image - Text shows parts of an image
file.

 Gradient - Text has the effect of one

color running into another.

Colors - RGB, Choose a base color by selecting a color range in

HSB the spectrum bar (rainbow) and then selecting a
spot in the color plane. A preview of your
selection appears above the parameters. Below
the color plane, the previous selection appears
on the left and the current selection appears on
the right.

Depending upon your Fill Type choice, the dialog

box provides additional type-specific
parameters.

Opacity Choose the level of opacity and transparency for

the text. At 100% opacity, the text is fully
visible. At 0% opacity, the text is invisible.

Pulse 4.12 User Guide 579

Setting Text Line Properties
Follow this procedure to define the graphic object’s text’s outline color or
pattern.

To define the graphic object’s text outline properties

1 Right-click the object, point to Graphics and click Text Line.

Pulse 4.12 User Guide 580

 Fill Type Choose the type of pattern for the object text’s
outline.

 None - Outline is invisible

 Solid - Outline is one solid line

 Hatch - Outline has a dotted-line effect

 Image - Outline is composed from an

image. Select an image file to fit along the
object’s contour.

 Gradient - Outline has the effect of one

color running into another.

Colors - RGB, Choose a base color by selecting a color range in

HSB the spectrum bar (rainbow) and then selecting a
spot in the color plane. A preview of your
selection appears above the parameters. Below
the color plane, the previous selection appears
on the left and the current selection appears on
the right.

Depending upon your Fill Type choice, the

dialog box provides additional type-specific
parameters.

Pulse 4.12 User Guide 581

 Opacity Choose the level of opacity and transparency for
the outline.

At 100% opacity, the outline is fully visible,

hiding anything residing under the outline. At
0% opacity, the outline is invisible.

2 Click on the Advanced Line Properties to add additional

elements, such as caps and more, to the line.

Pulse 4.12 User Guide 582

Setting Text Appearance Properties
Follow this procedure to edit the graphic object’s text, and to define its
font, typeface, and position.

To define the graphic object’s text appearance properties

 Right-click the object, point to Graphics and click Text

Appearance.

Pulse 4.12 User Guide 583

 Text box Type the text that will appear in the object.
Click Apply Text to display it.

Font Choose the text’s font and size.

Style Select Bold, Italic, and/or Underline to add

those effects to the text.

H. Alignment Select the text’s horizontal position within the

object - Left, Center, or Right.

V. Alignment Select the text’s vertical position within the

object - Top, Middle, or Bottom.

Padding Enter digits which represent the distance

between the object’s edge and the text, from
all directions.

Wrap Text Select this option to move text to the next line
when it reaches the padding border of the
object. If this option is not selected, parts of a
long text string may not be visible.

Right to Left Select this checkbox option for your text

language to stat from the right-to-left
direction.

Pulse 4.12 User Guide 584

Changing the Pulse Display Layout and Size
Moving and resizing a display on the Pulse Developer Workstation does
not automatically save the display size and location settings.

To adjust a display size and layout:

1 On the Pulse Developer Workstation, go to the Graphics Explorer

and open the display to adjust.

2 Click the Window ribbon.

3 Select Windows Layout (the option is only active when there is an

open file).

4 Set the window display size and layout.

-or-

1 On the Pulse Developer Workstation, go to the Graphics Explorer.

2 Right-click the display on the list and select Properties from the
pop-up menu.

The Display Properties dialog box is displayed.

3 Click the Window Style tab.

4 Set the window location, style, and size.

5 Click Apply to save the changes.

Pulse 4.12 User Guide 585

Lock Mode
The Lock Mode enables you to prevent unintended modifications to
graphic objects, instruments, and .NET controls while working in the
Developer Workstation. Locking is especially helpful when the display
includes a large number of elements. In “crowded” areas, this mode
allows you to edit only items that require editing and reduces the chances
for design errors.

When an object is locked, the following is affected:

 Graphic objects

• Prevents objects from moving, resizing, cutting, and deleting.

• Prevents addition and editing.

 Instruments and .NET Controls

• Prevents instruments and .NET controls from moving,

resizing, cutting, and deleting.

• Prevents addition and editing of instrument settings and .NET

control dynamic properties.

When an object is unlocked, all of its control and editing features are
enabled.

NOTE While an object is locked, its properties/settings may be added

or modified in the Advanced Properties pane, see Defining
Instrument Advanced Properties. When multiple locked objects
are selected, only advanced properties that are common
among the selected objects are editable. Any
properties/settings edited in the Advanced Properties pane
affect all the selected objects.

Turning on Lock Mode does the following:

 Locks all objects that are already lock-enabled.

 Allows users to lock all other objects.

Conversely, turning off Lock Mode unlocks all objects, regardless of

whether or not they are lock-enabled.

To enable/disable Lock Mode

 In the Window ribbon, click Lock Mode.

Pulse 4.12 User Guide 586

Locking/Unlocking Objects
To enable locking of an object

 Right-click the object or select multiple objects at the same time

and right-click. Click Enable Locking from the menu.

NOTE When Lock Mode is enabled, an unlocked object’s right-click

menu provides a Lock option.

When Lock Mode is turned on, the locking mechanism affects the object.
If the object is selected, a border and lock icon indicate that it is locked
(see the following illustrations of a graphic object on the left and an
instrument on the right). If the mouse pointer is hovering over a selected
locked graphic object, the pointer takes the form of a lock.

To disable locking of an object

 Right-click the object or select multiple objects at the same time

and right-click. Click Disable Locking from the menu.

NOTE When Lock Mode is enabled, a locked object’s right-click menu

provides an Unlock option.

When Lock Mode is turned on, the “unlocked” object remains

editable.

NOTE When Lock Mode is turned off, and a group of multiple

selected objects contains both lock-enabled and lock-disabled
objects, the right-click menu contains options to Enable
Locking and Disable Locking all selected objects.

When Lock Mode is turned on, and a group of multiple

selected objects contains both locked and unlocked objects,
the right-click menu contains options to Lock and Unlock all
selected objects.

Pulse 4.12 User Guide 587

Reports
Display Report
You can display, save, and print a report which lists all properties/settings
of a project, display, template, or cell objects. The report appears on a
grid with each object represented by a row entry and each
property/setting represented in a column. The reports can be produced
encompassing the following scopes:

 Report listing all objects and properties/settings in all of a project’s

displays.

 Report listing all objects and properties/settings in a single display.

From the Print Preview, reports can be saved, printed, exported to various
formats (PDF, HTML, MHT, RTF, Excel, CSV, Text, Image), and sent by
email.

To access the Display Report for all of a project’s displays

 In the Developer Workstation Project Navigator pane, right-click the

top of the Display tree and click Report.

The Display Report [for All] window is displayed.

• To expand the list and show all the objects, click .

• To collapse the list and hide all the objects, click .

• To expand or collapse the list for an individual display, click

the + or - button next to the graphic’s name.

Pulse 4.12 User Guide 588

To access the Display Report for a single display

 In the Developer Workstation Project Navigator pane, right-click

the display name and click Report.

The Display Report window is displayed.

• To expand the list and show all the objects, click .

• To collapse the list and hide all the objects, click .

Printing Reports
 Print current report immediately

 Print Preview the current report - preview, design, and filter reports
before sending them to a printer or exporting them to a different
file format, see Display Report Print Preview.

To print the current report immediately

 From the Display Report toolbar, click the Print button.

To view or work in the Print Preview before printing

 From the Display Report toolbar, click the Print Preview button.

Pulse 4.12 User Guide 589

Pulse 4.12 User Guide 590
Column Customization
To make it easier to view the Display Report, you can remove columns
which are not relevant, such as columns that do not display property
values. Removing unused columns can help present the report’s width on
as few as one page, depending on the amount of data remaining visible.

To customize the report columns

1 From the Display Report toolbar, click Column Customization.

The Customization window is displayed.

2 To remove a column from the table, drag its heading to the

Customization window.

Conversely, to restore a column to the table, drag the heading from

the Customization window to the relevant column location in the
Report table.

3 When you finish, close the Customization window.

Pulse 4.12 User Guide 591

Display Report Print Preview
The Print Preview displays how a report will look like on a paper page
when you print it. Additionally, from the Print Preview, reports can be
saved, printed, exported to various formats (PDF, HTML, MHT, RTF, Excel,
CSV, Text, Image), and sent by email. You can customize the appearance
of the printed report in various ways (data filter, page size, grid, etc.).

Pulse 4.12 User Guide 592

Designing Reports
From the Print Preview, use the following tools to customize the
appearance of the display report. The tools are available on the Print
Preview toolbar.

Customize Choose to include physical features such as lines,

headers, footers, previews, auto width, and more,
see Customizing Display Report.

Page Setup Define the page size and orientation of the report’s
pages.

Header and Design a header and footer that will appear on the
Footer report’s pages, see Designing a Header and Footer.

Scale Specify the proportionate size of the report on the

page, see Scaling the Display Report.

Color Specify a background color for the report pages, see

Changing the Display Report Background Color.

Watermark Define a text or image watermark that will appear on

the report’s pages, see Adding a Watermark to the
Display Report.

Pulse 4.12 User Guide 593

Displaying Reports
Various options for showing display reports in Pulse native format are
provided in the Print Preview. The tools are available on the Print
Preview toolbar.

Find Find instances of a text string in the report

Hand Tool In this mode, you can drag the report up and down
your screen to view it.

Magnifier Toggles between two zoom sizes

Zoom Out/ Zooms in or out to display the report at a

Specific Zoom/ satisfactory magnification level.
In

First/Previous/ Navigates to the specified pages

Next/Last Page

Multiple Pages Choose to display in layout of one or two rows, with

one to three pages in each row

Printing and Exporting Display Reports

You can produce display reports in Pulse’s native format, print them on a
printer, or export them to another type of document format for further
editing and distribution. The tools are available on the Print Preview
toolbar.

Save Saves the report in Pulse’s native format. The file

extension is .prnx.

Print Chooses a printer on which to print the report

Quick Print Prints the report on the computer’s default printer

Export Document Produces the report in a format that allows you to

open it in an external application (PDF, HTML, MHT,
RTF, Excel, CSV, Text, Image)

Send Via Email Produces the report in a format that allows you to
open it in an external application (PDF, HTML, MHT,
RTF, Excel, CSV, Text, and Image) and then send it
to recipient(s) using the computer’s default email
application.

Pulse 4.12 User Guide 594

Customizing Display Report
To customize the display report

1 From the Print Preview toolbar, click the Customize button.

The Print Options dialog box is displayed.

2 In the Options tab, select the items which you want to appear in
the report design.

3 Deselect items you prefer not to appear in the report design.

4 In the Behavior tab, select items which affect the layout of the
report.

The Preview shows a sample reflecting your choices.

5 Click OK to implement the customization.

Pulse 4.12 User Guide 595

Designing a Header and Footer
Use the following procedure to add a header and/or footer to the display
report.

To design a header and/or footer for the display report

1 From the Print Preview toolbar, click the Header and Footer
button.

The Header and Footer dialog box is displayed.

2 Type the text for the header and footer. For each one, the text
entered in the left box appears on the left side of the header/footer,
the text entered in the center box appears in the center, and the
text entered in the right box appears on the right side.

3 Select one of the following, respectively from left to right, to define

the header’s and footer’s alignment in relation to the report’s grid.

Header  Farthest from grid

 Midlevel from grid

 Closest to grid

Pulse 4.12 User Guide 596

 Footer  Closest to grid

 Midlevel from grid

 Farthest from grid

4 If required, click Font to change the font and text size.

5 Insert variables to the header and/or footer by clicking icons from

the lower part of the Header and Footer dialog box.

Report [Page Number]

Report [Page Number] of [Number of Pages]

Date of printing for this report

Time of printing for this report

User name of currently logged-in Pulse user

Image file to appear in header/footer

Pulse 4.12 User Guide 597

Scaling the Display Report
Use the Scaling tool to reduce or enlarge the report to fit onto a single
page or a portion of a page, or to spread over multiple pages.

To scale a display report

1 From the Print Preview toolbar, click the Scale button.

The Scaling dialog box is displayed.

2 Select a suitable scaling percentage and size and then click OK.

3 Check if the results are satisfactory. If not, try again.

Changing the Display Report Background Color

The Color command sets the color which surrounds the report contents.

To set the background color of the display report

1 From the Print Preview toolbar, click the Color button.

The color palette is displayed.

2 Choose the color.

Pulse 4.12 User Guide 598

Adding a Watermark to the Display Report
You can add a text or picture watermark either in front of or behind the
content of the report.

To add a watermark to the display report

1 From the Print Preview toolbar, click the Watermark button.

The Watermark dialog box is displayed.

2 Go to the Text Watermark tab and choose one of the suggested

text strings or type one in the Text box. Define the text properties
on the page.

-or-

In the Picture Watermark tab (the watermark may also include

both text and an image), click Load Image to choose an image
file. Define the properties on the page.

Pulse 4.12 User Guide 599

3 Define the remaining watermark properties:

Position Select In Front to place the watermark on top

of the report contents.

Select Behind to place the watermark in back

of the report contents.

Page Range Select All to place the watermark on all pages

of the report.

Select Pages and type a page range (for

example, 1, or 2-5) to place the watermark on
specific pages but not all.

4 Click OK.

The defined watermark is displayed according to the specifications.

Pulse 4.12 User Guide 600

Displaying Reports
Various options for showing display reports in Pulse native format are
provided in the Print Preview. The tools are available on the Print
Preview toolbar.

Find Finds instances of a text string in the report

Hand Tool In this mode, you can drag the report up and down
your screen to view it.

Magnifier Toggles between two zoom sizes

Zoom Out/ Zooms in or out to display the report at a

Specific Zoom/ satisfactory magnification level
In

First/Previous/ Navigates to the specified pages

Next/Last Page

Multiple Pages Chooses to display in layout of one or two rows, with

one to three pages in each row

Printing and Exporting Display Reports

You can produce display reports in Pulse’s native format, print them on a
printer, or export them to another type of document format for further
editing and distribution. The tools are available on the Print Preview
toolbar.

Save Saves the report in Pulse’s native format. The file

extension is .prnx.

Print Choose a printer on which to print the report.

Quick Print Prints the report on the computer’s default printer

Export Document Produces the report in a format that allows you to

open it in an external application (PDF, HTML, MHT,
RTF, Excel, CSV, Text, Image)

Send via Email Produces the report in a format that allows you to
open it in an external application (PDF, HTML, MHT,
RTF, Excel, CSV, Text, and Image) and then send it
to recipient(s) using the computer’s default email
application.

Pulse 4.12 User Guide 601

Graphic Objects Animation Properties
You can create graphic objects that use animation to supply information to
the operator or as a means of executing commands from the operator
workstation. A graphic object may represent an indicator, a control, or a
special item, such as an instrument. You select an object type from the
Insert ribbon’s Graphic Objects group.

Animation properties affect the look and the behavior of graphic objects
on the operator workstation as a result of runtime value changes. An
object’s look and actions may convey information statically or dynamically
as the data values change.

This section includes instructions on the following tasks:

 Setting the Animation Properties

 Setting Security Levels

Setting the Animation Properties

To define the animation properties

1 Double-click the graphic object.

2 Open the relevant animation properties.

3 Enable features and set values as required.

NOTE To minimize the risk of editing the animation properties of the

wrong object, you can work in Lock Mode. Locking objects
helps prevent unintended modifications to graphic object and
animation properties while working in the Developer
Workstation, see Lock Mode.

To set Animation Properties to a graphic object

1 From the Insert ribbon’s Graphic Objects group, select an object

type and then click and drag in the display to create a new object,
or else, select an existing graphic object.

2 Open a specific Animation Properties page by right-clicking on

the object and selecting Animations from the pop-up menu then
select a specific property.

Pulse 4.12 User Guide 602

 -or-

Double-click the object.

The Animation Properties dialog box is displayed.

Pulse 4.12 User Guide 603

3 To navigate to the relevant property page, click on the required
icon on the toolbar.

4 Define the properties.

NOTE You can also choose to edit a different object’s Animation

Properties by choosing the specific object in the Name drop-
down list - you will see the object selected in the display.

Pulse 4.12 User Guide 604

 Click this button To open this Animation Properties page

Appearance Animation, see Animation

Properties - Appearance

Size Animation, see Setting Shape Animation

for Graphic Objects

Visibility Animation, see Animation

Properties - Visibility

Orientation Animation, see Animation

Properties - Orientation

Fluid Fill Animation, see Animation Properties

- Fluid Fill

Fluid Flow Animation, see Animation

Properties - Fluid Flow

Position Animation, see Animation Properties

- Position

Text Animation, see Animation Properties -

Text

Action Button Animation, see Animation

Properties - Action Button

Slider Animation, see Animation Properties -

Slider

Context Menu Animation, see Animation

Properties - Context Menu

Show All - View all applicable sets of

Animation Properties in the dialog box, with all
parameters accessible by scrolling up and
down.

Pulse 4.12 User Guide 605

This section contains the following topics:

 Animation Properties - Appearance

 Animation Properties - Size

 Animation Properties - Visibility

 Animation Properties - Orientation

 Animation Properties - Fluid Flow

 Animation Properties - Fluid Flow

 Animation Properties - Position

 Animation Properties - Text

 Animation Properties - Action Button

 Animation Properties - Slider

 Animation Properties - Context Menu

Animation Properties - Appearance

In the graphic object’s Appearance Properties, define for it a set of
visibility and color settings which indicate different data values or
conditions. You can define that the object is visible with specific colors,
blinks with specific colors, or is invisible, depending on the data item’s
value. Color settings can be assigned to the object’s interior (Fill), outline
(Line), or textual characters (Text) attributes.

The Appearance Settings depend on the method of input for the object’s
data:

 Analog Value - the object’s color is displayed in accordance with

the data item’s value, see Setting Appearance Properties for Analog
Values.

 Digital Value - the object’s color is displayed in accordance with

the data item(s)’s ON/ OFF state, Setting Appearance Properties for
Digital Values.

 Analog Alarm - the object’s color is displayed in accordance with

the alarm conditions, see Setting Appearance Properties for Alarms.

Pulse 4.12 User Guide 606

Setting Appearance Properties for Analog Values

If the data item is an analog value, different colors and visibility settings
may be defined for numerical ranges specified in the Appearance
Animation Properties dialog box. Appearance settings can be assigned to
the object’s interior (Fill), outline (Line), or textual characters (Text)
attributes.

To set Appearance properties for Analog Value data items

1 Select the graphic object.

2 Open the Appearance Animation Properties.

The Appearance Animation Properties dialog box is displayed.

3 Click Appearance to activate it.

Pulse 4.12 User Guide 607

4 Click the Fill, Line, and/or Text tab to define appearance
properties for the respective graphic object t components.

5 Choose Analog Value from the Type list.

6 In the Item box, type the item name (or select it in the Item
Manager) which controls this property’s values.

7 Define the appearance settings for each pertinent value range.

The illustration below displays a sample Analog configuration:

8 To apply the color settings of the current appearance attribute (Fill,

Line, or Text) to another appearance attribute, click the relevant
button:

Copy the appearance settings to the Fill

attribute.

Copy the appearance settings to the Line

attribute.

Copy the appearance settings to the Text

attribute.

Pulse 4.12 User Guide 608

NOTE To restrict the object’s visibility and usability according to
users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Setting Appearance Properties for Digital Values

For a digital value data item, the object’s Fill, Line, and Text Color
attributes are displayed in accordance with the data item ON/OFF state.
One visibility/appearance attribute is set for the 0 value and another
visibility/appearance attribute is set for the 1 value. A graphic object may
have up to three data items associated with it, and eight different
appearance settings for all combinations of the data items’ states, for
each graphic object component (Fill, Line, Text).

The following table depicts all the 8 possible states of three digital data
items. The results of the settings affect changes in the object’s
appearance, visibility, and blinking

Color Setting Item3 Item2 Item1

0 0 0 0

1 0 0 1

2 0 1 0

3 0 1 0

4 1 0 0

5 1 0 1

6 1 1 0

7 1 1 1

To set Color properties for Digital Value data items

1 Select the graphic object.

2 Open the Appearance Animation Properties.

Pulse 4.12 User Guide 609

3 Click Appearance to activate it.

4 Click the Fill, Line, or Text tab to define appearance properties for
the respective graphic object components.

5 Choose Digital Value from the Type list.

Pulse 4.12 User Guide 610

6 Define the following color settings.

Item 1, 2, 3… Define the digital addresses which control this

property’s values, such as digital blocks and/or
dummy variables (or assemble them in the
Item Manager). You can define up to three
data items for each object attribute (Fill, Line,
Text)

Use DBSR for bit Select this option only if you define Pulse
calculation Kernel items for this object, and the digital-to-
analog expression is written to another Kernel
item.

Do not select this option if the items refer to

other address categories.

If this option is selected, the Expression

parameter is enabled, presenting the digital-to-
analog expression.

Expression This parameter is relevant when the Use

DBSR for bit calculation option is selected.

Displays the resulting digital-to-analog

expression for the advised Items calculation,
depending on the Items defined for this digital
value control (Item 1, 2, & 3). For example:

|!@D/A(,|!d:1,|!d:2)

You may insert an analog kernel item before

the first comma in this expression - this results
in a change to that analog item’s value every
time there is a change in the digital items’
state.

Pulse 4.12 User Guide 611

The following image displays the property settings of possible bit
combinations for the object’s appearance settings. Click in the Visibility,
Color, and Blink cells to modify the settings. The following illustration
shows an example of color settings for two digital items.

Visibility Define the object’s visibility setting for the

corresponding bit combination. The available
settings are:

 Visible - object displays constantly.

 Invisible - object is hidden constantly.

 Blink - object alternates between two

different colors.

Color Defines the object’s color combination for its

visibility state (relevant for Visible and Blink).

Blink Defines the object’s second color for its

blinking state, in addition to the setting in the
Color column (relevant only for Blink).

7 To apply the appearance settings of the current appearance

attribute (Fill, Line, or Text) to another appearance attribute, click
the relevant button:

Copy the appearance settings to the Fill

attribute.

Copy the appearance settings to the Line

attribute.

Copy the appearance settings to the Text

attribute.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 612

Setting Appearance Properties for Alarms

Apply appearance settings to indicate the normal, alarm, and

acknowledgement states of analog alarms that are defined for a graphic
object. An analog alarm is triggered after an analog item value above or
below specified set points is received. Appearance settings can be
assigned to the object’s interior (Fill), outline (Line), or textual
characters (Text) attributes.

NOTE Coloring (appearance) of alarm states is applicable only for

database blocks.

To set Appearance (color) properties for Alarm conditions

1 Select the graphic object.

2 Open the Appearance Animation Properties dialog box.

Pulse 4.12 User Guide 613

3 Click Appearance to activate it.

4 Click the Fill, Line, or Text tab to define appearance properties for
those respective graphic object components.

5 Choose Alarm from the Type list.

6 In the Item box, type the item name (or select it in the Item
Manager) which controls this property’s values.

Pulse 4.12 User Guide 614

7 Define the following appearance settings.

When value is Define visibility (Visible, Blink, and

normal paint Invisible) and a color for the object while the
Alarm is in the Normal state.

“Alarm Define the respective appearance/colors for

Condition” table the block’s alarm conditions. You can fill in
information in each column using the Auto
Filters ( ).

When alarm is Define visibility (Visible, Blink, and Invisible)

Acknowledged, and a color for the object to indicate if the last
Paint alarm was acknowledged.

8 To apply the appearance settings of the current appearance

attribute (Fill, Line, or Text) to another color attribute, click the
relevant button:

Copy the appearance settings to the Fill

attribute.

Copy the appearance settings to the Line

attribute.

Copy the appearance settings to the Text

attribute.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 615

Setting Shape Animation for Graphic Objects

Shape Animation can now be applied to groups of Graphic Objects via

the Appearance Animation pane.

Shape Animation is a rapid display of a sequence of static images

(consisting of more than one Graphic Object grouped together) that are
different from each other. The grouped Graphic Objects have a configured
Start and End values (to indicate when the grouped graphic object has to
start and stop its animated motion) with a given interval in milliseconds to
produce an illusion of motion.

To create Shape Animation

1 Create a group of graphical objects in the display.

2 Right-click on the group of objects and select Animations >

Appearance from the pop-up menu.

The Animation pane is displayed with the Appearance

Animation icon selected.

Pulse 4.12 User Guide 616

NOTE Make sure that the Appearance Animation icon is selected.

3 Go to the Graphic Object tab.

The Graphic Object tab is the newly added tab that supports Shape
Animation.

4 Select Shape Animation from the Type field.

5 Define the Item field (e.g., |!a:1).

6 Define the Start Value (i.e., 1); the Start Value is the trigger
value that starts the shape animation.

7 Define the End Value (i.e., 0); the End Value is the trigger value
that stops the shape animation

8 Define the Interval (milliseconds) value (i.e., 50 (minimum),

500, 1000 (default)), which is the shapes’ animation interval in
milliseconds.

Pulse 4.12 User Guide 617

Animation Properties - Size
Apply the Size Animation Properties to indicate a change in the object’s
size according to changes in the object’s data item’s received value. The
Start Value and End Value represent the range within which the object’s
displayed size reflects the item’s received value. You can define whether
the sizing affects the object’s width, height, or both.

To set Size Animation properties

1 Select the graphic object.

2 Open the Size Animation Properties dialog box.

Pulse 4.12 User Guide 618

3 Click Size to activate it.

4 Click the Width or Height tab to define size properties for those
respective graphic object components.

5 In the Item box, type the item name (or select it in the Item
Manager) which controls this property’s values.

6 Define the following size settings.

Start Value Defines the value which is represented when the

object is at its smallest size

End Value Defines the value which is represented when the

object is at its largest size

Resize Parameters

Resize Factor This value indicates the multiplied amount that

the object grows from the Start Value to the
End Value. For values in between the start and
the end, the object’s current size will equal the
proportionate relationship of the current value
to the Start and the End values.

NOTE A negative value indicates a

shrinking object.

For example, suppose the Start Value is 0 and

the End Value is 100 and the Resize Factor is
set to 2. This means that the object’s size grows
from its size at 0 to twice that size at 100. If
the current value is 75, the object resizes to
75% the maximum value.

The following figure shows a Developer

Workstation portrayal of an object whose Start
Value is 0, End Value is 100, and the Resize
Factor is set to 2.

Pulse 4.12 User Guide 619

 Anchor to Select the area of the object which remains
anchored in place while the object changes size.

For width, select Right, Center, or Left

For height, select Bottom, Middle, or Top

Copy Settings Click this button to apply the Size attribute’s

to settings to the other Size attribute (Height or
Height/Width Width).

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels , see
Setting Security Levels.

Pulse 4.12 User Guide 620

Animation Properties - Visibility
Apply the Visibility Animation properties to a graphic object so that it is
Visible, Flash, Blink, or Invisible, in accordance with the property item’s
ON/OFF state.

NOTE The Visibility settings for OFF cannot be the same as the
settings for ON.

To set Visibility properties

1 Select the graphic object.

2 Open the Visibility Animation Properties dialog box.

Pulse 4.12 User Guide 621

3 Click Visibility to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

5 Set Visibility properties as follows:

When On/When Off

Define the object’s Visibility setting for the ON state, and a different
setting for the OFF state.

Visible Select to constantly display the object.

Flash Select to alternately display and hide the

object.

Blink Select to continuously alternate between two

different colors.

If the Object Fill is listed as a Primary Color in

the Blinking Colors Manager, then the blinking
effect switches back and forth between the
defined Primary and Alternate Colors,
see Blinking Colors.

If the Object Fill is not listed as a Primary

Color in the Blinking Colors Manager, the
Alternate Color is the Primary color’s default
inverse.

Invisible Select to constantly hide the object.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 622

Animation Properties - Orientation
A graphic object’s orientation refers to its rotation angle in the screen
display. Apply the Orientation Animation Properties to an object so that
the amount it rotates indicates the object’s data values.

The settings indicate the amount that the object rotates along its axis
from the Start Value to the End Value. For values in between the Start
and the End, the object’s current orientation equals the proportionate
relationship of the current value to the Start and the End values.

The following figure shows an object (selected in the Developer

Workstation) that rotates along a counter-clockwise 90° rotation to display
values from 0 to 100.

To set Orientation Animation properties

1 Select the graphic object.

2 Open the Orientation Animation Properties dialog box.

Pulse 4.12 User Guide 623

3 Click Orientation to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

Pulse 4.12 User Guide 624

5 Define the following orientation settings:

Start Value Define the value which is represented when

the object is at its starting rotation angle.

End Value Define the value which is represented when

the object is at its end rotation angle.

Pivot Displacement

Choose the object’s pivot location by one of the following methods:

Pivot Select one of the nine buttons (as illustrated

Displacement above) to define the pivot location. For
example, the center button represents a pivot
in the object’s center; the upper right button
represents a pivot in the object’s upper right
corner.

Other Select this option to set a non-standard pivot

location.

Horizontal Type the horizontal displacement value.

Vertical Type the vertical displacement value.

Direction and Span

Clockwise Select this option to define rotation from the

start angle to the end angle in the clockwise.
Deselect this option for counterclockwise
rotation.

Cyclic Select this option to enable the display of

values over or under the end angle or start
angle, respectively. In such a case, the item’s
value is the remainder of the “item value/end
value” equation.

Angle Type the angle of the object’s orientation

(1-360°).

6 Close the Animation dialog box and save the changes.

Pulse 4.12 User Guide 625

NOTE To restrict the object’s visibility and usability according to
users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Animation Properties - Fluid Fill

The Fluid Fill Animation properties enable a graphic object to “fill up” to
indicate the values of the data item represented by the object. The
amount of fill is proportionate to the location of the current value within
the configured start value/end value range. For example, if the Start
Value is 0, the End Value is 100, and the current value is 50, the
graphic object appears half-full.

You can add Fluid Fill to a closed object of any shape, and in any of the
four directions (up, down, left, right).

To set Fluid Fill Animation properties

1 Select the graphic object.

2 Open the Fluid Fill Animation Properties dialog box.

Pulse 4.12 User Guide 626

3 Click FluidFill to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

5 Define the following Fluid Fill settings.

Start Value Define the value which is represented when

the object’s fill is at its minimum level.

End Value Define the value which is represented when

the object’s fill is at its maximum level.

Pulse 4.12 User Guide 627

 Fill Appearance

Max % Define the percentage of the object that is

filled when the runtime value equals the end
value. For example, 100% fills the object
completely at the end value, 75% fills the
object 3/4 at the end value, and so on.

Min % Define the percentage of the object that is

filled when the runtime value equals the start
value. For example, 0% provides no fill at the
start value, 25% fills the object 1/4 at the start
value, and so on.

Start Color Select the color of the fill close to the start
value level.

End Color Select the color of the fill close to the end
value level.

Background Select the color for the area within the object
Color not covered by the fill.

Angle Choose the angle of the fill.

Line Only Select this option to apply a line (instead of a

fill) to indicate the runtime values. The defined
Start and End colors affect the color of the line.

Thickness If you select the Line Only option, choose the

thickness of the line.

Preview

Preview Value Enter a value which is used to simulate the

fluid fill effect on the graphic object.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels,
see Setting Security Levels.

Pulse 4.12 User Guide 628

Animation Properties - Fluid Flow
The Fluid Flow Animation Properties enable the activation of a flow
movement, a static (non-moving) mode, or an invisible line, along the
outline of a graphic object, in accordance with the object item ON/OFF
state.

To set Fluid Flow Animation properties

1 Select the graphic object.

2 Open the Fluid Flow Animation Properties dialog box.

Pulse 4.12 User Guide 629

3 Click FluidFlow to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

5 For both WhenOn and WhenOff conditions, define the following fluid
flow settings.

When On/When Off

Define the object’s FluidFlow setting for the ON state, and a

different setting for the OFF state.

Invisible The outline movement is unseen.

Flow The outline movement is seen.

Static The outline does not move.

Color Select the color of the fluid flow. Only solid

colors are applicable.

Wave Length Define the length of the flow lines.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Animation Properties - Position

The Position Animation Properties enables a graphic object to change its
position (“portray motion”) to indicate changes in the object item’s value.
Any change in the position item’s value moves the object to a
proportionate position between the configured start and end value
positions.

You can set the object to move horizontally, vertically, or along both
planes.

To set Position Animation properties

1 Select the graphic object.

2 Open the Position Animation Properties dialog box.

Pulse 4.12 User Guide 630

3 Click Position to activate it.

4 Click the Horizontal or Vertical tab.

5 In the Item box, enter the name of the item which controls this
property’s values.

Pulse 4.12 User Guide 631

6 Define the following position settings.

Start Value Define the value which is represented when the

object is located at its start position.

End Value Define the value which is represented when the

object is located at its end position.

End Position Define the amount that the object moves along
Offset a vertical and/ or horizontal plane from the
Start Value to the End Value. For values in
between the Start and the End, the object’s
current position will equal the proportionate
relationship of the current value to the Start
and the End values.

Alternatively, you can drag the object’s end

value edge to a target location and the
resulting offset value will appear in this field.

Cyclic Select this option to enable the display of

values over or under the end or start values,
respectively. In such a case, the item’s value is
the remainder of the “item value/end value”
equation.

Pulse 4.12 User Guide 632

 Controllable

The options in this group enable operators to interactively control

the object’s position.

Use as Input Select this option to enable the object to

Slider behave as a slider.

When you drag the object along its defined

path, its data item’s value changes according to
the object’s location.

Set values as This option is applicable if Use as Input Slider

mouse moves is selected. Select this option to change the
object’s data value at the same time that you
drag it along its defined path.

Log Inputs Select this option to record all of this object’s

actions in a log file.

Copy Settings
to Click the Copy Settings to
(Horizontal/Vertical) button to apply the
Position settings to the other position attribute
(Horizontal or Vertical).

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Animation Properties - Text

The Text Animation Properties enable the graphic object to display
alphanumerical text, in accordance with the input or output values of the
object’s item. For example, you can use the text properties to display
counters, timers, warnings, operational state, or other textual
information.

To set Text properties

1 Select the graphic object.

2 Open the Text Animation Properties dialog box.

Pulse 4.12 User Guide 633

3 Click Text to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

Pulse 4.12 User Guide 634

5 Define the following position settings:

Behavior

Read Only Select this option to prevent the operator from

typing any input text in this object during
runtime.

Deselect this option to enable operators to

change the text.

Right Click Task Select this option to display a tasks menu if the
operator right- clicks on the object.

Tooltip

Show Time Select this option to display the data item’s

Stamp time stamp in the object’s tool tip. If selected,
choose the time stamp’s display format:

 Time Only

 Time And Short Date

 Time And Long Date

 None

Prompt Type free text to display in the object’s tool tip.

Accelerator Key

An accelerator key is a shortcut keyboard combination that when

pressed, carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut.

First, choose a key from the list (None, A-Z,
F1-F24, PageUp, PageDown, Home, End, 0-9,
NumPad0 – NumPad9, Escape, Space).
Optionally, you can add one, two, or all of the
Shift/Ctrl/Alt keys to the shortcut.

Pulse 4.12 User Guide 635

 Format

The Format parameters define how the object’s text output

appears during runtime.

Use Format Choose from one of the following format from

the drop-down list:

 UnformattedText

 DecimalValue

 SignedDecimalValue

 Text for On/Off

 Text for Value Range

 ZeroPaddedDecimalValue

 ZeroPaddedSignedDecimalValue

 SimpleTime

 RegionalTime

 ShortRegionalDate

 LongRegionalDate

 Advanced

Sample This box displays a sample of the selected

Format choice above.

NOTE The Mask Type parameter is only available if you chose

the Advanced format in the Use Format field.

The Edit Mask and Category parameters are available

for all mask types except Text for On/Off.

Pulse 4.12 User Guide 636

 Mask Type Choose the type of text to display as the
object’s output:

 None

 DateTime

 Numeric

 RegEx

 Regular

 Simple

 Text for On/Off

Edit Mask Edit the mask text in this box. Depending on

the Category selection, Pulse presents syntax
format suggestions for the object’s text.

Category Choose a subtype of the selected Mask Type.

This choice depends on the selected Mask
Type, and in turn, affects the format in the
Edit Mask box.

Place Holder You can define a character that represents the

mask text defined above.

Password You can define a character that functions as a

Character password character, hiding the identity of the
true character being typed. When the operator
types input text in the provided box, this
character appears in the text box instead.

Horiz. Select the location of the text output in the

Alignment object (Left, Center, or Right).

The following Command and Indication parameters are available

only for the Text for On/Off mask type (digital 1/0).

In the Operator Workstation, the operator has a dialog box which

presents the available commands and the expected output.

Pulse 4.12 User Guide 637

 Command

On (Set) Enter the text that will appear on the command

button to set the data (turning ON). Applies
only to input text.

Reset (Off) Enter the text that will appear on the command
button to reset the data (turning OFF). Applies
only to input text.

Indication

On Enter the value that represents the data’s ON

status.

Off Enter the value that represents the data’s OFF

status.

Input

The Input parameters define how the operator input will appear at
runtime.

Log Select this checkbox option to record all of this

object’s text inputs in a log file.

Immediate Select this checkbox option to display this

object’s text input dialog box when the mouse
hovers over the object. When deselected, the
operator opens the dialog box by clicking the
mouse.

Pulse 4.12 User Guide 638

 Secure Input by Select this checkbox option to require the
Additional Login operator to provide a User Name and Password
before typing an input.

Confirm Before Select this checkbox option to request

Activation confirmation from the operator before
implementing any input. In the text box, type
the confirmation request string.

Use Numeric Select this checkbox option to define a range of

Range Input permitted numerical values that the operator
Filter may enter.

Minimum Value Define a minimum value for the numeric range.

Maximum Value Define a maximum value for the numeric

range.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 639

Animation Properties - Action Button
The Action Button Animation Properties enable operators to carry out
commands by performing a mouse action on an object. You can define
actions to occur when the operator holds the mouse button down,
releases the mouse button, clicks the mouse button once, or double-clicks
the mouse button.

NOTE All mouse button commands referred to in this section assume

use of the left button as the primary mouse button. If the right
button is configured in the operator PC as the primary mouse
button, then the operator needs to use the right button to
carry out the defined commands.

Pulse commands can include the following:

Advised Items Set and retrieve data item values.

Display Open, close and manipulate Operator Workstation

Commands displays

Menu Commands Replicate Operator Workstation menu commands

Reporting and Generate reports and documents based on historical

Printing data and trends
Commands

Special Execute various specialty operations

Commands

Task Commands Start, stop and control Windows tasks

Windows Control Enable/Disable Operator Workstation window

Commands features

Pulse 4.12 User Guide 640

To set Action Button properties

1 Select the graphic object.

2 Open the Action Button Animation Properties dialog box.

3 Click Action Button to activate it.

4 Define the following action, workflow, and mouse attribute settings.

Pulse 4.12 User Guide 641

 Action Workflow

To define the object’s data item, enter an action command or

workflow.

• You can type it manually.

When manually typing a command to execute a

workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard syntax.

-or-

• Open the Action Selector to assemble and/or choose

the command or workflow.

NOTE After you enter a workflow, it appears in the relevant

edit box in the following syntax:

[WorkflowName] [arguments]

Action Down Specify a command or workflow to run while

the operator holds the mouse button down.

Action Up Specify a command or workflow to run when

the operator releases the mouse button after
holding it down.

Action Click Specify a command or workflow to run when

the operator clicks the mouse button.

Action Double Specify a command or workflow to run when

Click the operator double-clicks the mouse button.

Mouse Attributes

Prompt Type the text string to appear in the object’s

tool tip.

Repeat Action Repeat the defined action as long as the

mouse button remains held down on the
object. Choose the time interval in ms for the
repeat action.

Log Inputs Select this option to record all of this object’s

actions in a log file.

Pulse 4.12 User Guide 642

 Beep Select this option to make a beeping sound
when the operator performs a mouse action on
the object.

Invert Select this option to change an object’s defined

colors when the operator performs a mouse
action on the object.

Accelerator Key

An accelerator key is a shortcut keyboard combination that when

pressed, carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut.

First, choose a key from the list (None, A-Z,
F1-F24, PageUp, PageDown, Home, End, 0-9,
NumPad0 – NumPad9, Escape, Space).
Optionally, you can add one, two, or all of the
Shift/Ctrl/Alt keys to the shortcut.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Animation Properties - Slider

The Slider Animation Properties enables a graphic object to behave like
a slider, where the operator can either change the data value by dragging
the object along a defined plane, or the object passively changes position
along the plane after it receives the data input. The slider moves to a
location in accordance with the value’s proportionate relationship to the
configured start and end positions.

For example, a slider can indicate changes in temperature, power

intensity, or other quantitative changes in level.

To set Slider properties

1 Select the graphic object.

2 Open the Slider Animation Properties dialog box.

Pulse 4.12 User Guide 643

3 Click Slider to activate it.

4 In the Item box, enter the name of the item which controls this
property’s values.

Pulse 4.12 User Guide 644

5 Define the following slider attributes:

Start Value Define the value which is represented when

the object is located at its start position.

End Value Define the value which is represented when

the object is located at its end position.

End Position Define the amount that the object moves

Offset along a vertical and/ or horizontal plane from
the Start Value to the End Value. For values
in between the Start and the End, the object’s
current position will equal the proportionate
relationship of the current value to the Start
and the End values.

Alternatively, you can drag the object’s end

value edge to a target location and the
resulting offset value will appear in this field.

Direction Choose whether the slider moves along a

Horizontal or Vertical plane.

Prompt Type the text string to appear in the object’s

tool tip.

Set values as Select this option to change the object’s data

mouse moves value at the same time that you drag it along
its defined path.

Log Inputs Select this option to record all of this object’s

actions in a log file.

Pulse 4.12 User Guide 645

 Accelerator Key

An accelerator key is a shortcut keyboard combination that when

pressed, carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut.

First, choose a key from the list (None, A-Z,
F1-F24, PageUp, PageDown, Home, End, 0-9,
NumPad0 – NumPad9, Escape, Space).
Optionally, you can add one, two, or all of the
Shift/Ctrl/Alt keys to the shortcut.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels,
see Setting Security Levels.

Pulse 4.12 User Guide 646

Animation Properties - Context Menu
The Context Menu Animation Properties enable you to attach a context
menu that opens temporarily when the operator right-clicks on an object.
A context menu provides a set of choices that is relevant to a selected
object or active mode - additionally, it can also include a limited set of
additional commands. When the operator selects a command, or clicks
anywhere on the screen again, the menu disappears.

In addition to the standard Pulse context menus (system), you can assign
customized context menus which provide commands that are related to
specific functions or conditions. For more information about creating
customized context menus, see Toolbars and Context Menus.

Pulse provides the following options for defining a context menu that
depends on the method of input for the object’s data:

 Analog Value - set up multiple ranges within the data item’s

minimum and maximum values, and define different context menus
to open depending on the current value received for the item.

For example, one menu can open when the value is 0-20, another
menu can open when the value is 21-80, and a third menu can
open when the value is 81-100.

 Analog Alarm - define a context menu that is displayed if the data

value is in a Normal state and a menu that is displayed if an Alarm
is in an Acknowledged state.

 Digital Value - define a context menu that is displayed if the

digital data value is 0 and a menu that is displayed if the value is 1.

 Static Context Menu - choose one context menu that is not

dependent on any data value, and always opens when you right-
click the object (unless no menu is defined), regardless of the
current data and conditions in the Operator Workstation.

This section includes the following topics:

 Setting an Analog Value Context Menu

 Setting an Alarm Context Menu

 Setting a Digital Value Context Menu

 Setting a Static Context Menu

Pulse 4.12 User Guide 647

Setting an Analog Value Context Menu

If the data item is an analog value, different context menus may be

defined for different numerical ranges.

To define Context Menu animation for Analog Value objects

1 Select the graphic object.

2 Open the Context Menu Animation Properties dialog box.

3 Click Context Menu to activate it.

Pulse 4.12 User Guide 648

4 Choose Analog Value from the Type list.

5 In the Item box, type the item name (or select it in the Item
Manager) which controls this property’s values.

6 Select a context menu for each pertinent value range.

The illustration below displays a sample Analog Context Menu

configuration:

Replace Select this option to completely replace the

Pulse system context menu with the
customized menu.

Deselect this option to append the customized

menu commands to the Pulse system context
menu.

Add Enter a numerical range limit and then click

this button to add a new range.

Delete the corresponding range.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 649

Setting an Alarm Context Menu

Define the context menus to open during the Normal and Acknowledged
states of an alarm item that is defined for this graphic object. The defined
menus will open (when operator right-clicks) in accordance with the
current alarm state.

To define Context Menu Animation for Alarm conditions

1 Select the graphic object.

2 Open the Context Menu Animation Properties dialog box.

3 Click Context Menu Animation to activate it.

4 Choose Alarm from the Type list.

Pulse 4.12 User Guide 650

5 In the Item box, type the address with the block name (or select it
in the Item Manager) which controls this property’s values. Click
the check mark in the Item box - this displays any Alarm
Conditions in the dialog box’s Alarm Condition table.

6 Define the following context menu settings.

When value is Define the context menu that is displayed

normal paint when the operator right-clicks the object while
the Alarm is in the Normal state.

Replace System Select this option to completely replace the

Menu Pulse system context menu with the
customized menu for all alarm conditions.

Deselect this option to append the customized

menu commands to the Pulse system context
menu.

“Alarm In the table, select the alarm condition’s

Condition” table checkbox to enable the context menu property
setting.

In the Context Menu column, choose the

context menu associated with the alarm
condition.

In the Replace System Menu column, select

the checkbox to completely replace the Pulse
system context menu with the customized
menu.

When alarm is Define the context menu that is displayed

Acknowledged when the operator right-clicks the object while
paint the Alarm is in the Acknowledged state.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 651

Setting a Digital Value Context Menu

In this case, a context menu can open or close in accordance with the
data item’s ON/OFF state. One attribute is set for the 0 value and another
attribute is set for the 1 value. A graphic object’s Context Menu
Animation may have up to three data items associated with it, and eight
different context menu settings for all combinations of the data items’
states.

To define Context Menu Animation for Digital Value objects

1 Select the graphic object.

2 Open the Context Menu Animation Properties dialog box.

3 Click Context Menu Animation to activate it.

Pulse 4.12 User Guide 652

4 Choose Digital Value from the Type list.

5 Define the following menu settings.

Item 1, 2, 3 Define the digital addresses which control this

property’s values, such as digital blocks and/or
dummy variables (or assemble them in the
Item Manager).

For each item you add, the number of possible

context menu definitions is doubled. For
example:

 1 item > 2 context menu settings

 2 items > 4 context menu settings

 3 items > 8 context menu settings

Use DBSR for Select this option only if you define Pulse Kernel
bit calculation items for this object, and the digital-to-analog
expression will be written to another Kernel
item.

Do not select this option if the items will refer to

other address categories.

If this option is selected, the Expression

parameter is enabled, presenting the digital-to-
analog expression.

Pulse 4.12 User Guide 653

 Expression This parameter is relevant when the Use DBSR
for Bit Calculation option is selected.

Displays the resulting digital-to-analog

expression for the advised Items calculation,
depending on the Items defined for this digital
value control (Item 1, 2, & 3). For example:

|!@D/A(,|!d:1,|!d:2)

You may insert an analog kernel item before the

first comma in this expression - this results in a
change to that analog item’s value every time
there is a change in the digital items’ state.

Context Menu Choose a context menu for each digital item

column value combination.

Replace Select this option to completely replace the

Pulse system context menu with the customized
menu.

Deselect this option to append the customized

menu commands to the Pulse system context
menu.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Setting a Static Context Menu

Define a Static Context Menu that always opens when you right-click
the object, regardless of the current data and conditions in the Operator
Workstation.

Pulse 4.12 User Guide 654

To define a Static Context Menu for a graphic object

1 Select the graphic object.

2 Open the Context Menu Animation Properties dialog box.

3 Click Context Menu Animation to activate it.

4 Choose Static Context Menu from the Type list.

Pulse 4.12 User Guide 655

5 Define the following Static Context Menu properties:

Static Context Assign a specific menu to the object.

Menu
 System - opens the default Pulse
Operator Workstation context menu.

 None - no menu is displayed.

 Current - the most recently set context

menu.

 Any customized context menus that

were created in the Toolbars and
Context Menus Manager, see Toolbars
and Context Menus.

Replace System Select this option to completely replace the

Menu Pulse system context menu with a customized
menu.

Deselect this option to append the customized

menu commands to the Pulse system context
menu.

NOTE To restrict the object’s visibility and usability according to

users’ keys and authorization, set the Security levels, see
Setting Security Levels.

Pulse 4.12 User Guide 656

Referencing Animation Properties
There are two types of Pulse references:

 (this) - Display Name (Display ID)

 (thisobject) - Object Name (Symbol ID)

Referencing the Display Name (Display ID)

You can reference the name of the animated display (a collection of

graphical objects showing the plant floor (for example) or any other piece
of hardware. A display can show data and can also receive operator input
ID) as part of an animation parameter:

 In a control - in the prompt

 In an action button - in the action specification

 In any other animation property - in the server, topic or item

names of the data that drives that animation property

NOTE This function replaces P-CIM’s MYDID function.

Example:

close (this)

means: close (Display name); the display name where the item is
located.

To reference the display name (Display ID)

1 Open a display on the Developer Workstation and create an object.

2 Double-click on the object.

The Animation dialog box is displayed.

3 Click the Action Button Animation icon.

The ActionButton area within the Animation dialog box is displayed.

Pulse 4.12 User Guide 657

4 Enter close (this) on the Action Click field.

At runtime, when the display is opened and every time the object is
clicked, the display closes.

Pulse 4.12 User Guide 658

Referencing the Object Name |!(thisobject)

Use the name of the animated object (thisobject) as part of its animation
parameter:

 In a control - in the prompt

 In an action button - in the action specification

 In any other animation property - in the server, topic or item

names of the data that drives that animation property

You can benefit from the following features once you animated the first
object:

 On the next object that is animated, the Animation dialog box

enters into the server the topic and item that was last entered - so
you do not have to type them repeatedly.

To reference the object name (thisobject)

1 On the Developer Workstation, create an object on the display.

2 Double-click on the object.

The Animation dialog box is displayed.

3 Enter the object’s name on the Name field.

Pulse 4.12 User Guide 659

4 Click the Action Button Animation icon.

The ActionButton area within the Animation dialog box is displayed.

5 Enter the Set |!(thisobject) 10 command on the Action Down

field.

In this example, the command Set |!(thisobject) 10 is given

where (thisobject) is referring to a:1 which is the object’s name
that was provided on the Name field.

Set |!(thisobject) 10 means Set |!a:1 10

Pulse 4.12 User Guide 660

Setting Security Levels
There may be activities that are restricted and are only available to
certain operators, who have specialized knowledge and responsibilities.
Pulse uses security mechanisms such as locks/keys and access levels to
restrict operator access to specific controls in a display. For example,
restrictions may apply to access to a display or to objects within a display,
where certain lock levels or access values are attached to them.

You can assign user authorization in levels. The highest level is 0, which
allows users full control to all areas of the project. The lowest level is 99,
which allows users the most restricted authorization. You may define
additional levels in between 0 and 99 which reflect varying degrees of
permitted configuring, monitoring, and operating activities.

For more information about setting user authorization, see Simple

Authorization Mode and Advanced Authorization Mode.

To set security levels for Animation Properties

1 Select the graphic object.

2 Open the specific Animation Properties that you need to define.

3 Each property page has a section titled Security. Define the

security levels as follows:

Visibility The control is visible only to users whose

security level equals or is higher than the level
specified here.

Usability The control may be used only by users whose

security level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 661

Pulse Instruments
Instruments are pre-designed objects, which may be assigned with
dynamic properties that you insert into a display or a template. The
various types of instruments display information, carry out functions, or
run applications in accordance to the data they receive from their
respective advised items.

For example, trend graphs can display real-time or historical data from
numerous advised items, an embedded Alarm Explorer can display alarm
information, a data sheet instrument can display data from various data
sources (such as XML files, OLEDB databases, text and INI files), as well
as numerous other functions.

Further, you may insert buttons, sliders, gauges, and meters to control
production floor equipment, or to display information coming from the
field. Other instruments include the Web Browser and Media Player
instruments, which can display Internet content and video during runtime.

As opposed to graphic objects, instruments cannot have graphics nor

animation properties, but can have defined dynamic settings.

This chapter describes the instrument objects that you can apply to a
display:

 Pulse Web Browser Instrument

 Pulse Trend Graph Instrument

 Pulse Toolbar Instrument

 Pulse Selection Box Instrument

 Pulse Meter Instrument

 Pulse Media Player Instrument

 Pulse Gauge Instrument

 Pulse Datasheet Instrument

 Pulse Slider Instrument

 Pulse Text Object Instrument

 Pulse Action Button Instrument

 Pulse Cylinder Instrument

 Pulse Annunciator Instrument

Pulse 4.12 User Guide 662

 Pulse Alarm Explorer Instrument

 Pulse Table Instrument

 Pulse Animated Picture Instrument

 Pulse Event Management Instrument

 Pulse Chart Instrument

Instrument Dynamic Settings

Each Pulse instrument has a Settings dialog box for defining its type-
specific parameters. The dynamic settings affect the appearance and the
behavior of Pulse instruments on the operator workstation. An
instrument’s behavior may convey information statically or dynamically as
the data values change.

To define Pulse instrument settings

1 Double-click the instrument.

-or-

Right-click the instrument and select Settings from the menu.

2 In the specific instrument’s Settings dialog box, define the relevant

parameters and click OK.

Pulse 4.12 User Guide 663

Defining Instrument Advanced Properties
Opening an instrument’s Advanced Properties pane gives you access to
a comprehensive table of parameters for the selected instrument. You can
edit all writable parameters by clicking in the cell containing the value you
want to change; you then type, select from a list, or browse to select the
new value.

The Advanced Properties pane is context-sensitive to the selected

instrument type. Some of the parameters are only applicable to the
specific type, such as TickFrequency for a Slider, or BrowserAddress for a
Web Browser object. Many of the parameters can also be found and
defined in the instrument’s Settings dialog box.

The following options for displaying the Advanced Properties pane are
available:

To open an Instrument’s Advanced Properties

 Right-click on the instrument and choose Advanced Properties.

The Advanced Properties pane is displayed on the right side of the

display (you can move it to a different location and resize it).

Pulse 4.12 User Guide 664

Pulse 4.12 User Guide 665
Pulse Web Browser Instrument
Pulse enables you to embed a web browser in a display. You can
command the browser to go to a website specified by the operator during
runtime or define a URL that the browser will go to automatically
whenever the display is open during runtime.

To insert and define a Web Browser object

1 From the Insert ribbon’s Instruments group, click the Pulse

Web Browser icon and then drag an area on the display to locate
the browser object.

2 Right-click the object and select Settings from the menu.

The Pulse Web Browser Settings dialog box is displayed.

Pulse 4.12 User Guide 666

3 Define Web Browser settings as follows:

Item Use this parameter to enable the browser to go

to a URL that you provide on a dynamic basis,
for example through a $DS variable ($DS0,
$DS1, $DS2, up to $DS9 are supported by
Pulse).

For example, in the Operator Workstation,

open the Data Scope and type |!$DS1 and
then in the Value column, enter the name of
the URL.

Static Address Use this parameter to automatically go to the

same URL whenever the display is displayed at
runtime. Type the URL address in the box.

Show Address An address bar is displayed on the web

Bar browser object.

Show Progress A progress status bar is displayed on the web

Bar browser object.

4 Open the Security tab and set the Security levels:

Visibility The control is visible only to users whose

Security Lock authorization level equals or is higher than the
level specified here.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the
level specified here.

Pulse 4.12 User Guide 667

5 Click OK to implement the settings and close the dialog box

–or-

Click Apply to implement settings and keep the Pulse Web

Browser Settings dialog box open.

Pulse Trend Graph Instrument

Trend graphs display a set of data values in their order of occurrence over
a period of time. They are a very valuable tool for troubleshooting and
analyzing processes as they occur in runtime, or as they occurred in the
past from a historical perspective.

During runtime, Pulse continually updates a trend graph as the address’s

values change. You can scroll along the graph to view previous values.
The trend’s historical data collection continues even when the display is
not active.

You can insert a trend graph into the display and define it to track several
items at once. The available trend types are:

 Real Time Trend Graph

 Historical Trend Graph

 Curve Trend Graph

 Deviation Meter Graph

 Bidirect Deviation Meter Graph

 Historical Batch Graph

This section includes the following topics:

 Creating a Trend Graph

 Trend Graph Settings

Pulse 4.12 User Guide 668

Real Time Trend Graph
A Real-time Trends Graph displays real-time activities whose values are
automatically updated in the Operator Workstation. As values change, the
Trend Graph continually displays the latest real-time values. Addresses in
a real-time trend can be a direct address, a data block, or a variable.

Real Time Trend Graphs use pens to represent specific data items. By
defining various display parameters for each, you will receive clear
pictures of the rates of change or consistency among the items you need
to monitor.

Historical Trend Graph

The Historical Trend Graph is a dynamic graph that presents historical
data that was collected over a period of time and stored in the Database
Server. Data can be saved in historical files and viewed in a historical
trend in the Operator Workstation. The trend's sample time can be
automatically calculated based on the defined time span, or set manually.

Each item in a historical trend graph is represented in a separate pen.

The data can be retrieved within two distinct time spans: absolute (fixed
in time) or relative (relative to the current time).

Pulse 4.12 User Guide 669

Curve Trend Graph
The Curve Trend Graph is a dynamic graph that presents real-time data
compared to reference values over a period of time.

Curve Trend Graphs typically show the following:

 An actual data pen representing the real-time data

 A fixed data reference pen showing a reference value at a specific

time

 The start signal which synchronizes the starting point of the fixed
pen.

Pen configuration is similar to the Real Time Trend configuration.

Deviation Meter Graph

The Deviation Meter Graph indicates at-a-glance whether or not each
defined advised item is in its normal range or has deviated to
unacceptable levels (very low, low, high, or very high).

Each advised item is represented by a bar whose height indicates the last
received value. The bar’s baseline is the Bottom value. The bar’s minimum
(baseline) height is at the Bottom value and its maximum height indicates
the Top value.

The bar displays the normal value of each advised item between the Low
and High values as and four other ranges by visual level and by color,
delineated by the following defined values:

 Bottom

 LoLo

 High

 Top

 Low

 HiHi

You can define how much of the total visual span and which color you
allocate for each such condition.

Pulse 4.12 User Guide 670

For example, suppose that a Deviation Meter Graph’s bar is configured as
follows:

Bottom=0, Top=60, LoLo=10, Low=25, High=35, HiHi =50

The various ranges are configured to appear on the graph in different

colors.

Pulse 4.12 User Guide 671

Bidirect Deviation Meter Graph
The Bidirect Deviation Meter Graph shows the amount that an advised
item’s value deviates from the normal value, which is the graph’s
baseline. Each advised item is represented by a bar that grows if the
actual value goes farther away from the baseline value, and shrinks if the
actual value gets closer to the baseline value.

The Bidirect Deviation Meter Graph uses the bar length and colors to
indicate at-a-glance whether or not each variable is in its normal range
(very low, low, high or very high).

You can define how much of the bar’s total visual span and which color
you allocate for each range:

 Bottom

 Top

 LoLo

 Low

 High

 HiHi

For example, suppose that a Bidirect Deviation Meter Graph has a bar
configured as follows:

Bottom=0, Top=60, LoLo=10, Low=20, High=40, HiHi =50.

The various ranges are configured to appear on the graph in different

colors.

Pulse 4.12 User Guide 672

For more information, see Bars.

Historical Batch Graph

Batch Graphs display historical data over batch-related time frames. When
a block or advised item refers to a data trend in a specified time period,
Pulse can find and display the relevant trend as a batch graph.

When configuring a batch graph for an advised item, you need to define
its time base (start time and time span), maximum number of batches to
create, divisions of time within the recorded batch periods.

In order to associate the time frame of the trend with batch numbers, you
need to record the history of a variable whose value represents the
current batch number (in the same way you record the trended variables -
see Defining Analog Value Block Properties or Defining Calculation Block
Properties. The value of the batch number variable must be a whole
number, stay at the same value as long as a particular batch lasts, and
increase by 1 for each subsequent batch.

Pulse 4.12 User Guide 673

Creating a Trend Graph
To create a trend graph

1 From the Insert ribbon’s Instruments group, click the Pulse

Trend Graph icon and then drag an area on the display to locate
the trend object.

2 Right-click the object and select Settings from the menu.

The Trend Graph Settings dialog box is displayed.

3 Define Trend Graph properties. From the Trend Type list, choose
the type of trend graph.

The choice affects the availability of parameters in the other tabs.

Pulse 4.12 User Guide 674

4 Define the properties, opening all tabs, if necessary, to complete
the graph’s configuration. Click Apply to implement changes while
keeping the Trend Graph Settings dialog box open.

–or-

Click OK to implement changes and close the Trend Graph

Settings dialog box.

For explanations about all the properties, see General to Advanced.

5 To store these settings for reuse later, click Save. In the Save
Settings dialog box, enter a name for this set of Trend Graph
properties and click OK.

To reuse previously defined Trend Graph settings, click Load. In

the Load Settings dialog box, enter the name (or select it from the
list) of the set of properties and click OK.

Trend Graph Settings

Depending on the choice of trend graph, you can define the following
types of parameters for the graphs:

 General

 Time Settings

 Pens

 X Axis

 Y Axis

 Toolbar

 Bars

 Security

 Advanced

Pulse 4.12 User Guide 675

General

Graph Types: Real Time Trend Graph, Historical Trend Graph, Curve Trend
Graph, Deviation Meter Graph, Bidirect Deviation Meter Graph, Historical
Batch Graph

In the General tab, you can define the appearance of the graph display
space, such as its title text and background color scheme.

Trend

Name Type a descriptive name for the graph.

Trend Type Choose the graph type from the list.

Pulse 4.12 User Guide 676

Correlation Select this option to chart all the of the graph’s
values in relation to a variable. This option is
available only for Real Time Trend Graph, Historical
Trend Graph, and Historical Batch Graph.

Title

Visible Select this option to display the graph’s title.

Text Type the graph’s title.

Alignment Choose if the title appears on the graph’s Left,

Center, or Right side.

Color Choose the title’s color.

Font Choose the font and size of the title’s text.

Background

Instrument Choose a color for the background surrounding the

graph area.

Image/One Select the background for the graph:

Color/Two Colors
 Image - a graphic file

 One Color - one solid color

 Two Colors - two colors that transform into

each other in the direction defined in the
Shading tab, see Shading tab below.

Colors tab

Image Applicable if Image is the selected background.

Browse to insert a graphic file (such as .BMP, GIF,
JPG) as the graph’s background.

Color 1 If One Color is the selected background, choose the

color that appears as a solid background.

Color 2 If Two Colors is the selected background, choose

the color that appears together with Color 1 as the
background.

Pulse 4.12 User Guide 677

Shading tab

The Shading tab is applicable if a Two Colors background has been

selected.

From Center Select this option to orient Color 2 from the center of
the graph.

Light Move the slider to set the intensity of Color 2

between Light and Dark.

Left Move the slider to place Color 2 horizontally from

Left to Right on the graph.

Round Move the slider to orient the Color 2 bar’s position

along a circular plane.

Time Settings

Set the default time settings for the Trend Graph.

 Real Time Trend Graph, Curve Trend Graph Time Settings

 Historical Trend Graph Time Settings

 Historical Batch Graph Time Settings

The Trend Graph Time Settings time formats for Time Span and
Sample Time are as follows:

 The Time Span format is ddd:hh:mm:ss:ms

(day:hour:minute:second:millisecond)

 The Sample Time format is hh:mm:ss:ms

(hour:minute:second:millisecond).

Pulse 4.12 User Guide 678

The time formats enable users to define day and time options without
having to calculate time.

For example: The user can write 002:00:00:00:00 instead of writing 48

hours.

To define the Trend Graph Time Settings, set the Time Span and/or
Sample Time in the Time Settings tab within the Trend Graph Setting
dialog box.

The Sample Time does not change when you change the view of the
Historical Trend graph via Scroll Trend as long as the Span Time stays
the same.

Pulse 4.12 User Guide 679

Real Time Trend Graph, Curve Trend Graph Time Settings

Span Time

Time Specify the time span of the graph in milliseconds,

seconds, minutes, hours, or days.

Sample Time

Auto Sample Select this option to enable Pulse to set the sample
Time interval automatically.

Time This option is available if Auto Sample Time is not

selected.

Specify the time interval (in seconds, minutes, or

hours) for each sample period for which the graph
displays data.

Pulse 4.12 User Guide 680

Historical Trend Graph Time Settings

Use Global Time Click this checkbox to apply the settings to all
Stamp Settings for pens in the graph.
All Pens

Span Time

Time Specify the time span of the graph in

milliseconds, seconds, minutes, hours, or days.

Sample Time

Auto Sample Time Select this option to enable Pulse to set the
sample interval automatically.

Pulse 4.12 User Guide 681

Time This option is available if Auto Sample Time is
not selected.

Specify the time interval (in seconds, minutes,

or hours) for each sample period for which the
graph displays data.

Time Base

Specify a time frame for the graph.

Before: Specify the amount of time previous to the

Days_Hours_Minutes present time for the historical trend graph to
display data.

Before: Days_At Specify the amount of days previous to the

Time present time, and the exact time on that day, for
the historical trend graph to display data.

At Date_At Time Specify the exact date and time, from which the
historical Trend graph displays data.

Pulse 4.12 User Guide 682

Historical Batch Graph Time Settings

When configuring a batch graph for an advised item, you need to define
its time base (start time and time span), maximum number of batches to
create, divisions of time within the recorded batch periods.

Use Global Time Click this checkbox to apply the settings to all pens
Stamp Settings in the graph.
for All Pens

Span Time

Time Specify the time span of the graph in milliseconds,

seconds, minutes, hours, or days.

Pulse 4.12 User Guide 683

Sample Time

Auto Sample Select this option to enable Pulse to set the sample
Time interval automatically.

Time This option is available if Auto Sample Time is not

selected.

Specify the time interval (in seconds, minutes, or

hours) for each sample period for which the graph
displays data.

Time Base

Specify a time frame for the graph.

Before: Specify the amount of time previous to the present

Days_Hours_ time for the accumulation of historical batch data to
Minutes start.

Before: Days_At Specify the amount of days previous to the present

Time time, and the exact time on that day, for the
accumulation of historical batch data to start.

At Date_At Time Specify the exact date and time for the accumulation
of historical batch data to start

Apply to All Pens Click this button to apply these settings to all pens in
this graph.

Batch

Define the following batch graph properties:

Type Choose the method for naming the accumulated

batches.

 Batch - provides a static number for a

particular batch. The trend presents a
snapshot of the same time period each time
this graph is displayed.

Pulse 4.12 User Guide 684

  BatchMinus - provides a batch number
indicating the number of batches before the
one currently in progress at run time. Each
time a new batch starts, the trend graph
names advance dynamically. The most recent
batch is given the lowest batch number, and
the earliest batch is given the highest batch
number, and all other batches in-between
advance by one.

Advise Item The address of the batch variable

Batch # Applicable when the Batch type is chosen. Specify

the batch number for the most recent trend.

Current Batch # Applicable when the BatchMinus type is chosen.

Minus Specify the number that the batch names advance
whenever a new batch starts.

Batch Span Choose the time span presented in the batch

graphs:

 Batch Duration - The actual duration of the

batch (overrides the time span entered in the
Time (X) Axis tab).

 Time Span - The time span entered in the

Time (X) Axis tab.

 Longest - The longest between the Batch

Duration or the Time Span.

 Shortest - The shortest between the Batch

Duration or the Time Span.

Pulse 4.12 User Guide 685

Pens

Define the parameters of each pen which charts the data in the Trend
Graph. Pens represent dynamic items and show the change (if any
occurred) along the graph’s plot in the item’s runtime values over time.

 Pens for Real Time Trend Graph

 Pens for Historical Trend Graph, Historical Batch Graph

 Pens for Curve Trend Graph

Pens for Real Time Trend Graph

Margin Percent Specify the percent of the margin for the Trend
Graph for a wider and clearer view of the graph.

Adds a pen to the graph

Removes a pen from the graph

Pulse 4.12 User Guide 686

 Select the next line above the selected line in the
Pen table.

Select the next line below the selected line in the

Pen table.

Color Choose the pen’s color.

Visible Select this option to display the pen and deselect to

hide the pen.

Item Specify the item name (or select it in the Item

Manager) which controls the values that this pen
represents.

Description Type a descriptive name for the pen.

Scale Type Choose the factor that determines the pen’s scale.

 Manual - User enters the scale in Scale

Bottom and Scale Top parameters.

 Auto - Scale values are set by the system.

 From Block - If the pen’s item is an Analog

Value or Analog Pointer block type, the blocks
scale values are used.

If the block type is a Digital Value, Digital

Pointer, Alarm Bit, or a Boolean block, the
type automatically changes to Manual with
Low and High values of 0-1.

The Calculation block and direct addresses

automatically changes the type to Manual 0-
100.

Bottom Specify the minimum value of the pen’s scale.

Top Specify the maximum value of the pen’s scale

Properties

Color Choose the pen’s color.

LineStyle Choose whether the pen line appears as a Solid,

Dashed, Dotted line or a Custom design.

PointStyle Choose the way a point on the pen is represented:

Circle, Rectangle, or None.

Pulse 4.12 User Guide 687

Style Choose whether the pen appears as a Line, an
Area, a Bar or a Step Line.

TransparentArea Set a level of transparency on a sliding scale from 0

(most transparent) to 255 (most opaque).

Width Choose the thickness of the pen borderline.

The default width of the Trend Graph line is 2 points

to emphasize the line on the graph making it more
apparent than the scale lines in the graph.

To change the line width, enter a new value.

General

Band Enter the band (low %, high %) allocated to this

pen on the graph’s plot in relation to the graph
height. Click the plus sign to expand the parameter
and enter the DeadBand, From and To values.

 DeadBand - the required percentage of

change in the defined scale

 From - The low % location for the pen.

 To - The high % location for the pen.

Bottom The minimum value of the pen’s scale specified in

the table above.

Description The description for the pen

Engineering Units Name of engineering units, for display on

top/bottom of scale/ button, if Y axis scale division
labels are shown

Normal Value Specify the baseline value above or below to place

the bars.

Pattern The numeric presentation pattern (format) for Y axis

scale division labels.

Percentage The percentage value of the pen

Pulse 4.12 User Guide 688

ScaleType Choose the factor that determines the pen’s scale.

 Manual - User enters the scale in Scale

Bottom and Scale Top parameters.

 Auto - Scale values are set by the system.

 From Block - If the pen’s item is an Analog

Value or Analog Pointer block type, the blocks
scale values are used.

If the block type is a Digital Value, Digital

Pointer, Alarm Bit, or a Boolean block, the
type automatically changes to Manual with
Low and High values of 0-1.

The Calculation block and direct addresses

automatically changes the type to Manual 0-
100.

Top Define the highest value on the graph’s plot.

Visible Choose whether to Show or Hide the pen.

Item

Item Specify the item name which controls the values

that this pen represents.

Pens for Historical Trend Graph, Historical Batch Graph

Define the parameters of each pen which charts the data in the Historical
Trend Graph. Pens represent dynamic items and show the change (if any
occurred) along the graph’s plot in the item’s runtime values over time.

Pulse 4.12 User Guide 689

Margin Percent Specify the percent of the margin for the Trend
Graph for a wider and clearer view of the graph.

Adds a pen to the graph.

Removes a pen from the graph.

Moves up one line in the Pen table.

Moves down one line in the Pen table.

Color Choose the pen’s color.

Visible Select this option to display the pen and deselect it

to hide the pen.

History Group This column is available when the History Logger

option is selected.

Item Specify the item name (or select it in the Item

Manager) which controls the values that this pen
represents.

Pulse 4.12 User Guide 690

Description Type a descriptive name for the pen.

Scale Type Choose the factor that determines the pen’s scale.

Manual - User enters the scale in Scale Bottom and

Scale Top parameters.

 Auto - Scale values are set by the system.

 From Block - If the pen’s item is an Analog

Value or Analog Pointer block type, the blocks
scale values are used.

 If the block type is a Digital Value, Digital

Pointer, Alarm Bit, or a Boolean block, the
type automatically changes to Manual with
Low and High values of 0-1.

The Calculation block and direct addresses

automatically changes the type to Manual 0-
100.

Bottom Specify the minimum value of the pen’s scale.

Top Specify the maximum value of the pen’s scale

Time Settings Specify the time settings for each pen. Click … to
open the Historical Time Settings dialog box.

Pulse 4.12 User Guide 691

Span Time

Time Specify the time span of the pen in milliseconds,

seconds, minutes, hours, days.

Sample Time

Auto Sample Time Select this option to enable Pulse to set the
sample interval automatically for this pen.

Time This option is available if Auto Sample Time is

not selected.

Specify the time interval (in milliseconds,

seconds, minutes, or hours) for each sample
period for which the graph displays data.

Time Base

Specify a time frame for the pen.

Before: Specify the amount of time previous to the

Days_Hours_Minutes present time for the pen to indicate data.

Before: Days_At Specify the amount of days previous to the

Time present time, and the exact time on that day, for
the pen to indicate data.

At Date_At Time Specify the exact date and time, from which the
pen indicates data

Appearance

Color Choose the pen’s color.

Line Style Choose whether the pen appears as a Solid,

Dashed, Dotted line or a Custom design.

Point Style Choose the way a point on the pen is

represented: Circle, Rectangle, or None.

Style Choose whether the pen appears as a Line, an

Area, a Bar, or a Step Line.

Transparent Area Set a level of transparency on a sliding scale

from 0 (most transparent) to 255 (most
opaque).

Pulse 4.12 User Guide 692

Width Choose the thickness of the pen borderline.

The default width of the Trend Graph line is 2

points to emphasize the line on the graph
making it more apparent than the scale lines in
the graph.

To change the line width, enter a new value.

General

Band Enter the band (low %, high %) allocated to this

pen on the graph’s plot in relation to the graph
height. Click the plus sign to expand the
parameter and enter the DeadBand, From and
To values.

 DeadBand - the required percentage of

change in the defined scale

 From - The low % location for the pen.

 To - The high % location for the pen.

Engineering Units Name of engineering units, for display on

Name top/bottom of scale/ button, if Y axis scale
division labels are shown

Function Choose the actual value that the pen indicates.

This applies only to data recorded by the
Database Server:

 Sample - The value last stored in the

sample time interval.

 Average - The average across the sample

time interval.

 Minimum - The lowest value across the

sample time interval.

 Maximum - The highest value across the

sample time interval.

Normal Value Specify the baseline value above or below to

place the bars.

Pattern The numeric presentation pattern (format) for Y

axis scale division labels.

Pulse 4.12 User Guide 693

Percentage The percentage value of the pen

Scale Type Choose the factor that determines the pen’s

scale.

 Manual - User enters the scale in Scale

Bottom and Scale Top parameters.

 Auto - Scale values are set by the

system.

 From Block - If the pen’s item is an

Analog Value or Analog Pointer block type,
the blocks scale values are used.

If the block type is a Digital Value, Digital

Pointer, Alarm Bit, or a Boolean block, the
type automatically changes to Manual with
Low and High values of 0-1.

The Calculation block and direct addresses

automatically changes the type to Manual
0-100.

Top Define the highest value on the graph’s plot.

Visible Choose whether to Show or Hide the pen.

Item

Item Specify the item name which controls the values

that this pen represents.

Time Settings

Time Settings Set the time settings for the Trend Graph.

 Sample Time - Set the sample time

interval

• Auto Sample Time - Select this

option to enable Pulse to set the
sample interval automatically.

• Time Sample - Select this option

to enable Pulse to set the sample
interval

• Units Sample - Set the time unit

(in seconds, minutes, or hours) for
the sample time

Pulse 4.12 User Guide 694

  Span Time - Specify the time span of the
graph in seconds, minutes, hours, or
days.

• Time - The time span of the graph

• Time Units - Specify the time unit

of the graph in seconds, minutes,
hours, or days.

 Time Base - Specify a time frame for the

pen.

• At (Date Time At) - Specify the

exact date and time, from which
the pen indicates data.

• Start Before (Days, Time) -

Specify the amount of time
previous to the present time for the
pen to indicate data.

• Start From Fixed (Days, Hours,

Minutes) - Specify the fixed time
frame for the pen to start in days,
hours or minutes

• TypeTime - There are 3 types of

time to start to select from:
ttStartFromFixed, ttStartBefore,
and ttStartAtDateTime

Pens for Curve Trend Graph

Define the parameters of each pen which charts the data in the Curve
Trend Graph. The Curve Trend has pens that represent actual value, a
fixed reference value, and a start signal.

Pulse 4.12 User Guide 695

 Adds a pen to the graph.
Removes a pen from the graph.
Moves up one line in the Pen table.
Moves down one line in the Pen table.

Margin Percent Specify the percent of the margin for the Trend
Graph for a wider and clearer view of the graph.

Color Choose the pen’s color.

Visible Select to display the pen and deselect to hide the

pen.

Item For Fixed value pens

Specify the item name (or select it in the Fixed Pen

dialog box).

For Actual and Start Signal pens

Specify the item name (or select it in the Item

Manager) which controls the values that this pen
represents.

Pulse 4.12 User Guide 696

Description If you want to change the name of the pen, type a
descriptive name.

Scale Type Choose the factor that determines the pen’s scale.

 Manual - User enters the scale in Scale

Bottom and Scale Top parameters.

 Auto - Scale values are set by the system.

 From Block - If the pen’s item is an Analog

Value or Analog Pointer block type, the blocks
scale values are used.

If the block type is a Digital Value, Digital

Pointer, Alarm Bit, or a Boolean block, the
type automatically changes to Manual with
Low and High values of 0-1.

The Calculation block and direct addresses

automatically changes the type to Manual 0-
100.

Bottom Specify the minimum value of the pen’s scale.

Top Specify the maximum value of the pen’s scale

Fixed Pen

Band Enter the band (low %, high %) allocated to this pen

on the graph’s plot in relation to the graph height.
Click the plus sign to expand the parameter and
enter the DeadBand, From and To values.

 DeadBand - the required percentage of

change in the defined scale

 From - The low % location for the pen.

 To - The high % location for the pen.

Color Choose the pen’s color.

File Name Specify the pen’s file name

Style Choose whether the pen appears as a Line, an

Area, a Bar, or a Step Line.

Pulse 4.12 User Guide 697

Line

LineStyle Choose whether the pen appears as a solid,

dashed, dotted, dashed, and dotted, dashed
dotted and dotted line or a Custom design.

PointStyle Choose whether the pen appears with a circle,

rectangle, or plain point style.

Width Choose the width of the line (i.e., pt1, pt2, pt3, etc.)

The default width of the Trend Graph line is 2 points

to emphasize the line on the graph making it more
apparent than the scale lines in the graph.

To change the line width, enter a new value.

Pen

Visible Select to display the pen and deselect to hide the

pen.

X Axis

The X Axis tab is where you define the X axis’ lines and grid appearance
settings.

 X Axis for Real Time Trend Graph, Curve Trend Graph, Historical
Trend Graph, Historical Batch Graph

 X Axis for Deviation Meter Graph, Bidirect Deviation Meter Graph

Pulse 4.12 User Guide 698

X Axis for Real Time Trend Graph, Curve Trend Graph, Historical
Trend Graph, Historical Batch Graph

Pulse 4.12 User Guide 699

Line

Color, Width, Style Defines the appearance of the X axis’ division

lines.

Grid Lines X

Moving Grid Choose Grid to move the graph’s entire grid as

new data appears on the graph.

Choose Line to move only the pen lines as the

new data appears.

Major Divisions

Visible Select this option to make major divisions visible.

Number Specify the number of major divisions visible

along the graph’s X axis.

Color, Width, Style Define the appearance of the X axis’s major

division lines.

Minor Divisions

Visible Select this option to make minor divisions visible.

Number Specify the number of minor divisions that

appear between the major divisions.

Color, Width, Style Define the appearance of the X axis’s minor

division lines.

Label

Location Choose whether to display X axis unit labels at

the bottom of the graph, at the top, on both
locations, or none.

Show Label Every Define the spacing for the X axis unit labels (1
label per n divisions).

Pulse 4.12 User Guide 700

Format Choose the format for displaying the time units.

Font The font of the labels’ characters

X Axis for Deviation Meter Graph, Bidirect Deviation Meter Graph

Line

Color, Width, Style Define the appearance of the X axis’s division

lines.

Grid Lines X

Moving Grid Choose Grid to move the graph’s entire grid as

new data appears on the graph.

Choose Line to move only the data lines as the

new data appears.

Pulse 4.12 User Guide 701

Major Divisions

Visible Select this option to make major divisions visible.

Number Specify the number of major divisions visible

along the graph’s X axis.

Color, Width, Style Define the appearance of the X axis’s major

division lines.

Minor Divisions

Visible Select this option to make minor divisions visible.

Number Specify the number of minor divisions that appear

between the major divisions.

Color, Width, Style Define the appearance of the X axis’s minor

division lines.

Y Axis

The Y Axis tab is where you define the Y axis’s lines and grid appearance
settings.

NOTE The Split to Ranges option for the Deviation Meter Graph
and the Bidirect Deviation Meter Graph becomes available
when the Show Multi Scales checkbox is first checked and
then unchecked.

Pulse 4.12 User Guide 702

Line

Color, Width, Style Defines the appearance of the Y axis’ division

lines.

Show Multi Scales Enables users to display multiple Y axes on the

Trend Graph at once in a very comprehensible
manner. The scale values for each Y axis are
displayed according to the pen color the user has
specified in one column with a corresponding
graph (line) with a matching color.

Pulse 4.12 User Guide 703

Split to Ranges

This option is NOT available when the Show Multi Scales checkbox
option is selected. Define ranges along the Y axis which are depicted by
backgrounds of different color.

Click this button to open the Color Ranges dialog box. After setting the
range properties, click OK.

Ranges (left pane) Click Add to add a range to the Y axis.

Range (right pane) This pane displays the properties of the selected
range. Define a Color, the band range (From,
To) allocated to this pen along the Y axis in
relation to the graph height, and the Title of the
range area.

Order Click to select the first range.

Copy From Bands Click this button to add copies of already-defined

ranges, with identical settings.

Pulse 4.12 User Guide 704

Grid Lines tab

Major Divisions

Visible Select this option to make major divisions visible.

Number Specify the number of major divisions visible

along the graph’s Y axis.

Color, Width, Style Define the appearance of the Y axis’s major

division lines.

Minor Divisions

Visible Select this option to make minor divisions visible.

Number Specify the number of minor divisions that appear

between the major divisions.

Color, Width, Style Define the appearance of the Y axis’s minor

division lines.

Label tab

Location Choose whether to display Y axis unit labels at

the left of the graph, at the right, on both
locations, or none.

Show Label Every Define the spacing for the X axis unit labels (1
label per n divisions).

Font The font of the labels’ characters.

Pulse 4.12 User Guide 705

Numerical Format

Choose the format for displaying the time units.

You can change the Y-axis scale format to 0.0; 25.0.... or 0; 25; 50, etc.

Number of Digits Number of digits allowed after the decimal point.

After Decimal Point

Number of Digits Number of digits allowed before the decimal

Before Decimal point.
Point

Leading Zeros Select this option to add “0” digits, if necessary,

to meet the Digit Before Point setting.

Pulse 4.12 User Guide 706

Toolbar

Customize a toolbar to be displayed together with the graph with the

available commands in the Toolbar tab.

Tool & Status Bar

Show Toolbar Select/deselect this checkbox option to

display/hide the toolbar

Show Status Bar Select/deselect this checkbox option to

display/hide the status bar below the graph.

Multiline Select/deselect this checkbox option to

display/hide multiple toolbar lines, if a single line
is not enough to display all the enabled
commands.

Show Date/Time Shows when the Historical Trend time span

Picker for Historical begins and when it ends. The Historical Trend
Trends 'Begin' date and time is displayed on the lower
left corner and the 'End' date and time is
displayed on the lower right corner of the graph.

Pulse 4.12 User Guide 707

Alignment Choose the location of the toolbar in relation to
the graph.

Icon Size Choose the size of the toolbar icons.

Text Alignment Choose the location of the command’s text in

relation to the icon. This command is applicable if
the Tool Display Type is Icon and Text.

Tool Display Type Choose how the toolbar commands are displayed:
Text only, Icon only, Icon and Text together.

In the table, you can enable or disable the display of commands on the
toolbar in all situations, or according to security access levels, and define
various options if applicable.

Visible Select this checkbox option to display a toolbar

above the graph.

Picture Shows the icons in the toolbar.

Caption The caption of the icon; can be renamed by the

user
Trend Graph

Meter Graph

Meter Graph

Batch Graph
Curve Trend
Real Time

Historical

Deviation

Deviation

Historical
Bidirect

Picture Caption
Graph

Graph

Legend √ √ √ √ √ √

Report √ √ √ √ √ √

Zoom In √

Zoom Out √

Modify Trend √ √ √ √ √ √

Switch Left Scale √ √ √ √ √

Pulse 4.12 User Guide 708

 Trend Graph

Meter Graph

Meter Graph

Batch Graph
Curve Trend
Real Time

Historical

Deviation

Deviation

Historical
Bidirect
Picture Caption

Graph

Graph
Switch Right Scale √ √ √ √ √

Play/Pause √ √

Move Trend √ √ √

Crosshairs √ √ √

Vertical Hairline √ √ √

Horizontal Hairline √ √ √

Jump To Maximum √ √ √

Jump To Minimum √ √ √

Load Group √ √ √ √ √ √

Save √ √ √ √ √ √

Save As Group √ √ √ √ √ √

Delete Group √ √ √ √ √ √

Print Trend √ √ √ √ √ √

Scroll Trend* √

Scroll Batch** √

Pulse 4.12 User Guide 709

 Trend Graph

Meter Graph

Meter Graph

Batch Graph
Curve Trend
Real Time

Historical

Deviation

Deviation

Historical
Bidirect
Picture Caption

Graph

Graph
Next Batch √

Prev Batch √

Security Lock Set the security level of the icon here.

Options The icon options, if any, are displayed here.

Move Up Click this button to rearrange the toolbar icons by

moving the selected icon upwards.

Move Down Click this button to rearrange the toolbar icons by

moving the selected icon downwards.

NOTE *Clicking the Scroll Trend button displays the Set Span
Time dialog box, see Span Time.

NOTE **The Scroll Batch button displays the New Batch Number
dialog box, see New Batch Number.

Pulse 4.12 User Guide 710

Bars

The Deviation Meter Graph and the Bidirect Deviation Meter Graph
use bars to display indications. The bars are designed to display the
normal (or nominal) value of each variable in the middle, and the 5
possible conditions (very low, low, normal, high or very high) of up to 8
variables with uniform visual bar levels and colors. Use the Bars tab to
design the visual appearance of the indicator to include all the variables,
for the operator to tell at a glance the condition of each variable.

Click to add a bar to the graph.

Click to remove a bar from the graph.

Click to move up one line in the Bar table.

Click to move down one line in the Bar table.

Color The color of the bar.

Pulse 4.12 User Guide 711

Visible Select to display the bar and deselect to hide the
bar.

Title Type a descriptive name for the bar.

Item Specify the item name (or select it in the Item

Manager) which controls the values that this bar
represents.

Bottom Specify the minimum value of the bar’s scale.

Top Specify the maximum value of the bar’s scale

LoLo Specify the value at which the LoLo Alarm condition

starts (condition indicated until the lowest point of
the range).

Low Specify the value at which the Low Alarm condition

starts (condition indicated until the LoLo condition
starts).

High Specify the value at which the High Alarm condition

starts (condition indicated until the HiHi condition
starts).

HiHi Specify the value at which the HiHi Alarm condition

starts (condition indicated until the highest point of
the range).

Bars Properties

Set additional bar properties, such as the bar style, colors for each level,
level of transparency, and blinking.

Pulse 4.12 User Guide 712

Security

Assign user authorization levels for the Trend graph in the Security tab.
The allowed range is 0-99, in accordance with the security levels defined
for the Pulse system.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 713

Advanced

Define advanced settings for all graph types (Real Time Trend Graph,
Historical Trend Graph, Curve Trend Graph, Deviation Meter Graph,
Bidirect Deviation Meter Graph, and Historical Batch Graph) in the
Advanced tab.

Hide records Select this checkbox option to display/hide records

with bad status with bad status. The bad status is caused by an
indication on the graph for a period in which a value
was not being received (such as a communication
disconnection). For example, for such a period, the
graph would display a gap between the last received
value before the disruption and the first received
value after the resumption.

Pulse 4.12 User Guide 714

General Trend Graph Settings
Margin Percent for the Trend Graph Instrument

You can add margins below and above the Trend Graph Instrument to
change its scales; scales are calculated according to the margin. The
margins represent the original scale values below and above the Trend
Graph.

The Margin Percent parameter makes it possible for the minimum and
maximum Trend (whole area) to be calculated according to the percent of
the scale and labels, and the divisions to be calculated according to the
margin calculation. For example if '10%' is the margin value specified, the
margin is increased by 10% from the lowest scale making the scale reach
-10 (if the Low Scale value was initially set to 0) and 10% from the
highest scale making the margin reach 110% (if the High Scale value was
initially set to 100).

The feature enables the user to add margins to the Trend Graph to have a
wider and clearer view of the graph.

You can use the Margin Percent option when displaying the following
types of Trends:

 Trend Graph Instrument

 Smart Information

 Dynamic Trend

Pulse 4.12 User Guide 715

Using the Margin Percent Parameter for the Trend Graph
Instrument in the Developer Workstation

In the Trend Graph Instrument Trend Graph Settings dialog box, go to

the Pens tab and specify the percent of the margin for the Trend Graph in
the Margins Percent field, see following image.

Pulse 4.12 User Guide 716

Margin Percent Parameter for Dynamic Trend at Runtime

The Margin Percentage can also be set for Dynamic Trends at runtime.

To set the Margin Percent at Runtime

1 At runtime, right-click on an object with a historical item, and select

one of the Dynamic Trend presets (Hour, 8 Hours, 24 Hours, Week,
Month, or Year).

2 In the Dynamic Trend's Trend Graph Settings dialog box, go to

the Pen tab and specify the percent of the margin for the Dynamic
Graph in the Margins Percent field, see following image.

Pulse 4.12 User Guide 717

Saving and Loading Trend Settings from the Trend Graph Toolbar
at Runtime

You can define Trend parameters (including the Percent Margin

parameter) and save its settings by using the Set as Default Settings
option from the Trend Graph toolbar at runtime.

Pulse 4.12 User Guide 718

Date/Time Picker for Historical Trends

The Show Date/Time Picker for Historical Trends feature shows

when the Historical Trend time span begins and when it ends. The
Historical Trend 'Begin' date and time is displayed on the lower left corner
and the 'End' date and time is displayed on the lower right corner of the
graph.
The Date/Time Picker for Historical Trends allows you to view the date and
time when the Historical Trend starts and when it ends. The user can also
change 'Begin' and 'End' dates and time by clicking on the Date/Time
Pickers.

The Show Date/Time Picker for Historical Trends checkbox option

can be activated from the Toolbar tab in the Trend Graph Settings
window.

Pulse 4.12 User Guide 719

Trend Graph Multi Scales

The Trend Graph can display multi scales (all the Y axes) at the same
time.

The Show Multi Scales feature enables users to display multiple Y axes
on the Trend Graph at once in a very comprehensible manner. The scale
values for each Y axis is displayed according to the pen color the user has
specified in one column with a corresponding graph (line) with a matching
color, see image above.

To show multi-scales (all the Y scales at the same time) in the Trend
Graph, go to the Y Axis tab in the Trend Graph Settings dialog box and
check the Show Multi-Scales checkbox option.

Pulse 4.12 User Guide 720

Pulse 4.12 User Guide 721
Span Time

The Historical Trend Graph Span Time is set through the Set Span Time
dialog box. The Set Span Time dialog box allows the user to specify the
period of a Historical Trend Graph's Span Time.

The purpose of this feature is to enable the user to set or change the time
span period by specifying the Begin Date and Begin Time and/or the
End Date and End Time parameters. When the user specifies the Begin
Date and Begin Time parameters, the End Date and the End Time are
automatically displayed. However, the End Date and End Time
parameters can also be modified by the user.

To set the Span Time

1 Click Scroll Trend in the Historical Trend Graph toolbar or

click the Date/Time Picker (if defined) on the Historical Trend Graph
to display the Set Span Time dialog box (see image above).

2 Set the Begin Date and the Begin Time parameters; the End
Date and End Time are automatically displayed. The user can
change the End Date and End Time, if necessary.

3 Click OK.

The new Time Span is displayed according to the Time Span

settings.

In addition, the user may also view and/or change the span time from the
Date/Time Picker for Historical Trends.

Pulse 4.12 User Guide 722

New Batch Number

When batch numbers are created for a Historical Batch Graph, the batch
numbers are stored in the historical block. The New Batch Number
dialog box allows you to specify and retrieve the data of a specific block.

To specify or retrieve a batch number

1 Click Scroll Batch in the Historical Batch Graph toolbar.

The New batch number dialog box is displayed.

2 Enter the batch number and click OK.

Pulse 4.12 User Guide 723

Rearranging the Trend Graph Toolbar Icons

The Move Up and Move Down buttons in the Toolbar tab of the Trend
Graph Settings dialog box is used to rearrange icons in the Trend Graph
toolbar according to preference.

To use the Move Up/Move Down buttons

1 Go to the Toolbar tab in the Trend Graph Settings dialog box.

2 Select the Toolbar button from the table to move and click the
Move Up or Move Down button and position the icon according to
your preference.

3 Click Apply then click OK to continue.

Pulse 4.12 User Guide 724

Loading a Specific Saved Trend Group

You can open and view a specific Dynamic Historical Trend Group from a
list of previously saved Dynamic Trend groups.

To load a specific saved Trend Group

1 For example, after saving a group for a Historical Dynamic Trend

(Hours), right-click on the display area and select Historical Trend
> Hour.

The Load Settings dialog box is displayed.

2 Select a previously saved Dynamic History Hourly group that is

listed in the drop-down list to open and view the Trend graph.

Pulse 4.12 User Guide 725

Overwriting an Existing Dynamic Trend Group

You can choose to overwrite an existing Dynamic Trend Group when

saving a Dynamic Trend Group file. You can create a new Dynamic Trend
Group and name it with an already existing group or update the file and
just overwrite the old one.

To overwrite an existing Dynamic Trend Group

1 Save the current Dynamic Trend Group by clicking the Save as

Group icon from the toolbar.

2 In the Save as Settings dialog box, enter a name that already

exists in the database for the group in the Name field and click OK.

The Error Saving Data message is displayed informing the user

that the file name already exists and whether to overwrite it.

3 Click Yes to overwrite the old file.

Pulse 4.12 User Guide 726

Displaying X and Y Axes Correlated Variables in the Pulse
Trend Graph

The X-Axis in the Pulse Trend Graph Instrument can display its correlated
variables in the graph. Correlation variables of the X Axis can be
illustrated in the Pulse Trend Graph Instrument via its Correlation
tab’s Split to Ranges dialog box.

When the Pulse Trend Graph instrument detects correlated variables

(mutual data dependent between the X and Y axes), it highlights the
extent of the congruence between the X and Y axes in the graph.

Both ranges are defined and the congruence area is displayed with a
combination of both the X and Y axes together (i.e., X axis = blue,
Y axis = green then the congruent area is represented in cyan.

To display X and Y Axes correlation

1 In the Pulse Trend Graph Settings dialog box General tab, select
a type of Trend graph from the Trend Type drop-down list.

2 Check the Correlation checkbox.

3 Go to the Pens tab and add Pen(s) with Item(s), (i.e., |!a:1,
|!a:2).

4 Go to the X Axis tab then click the Correlation tab.

5 Define the Item field (i.e., |!a:1)

6 Click the Split to Ranges dialog box.

The Color Ranges window is displayed.

7 Set the color ranges (i.e., 0-50 to blue, 51-100 yellow) and click
OK.

Pulse 4.12 User Guide 727

8 Go to the Y Axis tab and click the Split to Ranges button.

The Color Ranges window is displayed.

9 Set the color ranges (i.e., 0-50 to yellow, 51-100 to red) and click
OK.

10 Set the item values at runtime.

The Pulse Trend Graph displays a graph similar to the one below.

Pulse 4.12 User Guide 728

Showing the X Axis Value in Numerical Format for the Pulse
Curve Trend Graph with Correlation

The Pulse Curve Trend Graph displays correlated X and Y values in

numerical format. The user can compare a Y axis value that corresponds
with an X axis value where each value is connected to a different item.
You can plot two different items and show the relationship between the
two variables in a correlation curve trend graph; one item is represented
vertically and the other horizontally.

The Pulse Curve Trend Graph with correlation displays a graph with a
static set of values; 2 set of values and a graph with real time values of
item(s) represented by the Y axis in correlation to another item(s)
represented by the X axis.

The axes values are taken from correlated items, not just plain time
stamps and the graph displays values in a numerical format.

To define a Pulse Curve Trend Graph with correlation

1 In the Trend Graph Settings dialog box, go to the General tab

and select Curve Trend Graph from the TrendType drop-down
list.

2 Click to select the Correlation checkbox option.

3 Define the time settings in the Time Settings tab.

4 Go to the Pens tab and define the pen for each item.

5 Define the X axis parameters in the X Axis tab.

6 Define the Y axis parameters in the Y Axis tab.

Pulse 4.12 User Guide 729

Zooming X and Y scale selections in the Pulse Trend Graph

You can zoom in/zoom out X and Y scale selections in the Pulse Trend
graph. You can zoom a graph that may contain multiple pens or multiple
scales.

Assigning Keys via the Display Resources Manager for Pulse

Trend Graph Instrument Properties

The Pulse Trend Graph Instrument now supports Display Resources.

Pulse 4.12 User Guide 730

In the Pulse Historical Trend Graph Trend Graph Settings dialog box,
the following Pen parameters can have keys as their values. The keys are
assigned from the Display Resource Manager dialog box.

 Item

 Engineering Units

 Margin Percent (%)

 Description

 Scales

 Color

 Time Settings

Retrieving Engineering Units for Regular and Dynamic Trend

Graphs from a Historical Block

Trend Graphs has the ability to retrieve the Engineering Units value
from a historical block in the database.

Retrieving an Engineering Unit’s value

1 Create a Historical Trend Graph.

2 Go to the Pens tab and select the History Group.

3 Select the historical block as the Item from the database.

4 Enter a description in the Description column (optional).

5 Select FromBlock from the Scale Type column’s drop-down list.

6 Go to the Properties area and observe that the values for the
Properties parameters such as the Engineering Units parameter,
is derived from the Historical block item specified on the table
above.

Pulse 4.12 User Guide 731

Pulse 4.12 User Guide 732
Dynamically Updating Batch Data to a Historical Batch Graph

The Pulse Trend Graph Instrument now supports the

UpdateDataToBatch() method in the Workflow. The method allows
effortlessly updating batch data instead of using the Trend Graph
Setting dialog box to set the new value.

To use the “UpdateDataToBatch() “method

When an Item on a Historical Batch Graph has a certain value (i.e., Batch
# = 30) that was set and saved, the Batch # value can be changed from
a workflow.

1 Create a workflow and use the Pulse SetProperty activity as the

first activity.

2 Use the Pulse invokeMethod activity as the second activity.

3 Enter the new batch value in the Arguments field under the Misc
area.

4 Click the button on the Method field.

Pulse 4.12 User Guide 733

 The Select control method window is displayed.

5 Select the display from the display from the Displays list.

6 Select the control from the Controls list.

7 Select UpdateDataToBatch() from the Methods list.

The Historical Batch Graph data is updated.

Pulse 4.12 User Guide 734

Pulse Toolbar Instrument
Adding a toolbar to the display enables operators to perform commands
and select functions without the need to open menus and search for them.
You can populate a toolbar with command buttons (icons and labeled),
text boxes, and progress bars.

To insert and define a Toolbar element

1 From the Insert ribbon’s Instruments group, click the Pulse

Toolbar icon and then drag an area on the display to place a
toolbar at the top of the display. Later, you can dock it to another
location on the General tab.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Toolbar Settings dialog box is displayed.

3 When inserting a Pulse Toolbar instrument or designing a toolbar

to use in displays, define the parameters in the following tabs in the
Pulse Toolbar Settings dialog box:

• General

• Buttons

• Appearance

• Security

Pulse 4.12 User Guide 735

4 Click OK to implement the settings and close the dialog box, or
click Apply to implement settings and keep the Pulse Toolbar
Settings dialog box open.

General
Toolbar placement and size properties elements are defined in the
General tab.

Dock Choose the location of the toolbar from the in

relation to the display’s work area. Possible location
selections are None, Top, Bottom, Left, Right, and
Fill.

Toolbar Size

Auto Size Select this option to allow the toolbar to resize itself
automatically to fit its contents. If this option is
selected, the Width and Height parameters (below)
are unavailable.

Width, Height If Auto Size is not selected, define the size of the
toolbar in pixels.

Image Size

Width, Height Define the Width and Height parameters in pixels

of the images (icons) on the toolbar.

Pulse 4.12 User Guide 736

Buttons
You can create Pulse Toolbar Instrument drop-down menus via the Pulse
Toolbar Settings dialog box’s Button tab. This option enables creating
menus with two or more levels to establish an organizational hierarchy of
commands.

In the Buttons tab, you can also add and remove elements on the
toolbar, define their functions, and change their order in the toolbar.

Additionally, clicking Button or DropDownMenu on the left pane opens

up a table for setting up a Dynamic button on the lower part of the right
pane, where you can define the behavior of the button in two states (if
only Item 1 is defined) or four states (if both Item 1 and Item 2 are
defined).

Type This column displays the type of button specified

under Type on the right pane.

Image This column displays the image for the button

specified under Image on the right pane.

The Image option is only available for the Button,

Label, TextBox, or Drop Down Menu type.

Caption This column displays the caption for the button

specified under Text on the right pane.

The Caption option is only available for the Button,

Label, TextBox, or Drop Down Menu type.

Enable Select to activate the specific toolbar element

represented by the properties in the row

Pulse 4.12 User Guide 737

Type  Button - a command that carries out an item
command, action, or workflow.

 Label - text that appears on the toolbar in

order to, for example, label an adjacent
element or identify a group of buttons.

 Separator - a line that separates controls or

groups of controls in the toolbar.

 TextBox - a box requiring text input by the

operator.

 ProgressBar - an element displaying the

percentage of a process that was already
completed.

 DropDownMenu – a visual element that is a

list box allowing the user to select one value
from a list.

Width Specify the width of the TextBox here.

This option is only available for the TextBox type.

Style An element that is only available when Button or

DropDownMenu is selected in the Type field.

The following styles are:

 None – No style is selected for the button

 Text – The button style is textual

 Image – The button style is in the form of an

image (icon)

 ImageAndText – The button style is in the

form of an image (icon) accompanied by a text

Image Click in the cell to add an image to appear over a

button. Click “+” to browse and select an image.
Click “-“ to remove the image.

The Image option is only available for the Button,

Label, TextBox, or Drop Down Menu type.

Pulse 4.12 User Guide 738

Text Type the label text for this toolbar element, which is
displayed in the Caption column and will appear in
the Button, Label, TextBox, or Drop Down Menu
button type.

This option is NOT available for the Separator type.

Tooltip Type a tooltip that appears when the user’s mouse

pointer hovers over the button.

This option is NOT available for the Separator type.

Action Workflow To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to execute

a workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard

syntax.

-or-

 Open the Action Selector … to assemble

and/or choose the command or workflow.

NOTE After you enter a workflow, it appears in

the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

The Action Workflow option is only available for

the Button, or Drop Down Menu type.

Pulse 4.12 User Guide 739

Key Specify the shortcut keyboard combination (or select
it in the Select Accelerator Key dialog box …),
which when pressed, carries out the button’s
command.

Use the Select Accelerator Key dialog box to

associate a shortcut keyboard combination with a
button in a Pulse Toolbar object.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut. First,

choose a key from the list (i.e., None, A-Z, F1-F24,
PageUp, PageDown, End, Home, 0-9, Numpad0-
NumPad9, Escape, Space). Optionally, you can add
one, two, or all of the Shift/Ctrl/Alt keys to the
shortcut.
The Key option is only available for the Button, or
Drop Down Menu type.

Visibility Choose the visibility security level for users allowed

Security Lock to use this specific button.

This option is NOT available for the Separator type.

Usability Choose the usability security level for users allowed

Security Lock to use this specific button.

This option is NOT available for the Separator type.

Item 1 Specify the item name (or select it in the Item

Manager …) which affects this toolbar element.

This option is NOT available for the Separator type.

Item 2 Specify the item name (or select it in the Item

Manager …) which affects this toolbar element.

This option is NOT available for the Separator or

TextBox type.

Add Adds a toolbar element

Remove Removes the selected toolbar element

Pulse 4.12 User Guide 740

Adding a Drop-Down Menu into the Pulse Table
Instrument
To add a drop-down menu into the Pulse Table Instrument

1 Go to the Pulse Toolbar Settings dialog box and click the

Buttons tab.

2 Click the Add button to create and define a new button.

The right pane becomes active.

3 Select DropDownMenu from the Type drop-down list on the right

pane.

DropDownMenu is added on the left pane column.

4 Define the rest of the button’s drop-down menu’s parameters.

5 Click the Add button.

A sub-menu is added under the DropDownMenu tree.

6 Select Menu, Separator, or TextBox from the Type drop-down

list to define the type of sub-menu.

7 Define the rest of the button’s sub- menu’s parameters and click
Apply.

It is possible to create more than one sub-menu under a

DropDownMenu.

Pulse 4.12 User Guide 741

Appearance
The toolbar’s appearance background, foreground, and text properties are
defined in the Appearance tab.

BackColor Select the toolbar’s background color from the drop-

down list.

Background Browse and select from the available background

Image images.

Background Select a background image from the drop-down list:

Image Layout None, Tile, Center, Stretch, or Zoom.

Font Select a font for the toolbar from the list of fonts.

ForeColor Select a foreground color from the drop-down list.

Text Direction Select the direction of the toolbar’s text:

Horizontal, Vertical90, Vertical270.

Right to Left Select No for the text to start from the left or select
Yes for the text to start from the right.

Grip Style Select Visible to show the grip on the toolbar and
Hidden to hide it.

Pulse 4.12 User Guide 742

Security
In the Pulse Toolbar Settings Security tab, assign user authorization
levels to the toolbar object. The allowed range is 0-99, in accordance with
the security levels defined for your Pulse system.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 743

Pulse Selection Box Instrument
You can insert a list box or combo box from which users can choose items.
You can freely define the result of this choice, which can range in scope
from a variable argument of a command to a variable action.

The Pulse Selection Box can be dynamic or static. In a dynamic

selection box, the choices may change in accordance with the received
values of the associated item during runtime. In a static selection box, the
choices do not change.

To insert and define a Selection Box element

1 From the Insert ribbon’s Instruments group, click the Pulse

Selection Box icon and then drag an area on the display to place a
selection box.

2 Right-click the object and select Settings from the menu.

The Pulse Selection Box Settings dialog box is displayed.

Pulse 4.12 User Guide 744

You can define the following types of parameters for the selection box:

 General

 List Box

 Combo Box

 Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 745

General
In the General tab, define the type of selection box and the item values
which affect its choices.

List Box Select this option to create a list box.

Combo Box Select this option to create a combo box.

Dynamic Select this option to allow the choices in the

selection box to vary in accordance with the runtime
values.

Static Select this option to present the same set of choices

at all times.

Pulse 4.12 User Guide 746

Activate the Choose one of the events that will trigger the action
action on the from the drop-down list:
event
 Selection Change and Click

 Selection Change

 Click

 Double-click

Dynamic

The following parameters appear if the Dynamic option was selected.

Read Item Specify the item name (or select it in the Item
Manager …) which affects the choices available in
the selection box.

Pulse 4.12 User Guide 747

Separator Choose a separator in order to separate multiple
choices which you specify while creating the Item’s
expression.

Write Item Specify the item name (or select it in the Item
Manager …) to execute when the user makes the
selection. When a runtime user chooses one of items
in the selection box, the selected value is inserted
into the item.

Action To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to execute

a workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard

syntax.

-or-

 Open the Action Selector to assemble

and/or choose the command or workflow.

NOTE After you enter a workflow, it appears in

the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

Pulse 4.12 User Guide 748

Static

The following parameters appear if the Static option was selected.

Value Option name that appears in the selection box.

Pulse 4.12 User Guide 749

Action To define the object’s data item, enter an action
command or workflow.

 You can type it manually.

When manually typing a command to execute

a workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard

syntax.

-or-

 Open the Action Selector to assemble

and/or choose the command or workflow.

NOTE After you enter a workflow, it appears in

the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

Add Adds another option at the bottom of the list

Insert Adds another option above the selected option name

Remove Deletes the selected option name

Pulse 4.12 User Guide 750

List Box
The List Box tab is available if you selected the List Box option in the
General tab. In this tab, define display parameters for the List Box
object.

Border Style For the border of the list box, select a 3D look
(Fixed3D), a flattened look (FixedSingle), or no
borderline (None).

Font Select the font for the text in the list box.

Back Color Select the background color for the list box.

Fore Color Select the color of the text.

Alphabetically Select this checkbox option to sort the List Box in

Sorted alphabetical order.

Pulse 4.12 User Guide 751

Combo Box
The Combo Box tab is available if you selected the Combo Box option in
the General tab. In this tab, define display parameters for the Combo
Box object.

Font Select the font for the text in the combo box.

Back Color Select the background color for the combo box.

Fore Color Select the color of the text.

Drop Down Style Choose one from the following options for the drop
down style:

 Simple

 DropDown (default)

 DropDownList

Pulse 4.12 User Guide 752

Auto Complete Choose one from the following options for the auto-
Mode complete mode:

 None (default)

 Suggest

 SuggestAppend

 Append

Auto Complete Choose one from the following options for auto
Source complete source:

 None (default)

 AllSystemSources

 AllUrl

 FileSystem

 FileSystemDirectories

 HistoryList

 ListItems

 RecentlyUsedList

 CustomSource

Alphabetically Select this checkbox option to sort the Combo Box in

Sorted alphabetical order.

Pulse 4.12 User Guide 753

Security
In the Pulse Selection Box Settings Security tab, you assign user
authorization levels to the toolbar object. The allowed range is 0-99, in
accordance with the security levels defined for your Pulse system.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 754

Pulse Meter Instrument
A Pulse meter is an object whose indicator rotates according to data
values.

During runtime, any change in the source value rotates the meter’s
indicator to an angle that is proportionate to the configured start and end
angles of the meter.

You can choose between clockwise and counterclockwise direction.

To insert and define a Pulse meter

1 From the Insert ribbon’s Instruments group, click the Pulse

Meter icon and then drag an area on the display to place the meter
at that location.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Meter Settings dialog box is displayed.

Pulse 4.12 User Guide 755

 You can define the following types of parameters for the meter:

• General

• Labels

• Ticks

• Geometry

• Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the Pulse Meter Settings
dialog box open.

Pulse 4.12 User Guide 756

General

Item In the Item box, type the item name (or select it in
the Item Manager …) which controls this meter’s
values.

Static Value The value indicated by the meter when it is not

receiving an “item” value (such as an idle position).

Meter Mode The size of the angle covered by the meter’s range
of values.

Major Scale

The Major Scale is represented by the outer circle of measurement.

Start Value The lowest possible value indicated in the major

scale on its 0° angle.

End Value The highest possible value indicated in the major

scale on its largest degree angle.

Minor Scale

The Minor Scale is represented by the inner circle of measurement.

Start Value The lowest possible value indicated in the minor

scale on its 0° angle.

End Value The highest possible value indicated in the minor

scale on its largest degree angle.

Pulse 4.12 User Guide 757

Labels

Counter Select this checkbox option for the meter to display

Clockwise lowest to highest values in a counterclockwise
direction.

Major Scale

Select this option to display numerical values along the outer scale.

Offset Specify the difference between units along the major

scale.

Spacing Specify the rate at which the units are displayed. For
example, 1 indicates that every point specified by
the Offset value is displayed. 2 indicates that every
second unit (as specified by the Offset value) is
displayed.

Align Select this option to align the major scale’s value

labels with the contour of the object.

Minor

Select this option to display numerical values along the inner scale.

Offset Specify the difference between units along the inner

scale.

Pulse 4.12 User Guide 758

Spacing Specify the rate at which the units are displayed. For
example, 1 indicates that every point specified by
the Offset value is displayed. 2 indicates that every
second unit (as specified by the Offset value) is
displayed.

Align Select this option to align the minor scale’s value

labels with the contour of the object.

Pulse 4.12 User Guide 759

Ticks
Ticks on the meter denote visible points of measure along the meter,
usually in the form of a line. In the Ticks tab, define the space and the
size of the ticks.

Major Scale

The Major Scale is represented by the outer circle of measurement.

Spacing Specify the distance apart, in this scale’s units, for

the displayed ticks.

Length Specify the length of each tick line.

Minor Scale

The Minor Scale is represented by the inner circle of measurement.

Spacing Specify the distance apart, in this scale’s units, for

the displayed ticks.

Length Specify the length of each tick line.

Pulse 4.12 User Guide 760

Geometry
In the Geometry tab, define the angles at which the meter’s scales are
circularly oriented.

Major Scale

The Major Scale is represented by the outer circle of measurement.

Start Angle Specify the starting point for the scale, relative to
the location on the meter surface.

Sweep Angle Specify the area covered by the scale, relative to the
total area on the meter surface.

Minor Scale

The Minor Scale is represented by the inner circle of measurement.

Start Angle Specify the starting point for the scale, relative to
the location on the meter surface.

Sweep Angle Specify the area covered by the scale, relative to the
total area on the meter surface.

Pulse 4.12 User Guide 761

Security
In the Security tab, define the security levels for Visibility and Usability of
the toolbar.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 762

Pulse Media Player Instrument
Pulse enables you to embed a media player in order to broadcast audio
and video in a display. A media file can be played manually or
automatically when the user starts the Operator Workstation or stream a
media file while the Workstation is open. It can also be played in full
screen and in loop mode.

To insert and define a Media Player object

1 From the Insert ribbon’s Instruments group, click the Pulse

Media Player icon and then drag an area on the display to locate
the Media Player object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Web Media Player Settings dialog box is displayed.

Pulse 4.12 User Guide 763

 You can define the following types of parameters for the media
player:

• General

• Security

3 Click OK to implement the settings and close the dialog box, or

click Apply to implement settings and keep the Pulse Media
Player Settings dialog box open.

General
In the General tab, specify the media file that will play in the Media
Player object.

Show video from Specify the full path and filename of a media file to
URL/File path play when the workstation is displayed or the user
invokes the object.

Stream video Specify the item name (or select it in the Item
from Item Manager …) which controls the playing of the media
file. The file is then streamed to the player.

Show Button Select this checkbox option to provide controls

Panel (Start, Stop, Pause, etc.) on the object.

Loop video Select this checkbox option to play the video in a

continuous loop until the video is paused or stopped.

Play Full Screen Select this option to play the video in full screen.

Auto Play Select this option to play the video automatically

when you open the display in the Operator
Workstation.

Pulse 4.12 User Guide 764

Security
In the Security tab, define the security levels for Visibility and Usability of
the Media Player.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 765

Pulse Gauge Instrument
A variety of gauge types are available for insertion into the display. You
can select from a large selection of circular gauges, linear gauges, or
numeric indicators. The gauge displays the value of its associated item.

The following gauge objects are available:

 Circular Gauges

• Circular

• Circular Mini Gauge

• Two Scales

• Numeric Indicator

• Knob with Ranges (possible to change its item value by

dragging the mouse around the knob)

• 45 Degrees NE

• 180 Degrees with Ranges

• Meter

Pulse 4.12 User Guide 766

 Linear Gauges

• Horizontal

• Vertical

• Multiple Bar Pointers

• Two Scales

• Numeric Indicator

• Three Color Ranges

• Logarithmic

• Thermometer

• Bullet Graph

 Numeric Objects

• Mechanical

• Leading Zeros, Decimal Point and Sign

• Digital 7 Segments

• Digital 14 Segments

• State Indicators (user can set minimum and maximum range

values)

• Multiple Digital Indicators

• Linear Scale

You can define the following types of parameters for the Pulse Gauge:

 General

 Security

Pulse 4.12 User Guide 767

General
To insert and define a Gauge object

1 From the Insert ribbon’s Instruments group, click the Pulse

Gauge icon and then drag an area on the display to locate the
Gauge object.

2 Right-click the object and select Settings from the menu. The Pulse
Gauge Settings dialog box is displayed, containing a table of
configured gauges.

3 Click Add.

The Select Gauge window is displayed where you can select from a
range of gauge types.

Pulse 4.12 User Guide 768

4 Select a gauge type from the Select Gauge Category drop-down
list.

5 For each type, you can browse among the available types by:

• Moving the slider back and forth.

• Clicking the light thumbnail images in the gallery.

6 When the relevant gauge appears prominently in the gallery, click

OK to select it and add it to the gauge table in the Pulse Gauge
Settings dialog box.

7 Define additional gauge properties as follows:

Minimum Specify the minimum value of the gauge’s

scale.

Maximum Specify the maximum value of the gauge’s

scale

Item In the Item box, type the item name (or select
it in the Item Manager ) which controls
this gauge’s values.

Pulse 4.12 User Guide 769

To remove a Gauge object

1 In the Pulse Gauge Settings dialog box, select the gauge object
entry in the table.

2 Click Remove and then click Yes to confirm.

Security
In the Security tab, define the security levels for Visibility and Usability of
the Pulse Gauge.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 770

Pulse Datasheet Instrument
You can insert a datasheet object in which you can display database data
in a datasheet manager (such as Microsoft Excel). You can specify
whether to display the data in a table, chart, or both formats. The
displayed data can correspond to specific alarms, events, or other data
stored in the Pulse database (OLEDB, ODBC), or to values configured in
an INI, TEXT or XML file.

To insert and define a Pulse datasheet object

1 From the Insert ribbon’s Instruments group, click the Pulse

Datasheet icon and then drag an area on the display to locate the
Datasheet object.

2 Right-click the object and select Settings from the menu.

The Pulse Data Sheet Settings dialog box is displayed, containing

tabs for General, Toolbar Buttons, Columns, Charts, and Security
settings.

Pulse 4.12 User Guide 771

 You can define the following types of parameters for the datasheet
object:

• General

• Toolbar Buttons

• Columns

• Charts

• Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box displayed.

Pulse 4.12 User Guide 772

General
In the General tab, define the structure of the Datasheet object.

Item In the Item box, type the item name (or select it in
the Item Manager ) which controls this
datasheet’s values. In the Item Manager, browse to
the relevant Datasheet item name and find the data
source type, tag, and item name which will be the
reference for the object’s data.

View Type Choose to display the datasheet values in a Table,

graphically in a Chart, or in Both formats.

Toolbar Display Define the style of the command buttons on this

Style object’s toolbar. The buttons can appear as icons
(Image), textual commands (Text), or a
combination of both (Text and Image).

Toolbar Choose the location of the toolbar (Top, Bottom,

Alignment Left, and Right) in relation to the worksheet.

Use Whole Row Click this checkbox to use the whole row option.

Toolbar Icon Size Choose whether the Small or Large icons appear in
the toolbar.

Pulse 4.12 User Guide 773

Chart Alignment Applicable when the View Type is Both.

Choose whether the chart appears below (Bottom)

or to the right (Right) of the table.

Show Formatting Applicable when the View Type is Table or Both.

Toolbar
Select this option to display a toolbar with
commands for formatting the contents of the
worksheet.

Show Standard Select this option to display a toolbar with

Toolbar commands such as New, Open, Save, Export and
Settings.

Show Chart Select this option to display a toolbar with

Toolbar commands for working with a chart.

Show Status Bar Select this option to display a status bar below the
worksheet.

Pulse 4.12 User Guide 774

Toolbar Buttons
In the Toolbar Buttons tab, select the commands which appear in the
toolbar. Commands that are deselected are not displayed.

Visible Select the checkbox of the command entry to make

it available in the toolbar.

Caption The string that appears if the button is defined as a

text command.

Icon The image that appears if the button is defined as an

image.

Security Lock Choose the security level for users allowed to use
this specific button.

Pulse 4.12 User Guide 775

Columns
In the Columns tab, define all of the worksheet table’s columns and their
headers and attributes.

Show Group by Select this option to be able to drag a column header

Box to group by that column.

The checkbox is checked by default.

Show Filter Row Select this option to display the Filter row.

The checkbox is selected by default.

Show Navigator Select this option to display the navigator.

The checkbox is selected by default.

Pulse 4.12 User Guide 776

Show Headers Select this option to display the Header row.

The checkbox is selected by default.

Best Fit Select this option to best fit all columns on the
display.

The checkbox is selected by default.

Show Row Select this option to display the row indicator. The
Indicator checkbox is selected by default.

Name The data source column header name.

Summary Type Defines what type of information is displayed and/or

computed in the column, such as time, sums, status.

Item In the Item box, type the item name (or select it in
the Item Manager …). This item’s value will be set
when the user double-clicks in the data source
column during runtime.

HAlignment The horizontal alignment column header name.

Width The width column header name.

Visible Select to display the command in the toolbar.

Refresh Click this button to update this table.

Pulse 4.12 User Guide 777

Charts
In the Charts tab, define how the datasheet instrument presents data in
graphic format.

Chart Type Choose the type of chart from the drop-down list.
Several types of bars, lines, shapes, 3-D and others
are available.

Bar Text Type a legend for the bar.

Bar Color Select the bar’s color from the drop-down selection.

Label Column Enter the name of the column label.

Data Column Enter the name of the data column.

Refresh Click the button to refresh the details on the

window.

Appearance Select the type of appearance from the drop-down

selection.

Palette Select the type of palette to use from the drop-down

selection.

Pulse 4.12 User Guide 778

Security
In the Security tab, define the security levels for Visibility and Usability of
the Datasheet object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 779

Setting the Datasheet Report’s Header and
Footer
The header and footer of the Pulse Datasheet Report can be configured
via the Pulse Datasheet Instrument Advanced Properties pane.

Define the following Advanced Properties parameters for the Datasheet

Report header and footer:

 ReportFooterCenterText - Text on the center of the report’s

footer

 ReportFooterFont – Font options for the report’s footer which can

be configured from the Font dialog box by clicking the button in
its corresponding field or by defining the following sub-properties:
Name, Size, Unit, Bold, GdiCharSet, GdiVerticalFont, Italic,
Strikeout, and Underline.

 ReportFooterLeftText - Text on the left side of the report’s footer

 ReportFooterRightText - Text on the right side of the report’s

footer

 ReportHeaderCenterText - Text on the center of the report’s

header

 ReportHeaderFont – Font options for the report’s header which

can be configured from the Font dialog box by clicking the
button in its corresponding field or by defining the following sub-
properties: Name, Size, Unit, Bold, GdiCharSet,
GdiVerticalFont, Italic, Strikeout, and Underline.

 ReportHeaderLeftText - Text on the left side of the report’s

header

 ReportHeaderRightText - Text on the right side of the report’s

header

Pulse 4.12 User Guide 780

The configured parameters are seen and can be modified in the Header
and Footer dialog box via the Datasheet Report Preview at runtime.

Pulse 4.12 User Guide 781

Pulse Slider Instrument
A Pulse Slider object enables the display of values as a result of dragging
the object along a plane. The user can either change the value
dynamically by dragging the object left-right or up-down, or else, the
slider location can change passively according to the data value received
during runtime. The location of the slider handle is equal to the current
value of the object’s configured item.

At runtime, the slider displays the value in the same proportion as the
object’s actual value in relation to the configured start and end positions.
For example, if the actual value is 5 and the configured start and end
positions are 0 and 10, respectively, the slider handle is located at the half
way point of the slider.

NOTE A slider (vertical and horizontal) can be assigned to all objects

(except unfilled rectangles).

Vertical and horizontal sliders cannot be configured on the

same object.

You can also move the slider in a specific direction by holding

down the keyboard’s SHIFT button and pressing the relevant
Arrow key.

To insert and define a Slider object

1 From the Insert ribbon’s Instruments group, click the Pulse

Slider icon and then drag an area on the display to locate the
Slider object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Slider Settings dialog box is displayed.

Pulse 4.12 User Guide 782

You can define the following types of parameters for the Pulse Slider:

 General

 Appearance

 Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 783

General

Item In the Item box, type the item name (or select it in
the Item Manager ) which controls this object’s
values.

Value Specify an idle point for the slider, where the handle
rests at workstation startup before the object has
received any data input.

Orientation Choose whether the slider moves along a

Horizontal or Vertical plane.

Minimum Define the lowest value displayed on the slider

plane.

Maximum Define the highest value displayed on the slider

plane.

Prompt Type the prompt text that the operator will see.

Pulse 4.12 User Guide 784

Accelerator Key An accelerator key is a shortcut keyboard
combination that when pressed, carries out a
predefined command.

Select the key(s) which comprise the shortcut:

 Shift - Click the checkbox to add the Shift

key to the shortcut.

 Ctrl - Click the checkbox to add the Ctrl key

to the shortcut.

 Alt - Click the checkbox to add the Alt key to

the shortcut.

Select a value from the drop-down list to add a key,

i.e., None, A-Z, F1-F24, PageUp, PageDown, End,
Home, 0-9, NumPad0- NumPad9, Escape, Space.

Optionally, you can add one, two, or all of the

Shift/Ctrl/Alt keys to the shortcut.

Read Access Select this option to enable the slider handle to

move passively when it receives data source values.

Write Access Select this option to enable the operator to change

the value by pressing and dragging the handle.

Log Actions Select this option to record all of this object’s actions
in a log file.

Pulse 4.12 User Guide 785

Appearance
In the Appearance tab, define the way the slider elements, such as the
handle, ticks, and track line should appear in the display.

Pulse 4.12 User Guide 786

Security
In the Security tab, define the security levels for Visibility and Usability of
the Slider object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 787

Pulse Text Object Instrument
A Pulse Text object allows users to write alphanumeric input to the
control or to receive alphanumeric output indications.

To insert and define a Text object

1 From the Insert ribbon’s Instruments group, click the Pulse

Text icon and then drag an area on the display to locate the Text
object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Text Settings dialog box is displayed.

Pulse 4.12 User Guide 788

 You can define the following types of parameters for the Pulse
Text object:

• General

• Format

• Input Options

• Font

• Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box displayed.

General
In the General tab, define parameters that affect the behavior of the text
object.

Pulse 4.12 User Guide 789

Text

Item In the Item field, type the item name (or select it in
the Item Manager ) which controls this object’s
values.

Static Enter a text string which remains fixed at all times

that the object appears on the display.

Options

Read Only Select this option to limit this control to display

values as output only, preventing the values from
changing as a result of operator input.

Enable Workflow Places a 3-dot button which users could press to

Selector assemble a text string from the Execute Workflow
selector.

Show Context Places a check button which users could press to

Menu confirm whether they entered a good value into the
text box.

Show Confirm Places a check button which users could press to

Button confirm whether they entered a good value into the
text box.

Extra Information as Tooltip

Show Value Time Select this option to show a time stamp based on
Stamp as the system clock of the data source (such as a
connected PLC). Choose to display Time Only,
Time and Short Date format, or Time and Long
Date format.

Prompt Type the prompt text that the operator sees.

Pulse 4.12 User Guide 790

Accelerator Key

An accelerator key is a shortcut keyboard combination that when pressed,

carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut:

 Shift - Click the checkbox to add the Shift

key to the shortcut.

 Ctrl - Click the checkbox to add the Ctrl key

to the shortcut.

 Alt - Click the checkbox to add the Alt key to

the shortcut.

Select a value from the drop-down list to add a key,

i.e., None, A-Z, F1-F24, PageUp, PageDown, End,
Home, 0-9, NumPad0- NumPad9, Escape, Space.

Optionally, you can add one, two, or all of the

Shift/Ctrl/Alt keys to the shortcut.

Pulse 4.12 User Guide 791

Format
In the Format tab, define the data presentation format for the text
strings. When you select a mask category, the applicable syntax appears
in the Edit Mask field and if required, you can modify or add free text
while maintaining the correct syntax.

Place Holder Choose a character which acts as a placeholder for

variable text.

Password Choose a character which represents password text.

Character When the user types a password, these characters
appear on the display instead.

Mask Type Choose the type of text string format that appears in
the text box. The options are None, DateTime,
Numeric, RegEx, Regular, Simple, and Text for
On/Off.

Use Mask as Choose this checkbox option to use the mask as the
Display Format display format.

Pulse 4.12 User Guide 792

Edit Mask Assemble the format pattern for the text that
appears in the text box. Choosing the Mask Type
and Category affects the pattern which is presented
here.

Category Select a text string format category. The choices in

this list are affected by the Mask Type selection.
The Sample box at the right displays a preview of
how text in the selected category appears in the
display.

Test Format Test the integrity of the text that you expect to
display by typing it into this space. Invalid
characters are not added, which is important
information.

Input Options
The Input Options tab contains parameters and options for defining and
assembling valid text strings for the text object.

Pulse 4.12 User Guide 793

Log Inputs Select this option to record all of this object’s text
changes in a log file.

Immediate Select this option to allow the user to type text

without clicking the object first or pressing Enter
while hovering over it.

Secure Input by Select this option to prompt the for login information
Additional User before allowing the user to enter data.
Login

Confirm before Select this option to prompt the user to confirm the
Activation entered data. In the edit box, type the prompt to
ask the user (for example, “Are you sure?”)

Numeric Range Select this option to define a limited valid numerical

range.

Minimum Value Type the lowest allowed number.

Maximum Value Type the highest allowed number.

Pulse 4.12 User Guide 794

Font
In the Font tab, define the appearance of the text in the text object.

Text Align Choose the location of the text in the text box.
Choose Near to start the text at the beginning of the
box. Choose Center to place the text in the middle.
Choose Far to flush the text to the far end of the
box.

Back Color Select the background color of the text box.

Fore Color Select the color of the text.

Font Select the text’s font, style, and size.

Pulse 4.12 User Guide 795

Security
In the Security tab, define the security levels for Visibility and Usability of
the Text object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 796

Pulse Action Button Instrument
Action Buttons give plant personnel the ability to initiate commands by
clicking or pressing on a graphic object. Pulse action commands can
include the following:

DDE Commands Set the value of DDE variables

Display Open, close and manipulate Operator Workstation

Commands displays

Menu Commands Replicate Operator Workstation menu commands

Reporting and Generate reports and documents based on historical

Printing data and trends
Commands

Special Execute various specialty operations

Commands

Task Commands Start, stop and control Windows tasks

Windows Control Enable/Disable Operator Workstation window

Commands features

An Action Button property can have more than one command. You can
define different commands to execute whenever the user pushes the
primary mouse button down, releases it up, or clicks the primary mouse
button.

NOTE All mouse button commands referred to in this section assume

use of the left button as the primary mouse button. If the right
button is configured in the operator PC as the primary mouse
button, then the operator needs to use the right button to
carry out the defined commands.

You can configure a rigid action (commands and their arguments) so that
the same task runs whenever someone presses the Action Button. To
obtain runtime flexibility, you can replace any part of the action with an
expression, alias, or "ask" placeholder.

Pulse 4.12 User Guide 797

To insert and define a Button object

1 From the Insert ribbon’s Instruments group, click the Pulse

Button icon and then drag an area on the display to locate the
Pulse Button object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Button Settings dialog box is displayed.

You can define the following types of parameters for the action
button:

• General

• Actions Workflow

• Security

• Appearance

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 798

General
In the General tab, define parameters for the action button.

Text Type the text string that appears on the button.

Tooltip Type the text string that appears in the button’s

tooltip.

Accelerator Key An accelerator key is a shortcut keyboard

combination that when pressed, carries out a
predefined command.

Select the key(s) to comprise the shortcut. Choose a

key from the drop-down list, i.e., None, A-Z, F1-F24,
PageUp, PageDown, End, Home, 0-9, NumPad0-
NumPad9, Escape, Space). You can add one, two, or
all of the Shift/Ctrl/Alt keys to the shortcut.

Log Actions Select this option to record all of this object’s actions
in a log file.

Beep on Click Select this option to play a beeping sound whenever

a user presses the button object.

Pulse 4.12 User Guide 799

Actions Workflow
In the Actions Workflow tab, define the commands to execute when the
user pushes the mouse button down, releases it up, or clicks it.

To define the object’s data item

 Enter an action command or workflow.

• You can type it manually.

When manually typing a command to execute a workflow,

add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard syntax.

-or-

• Open the Action Selector to assemble and/or choose the

command or workflow.

NOTE After you enter a workflow, it appears in the relevant edit box
in the following syntax:

[WorkflowName] [arguments]

Pulse 4.12 User Guide 800

Mouse Down Specify a command or workflow to run while the
operator holds the mouse button down.

Repeat Action Select this command to enable the command to

Every __ execute repeatedly if the user continues holding the
milliseconds mouse button down. Enter the frequency in
milliseconds for the repeat action to occur.

Mouse Up Specify a command or workflow to run when the

operator releases the mouse button after holding it
down.

Mouse Click Specify a command or workflow to run when the

operator clicks the mouse button.

Security
In the Security tab, define the security levels for Visibility and Usability of
the Action Button object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 801

Appearance
In the Font tab, define the appearance of the text on the button object.

Text Color Select the color of the text.

Font Select the text’s font, style, and size.

Use Skin Selected by default, deselect the option to define a

different appearance. When this option is not
selected, the Style, Back Color, and Back Color 2
fields are activated.

Style Select one of the following style from the drop-down

list: Office2003 (default), Simple, Flat, HotFlat,
UltraFlat, Style3D, NoBorder

Back Color Select a color from the drop-down options

Back Color 2

Pulse 4.12 User Guide 802

Pulse Cylinder Instrument
The Pulse Cylinder object is a cylindrical-shaped element that uses fills
to display data values and fluid levels. The user may also drag the fill in
order to change the associated item value.

To insert and define a Pulse Cylinder object

1 From the Insert ribbon’s Instruments group, click the Pulse

Cylinder icon and then drag an area on the display to locate the
Cylinder object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Cylinder Settings dialog box is displayed.

Pulse 4.12 User Guide 803

 You can define the following types of parameters for the Pulse
Cylinder:

• General

• Security

3 Define the General parameters for the text object, see General for
more details.

4 Click OK to implement the settings and close the dialog box, or

click Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 804

General
In the General tab, define the properties for the Pulse Cylinder object.

Read Item In the Item box, type the item name (or select it in
the Item Manager ) which controls this object’s
values.

Write Item Specify the item name (or select it in the Item
Manager ) to execute when the user drags the
object’s fill.

Precision Choose the percentage of accuracy between the drag

location and the actual value input (Write Item
value).

Pulse 4.12 User Guide 805

Cylinder

Value Specify an idle point for the cylinder, where the fill
level rests at workstation startup before the object
has received any data input.

Show Value Select this option to display the Value defined above
in digits with the cylinder.

Minimum Define the lowest value displayed on the cylinder.

Maximum Define the highest value displayed on the cylinder.

Outline Color Select the color of the cylinder’s outline.

Fill Color Select the color of the fill.

Tank Color Select the color for the tank.

Hover Color Select the hover’s color.

Drag Line

Color Select the color of the fill’s edge, which the user can
drag to change the value (if a write item is defined
for this object).

Log Inputs Select this option to record all of this object’s actions
in a log file.

Show Value Select this option to display the Value of the fill in
digits with the cylinder.

Set Value as It Select this option to change the object’s value

Moves dynamically as the user drags the fill.

Set Value Only Select this option to change the object’s value
when Released dynamically only after the user releases the mouse
button after dragging the fill.

Pulse 4.12 User Guide 806

Security
In the Security tab, define the security levels for Visibility and Usability of
the Pulse Cylinder object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 807

Pulse Annunciator Instrument
The Pulse Annunciator object allows you to set up a panel of “buttons”
that change color if they receive a signal that an alarm condition turned
on in their associated data source. You can associate an unlimited number
of buttons with the various displays in your project. In this way, an
operator can see immediately the area in the organization’s facilities from
which an alarm originates.

To insert and define an Pulse Annunciator object

1 From the Insert ribbon’s Instruments group, click the Pulse

Annunciator icon and then drag an area on the display to locate
the Pulse Annunciator object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Annunciator Settings dialog box is displayed.

Pulse 4.12 User Guide 808

 You can define the following types of parameters for the
Annunciator object:

• Buttons

• Design

• Security

3 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 809

Buttons
In the Buttons tab, associate each button with a display from the project,
which serves as its alarm source.

Caption Type the text string that appears on the button.

Display Name Browse and select the display which is associated

with the button. If an alarm condition turns on in the
area controlled by this display, the operator will see
an indication on this button. Clicking the button
opens the associated display.

Tooltip Type a tooltip that appears when the user’s mouse

pointer hovers over the button.

Pulse 4.12 User Guide 810

Add Add a button to the panel. After clicking this button,
a new entry appears at the bottom of the table.
Define its properties in the table.

Insert Add a button to the panel. Select a point in the table

where you want the button to appear and then click
Insert. A new entry appears in the selected
location. Define its properties in the table.

Remove Deletes a button from the panel. Select the button

you want to remove and then click Remove.

Move Up/Down To change a button’s location on the panel, select a

button entry and click Move Up or Move Down as
many times as required.

Pulse 4.12 User Guide 811

Design
In the Design tab, define the physical properties of the panel buttons,
such as Alarm indication colors, button size, and other attributes.

Text Color Select the color of the text that appears on the panel
buttons.

Alarm ON Select the color of the button when an Alarm ON

condition signal is received from the associated
display.

Alarm OFF Select the color of the button when an Alarm OFF
condition signal is received from the associated
display.

Pulse 4.12 User Guide 812

Font Select the text’s font, style, and size.

Buttons Width Define the width (in pixels) of the panel buttons.

Buttons Height Define the height (in pixels) of the panel buttons.

Log Inputs Select this option to record all indications received

by the buttons in a log file.

Beep Select this option to play a beeping sound when an

Alarm Condition change occurs.

Pulse 4.12 User Guide 813

Security
In the Security tab, define the security levels for Visibility and Usability of
the Annunciator object.

Usability The control may be used only by users whose

Security Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 814

Pulse Alarm Explorer Instrument
The Pulse Alarm Explorer object is an interface to the project’s Alarm
Explorer. Users can use the object monitor, acknowledge, and analyze
alarms and events from the operator workstation.

The Alarm Explorer object enables operators to:

 View records alarms, including start, acknowledge, and clear status.

 Acknowledge alarms one at a time or in groups. The alarm log

records when they were acknowledged and by whom.

To insert and define an Alarm Explorer object

1 From the Insert ribbon’s Instruments group, click the Pulse

Alarm Explorer icon and then drag an area on the display to
locate the Pulse Alarm Explorer object.

2 Right-click the object and select Settings from the pop-up menu.

The Pulse Alarm Explorer dialog box is displayed.

Pulse 4.12 User Guide 815

3 Click Save after customizing to save the details and to save the
size and location of the Pulse Alarm Explorer window.

Pulse 4.12 User Guide 816

 You can define the following types of parameters for the Pulse
Alarm Explorer object:

• General

• Look and Feel

• Colors

• Fields

• Filters

• Security

4 Click OK to implement the settings and close the dialog, or click

Apply to implement settings and keep the Pulse Alarm Explorer
dialog box open.

Pulse 4.12 User Guide 817

General
In the General tab, define properties that affect the functionality of the
Alarm Explorer object.

Pulse 4.12 User Guide 818

General

Active Window Choose the view to display:

 Current - Displays current active alarms and

events.

 Log - Displays the record of all alarms

(active, acknowledged, and closed)

 System Messages - Displays messages

related to the operation of various Pulse
modules and communications

Tree Type Choose to display the Functional or Location

hierarchy in the Alarm Explorer tree.

Selected Branch Choose a branch from the Functional or Location

tree to display.

Selected Branch An option to expand the depth of the selected

Expand Depth branch. Provide the level number to indicate up to
which depth to expand. The default depth is 1.

Show Only A checkbox option to hide branches other than the

Selected Branch selected branch in the Pulse Alarm Explorer.

View Choose if the Alarm Explorer displays a Tree and

Alarms, Alarms Only or Tree Only view.

Filter Choose a default filter that the Alarm Explorer object

uses when the operator opens it. This filter is listed
in the Alarm Explorer Settings Filters tab, see
Filters or under the Alarm Explorer’s Filter option,
see Filtering Alarms.

Indicate Alarm Select this option to show an indication in the Pulse

Alarm Explorer tree if the branch contains alarms.

All Alarms In Select this option to show indications if alarms are

Branch active in the subfolders of a branch.

Tree Pane Width Enter the value of the tree’s pane width size (by
percentage)

Pulse 4.12 User Guide 819

Sound On Alarm

Play Sound Select this option to play an audio indication if an

alarm or event occurs.

Select Sound Browse to select the audio file for the alarm
indication (*.wav).

Tree Appearance

Select Font Specify the tree text’s font, style, and size.

Text Color Specify the tree text’s color.

Background Specify the tree’s background.

Color

Alarms Appearance

Select Font Specify the alarm text’s font, style, and size.

Background Specify the alarm window workspace’s background.

Color

Pulse 4.12 User Guide 820

Look and Feel
You can customize the Pulse Alarm Explorer’s toolbar and status bar in the
Look and Feel tab.

Show Toolbar Select this checkbox option to display a toolbar of

commands and functions in the Alarm Explorer
object.

Toolbar Position Select one of the following display positions for the
toolbar in the Pulse Alarm Explorer object: None,
Left, Top (default), Right, Bottom, or
Standalone.

Icon Size Choose whether the Small or Large icons appear in

the toolbar.

Pulse 4.12 User Guide 821

Tool Caption Choose the alignment of the tool caption: Left
Alignment (default), Top, Right, or Bottom.

Tool Paint Style Choose a style for displaying tool paint style: Icon
Only (default), Text Only, or Icon and Text.

Current Alarms/Alarms Log/ System Messages/Suspend View

Enable or disable the applicable alarms for each view that can appear in
the Pulse Alarm Explorer object.

Visible Click to select the checkbox option to display the

command in the toolbar.

Picture The icon that appears on the command button (if

icon style has been chosen).

Caption The text that appears on the command button (if

text style has been chosen) and in the tooltip.

Security Choose the security level for users allowed to use

this specific button.

Pulse 4.12 User Guide 822

Colors
In the Colors tab, define the colors that indicate the status for the alarms
in the Pulse Alarm Explorer object.

Pulse 4.12 User Guide 823

Current View Colors

Select the colors indicating alarm status for active alarms, inactive
alarms, and events in the Current Alarm View.

Alarm Active Colors

Not Select a unique color to represent the active alarm

Acknowledged when it is not acknowledged.

Acknowledged Select a unique color to represent the active alarm

when it is acknowledged.

Alarm NOT Active Colors

Not Select a unique color to represent the inactive

Acknowledged alarm when it is not acknowledged.

Acknowledged Select a unique color to represent the inactive

alarm when it is acknowledged.

Indicate Alarm When the checkbox option is selected, Pulse

generates an alarm indication.

Checking the Indicate Alarm checkbox makes the

Blink On Alarm feature available.

Blink On Alarm When the option is selected, the feature allows

Pulse to indicate an alarm by blinking the branch
when an alarm is generated.

The Blink On Alarm checkbox option is only

available when the Indicate Alarm option is
selected.

Log View Colors

Select the colors indicating alarm status in the Current Alarm View.

Started/ Select a unique color to represent these status

Acknowledged/ indications.
Cleared/Logged

Alarm Event Color

Event Select a unique color to represent an alarm event.

Pulse 4.12 User Guide 824

Suspend View Colors

Select the colors indicating suspend block/branch alarm status in the

Current Alarm View.

Suspended Select a unique color to represent these status

Background/ indications.
Suspended
Forecolor/
Unsuspended
Background /
Unsuspended
Forecolor

Priorities Colors

Define background colors to indicate the priority levels of the alarm

entries in the Alarm Explorer.

Click + to add a priority definition.

Click - to remove a priority definition.

From/To Enter a range of alarm priority.

Background Color Choose the background color of Alarm Explorer

entries for alarms belonging to this priority range.

Pulse 4.12 User Guide 825

Fields
In the Fields tab, design the layout and select the parameters which
appear in the various views of the Pulse Alarm Explorer object.

Time Format Choose the format for displaying alarm and event
times.

Show Drag Drop Select this option to allow the user to drag column
Fields names above the header, which then sorts the
entries into groups according to that column’s
information.

Show Filter Row Select this option to allow the user to specify a filter
for displaying entries.

Pulse 4.12 User Guide 826

Show Headers Select this option to display column headers.

Best Fit Select this option to display the alarm and event
times as best fit as possible.

Show Navigator Select this checkbox option to display the navigator.

The checkbox is selected by default.

Right to Left Select this checkbox option for your text language
to start from a right-to-left direction.

Current Alarms / Log View / System Messages / Suspend View

Click the relevant tab in order to define the layout of the respective table.

Sort

Choose the column which determines the sorting order of the alarm and
event entries.

First By Choose the main sorting criterion; entries appear in

ascending order, unless you select the Descending
checkbox option.

Second By Select this option to enable a secondary sorting

criterion; entries appear in ascending order, unless
you select the Descending option.

Visible Select this checkbox next to all fields which you

want to display in the Pulse Alarm Explorer view.
Deselecting a field’s checkbox hides the field.

Caption The name for the field that appears in the Pulse
Alarm Explorer view.

Width Define the width of the displayed caption.

Pulse 4.12 User Guide 827

Filters
In the Filters tab, create filter views which will be available for the users
during runtime. The user can use the Customize View Filter Wizard to
define the properties of each filter view. For example, you can create a
view filter that hides alarms that have been acknowledged and cleared.

Pulse 4.12 User Guide 828

1 Click Add.

The Customize View Filter Wizard is displayed.

2 Type Name and Description strings for the filter and click Next.

The Customize View Filter Wizard window’s Select fields to add to

filter page is displayed.

Pulse 4.12 User Guide 829

3 Select the Alarm View to which the filter applies: Current Alarms,
Alarms Log, or System Message and click Next.

The Customize View Filter Wizard window’s Add or Edit an Alarm

Filter page is displayed.

Pulse 4.12 User Guide 830

4 Click the Build Filter button.

The Build Filter dialog box is displayed.

The Build Filter dialog box allows you to assemble the filter’s
components. Select fields, data, and use expressions and Boolean
operators to create the filter.

5 After defining the filter, click OK.

The selected items are displayed in the wizard’s Filter Query box.

6 Click OK.

The Filter query is displayed.

7 Click Finish.

The filter details appear in the Filter tab.

Pulse 4.12 User Guide 831

Security
In the Security tab, define the security levels for Visibility and Usability of
the Pulse Alarm Explorer object.

Usability Security The control may be used only by users whose

Lock authorization level equals or is higher than the level
specified here.

Visibility Security The control is visible only to users whose authorization

Lock level equals or is higher than the level specified here.

Pulse 4.12 User Guide 832

Pulse Table Instrument
The Table Instrument makes it easier and convenient for the user to
create a table on the display. The user can create a table and customize
its cells, rows and columns - individually or as a group. A cell has static
and/or animation properties.

To use the Table instrument

1 In the Developer Workstation, go to the Insert ribbon and click the

Pulse Table icon from the Instruments group.

2 Drag an area on the display to locate the Pulse Table instrument.

3 Right-click on the instrument and select Settings from the pop-up

menu.

The Pulse Table Settings dialog box is displayed.

Pulse 4.12 User Guide 833

4 Define the Pulse Table properties in the following tabs:

• Cells

• Appearance

• Toolbar Buttons

• Security

Cells
The Cells tab includes the following sub-tabs that enable the user to
customize the cell(s):

 Cell Appearance

 Text Animation

 Color Animation

 Action Button Animation

Pulse 4.12 User Guide 834

Managing Rows

To manage row(s)

The Insert and Remove buttons in the Row area are only active when at
least one row is available and selected.

Add Select a row and click the Add button from the
Row area to add a row next to the last row.

Insert To insert a row, select any row, and click the

Insert button, a row is added next to the selected
row.

Remove To remove row(s), select the row or multiple rows

and click the Remove button.

Managing Columns

To manage column(s)

The Insert and Remove buttons in the Column area are only active
when at least one column is available and selected.

Add Select a column and click the Add button from the
Column area to add a column next to the last
column.

Insert To insert a column, select a column, and click the

Insert button, a column is added next to the
selected column.

Remove To remove column(s), select the column and click

the Remove button.

The user can select multiple cells (multiple rows, multiple columns or
multiple rows and columns) to customize or define the cell(s) properties.

When a cell, row, or column is selected, it is indicated by a blue dot on the

right part of the cell.

Pulse 4.12 User Guide 835

Cell Appearance
To customize cell(s), define the following parameters from the Cell
Appearance tab

Text Write any alphanumeric value; the entry will

appear on the cell as its label.

Font Select an available font from the drop-down list

(the default Font and Font Style are Tahoma,
8.25, Regular) and then select the Font Style by
checking its corresponding checkbox (the Font
Style appears on the right side of the Font
selections when clicking the drop-down list).

Back Color Select the background color from the drop-down

list, the default is white

Back Color2 Select the second background color from the drop-
down list, if the user selects a different color from
the first background color, then a blend of two
background colors appears on the cell; the default
is white

Pulse 4.12 User Guide 836

Fore Color Select the foreground color from the drop-down
list, if you have a text then the text changes to the
foreground color you selected; the default is white.
Note that the Text has a black color and is not
white even if the default foreground color is white;
it only changes when a different color is selected
from the ForeColor drop-down list.

Frame Color Select the color of the frame from the drop-down
list, the default selection is white. This parameter
is disabled when the Action Button Animation is
defined.

Frame Width Define the width of the frame, i.e., 2. This

parameter is disabled when the Action Button
Animation is defined.

Horiz. Alignment Select the horizontal alignment from the drop-

down list (Left, Center, Right)

Row Height The height of the selected row is displayed in the

field, i.e., 50, define a new one if necessary

Column Height The height of the selected column is displayed in

the field, i.e., 50, define a new one if necessary

Image A graphic image with a *.bmp, *.jpg, or *.bmp file

can be loaded into the cell

Security

Visibility Security The selected cell is only visible to users whose

Lock authorization level equals or higher than the level
specified

Usability Security The selected cell may only be used by users whose
Lock authorization level equals or higher than the level
specified

Reset Cells

Click the Reset Cells button to restore the default values for the Cell
Appearance parameters.

When defining the Cell Appearance parameters, the cell is only

considered as 'static'.

Pulse 4.12 User Guide 837

Defining Animation Properties to a Cell
To add animation properties to a cell

 Define the parameters in the Text Animation, Color Animation,

and the Action Button Animation tabs.

A red dot within the cell indicates that it has animation properties.

The user can do the following when right-clicking on a cell or multiple cells
and selecting one of the following options:

 Merge - Select two or more cells and choose this option to merge
the cells; when selecting merged cells, the option changes into
UnMerge which unmerges merged cells

 Copy - Copies the cell with all its properties

 Paste Cell with Animation - Pastes the cell static properties

including its animation properties

 Paste - Pastes the cell with its static properties; the animation
properties, if any, are not included

Inserting an Image into a Cell in the Table

To insert an image into a cell in the Table Instrument:

1 In the Pulse Table Settings dialog box, go to the Cells tab and
click on the cell where the image would be inserted (assuming that
a table already exists).

2 Click the Cell Appearance tab on the right pane of the Pulse
Table Settings dialog box.

3 Click on the Image field.

A box with a No image data text is displayed.

Pulse 4.12 User Guide 838

4 Right-click on the box and select Load from the pop-up menu.

Pulse 4.12 User Guide 839

5 Browse for an image or select one from the Open window then click
Open.

NOTE It is recommended to load only *.bmp, *.jpg, or *.bmp

graphic files.

6 Click OK in the Image box then click Apply and OK again in the
Pulse Table Settings dialog box.

The loaded graphic is shown in the cell.

Pulse 4.12 User Guide 840

Text Animation
The user can define cell’s text animation properties in the Text
Animation, tab.

Item Click the … button to display the Item Manager

dialog box.

Behavior

Read Only Select this option to prevent the operator from

typing any input text in this object during
runtime.

Deselect this option to enable operators to change

the text.

For more details, see Using Pulse Table

Instrument.

Right Click Task Select this option to display a pop-up menu when
the user right-clicks on the object.

Pulse 4.12 User Guide 841

Tooltip

Show Time Stamp Select this checkbox option to display the data
item’s time stamp in the object’s tool tip. If
selected, choose the time stamp’s display format
from the drop-down list:

 TimeOnly (default)

 TimeAndShortDate

 TimeAndLongDate

 None

Prompt Type free text that is displayed as the object’s tool

tip.

Accelerator Key

An accelerator key is a shortcut keyboard combination that when pressed,

carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut.

First, choose a key from the list (None, A-Z, F1-
F24, PageUp, PageDown, Home, End, 0-9,
NumPad0 – NumPad9, Escape, Space). Optionally,
you can add one, two, or all of the Shift/Ctrl/Alt
keys to the shortcut.

Pulse 4.12 User Guide 842

Format

The Format parameters define how the object’s text output appears
during runtime.

Use Format Choose an alphanumerical format from the drop-

down list:

 UnformattedText (default)

 DecimalValue

 SignedDecimalValue

 Test for On/Off

 Text for Value Range,

for more details, see Displaying a Text
Comment Based on the Specified Range
Value of the Cell

 ZeroPaddedDecimalValue

 ZeroPaddedSingedDecimalValue

 SimpleTime

 RegionalTime

 ShortRegionalDate

 LongRegionalDate

 Advanced

Pulse 4.12 User Guide 843

Mask Type The Mask Type parameter is only available if you
chose the Advanced format in the Use Format
field.

Select one of the following mask types from the

drop-down list:

 None

 DateTime

 Numeric

 RegEx

 Regular

 Sample

 Text for On/off

Edit Mask The Edit Mask parameter is only available if you

chose the Advanced format in the Use Format
field.

The Edit Mask field displays the value of the

mask type you chose in the Mask Type field.

NOTE The Edit Mask field is not available

when Text for On/Off is selected as
the Mask Type.

Pulse 4.12 User Guide 844

Category The Category parameter is only available if you
chose the Advanced format in the Use Format
field.

Select one of the following category from the

drop-down list:

 Custom

 Short date

 Long date

 Short time

 Long time

 Full date/time (short time)

 Full date/time (long time)

Sample This box displays an example of the selected

Format choices.

The Edit Mask and Category parameters are available for all mask types.

Placeholder You can define a character that represents the

mask text defined above.

Password You can define a character that functions as a

Character password character, hiding the identity of the true
character being typed. When the operator types
input text in the provided box, this character
appears in the text box instead.

Horiz. Alignment

Left/Center/Right Select the location of the text output in the object

(Left, Center or, Right).

Pulse 4.12 User Guide 845

Command

The Command and Indication parameters are available only for the
Text for On/Off mask type (digital 1/0).

In the Operator Workstation, a dialog box is displayed which presents the

available commands and the expected output.

Set (On) Enter the text that will appear on the command
button to set the data (turning ON), applies only
to input text.

Reset (Off) Enter the text that will appear on the command
button to reset the data (turning OFF), applies
only to input text.

Indication

On Enter the value that represents the data’s ON

status.

Off Enter the value that represents the data’s OFF

status.

Input

The Input parameters define how the operator input will appear at
runtime.

Log Select this option to record all of this object’s text

inputs in a log file.

Secure Input by Select this option to require the operator to

Additional Login provide a User Name and Password before typing
an input

Pulse 4.12 User Guide 846

Confirm Before Select this option to request confirmation from the
Activation operator before implementing any input. In the
text box, type the confirmation request string.

Immediate Select this option to display this object’s text input

dialog box when the mouse hovers over the
object. When deselected, the operator opens the
dialog box by clicking the mouse.

Color Animation
The user can define a cell’s color animation properties in the Color
Animation tab.

Pulse 4.12 User Guide 847

Fill / Line / Text tab

Type Select one of the following type from the drop-down

list:

 Analog Value

 Alarm

 Digital Value

When the Analog Value type is selected:

• Replace - Select this option to

completely replace the Pulse system
context menu with the customized
menu.

Deselect this option to append the customized

menu commands to the Pulse system context
menu.

• Add - Enter a numerical range limit and

then click this button to add a new
range.

• - Delete the corresponding range.

Pulse 4.12 User Guide 848

 When the Alarm type is selected:

• When Value is Normal, Paint – Define

the context menu that is displayed when
the operator right-clicks the object while
the Alarm is in the Normal state.

• Alarm Condition table - In the table,

select the alarm condition’s checkbox to
enable the context menu property
setting.

In the Context Menu column, choose the

context menu associated with the alarm
condition.

Define the Paint, Color, and Blink properties in

their respective columns.

Pulse 4.12 User Guide 849

 • When Alarm is Acknowledged, Paint
- Define the context menu that is
displayed when the operator right-clicks
the object while the Alarm is in the
Acknowledged state.

When the Digital Value type is selected:

Pulse 4.12 User Guide 850

 • Item 1, 2, and 3 - Define the digital
addresses which control this property’s
values, such as digital blocks and/or
dummy variables (or assemble them in
the Item Manager …).

• For each item you add, the number of

possible context menu definitions is
doubled. For example:

• 1 item > 2 context menu settings

• 2 items > 4 context menu settings

• 3 items > 8 context menu settings

• Use DBSR for bit calculation - Select

this option only if you define Pulse
Kernel items for this object, and the
digital-to-analog expression will be
written to another Kernel item.

Do not select this option if the items will

refer to other address categories.

If this option is selected, the

Expression parameter is enabled,
presenting the digital-to-analog
expression.

• Expression - This parameter is relevant

when the Use DBSR for Bit
Calculation option is selected.

Displays the resulting digital-to-analog

expression for the advised Items calculation,
depending on the Items defined for this
digital value control (Item 1, 2, & 3). For
example:

|!@D/A(,|!d:1,|!d:2)

You may insert an analog kernel item before

the first comma in this expression - this
results in a change to that analog item’s
value every time there is a change in the
digital items’ state.

Pulse 4.12 User Guide 851

Action Button Animation
The user can define cell’s action button animation properties in the Action
Button Animation tab.

Define the following action, workflow, and mouse attribute settings.

Action Workflow

To define the object’s data item, enter an action command or workflow.

 You can type it manually.

When manually typing a command to execute a workflow, add a
workflow prefix (WF).
For example, WF:Alert_in_B4
When manually typing an action, use standard syntax.
-or-

 Open the Action Selector … to assemble and/or choose the

command or workflow.

NOTE After you enter a workflow, it appears in the relevant edit box
in the following syntax:
[WorkflowName] [arguments]

Pulse 4.12 User Guide 852

Action Down Specify a command or workflow to run while the
operator holds the mouse button down.

Action Up Specify a command or workflow to run when

the operator releases the mouse button after
holding it down.

Action Click Specify a command or workflow to run when

the operator clicks the mouse button.

Action Double Click Specify a command or workflow to run when

the operator double-clicks the mouse button.

Mouse Attributes

Prompt Type the text string to appear in the object’s

tool tip.

Repeat Action Repeat the defined action as long as the mouse

button remains held down on the object.
Choose the time interval in ms for the repeat
action.

Log Inputs Select this option to record all of this object’s

actions in a log file.

Beep Select this option to make a beeping sound

when the operator performs a mouse action on
the object.

Invert Select this option to change an object’s defined

colors when the operator performs a mouse
action on the object.

Accelerator Key

An accelerator key is a shortcut keyboard combination that when pressed,

carries out a predefined command.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut.

First, choose a key from the list (None, A-Z, F1-
F24, PageUp, PageDown, Home, End, 0-9,
NumPad0 – NumPad9, Escape, Space).
Optionally, you can add one, two, or all of the
Shift/Ctrl/Alt keys to the shortcut.

Pulse 4.12 User Guide 853

Appearance
The user can define the following parameters in the Appearance tab.

Table

Show Footer Select this checkbox option to display footer on the

table.

Best Fit Select this checkbox option to distribute the rows and
columns evenly in the Table display.

Show Row Select this checkbox option to display the row

Indicator indicator on the left most part of the table

Toolbar

Toolbar Display Select one of the following options from the drop-
Style down list:

 Text and Image - Displays the toolbar icons

and the text

 Text - Displays only the text on the toolbar

 Image - Displays only the toolbar icons on the

toolbar

Pulse 4.12 User Guide 854

Toolbar Icon Select Small or Large from the drop-down list to
Size define the size of the toolbar to display.

Show Standard Select this checkbox option to display the toolbar on

Toolbar the table display.

Use Whole Row Select this checkbox option for the toolbar to occupy
the whole top row of the table.

Toolbar Buttons
The user can view or define the following parameters in the Toolbar
Buttons tab

Visible When the checkbox corresponding to the Caption

is checked, the caption is displayed on the
Toolbar.

Pulse 4.12 User Guide 855

Caption Lists all the available buttons that can be
displayed on the Toolbar:

 Export Table

 Export to XLS

 Export to HTML

 Export to TXT

 Export to XML

 Preview

 Export to PDF

 Show Footer

 Row Indicator

 Best Fit

Icon Displays the icon of the corresponding Caption.

Security Lock Set the level of visibility security for each toolbar
button here.

Pulse 4.12 User Guide 856

Security

The user can define the following parameters in the Security tab:

Visibility Security The table is only visible to users whose

Lock authorization level equals or higher than the
level specified.

Usability Security The table may only be used by users whose

Lock authorization level equals or higher than the
level specified.

Pulse 4.12 User Guide 857

Using Pulse Table Instrument

Using (thiscolumn) and (thisrow) in the Pulse Table

Instrument

(thiscolumn) and (thisrow) can be used in the Pulse Table

Instrument Text Animation to replace an item.

 (thiscolumn) replaces the table’s column number(s) (i.e., 0, 1, 2,

3, ...) on the Pulse Table Instrument at runtime

 (thisrow) replaces the table’s row number(s) (i.e., 0, 1, 2, 3, …)

on the Pulse Table Instrument at runtime

NOTE The first row count starts at zero and the first column count
starts at zero.

Example 1

|!a:(thisrow) is replaced by |!a:0 for row #0 (first row) and/or |!a:1 for
row #1 (second row) and so on.

Pulse 4.12 User Guide 858

Example 2

Set |!a:(thisrow) 50 is replaced by Set |!a:0 50 for row #0 and/or Set

|!a:1 50 for row #1.

Example 3

Set |!a:2 ?GetProperty('Table1.PulseTable1.Settings.CellsTable[' +

((thisrow) - 1) + '][0].CellText')?

is replaced by

Set |!a:2 ?GetProperty('Table1.PulseTable1.Settings.CellsTable[' +

(1 - 1) + '][0].CellText')?

Setting the Pulse Table Instrument Cell Text

Animation Behavior per Cell
You can set the Pulse Table Instrument cell’s Text Animation behavior
to Read Only.

1 Select a cell or multiple cells in the Pulse Table Settings dialog

box.

2 In the Cells tab, click the Text Animation tab and check the Read
Only checkbox option under Behavior.

The selected cell(s) is/are now read only.

Pulse 4.12 User Guide 859

Displaying a Text Comment Based on the Specified
Range Value of the Cell
You can display a text comment based on the specified range value of the
cell in the Pulse Table Instrument.

For example, if the specified range is between 1-10 with Text=Low and
the value read from Pulse is 7, then the cell displays “Low”.

To display a text comment based on the specified range value of

the cell in the Pulse Table Instrument

1 Select a cell in the Pulse Table Settings dialog box.

2 In the Cells tab, click the Text Animation tab.

3 Select Text for Value Range from the Use Format drop-down
list.

4 Click “+” to add a row on the table and define the following:

• From Value Range (Input) – The lowest value in the range

read from the Pulse item

• To Value Range (Input) - The highest value in the range

read from the Pulse item

• Text – The text value that Pulse displays when the value is
within the range

• Value (Output) - The value written by Pulse to the Pulse

item

Pulse 4.12 User Guide 860

Pulse 4.12 User Guide 861
Pulse Animated Picture Instrument
The Pulse Animated Picture Instrument enables displaying selected
images and animated GIFs according to an item's value(s). The image of
an Instrument changes when a value of an item (such as a block, direct
address, expression, and more) is triggered.

General
The Pulse Animated Picture Settings consists of two modes:

 Dynamic - can be set as Analog, Range, or Digital.

• Dynamic - Analog

In this mode, the user adds images (i.e., jpg, png, bmp)
where each image is set with a specific item value. When a
value is entered, the corresponding image is displayed.

This is done by adding images to the Selected Images list

and setting the required value next to the image name. Note
that when adding an image to the image area (right pane),
the default Value for the initial image is 0 and thereafter
automatically increases by 1. The value(s) can be changed.
Duplicate values are not allowed in the list.

• Dynamic – Range

The Range values define the extent the animated picture will
occupy.

• Dynamic - Digital

In this mode, the user adds images to the Selected Images

list. The selected images are displayed in a continuous loop
when the set item value = 1 or more.

When the Item value = 0, one of the static images are

displayed and the loop is stopped. The rate in which the
images are looped depends on the Interval value.

Interval 100 is considered slower than 1000.

Pulse 4.12 User Guide 862

 Static - Static mode is exclusively set as Digital.

Static mode displays an animated GIF image and is designed to

work with Digital Blocks or values (0;1)

When the Item Value = 1, the animated GIF is animated in the

Instrument and when the value = 0, the animation stops. The
frame rate Speed in which the animated GIF runs depends on the
Interval value. Interval 100 is considered slower than 1000.

To add an animated picture into the display:

1 In the Developer workstation, open a display and go to the Insert

ribbon, click Pulse Animated Picture icon from the
Instruments group then create a rectangle or square on the
display.

A rectangle or square with a "No image data" on it is displayed.

2 Double-click on the object.

The Animated Picture Settings dialog box is displayed.

3 On the General tab, define the block, address or expression

(i.e., |!a:1) in the Item field.

4 Select whether you want an animated picture that is Dynamic

(Analog/Digital) or Static.

Pulse 4.12 User Guide 863

Dynamic and Analog
1 To select an animated picture that is Dynamic and Analog
(default), click on the Dynamic option on the left area below the
Item field.

2 Click Analog on the right area on the right part below the Item
field.

3 Go to the Select Images area and click the Add button then select
an image file (*.jpg, *.jpeg, *.jpe, *.png, *.bmp, *.jfif) and click
Open; the Value and ImageName rows are filled every time an
image is added or inserted.

4 Click OK then click Apply.

The image that is displayed is corresponds to the Value (i.e., 0,

1, 2, etc.) you enter in Data Scope.

Pulse 4.12 User Guide 864

Dynamic and Range
The user can define the Range parameter for the Dynamic mode in the
Animated Picture Settings dialog box.

To define the Range in the Animated Picture Settings

1 Go to the General tab and select Dynamic.

2 Select the Range option then click the Add button.

A new row is added in the Select Images table.

3 Define the Image Name, the From Value, and the To Value for
the range of the image that will be shown.

The From Value and the To Value are the two parameters
comprising the Range values. The Range values define the limit
between the lowest value and the highest value of the image that
will be shown.

Pulse 4.12 User Guide 865

Dynamic and Digital
1 To select an animated picture that is Dynamic and Digital, click on
the Dynamic option on the left area below the Item field.

2 Click Digital on the right area on the right part below the Item
field.

3 Define the interval value from the Interval field.

4 Click the Add button then select an image file (*.jpg, *.jpeg, *.jpe,
*.png, *.bmp, *.jfif) and click Open.

5 The ImageName row is filled every time an image is added or

inserted.

6 Click OK then click Apply.

The images are displayed in a loop with an interval that you have
previously defined.

Pulse 4.12 User Guide 866

Static
1 To select an animated picture that is Static, click on the Static
option on the left area below the Item field.

2 Define the interval value in the Interval field.

3 In the Animated GIF area, click the Load Image button then
select an image file (*.gif).

4 Click Open.

The Animated GIF image is displayed.

5 Define the parameters in the Security tab as required.

6 Define the parameters in the Appearance tab as required.

7 Click Apply.

Pulse 4.12 User Guide 867

Security

Visibility Security The control is visible only to users whose

Lock authorization level equals or is higher than the
level specified here.

Usability Security The control may be used only by users whose

Lock authorization level equals or is higher than the
level specified here.

Pulse 4.12 User Guide 868

Appearance

Alignment Define the animated picture alignment by

selecting one of the following from the drop-
down list:

 TopLeft

 TopCenter

 TopRight

 MiddleLeft

 MiddleCenter

 MiddleRight

 BottomLeft

 BottomCenter

 BottomRight

Pulse 4.12 User Guide 869

Size Mode Define the animated picture size mode by
selecting one of the following from the drop-
down list:

 Clip

 Stretch

 Zoom

 StretchHorizontal

 StretchVertical

 Squeeze

Border Style Define the animated picture border style by

selecting one of the following from the drop-
down list:

 None

 FixedSingle

 Fixed3D

Pulse 4.12 User Guide 870

Pulse Event Management Instrument
You may insert a Pulse Event Management instrument in a display,
together with other control and indicators, to create an operations
environment for the Pulse user. A Pulse Event Management instrument
has the following design options, in addition to its size and location in the
display.

Intended User and Layout

You may choose the view for the respective intended user: Operator View,
Supervisor View, or Events Journal View.

The default layout is a rectangle with a toolbar at the top and two panes
below it - the left hand pane for a tree (Location or Functional) and the
right hand pane for the events list.

You may change the location of the toolbar - to any edge of the rectangle
- and its button complement and look and feel.

You may change the relative width of each pane or remove one of the two
altogether.

NOTE The Operator View and the Supervisor View split at run time
the bottom of the instrument to display there a pane for
Suspended Events pane. Adjust the overall height of the
instrument to accommodate that pane too.

Pulse 4.12 User Guide 871

Presentation Details
You may adjust the fonts and colors used for various text items (mainly
event messages). You may decide which columns are displayed in the
event list pane, and associated features (filtering, sorting, date and time
format, etc.).

Authorization Details
As with any other instrument, you may decide the authorization levels
needed to view and use this instrument.

Configuring a Pulse Event Management

Instrument
To insert and define a Pulse Event Manager

1 From the Insert ribbon’s Instruments group, click the Pulse

Event Management icon and then drag an area on the display to
locate the Pulse Event Management object and define its size
and position in the display.

2 Right-click on the Pulse Event Management object and select

Settings from the pop-up menu.

The Pulse Event Management Settings dialog box is displayed.

Pulse 4.12 User Guide 872

General

General

Active View Select the intended view from the drop-down

list.

 Operator View

 Supervisor View

 Events Journal View

Pulse 4.12 User Guide 873

Tree Type Select which type of tree to display on the left-
hand pane of the Pulse Event Management
object (when the pane is available) from the
drop-down list.

 Location

 Functional

The tree is used at runtime to filter events.

Selected Branch Select which branch (of the tree selected above)
is to be shown.

Select Branch Expand Enter the number of levels to expand below the
Depth selected branch.

Show Only Selected Select this checkbox option to show selected

Branch branches only

View Style Select which pane(s) are shown: Tree and

Events, Tree only or Events only

Default Filter Applies only if Events Journal View is selected

in the Active View field.

Select a default filter from the drop-down list:

 Last 50 Events

 Last 48 Hours

 Only Open Events

 Selected Period

 Current Shift Events

 Previous Shift Events

 Show Last

Close Event Left Define the position value when closing an event
Position on the left position

Close Event Top Define the position value when closing an event
Position on the top position

Close Task Left Define the position value when closing a task on
Position the left position

Pulse 4.12 User Guide 874

Close Task Top Define the position value when closing a task on
Position the top position

Tree Appearance

Font Select the font for the tree text labels

Text Color Select the color for the tree text labels

Background Color Select the color for the tree background

Events Appearance

Font Select the font for event text labels

Background Color Select the color for event text background

Pane Appearance

Tree Pane Width Enter the percentage of the instrument width

occupied by the tree pane (effective if the Tree
Pane is displayed)

Pulse 4.12 User Guide 875

Look and Feel

Use the Look and Feel tab to configure the toolbar features of the Pulse
Event Management instrument.

You can define these features separately for each of the three modes by
using the respective tab under the Toolbar Properties section:

 Operator View

 Supervisor View

 Events Journal View

Pulse 4.12 User Guide 876

Toolbar Properties

Show Toolbar Check this checkbox option to show the toolbar

Toolbar Position Select the position of the toolbar from the drop-
down list:

 Top

 Bottom

 Left

 Right

Tool Caption Select the alignment of the tool caption from

Alignment the drop-down list:

 Top

 Bottom

 Left

 Right

Icon Size Select the size of the tool icon from the drop-
down list:

 Large

 Small

Tool Paint Style Select the tool presentation format style from
the drop-down list:

 Text Only

 Icon Only

 Icon and Text

Show Status Bar Click to select this checkbox option to display

the status bar in the Pulse Management
instrument window.

Pulse 4.12 User Guide 877

Tools table

This part presents three tabs for the respective view modes of the
instrument. Select the tool(s) to present in the Pulse Event Management
instrument toolbar for each view.

Select the tool and its authorization level.

Visible Click to select the corresponding tool to show in

the Pulse Event Management toolbar.

Picture The icon image of the tool - for information only

Caption the text of the caption used for the tool - - for
information only

Security Level enter the lowest security level required to use

the tool

Tools (Icons/Caption)

Operator View Displays the Operator View command (icon)

on the Pulse Management instrument toolbar.

Supervisor View Displays the Supervisor View command (icon)

on the Pulse Management instrument toolbar.

Events Journal View Displays the Events Journal View command

(icon) on the Pulse Management instrument
toolbar.

Toggle Tree Displays the Toggle Tree command (icon) on

the Pulse Management instrument toolbar.

Tree Only Displays the Tree Only command (icon) on the

Pulse Management instrument toolbar.

Tree And Events Displays the Tree and the Events command
(icon) on the Pulse Management instrument
toolbar.

Events Only Displays the Events Only command (icon) on

the Pulse Management instrument toolbar.

New User Event Displays the New User Event command (icon)
on the Pulse Management instrument toolbar.

Close Event Displays the Close Event command (icon) on

the Pulse Management instrument toolbar.

Pulse 4.12 User Guide 878

Close Events in Zone Displays the Close Events in Zone command
(icon) on the Pulse Management instrument
toolbar.

Suspend Event Displays the Suspend Event command (icon)

on the Pulse Management instrument toolbar.

Show/Hide Displays the Show/Hide Suspended

Suspended command (icon) on the Pulse Management
instrument toolbar.

Filters Displays the Filters command (icon) on the

Pulse Management instrument toolbar.

Refresh Displays the Refresh command (icon) on the

Pulse Management instrument toolbar.

Print Displays the Print command (icon) on the Pulse

Management instrument toolbar.

Settings Displays the Settings command (icon) on the

Pulse Management instrument toolbar.

Save Displays the Save command (icon) on the Pulse

Management instrument toolbar.

Pulse 4.12 User Guide 879

Colors
The Colors tab is used to define the various colors of event lines in the
events pane.

Operator and Supervisor views color per priority

This section is used to define the colors in the Operator and Supervisor
View modes for the background and for the text of event messages
according to their respective priority.

From You can divide the priority scale of 0 to 99 into

as many non-overlapping bands as you need
To and assign to each such band different
background and text color pairs.

Pulse 4.12 User Guide 880

Background Color, You can choose from three color sets:

Text Color  Custom - a set of 48 colors that you can

customize

 Web - a predefined set of colors

 System - the Windows user interface

(display) set of colors

Events Journal view colors for state

This section is used to define the colors in the Events Journal View for the
background and for the text of event messages according to its respective
state.

Started You can choose from three color sets:

Assigned  Custom - a set of 48 colors that you can

customize
Suspended
 Web - a predefined set of colors
Closed
 System - the Windows user interface
(display) set of colors

Pulse 4.12 User Guide 881

Fields
The Fields tab is used to define which event-related fields are displayed
in an event message columns and how. You can configure this separately
for the Operator View, the Supervisor View and the Events Journal view
modes.

Pulse 4.12 User Guide 882

General

This section defines the date, time formats, and general presentation
options.

Date Time Format Define how the time and date are displayed:

 General date/time pattern (short time)

 General date/time pattern (long time)

 Short date pattern

 Long date pattern

 Short time pattern

 Long time pattern

 Full date/time pattern (short time)

Show Group Panel Checkbox option that allows displaying a panel

above the events listing, used at runtime to
group events using one of columns as criterion

Show Filter Row Checkbox option that allows displaying a row

above the event listing - used at run time to
type a filtering expression above a column

Show Headers Checkbox option that allows displaying column

headers (titles)

Best Fit Checkbox option that allows automatically

adjusting the column widths that best fit at
runtime.

Pulse 4.12 User Guide 883

Appearance

Operator View Have the following sub-tabs:

Supervisor View  Events – Specify what to show in the

Event pane of the Pulse Event
Management instrument window

 Tasks - Specify the respective Tasks

 Suspended - Specify the Suspended

events

Sort

Define one or two sort keys and their respective

sort order in the Sort area.

Events Journal View Sort

Define one or two sort keys and their respective

sort order in the Sort area.

Pulse 4.12 User Guide 884

Security
The Security tab is used to define the operator authorization level
required to respectively view the instrument and to operate it.

Visibility Security The table is only visible to users whose

Lock authorization level equals or higher than the
level specified.

Usability Security The table may only be used by users whose

Lock authorization level equals or higher than the
level specified.

Pulse 4.12 User Guide 885

Pulse Chart Instrument
The Pulse Chart Instrument enables Pulse to display data in various forms
of chart layouts.

To insert and define a Pulse Chart Instrument

1 From the Insert ribbon’s Instruments group, click the Pulse

Chart icon and then drag an area on the display to locate the Chart
instrument.

2 Double-click on the object or right-click the object and select

Settings from the pop-up menu.

The Pulse Chart Settings dialog box is displayed.

3 Define the parameters for the chart.

4 Click OK to implement the settings and close the dialog box, or

click Apply to implement settings and keep the dialog box open.

Pulse 4.12 User Guide 886

Chart

 Chart Type - select the type of chart from one of the following
options on the drop-down list:

• Bar (default), StackedBar, FullStackedBar,

SideBySideStackedBar, SideBySideFullStackedBar, Pie,
Doughnut, Funnel, Point, Bubble, Line, StepLine,
Spline, ScatterLine, SwiftPlot, Area, SplineArea,
StackedArea, StackedSplineArea, FullStackedArea,
FullStackedSplineArea, Stock, CandleStick,
SideBySideRangeBar, RangeBar, SideBySideGantt,
Gantt, PolarPoint, PolarLine, PolarArea, RadarPoint,
RadarLine, RadarArea, Bar3D, StackedBar3D,
FullStackedBar3D, ManhattanBar,
SideBySideStackedBar3D,
SideBySideFullStackedBar3D, Pie3D, Doughnut3D,
Funnel3D, Line3D, StepLine3D, Area3D,
StackedArea3D, FullStackedArea3D, Spline3D,
SplineArea3D, StackedSplineArea3D,
FullStackedSplineArea3D

Pulse 4.12 User Guide 887

Chart > General
 Legend Visible – Select this checkbox option to display the legend
on the chart.

 Appearance – Select the appearance of the chart from the drop-

down list: Nature Colors (default), Chameleon, Dark, DarkFlat,
Gray, In A fog, Light, Northern Lights, Pastel Kit, Terracotta
Pie, The Trees

 Palette - Select the palette for the chart from the drop-down list:
Nature Colors (default), Apex, Aspect, Black and White,
Chameleon, Civic, Concourse, Equity, Flow, Foundry,
Grayscale, In A Fog, Median, Metro, Mixed, Module, Northern
Lights, Office, Opulent, Oriel, Origin, Paper, Pastel Kit,
Solstice, Technic, Terracotta Pie, The Trees, Trek, Urban,
Verve

Axis

Axis X

 Visible – Select this checkbox option to display the X Axis on the

chart

 Position – Select the position of the X Axis on the chart from the
drop-down list: Left, Right

 Reverse – Select this checkbox option to display the X Axis in

reverse

 Color – Select the color for the X Axis from the drop-down list

Axis Y Date-Time Scale Options

 Visible – Select this checkbox option to display the Y Axis on the

chart

 Position – Select the position of the Y Axis on the chart from the
drop-down list: Top, Bottom

 Reverse –Select this checkbox option to display the Y Axis in

reverse

 Format - Select the format of the Y Axis Date Time Scale from the
drop-down list: General (default), LongDate, LongTime,
MonthAndDay, MonthAndYear, QuarterAndYear, ShortDate,
ShortTime

Pulse 4.12 User Guide 888

 Measure unit - Select the measuring unit of the Y Axis Date Time
Scale from the drop-down list: Day, Hour, Millisecond, Minute
(default), Month, Quarter, Second, Week, Year, Week, Year

 Color – Select the color for the Y Axis from the drop-down list

 Grid alignment - Select the grid alignment option from the drop-
down list: Day, Hour, Millisecond, Minute (default), Month,
Quarter, Second, Week, Year, Week, Year

Chart > Series

 Series – A list that displays all the names of the series that were
created and that will appear in the chart.

 Add – Click this button to create a new series

 Remove - Click this button to delete the selected series

Pulse 4.12 User Guide 889

Chart > Series > General

 Series name – The name of the series that is currently selected in

the Series list. Each series displays the value on each Point or Bar
in the chart.

 Color - Select a color to represent the series from the drop-down

list

 Selected Action – An action defined via the Action Selector for

the extracted bar data. The action can be activated by clicking on
the bar data, or by defining the action via a workflow or a
command.

Example:

alert ?GetProperty('(this).PulseChart2.FieldValue1')?;alert
?GetProperty('(this).PulseChart2.FieldValue2')?

Chart > Series > Binding

 Item – A Datasheet item which is the data source of the series

Pulse 4.12 User Guide 890

Argument Properties

The Argument Properties parameters are the properties that define the
Y axis in the chart.

 Argument Scale Type – Select DateTime or Numerical from the

drop-down list as the argument scale type. The data source
columns will bind with the selected argument.

 Argument – The argument that the data source will bind with

Value Properties

The Value Properties parameters are the properties that define the X
axis in the chart.

 Value Scale Type – Select DateTime or Numerical from the

drop-down list as the value scale type. The data source columns will
bind with the selected value scale.

 Value 1 – The value the scale starts

 Value 2 - The value the scale ends

Data Filter - Selecting one or more Column Names and the appropriate
condition and value to filter a data source series.

 Column Name – Select a column name to filter

 Condition – Select a filter condition

 DataType – Select a data type condition

 Value – Enter the value to for the column name

 Refresh – Click this button to refresh the details in the Binding

tab.

 And / Or – Select one to use for the data filter

Pulse 4.12 User Guide 891

Chart > Series > Point Labels

You can customize the type of label to use in the chart, its position, value
format, and any information to display in the tooltip about the label via
the Point Labels tab. The labels in the chart display represents the value
of the series on each Point or Bar on the chart.

 Visible – Click to select this checkbox option to make the point

label visible on the chart instrument.

 Kind – Select the kind of point tooltip label to display on the chart
from the drop-down list: MaxValueLabel, MinValueLabel,
OneLabel (default), and TwoLabels.

 Position – Select the position of the tooltip label on the chart

instrument from the drop-down list: Outside (default), Inside,
Center.

Pulse 4.12 User Guide 892

 Value Format - Select the value format of the point label on the
chart instrument from the drop-down list: General (default),
LongDate, LongTime, MonthAndDay, MonthAndYear,
QuarterAndYear, ShortDate, and ShortTime.

Tooltip - Define the tooltip of the point label

 Field Name – Select an available field name from drop-down list

 Insert – Click this button to insert the field name, or type as free
text any instruction(s), information or any relevant data about the
series.

Pulse 4.12 User Guide 893

Toolbar Buttons
The Toolbar Buttons tab allows the user to customize the Pulse Chart
Instrument’s toolbar, in which to display available commands together
with the chart.

 Show Chart Toolbar – Select/deselect this checkbox option to

display/hide the chart’s toolbar.

 Show Status Bar – Select/deselect this checkbox option to

display/hide the chart’s status bar below the graph.

 Use Whole Row – Select/deselect this checkbox option to use the

whole row

 Visible – Select a command’s checkbox option to display the

chart’s command in the toolbar above the graph.

 Caption - The caption of the icon; the caption can be renamed by

the user.

 Icon – The icon to display on the chart’s toolbar.

Pulse 4.12 User Guide 894

 Security Lock - Set the security level of the command/icon here.

 Toolbar Display Style – Choose how the toolbar commands are

displayed on the chart: select Text and Image, Text, or Image
from the drop-down list.

 Toolbar Alignment - Choose the location of the toolbar in relation

to the chart. Select Top (default), Right, Bottom, or Left.

 Toolbar Icon Size - Choose the size of the toolbar icons from the
drop-down list: Small (default), Large.

Pulse 4.12 User Guide 895

Security
The user can assign the user authorization levels of the Pulse Chart
Instrument in the Security tab. The valid Security value range is 0-99, in
accordance with the security levels defined on the Pulse system.

 Visibility Security Lock - The chart is visible only to users whose

authorization level equals or is higher than the level specified here.

 Usability Security Lock - The chart may only be used by users

whose authorization level equals or is higher than the level specified
here.

Pulse 4.12 User Guide 896

Inserting ClipArt
The Pulse Developer Workstation allows adding external clipart to a
display. Those clipart objects will be converted to normal graphics objects
and embedded in the display.

Pulse allows you to add external ClipArt images to displays. The ClipArt
images represent various equipment objects which are difficult to draw,
yet allow you to define properties and assign appropriate actions and
events. You can use the ClipArt objects to create dynamic operator
interfaces or static elements.

Like graphic objects, you can edit, cut/copy/paste, rotate, resize, group,
duplicate, and align ClipArt images, as well as other graphic actions.

Pulse offers the following ClipArt categories for insertion to the display:

 Blowers

 Motors

 Boilers

 PC Icons

 Buttons

 Pipes

 Controllers

 Pumps

 Conveyors

 Sensors

 Generators

 Tanks 1

 Heat Exchangers

 Tanks 2

 Mixers

 Valves

Pulse 4.12 User Guide 897

The provided ClipArt files are non-animated objects created as vector
graphics, are named after the respective category with DSF extensions,
and are located in the application’s Clipart folder. You can edit them with
Animation Editor or Windows Draw.

The name of the User ClipArt file is stored in the pcimuser.ini file, in the
[UpdateUserClipArt] section’s UserDRW parameter. Any customized
ClipArt settings of the predefined categories are also stored in the
pcimuser.ini file, in the [UpdateUserClipArt] section.

To insert a ClipArt object into the display

1 From the Developer Workstation’s Insert ribbon, click the

ClipArt icon.

The Pulse Clip Art dialog box is displayed.

2 In the Categories list, choose the category of the object.

3 Double-click the element or click the element once and then click
Insert.

4 Minimize or close the Pulse Clip Art dialog box.

Pulse 4.12 User Guide 898

To select a ClipArt object in the display

 Click the object.

The selected object is indicated by handles and rotation arrows.

To select a component within a ClipArt object in the display

1 Click the object.

The selected object is indicated by handles and rotation arrows.

2 Right-click the object and then click Grouping > Break Group.

3 Hold down <ALT> on the keyboard and select the component.

The selected component is indicated by handles and rotation

arrows.

Pulse 4.12 User Guide 899

.NET Framework DLLs and ActiveX Controls in
Displays
The Pulse Developer Workstation contains two libraries of unique graphic
objects that enhance and simplifies the development process of the
project.

ActiveX controls and .NET framework components are unique objects that
perform a task or display information and come with settings that control
its behavior, functionality, and appearance. You insert these controls and
components into a display, cell, or template in the same exact way as you
would insert graphic objects.

In addition to assigning these specific settings, ActiveX controls and .NET

framework components can be assigned with both advanced and dynamic
properties.

Furthermore, you can customize each library of components by adding

additional ActiveX controls or .NET components into the Pulse libraries.
You can add countless new controls and .NET components into Pulse by
simply browsing through the list of controls and components that are
installed on your computer, select them and immediately insert them into
a display, cell, or template, configure them and use them in runtime.

The Pulse workstation is installed by default with a library of ActiveX

controls and .NET components that were chosen due to their usability in
the development process.

NOTE The Pulse User Guide provides only general information about
using the ActiveX and .NET framework components. For more
information regarding third party controls and their properties,
refer to the specific controls’ Help files (accessible from the
control properties dialog boxes).

NOTE Industrial Gadget objects resize (stretch) properties are

limited.

Industrial Gadget objects may only be resized proportionally

without distortion. Dragging a side handle resizes both height
and width.

Pulse 4.12 User Guide 900

This section contains the following topics:

 Choosing a .NET Framework or ActiveX Control from the Toolbox

 Defining Advanced Properties for .NET Framework and ActiveX

Controls

 Defining Dynamic Properties For .NET Framework and ActiveX

Controls

Choosing a .NET Framework or ActiveX Control

from the Toolbox
Use the Toolbox Panel as a source for easily adding ActiveX Controls and
.NET Framework Controls to the active display in the Developer
Workstation. The Toolbox Panel contains the same ActiveX Controls, and
.NET Framework Controls as are available from the Insert ribbon.

Additionally, you can add and remove Active X and .NET Framework
Controls from the Toolbox Panel and the Insert ribbon. By adding the
item, you are making it available for use from both locations. Conversely,
by removing the item, it disappears from both locations (although remains
in the library and can be made available at other times).

Pulse does not limit the number of third-party controls and components
that you can add and insert into the project.

To add an object to the display

1 In the Toolbox, click the .NET Framework Controls or ActiveX

Controls object category’s “+” button to expand the category and
display its available objects.

Pulse 4.12 User Guide 901

2 Select the object, and then place the mouse pointer inside the
display area.

3 Drag the pointer to another location to draw the object.

4 Adjust the object’s dimensions until you’re satisfied with the result.

Pulse 4.12 User Guide 902

To add or delete an object from the Toolbox Panel and the Insert
Ribbon

1 In the Toolbox, click the .NET Framework Controls or ActiveX

Controls object category’s “+” button to expand the category and
display its available objects.

2 Right-click inside the .NET Framework Controls or ActiveX Controls

and click Choose Items.

The Choose Toolbox Items dialog box is displayed.

The .NET Framework Controls tab contains the library of .NET

Framework Controls. The COM Controls tab contains the library of
ActiveX Controls.

3 In the relevant tab, select a control’s checkbox to add it to the

panel or deselect a control’s checkbox to remove it from the panel.

You can also add a customized Control to the panel. Browse and
select the DLL or OCX file that you want to add, and then select its
checkbox.

4 Click OK.

The control types you added or deleted will either appear or

disappear, respectively, from the Toolbox Panel.

Pulse 4.12 User Guide 903

To define .NET Framework Control Gadget properties

1 Right-click a .NET Framework control and choose Gadget

Properties.

The Properties dialog box for the associated .NET Framework

Control category is displayed.

NOTE Each .NET Framework control category has its own unique set
of properties. Their properties may vary from the ones visible
in the illustration below (the example represents the properties
for a .NET meter).

2 Either use the default control for the selected category or select
another of the available control types in the dialog box.

3 To modify other properties so that the ActiveX control more

accurately simulates the appearance of its counterpart in your
factory, open the Options tag and set the parameters accordingly.
The Preview area allows you to see how your settings will appear.

Pulse 4.12 User Guide 904

4 When you are satisfied with the appearance of the object, click OK
to implement the change and close the dialog box.

Pulse 4.12 User Guide 905

Defining Advanced Properties for .NET
Framework and ActiveX Controls
If you added .NET Framework or ActiveX controls to your display(s), you
can also define and modify its Advanced properties. Opening Advanced
Properties gives you access to a comprehensive table of parameters for
the selected control. You can edit all writable parameters by clicking in the
cell containing the value you want to change; you then type, select from a
list, or browse to select the new value.

The Advanced Properties pane is context-sensitive to the selected

control type. Some of the parameters are only applicable to the specific
type, such as NeedleColor for a Meter, or DecimalPlaces for a LED
Display object. Many of the parameters can also be found and defined in
the control’s Properties dialog box.

The following options for displaying the Advanced Properties pane are
available:

NOTE An ActiveX control may be resized along X and Y planes if it

supports the Stretch property. Controls not supporting Stretch
cannot be resized along the X or Y axis.

Pulse 4.12 User Guide 906

To define Advanced Properties

 Right-click on the .NET Framework or ActiveX control and choose

Advanced Properties.

The Advanced Properties pane is displayed on the right side of the

display (you can move it to a different location and resize it).

Pulse 4.12 User Guide 907

Example - Setting |!d:1 to 1 Whenever User Presses
Button Control
Set a value of |!d:1 1 whenever a user clicks the .NET button. For this
example, we will use an Industrial Button control.

1 Add an Industrial Gadget .NET position switch to the display.

2 Right-click on the switch and select Gadget Properties from the

pop-up menu or double-click the switch.

The Industrial Gadgets .NET PropertyPage window is displayed.

3 Select the Industrial Button and click OK.

4 In the display, right-click the button and then click Advanced

Properties.

5 In the Advanced Properties pane, click the Events button to

display the Events properties.

Pulse 4.12 User Guide 908

6 In the Click property entry, type set |!d:1 1.

NOTE You can also assemble an address by clicking to open the

Action Selector dialog box.

Pulse 4.12 User Guide 909

Defining Dynamic Properties For .NET
Framework and ActiveX Controls
.NET Framework or ActiveX controls can be dynamic, meaning that their
values can change during runtime, according to their advised item
definitions. In the Dynamic Properties pages, you can control the behavior
of the object by changing one or a few individual properties while leaving
the other default properties as they are.

NOTE The Pulse User Guide provides only general information about
using the ActiveX and .NET framework components. For more
information regarding third party controls and their properties,
refer to the specific controls’ Help files (accessible from the
control properties dialog boxes).

To define dynamic properties

1 Right-click a .NET Framework or ActiveX control and choose

Dynamic Properties.

The Dynamic Properties dialog box is displayed.

NOTE Each .NET Framework or ActiveX control has its own unique set
of Dynamic Properties. Their properties may vary from the
ones visible in the illustration below (the example represents
the properties for a .NET monthly calendar).

Pulse 4.12 User Guide 910

 In the Dynamic Properties dialog box, the left column contains the
property name and the right column contains text boxes in which
you can either type the appropriate value or assemble it using the
Item Manager.

2 Define the security levels as follows:

Usability lock The control may be used only by users whose

security level equals or is higher than the level
specified here.

Visibility lock The control is visible only to users whose

security level equals or is higher than the level
specified here.

3 Click OK to implement the property change(s) and close the

Dynamic Properties dialog box.

Pulse 4.12 User Guide 911

Example - Changing the State when the User Turns
the Switch Control On or Off
Add a .NET position switch that reflects the current |!d:1 value and
changes that value whenever a user “turns the switch” to OFF or ON. For
this example, a position switch control is used.

1 Add an Industrial Gadget .NET 2-Position Selector switch to the

display.

2 Right-click on the switch and select Gadget Properties from the

pop-up menu or double-click on the switch.

The Industrial Gadgets .NET PropertyPage window is displayed.

Pulse 4.12 User Guide 912

3 In the display, right-click the button and then click Dynamic
Properties.

The Dynamic Properties window is displayed.

4 In the Advanced Properties pane, click the Events button to

display the Events properties.

5 Scroll down and select the SwitchOn property. Type |!d:1 1 and
then click OK.

The OnChange event displays any change in the control’s state

(OFF or ON). In the following steps, set |!d:1 1 to equal this
change in state. This requires building an expression that applies
the GetProperty function.

6 Right-click the control and choose Advanced Properties.

The Advanced Properties pane is displayed on the right side of the

display (you can move it to a different location and resize it).

7 In the Advanced Properties pane, click the Events button to

open the Events properties.

8 Scroll down to the OnChange property. Click to open the

Action Selector dialog box.

Pulse 4.12 User Guide 913

9 In the Action Selector, select Action Command and type set
|!d:1 and then click to open the Item Manager.

10 In the Item Manager, click Expression Mode to enable

expression assembly.

In the Item Manager, you need to assemble one of the following

expressions:

?Cint(GetProperty('DisplayName.NetPosSwitchCtrll.SwitchOn'))?

-or-

?Cint(GetProperty('(this).NetPosSwitchCtrll.SwitchOn'))?

11 Browse to find and select the GetProperty function and click .

Pulse 4.12 User Guide 914

12 In the Select Control Property dialog box, select the current
display, the NetButtonCtrl1 control, and the SwitchOn property.

13 Click OK.

NOTE Select the Use “this” format checkbox option to replace the
display and/or resource name (if applicable) with a “(this)”
string. The “(this)” string allows you to maintain links to the
property even if you change the display name at a future
name, or if you use a resource in another display.

14 In the Item Manager, click Apply.

The expression function appears in the Item Manager’s edit box.

15 Select the entire expression and click the ? ? button in the toolbar.

A ? appears on both sides of the expression.

Pulse 4.12 User Guide 915

16 To make sure that the returned property value is numeric, enclose
the expression inside a CInt() function as follows:

?Cint(GetProperty('DisplayName.NetPosSwitchCtrll.SwitchOn'))?

17 To apply the expression in the Action Selector, click the

check mark button.

The following item should appear in the Action Command box:

set |!d:1 ?Cint(GetProperty('DisplayName.NetPosSwitchCtrll.SwitchOn'))?

18 Click OK in the Action Selector window.

19 Save the display and test the control’s behavior in the Operator
Workstation.

Pulse 4.12 User Guide 916

Defining Blocks in the Database
Explorer
A data block is a database element used for processing data. It has the
following functionalities:

 Provides an operator interface

 Generates alarms

 Collects history

 Exchanges data with external devices and internal variables

 Exchanges data between blocks

 Converts raw data

Database Explorer Structure

The Database Explorer provides an environment for defining, viewing, and
organizing data blocks.

The Database Explorer’s left panel contains hierarchic trees that allow you
to organize the blocks in several different, yet parallel, structures. The
trees contain branches, which represent zones in the monitored places;
branches may also contain sub-branches. The branches and sub-branches
contain blocks.

In the Tree View, you create and modify the blocks, their properties, their
various alarm conditions, and resulting actions. By default, up to 32,750
data blocks can be defined for each type of data block. The data block
types are:

Analog Value This block is used for analog variables. Analog

values are constantly scanned. Alarms can be
generated and history collected.

Analog Pointer This block is used for analog variables, mainly

for data conversion. An analog pointer type of
block is scanned upon request.

Digital Value This block is used for digital variables. Digital

values are constantly scanned. Alarms can be
generated.

Digital Pointer This block is used for digital variables and is

scanned only upon request.

Pulse 4.12 User Guide 917

Calculation This block can perform calculations on analog
and digital block values. These blocks are
constantly scanned. Alarms can be generated
and history collected.

Boolean This block is used for Boolean algebraic

calculations, which are constantly scanned.
Alarms can be generated.

Alarm This block enables definition of up to 80 digital

alarms. Each alarm block reads 5 registers of 16
bits, each from up to five different Plus, and
relates to each bit as a separate alarm. A
different alarm status can be defined for each
different bit. Alarm status can be: On, Off,
Change Of State.

Each Alarm block reads 5 addresses (registers)

of 16 bits each (up to eighty digital alarms),
from up to five different PLCs, and relates to
each bit as a separate alarm. For each bit, a
different alarm status can be defined: ON, OFF,
or COS.

String Pointer This block receives up to twenty 16 bit word

values from registers in a PLC or other devices
and converts them into a text string of up to 40
characters.

SER The SER block contains fields for the PLC

registers for the alarm data (time, value and
event ID)

Alarm Bit Each alarm bit can hold a unique digital alarm
associated with its register’s data source. For
each bit.

Alarm Bit windows can be accessed directly via

the Block Directory or via the associated Alarm
block.

Master Blocks A Master Block is a template of a block inherited

from the existing block types, which define a
number of free block arguments. The user can
create an instance of a block and update only
the free arguments from a master block
created. Any other block fields which are not
defined as free arguments will hold the values
as saved in the Master Block.

Pulse 4.12 User Guide 918

In addition to the main Tree View, the Database Explorer provides trees
called (by default) Functional, Location, Category, and Priority. These
trees are populated in accordance with the Tree Settings defined in each
block’s properties (except for the Priority tree, which is populated in
accordance with the blocks’ Priority settings). These trees have branches
which reflect the way you wish to organize and categorize the blocks.
Branches can also have multiple nested sub branches, providing additional
organizing flexibility.

NOTE You cannot create new blocks inside the Functional,

Location, Category, and Priority trees.

Tree View This tree lists all the blocks according to block
type. From this tree, you create the blocks and
modify their properties.

Functional This tree is associated with factors such as

surveillance, division, plant, line, and so on.

Location This tree is associated with the physical location

of the managed area (campus, building,
production floor, and so on).

Category This tree includes branches that display the

blocks according to user-defined categories,
with icons to visually help users to place and
find blocks in appropriate locations (within the
database hierarchy)

Priority This tree lists the blocks in accordance with

their defined priority.

Pulse 4.12 User Guide 919

This section contains the following topics:

 Block
 Branch
 Category
 Analog Value Blocks
 Analog Pointer Blocks
 Digital Value Blocks
 Digital Pointer Blocks
 Calculation Blocks
 Boolean Blocks
 Alarm Blocks
 StringPointer Blocks
 Block Explorer
 Adding Multiple Database Blocks
 Viewing Database Properties

Pulse 4.12 User Guide 920

Block
Creating a Block
To create a new block

1 In the Database Explorer’s File ribbon, click New and then choose
the Block Type from the pop-up menu.

-or-

In the Tree view, right-click anywhere in the branch of the Block

Type you want to create and click New Block.

A Create New dialog box is displayed in the workstation’s window

(the example below shows a new Analog Value block dialog box).

2 In the Block Name box, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

It is recommended to specify meaningful block names (for

example: PUMP3, DEPTK17).

3 Define the rest of the block parameters according to the block type
and your specifications. For detailed information about defining
each block type’s parameters, refer to the respective block type
sections.

Pulse 4.12 User Guide 921

4 Click Save.

5 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

To edit an existing block

1 In the Tree View, double-click the name of the block you want to
modify.

The Edit dialog box is displayed.

2 Edit any of the parameters or the block name as required.

3 Click Save (or Save As to create a new block with these

parameters).

4 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

Pulse 4.12 User Guide 922

Selecting Multiple Blocks in the Database
Explorer
You can select multiple blocks in the Database Explorer table or the
Database Explorer tree to delete multiple blocks at once.

To display the Block Types window, double-click Block Types on the

tree or right-click on it and select the Explore or Explore in New
Window option from the drop-down menu.

Pulse 4.12 User Guide 923

Branch
Creating a Branch
In the Functional and Locational trees, you can create new branches for
organizing the blocks. In the Functional tree, the branches can reflect
organizational needs like assembly lines, packaging, cooling systems, and
so on. In the Location tree, the branches can reflect production floors,
shipping platforms, offices, stairwells, and other places.

To create a new branch

1 Right-click on Functional or Location in their respective trees,

point to New, and click Branch (to create a sub-branch, right-click
the mother branch and click New > Branch).

The Edit dialog box is displayed.

NOTE It is possible to add a branch from the Functional or

Location tree on the Tree Settings sub tab under the
Alarms tab on the Create New or Edit dialog box. On the
Functional or Location tree, right-click then click New >
Branch from the drop-down menu to display the Branch
Properties window in order to add a branch.

Pulse 4.12 User Guide 924

2 Define the branch parameters as follows:

Name Type a descriptive name for the branch

which describes a function or location.

Security Locks

Show The branch is visible in the Database

Explorer only to users whose security level
equals or is higher than the level specified
here.

Acknowledge Any alarms residing in this branch may be

acknowledged only by users whose security
level equals or is higher than the level
specified here.

Erase The branch may be deleted only by users

whose security level equals or is higher
than the level specified here.

Suspend The branch’s alarms may be suspended

only by users whose security level equals
or is higher than the level specified here.

Pulse 4.12 User Guide 925

 Enable Print Select this checkbox option to send alarm
messages to a printer whenever an alarm
condition residing in this branch is
triggered.

 If this option is selected, the Alarm

Publisher sends messages even from
an individual block whose own Print
option is disabled.

 Likewise, if this option is not

selected, the Alarm Publisher will still
send messages from an individual
block whose own Print option is
enabled.

Apply to sub- The Apply to sub-branches checkbox

branches option enables the user to save all the
properties of sub-branches for a defined
branch.

3 Click Save.

4 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

To edit an existing branch

1 In the Tree View, right-click the name of the branch you want to
modify and click Edit.

The Branch Properties dialog box is displayed, or

In the Tree Settings tab’s Functional or Location tree, right-click

a branch and click Edit to modify the settings of the specific
branch.

2 Edit any of the parameters or the branch name according to your

needs.

3 Click Save (or Save As to create a new branch with these

parameters).

4 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

Pulse 4.12 User Guide 926

Category
Creating a Category
The Category tree includes branches that display the blocks according to
user-defined categories, with icons to visually help users to place and find
blocks in appropriate locations (within the database hierarchy).

To create a new category

1 At the top of the Category tree, right-click then select New >
Category from the drop-down menu.

The Category dialog box is displayed.

Pulse 4.12 User Guide 927

2 Define the category parameters as follows:

Name Type a descriptive name for the category

which describes a common factor of its
included blocks.

Icon Select an icon that will visually indicate the

category’s subject.

3 Click Save.

4 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

To edit an existing category

1 In the Tree view, right-click the name of the category you want to
modify and click Edit.

The Category dialog box is displayed.

-or-

In the Tree Settings tab’s Category tree, right-click a category

and click Edit to modify the settings of that specific category.

2 Change the category name or the icon according to your needs.

3 Click Save (or Save As to create a new category with these

parameters).

4 After working in the Database Explorer, go to the File ribbon and

click Activate in order to apply the changes in the project
database.

Pulse 4.12 User Guide 928

Analog Value Blocks
Analog Value blocks receive analog values from registers in PLCs and
other peripheral devices. They can convert that value from raw units to
engineering units, according to user- specified range, conversion, and
smoothing parameters. Conversely, they can receive an operator entered
or internal value, clamp it within an allowed range, convert it to raw units,
and send it to a device.

Analog Value Blocks support the following:

 Data input from devices

 Operator input

 Data output to devices

 Alarm monitoring

 Data conversion to engineering units

 Inversion of data values

 Filtering of data by running-average method (smoothing)

 Data output to a target block

 Dynamic control of alarm parameters of another block (interlock)

 Dynamic control of trend parameters of another block

 Dynamic storage of Short-Term Trends

 Permanent storage of Historical Trends

Pulse 4.12 User Guide 929

Applications
Analog value blocks can be used for:

 Displaying values to the operator

 Writing of values to reports

 Specification and handling of various alarm situations: High, Low,

and Rate of Change

 Password protected write-back of data entered from the Operator

Workstation

 Trend recording

 Recipe operations

 Source of data for Calculation and Boolean blocks

Input
The Analog Value block can receive data from devices and analog internal
variables to an input accumulator, from the operator, and from other
blocks through the Target block mechanism.

Alarm Parameters (set points) and Trend parameters can be altered

according to data input from other blocks via the Target block mechanism.

Output
The Analog Value block can send data to devices, to internal variables and
operator, to blocks via the Target block mechanism, and to Short-Term
storage and Historical Trend files.

 Alarm Parameters to other blocks, in order to change their alarm

set points or modes via the Target block mechanism.

 Trend Parameters to other blocks, to set their trend parameters

via the Target block mechanism.

 Alarm Signals to the system, and to other blocks via the Interlock
mechanism.

Pulse 4.12 User Guide 930

Alternatives
Analog Value blocks use more memory than Analog Pointer blocks. Use
Analog Pointer blocks for applications that do not require alarm monitoring
or trend storage.

This section contains the following topics:

 Defining Analog Value Block Properties

 Analog Value Block - General Parameters

 Analog Value Block - Alarms - General Parameters

 Analog Value Block - Alarms - Tree Settings Parameters

 Analog Value Block - Alarms - Actions Parameters

Pulse 4.12 User Guide 931

Defining Analog Value Block Properties
Analog Value blocks process analog data. You will generally use Analog
Value blocks for converting raw data to engineering units, setting alarms,
clamping output, and recording trends.

To add an Analog Value block

1 In the Tree view, right-click anywhere in the AnalogValue branch

and then click New Block.

The Create New – Analog Value dialog box is displayed in the

workstation’s window.

2 Enter a unique name for the block in the Block Name field.

Block names may be up to 34 characters long. The first character

must be a letter (A to Z). The following characters may be letters
(A to Z), numbers (0-9), or hyphens (-). Lower case letters are
automatically converted to upper case.

It is recommended to specify meaningful block names (for

example: PUMP3, DEPTK17).

3 In the block’s General tab, define the block parameters.

4 In the block’s Alarms tab, create and define the alarms associated
with this block.

5 Click the + button to add an alarm condition to the list.

6 Define the Alarm’s general parameters in the General tab.

7 Define the Alarm’s Tree Settings parameters.

8 Define the Alarm’s Actions parameters (not applicable to Events).

9 Select Enable Alarms checkbox option in the Alarms tab to allow

Pulse to trigger alarms and generate the listing of alarm data.

10 Click Save to save the block in the project database.

Pulse 4.12 User Guide 932

Analog Value Block - General Parameters
In the Analog Value Block’s General tab, define the block parameters:

General

Description Enter the description text of up to 255

characters and spaces. The block description is
displayed in an alarm message, along with
standard alarm information.

Node Node number of the station that handles this

alarm or event point. This parameter is
applicable only when a Pulse network is set up
and the network is enabled in the Network
Setup.

Pulse 4.12 User Guide 933

Address Enter the analog-type address of the item to
which the alarm refers.

The address could be:

 A driver address, and optionally, a

driver-specific conversion, or a Driver
Server conversion

 An internal (dummy) variable

 A System (Dollar) Variable (and its Dot

Fields), and optionally, a Database
Server conversion (LIN or SQRT)

 Driver Server Dollar Variables and Dot

Fields

 A DDE address of an item of a 3rd party

DDE server

Security Security level (0-99) for users authorized to

receive and view the alarm.

Scan Time (Sec) The interval between successive processing of

the block, in the range of 1-255 seconds.

The default is 1 second.

Phase Time (Sec) The initial time delay from the loading of the
database to the first processing of the block, in
the range 1-255 seconds.

The default time unit is one second.

Use PLC Time Stamp Select to read the date and time of the alarm
from the PLC

Maintenance Select to enable the use of maintenance

counters (.AccumTime, .AccumStart) to record
time elapsed since the block’s value changed.

Scales and Conversion

Low Scale The absolute minimum value of the block, in

engineering units (-99999.99 to +99999.98).

High Scale The absolute maximum value of the block, in

engineering units (-99999.99 to +99999.98).

Pulse 4.12 User Guide 934

Smoothing Smoothing filters incoming readings,
calculating the block’s value from the average
of the specified number of readings.

Enter the number of readings to calculate (0

and 1 mean no smoothing).

Conversion The conversion algorithm for transforming raw

data to engineering units.

NOTE Conversions are specific to each

communication driver - consult the
driver guide.

Units The engineering unit displayed in alarm

messages and historical graphs associated with
the block.

History

Factor The number of readings (0-255) to be

averaged for each point recorded in the
historical trend file:

 If the averaging is not required, enter 0.

 If the averaging is required permanently,

enter between 1 and 254.

 If averaging is not initially required, but

need to be operational during runtime
using the Target block mechanism, enter
255.

Step Enter the minimum change in value required to

record a factored point in the historical trend.
Choose from valid Historical Trend Steps (0%
to 1.0% in 0.1% steps, and 1.0% to 100% in
0.5% steps).

The Historical Trend Step is specified as a

percentage of the Output Clamp range (High
limit to Low limit, regardless of whether or not
the Clamp is enabled.

Pulse 4.12 User Guide 935

Target

Target Block Target blocks are database blocks, which

receive data values from other initiating blocks.

The destination within the target block (and the

effect) of the data values sent from the
initiating block are specified in the initiating
block’s Targetlogic.

Target Logic Select an alarm component, which value is

written to the target block whenever the alarm
is initiated:

 Input – Sets the value of the target

block to the value of the initiating block
(the input option was included to support
old versions of P-CIM).

 Output - Sets the output value of the

target block to the value of the initiating
block. As a result, the value is written to
a PLC or other external field device.

 Alarm Enable – Sets the Alarm Enable

mechanism of the target block to ON
when the value of the initiating block is
non zero; and sets the Alarm Enable
mechanism of the target block OFF,
when the value of the initiating block is
zero.

 Alarm High – Sets the Alarm High set

point of the target block to the value of
the initiating block.

 Alarm Low - Sets the Alarm Low set

point of the target block to the value of
the initiating block.

 Alarm RoC (Rate of Change) – Sets

the Alarm Rate of Change set point of
the target block to the value of the
initiating block.

 Step Trend Factor (S. T.) – Sets the

S. T. factor of the target block to the
value of the initiating block.

 History Trend Factor (H. T.) – Sets

the H. T. factor of the target block to the
value of the initiating block.

Pulse 4.12 User Guide 936

Output

Low Limit The absolute minimum value of the block’s

clamped output, in engineering units
(-99999.99 to +99999.98)

High Scale The absolute maximum value of the block’s

clamped output, in engineering units
(-99999.99 to +99999.98)

Clamp Select this option to limit the output of a

database block or the input of a control to a
specified high/low value range.

Invert Select this option to enable inverting of values

input from the device and values output to the
device. Inversion reverses the High and Low
limits of the scale (30% empty becomes 70%
full).

Pulse 4.12 User Guide 937

Analog Value Block - Alarms - General Parameters
In the Analog Value block Alarms’ General tab, define the alarm’s type,
and trigger conditions.

Name Type a name for the alarm.

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an alarm

message, along with standard alarm
information.

Priority The level of precedence or importance of this

alarm, between 0 and 99, where 0 is
considered the highest priority.

Event Select this option to make this condition an

event message.

An event message provides information and

cannot be acknowledged nor trigger an action.

Pulse 4.12 User Guide 938

Condition

Alarm Type Choose an alarm state:

HIGH, LOW, ROC (Rate of Change), HIHI,

LOLO, RANGE, or EQUAL

Value The value that triggers this alarm condition

Dead Band The amount that the value has to increase (if
alarm is LOW or LOLO) or to decrease (if alarm
is HIGH or HIHI) in order to restore the normal
state and turn off the alarm condition.

NOTE Not available for ROC alarms

Alarm Wait The amount of time before Pulse generates the

alarm.

The user can define the Alarm Wait field

accurately with its 00:00:00 time format.

Pulse 4.12 User Guide 939

Analog Value Block - Alarms - Tree Settings
Parameters
The tree is a structure for organizing the alarm and event blocks. It allows
operators to see alarms in various contexts, such as functional, location,
and category.

Functional Choose the alarm’s or event’s placement in the

Functional alarm tree (associated with factors
such as division, plant, line, and so on).

Location Choose the alarm’s or event’s placement in the

Location alarm tree (associated with the
physical location of the managed area
(campus, building, production floor, and so on).

Category Choose the alarm’s or event’s placement

according to a category attribute. The category
ranges between 0 and 999.

Pulse 4.12 User Guide 940

Analog Value Block - Alarms - Actions Parameters
In the Analog Value block Alarms’ Actions tab, define the
actions/events that will be triggered/initiated when this alarm occurs.

Show Select this checkbox option to display the

alarm notification in the Alarm Summary.

Print Select this checkbox option to send the alarm

message to a printer.

Log Select this checkbox option to display this

alarm’s instances in the Logger Window.

Sound Select this checkbox option to produce a sound

when the alarm is triggered.

On Alarm

Alarm Command on Click to display the Action Selector

Double-Click window to define the alarm command or
workflow when the mouse is double-clicked on
alarm.

Pulse 4.12 User Guide 941

On Active

Always Click to display the Action Selector

window to define the alarm command when the
alarm for the block is active.

To define the object’s data item, enter an

action command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command
or workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Interlogic Determines the way the Interlock signal

(value = 1) is sent:

 New sends the Interlock signal when a

new alarm is detected, for the first scan
only.

 Any sends the Interlock signal for each

scan in which the alarm condition
persists.

Interlock Choose the target block which receives the

value of 1 (ON) when this block triggers an
alarm.

Interlock operates according to the mode

specified under Interlogic (see above).

Pulse 4.12 User Guide 942

Open Display Choose a display to open when the alarm is
triggered or the event occurs.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm is
active, via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

On Acknowledge

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block is
acknowledged.

To send an email notification when the alarm is

acknowledged using the Email activity,
see Email.

On Return to Normal

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block returns
to normal.

To send an email when the alarm returns to

normal notification using the Email activity,
see Email.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm
returns to normal via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

Report Status Select this option to generate a report when

the alarm condition returns to the normal
state.

Pulse 4.12 User Guide 943

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Value Master Block.

An Analog Value Master Block is an Analog

Value block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update
only the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 944

Analog Value Block - Alarms – Event Management
Parameters
In the Analog Value block Alarms’ Event Management tab, define the
Event Management events that will be triggered when this alarm occurs.

NOTE The Event Management tab is only available when the Event
Management Authorizations checkbox option is checked in
the User Manager.

Enabled Check to enable the alarm to trigger a

managed event.

Class Select the available Event Class - from those

already configured in the Event Center
Administration (Event Classes) that is
triggered by the alarm, i.e., the event
management procedure to be carried out by
the Event Center operator

On Start

Show Video Check this option to show the video from the
camera associated with the event shown on
the workstation when the alarm occurs.

On Station ID(s) The ID number of the Pulse stations on which

video is played in conjunction with a managed
event - separated by a comma.

Pulse 4.12 User Guide 945

On Close

Actions\Workflows Set the actions or workflow to be carried out

when the event is closed.

Close Event Condition Set the condition to be fulfilled in order to

close the event.

Assign Cameras

Select the camera associated with the event and its associated features

Description The camera’s description

Playback The video playback

View No. The playback’s view number

Live The live video

View No. The live video’s number

Preset The video preset

Pulse 4.12 User Guide 946

Analog Pointer Blocks
Analog Pointer blocks receive analog values from registers in PLCs or
other peripheral devices. They can convert values from raw units to
engineering units, according to user- specified ranges and conversions.
Conversely, they can receive an operator entered or internal value, clamp
it within a specified range, convert it to raw units, and send it to a device.

Analog Pointer Blocks support:

 Data input from devices and internal variables

 Operator input to devices

 Conversion of data values to engineering units

 Inversion of data values

Applications
Analog Pointer blocks can be used for most analog data handling:

 Data conversion

 Display of values

 Writing to devices

 Presentation of real time trends

 Password protected write-back of data entered from the Operator

Workstation

 Source of values for Calculation and Boolean blocks

Input
The Analog Pointer block can receive data from devices and analog
internal variables to an input accumulator, from the operator, and from
other blocks through the Target block mechanism.

Output
The Analog Pointer block can send data to devices, internal variables,
calculation blocks, and the operator.

Pulse 4.12 User Guide 947

Defining Analog Pointer Block Properties
Analog Pointer blocks process analog data. You will generally use Analog
Pointer blocks to convert raw data for display in the Operator Workstation,
or as a source of data for Calculation blocks, when no other processing is
required (such as smoothing, alarms, clamping, historical trends, which all
require Analog Value blocks).

When in use, Analog Pointer blocks are scanned at intervals of one time
unit. The default time unit is one second.

To add an Analog Pointer block

1 In the Tree view, right-click anywhere in the AnalogPointer

branch and then click New Block.

The Create New – Analog Pointer dialog box is displayed in the

workstation’s window.

Pulse 4.12 User Guide 948

2 Enter a unique name for the block in the Block Name field.

Block names may be up to 34 characters long. The first character

must be a letter (A to Z). The following characters may be letters
(A to Z), numbers (0-9), or hyphens (-). Lower case letters are
automatically converted to upper case.

It is recommended to specify meaningful block names (for

example: PUMP3, DEPTK17).

3 Define the block parameters.

4 Click Save to save the block in the project database.

Analog Pointer Block Parameters

Define the Analog Pointer block parameters:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message.

Node Node number of the station that handles this

alarm or event point.

Address Enter an analog-type address of the item to

which the alarm refers.

The address could be:

 A driver address, and optionally, a driver-

specific conversion, or a Driver Server
conversion

 An internal (dummy) variable

 A System (Dollar) Variable (and its Dot

Fields), and optionally, a Database Server
conversion (LIN or SQRT)

 Driver Server Dollar Variables and Dot

Fields

 A DDE address of an item of a 3rd party

DDE server

Pulse 4.12 User Guide 949

Security Security level (0-99) for users authorized to
receive and view the alarm.

Scales and Conversion

Low Scale The absolute minimum value of the block, in

engineering units (-9999999 to +0.9999999)

High Scale The absolute maximum value of the block, in

engineering units (-9999999 to +0.9999999)

Conversion The conversion algorithm for transforming raw

data to engineering units.

NOTE Conversions are specific to each

communication driver - consult the
driver guide.

Output

Invert Select this option to enable inverting of values

input from the device and values output to the
device. Inversion reverses the High and Low
limits of the scale (30% empty becomes 70%
full).

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Pointer Master Block.

Pulse 4.12 User Guide 950

 An Analog Pointer Master Block is an Analog
Pointer block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update only
the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 951

Digital Value Blocks
Digital Value blocks receive a digital value from a coil, relay, or input, or a
bit in a register from a PLC or other peripheral device. They process
logical data whose values equal 0 (OFF) or 1 (ON).

Digital Value blocks support:

 Data input from devices

 Operator input

 Data output to devices

 Alarm monitoring

 Display of text messages corresponding to each state, such as ON

for 1 and OFF for 0.

 Inversion of data values

Applications
Use Digital Value blocks to process alarms from binary data sources, or if
you need to use the value in a calculation. Digital Value blocks can be
used for:

 Inversion of values (a value of 1 in the PLC is converted to 0 in

Pulse and vice versa)

 Display of values to the operator

 Writing of values to reports

 Specification and handling of various alarm situations: ON, OFF,

and Change of State

 Password protected write-back of data entered from the Operator

Workstation

 Output of data to a target block

 Dynamic control of alarm parameters of another block

 Source of data for Calculation and Boolean blocks

Pulse 4.12 User Guide 952

Input
The Digital Value block can receive data from devices and analog or digital
internal variables to an input accumulator, from the operator, and from
other blocks through the Target block mechanism.

 Alarm Parameters (set points) can be altered according to data

input from other blocks via the Target block mechanism.

 Alarm Signals can be sent as data via the Interlock mechanism.

Output
The Digital Value block can send data to devices, to internal variables and
operator, and to other blocks via the Target block mechanism.

 Alarm Parameters to other blocks, in order to change their alarm

set points or modes via the Target block mechanism.

 Alarm Signals to the system, and to other blocks via the Interlock
mechanism.

Alternatives
Digital Value blocks require comparatively large amounts of memory. If
you do not require monitoring of alarms, use Digital Pointer blocks
instead. If you need to monitor many alarms, use an Alarm block.

Defining Digital Value Block Properties

Digital Value blocks process digital data having values of 0 (OFF) and 1
(ON). These may be the state of a coil, relay, input, or a bit in a register
from a PLC or other peripheral device. Use Digital Value blocks to process
digital data that need alarms monitoring, display capabilities, and operator
input.

To add a Digital Value block

1 In the Tree view, right-click anywhere in the DigitalValue branch

and then click New Block.

The Create New – Digital Value dialog box is displayed in the

workstation’s window.

2 Enter a unique name for the block in the Block Name field.

Block names may be up to 34 characters long. The first character

must be a letter (A to Z). The following characters may be letters
(A to Z), numbers (0-9), or hyphens (-). Lower case letters are
automatically converted to upper case.

Pulse 4.12 User Guide 953

 It is recommended to specify meaningful block names (for
example: PUMP3, DEPTK17).

3 In the block’s General tab, define the block parameters.

4 Select this option to make this condition an event message. An

event message provides information and cannot be acknowledged
nor trigger an action.

5 Define the alarm’s General parameters.

6 Define the alarm’s Tree Settings parameters.

7 Define the alarm’s Actions parameters (not applicable to Events).

8 Select Enable Alarms checkbox option to allow Pulse to trigger

alarms and generate the listing of alarm data.

9 Click Save to save the block in the project database.

Digital Value Block - General Parameters

In the Digital Value block’s General tab, define the block parameters:

Pulse 4.12 User Guide 954

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node The node number of the station that handles

this alarm or event point

Address Enter the digital-type address of the item to

which the alarm refers.

The address could be:

 A driver address, and optionally, a

driver-specific conversion, or a Driver
Server conversion

 An internal (dummy) variable

 A System (Dollar) Variable (and its Dot

Fields), and optionally, a Database
Server conversion (LIN or SQRT)

 Driver Server Dollar Variables and Dot

Fields

 A DDE address of an item of a 3rd party

DDE server

Security Security level (0-99) for users authorized to

receive and view the alarm

Maintenance Select to enable the use of maintenance

counters (.AccumTime, .AccumStart) to record
time elapsed since the block’s value changed

Timings

Scan Time The interval between successive processing of

the block, in the range of 1-255 seconds. The
default is 1 second.

Phase Time The initial time delay from the loading of the
database to the first processing of the block, in
the range 1-255 seconds. The default time unit
is one second.

Pulse 4.12 User Guide 955

PLC Time Stamp Select to read the date and time of the alarm
from the PLC.

Text

Text for 0 Text of up to eight characters and spaces

describing the digital 0 state (for example:
OFF, SHUT, NO, etc.). This text will appear in
displays, data entry, and alarm messages.

Text for 1 Text of up to eight characters and spaces

describing the digital 1 state (for example: ON,
OPEN, YES, etc.). This text will appear in
displays, data entry, and alarm messages.

History

Enabled Select this option to record the alarm in the

history file.

Target

Target Block Target blocks are database blocks which

receive data values from other initiating blocks.

The destination within the target block (and the

effect) of the data values sent from the
initiating block are specified in the initiating
block’s Targetlogic.

Target Logic Select an alarm component, which value is

written to the target block whenever the alarm
is initiated:

 Input – Sets the value of the target

block to the value of the initiating block
(the input option was included to support
old versions of P-CIM).

 Output - Sets the output value of the

target block to the value of the initiating
block. As a result, the value is written to
a PLC or other external field device.

Pulse 4.12 User Guide 956

  Alarm Enable – Sets the Alarm Enable
mechanism of the target block to ON
when the value of the initiating block is
non zero; and sets the Alarm Enable
mechanism of the target block OFF,
when the value of the initiating block is
zero.

 Alarm High – Sets the Alarm High set

point of the target block to the value of
the initiating block.

 Alarm Low - Sets the Alarm Low set

point of the target block to the value of
the initiating block.

 Alarm RoC (Rate of Change) – Sets

the Alarm Rate of Change set point of
the target block to the value of the
initiating block.

 Step Trend Factor (S. T.) – Sets the

S. T. factor of the target block to the
value of the initiating block.

 History Trend Factor (H. T.) – Sets

the H. T. factor of the target block to the
value of the initiating block.

Output

Invert Select this option to enable inverting of the

device value (negative logic).

Pulse 4.12 User Guide 957

Digital Value Block - Alarms - General Parameters
In the Digital Value Block Alarms’ General tab, define the alarm’s type
and trigger conditions.

Name Type a name for the alarm.

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an alarm

message, along with standard alarm
information.

Priority The level of precedence or importance of this

alarm, between 0 and 99, where 0 is
considered the highest priority.

Event Select this option to make this condition an

event message.

Condition

Alarm Type Choose the state of the block value which

triggers this alarm: ON, OFF, COS (value
changes in either direction)

Pulse 4.12 User Guide 958

Alarm Wait The amount of time before Pulse generates the
alarm.

The user can define the Alarm Wait field

accurately with its 00:00:00 time format.

Digital Value Block - Alarms - Tree Settings

Parameters
The tree is a structure for organizing the alarm and event blocks. It allows
operators to see alarms in various contexts, such as functional, location,
and category.

Functional Choose the alarm’s or event’s placement in the

Functional alarm tree (associated with factors
such as division, plant, line, and so on)

Location Choose the alarm’s or event’s placement in the

Location alarm tree (associated with the
physical location of the managed area
(campus, building, production floor, and so on).

Category Choose the alarm’s or event’s placement

according to a category attribute. The category
ranges between 0 and 999.

Pulse 4.12 User Guide 959

Digital Value Block - Alarms - Actions Parameters
In the Digital Value Block Alarm Actions tab, define the actions/events
that will be triggered/initiated when this alarm occurs.

Show Select this checkbox option to display the

alarm notification in the Alarm Summary.

Print Select this checkbox option to send the alarm

message to a printer.

Log Select this checkbox option to display this

alarm’s instances in the Logger Window.

Sound Select this checkbox option to produce a sound

when the alarm is triggered.

On Alarm

Alarm Command on Click to display the Action Selector

Double-Click window to define the alarm command or
workflow when the mouse is double-clicked on
alarm.

Pulse 4.12 User Guide 960

On Active

Always Click to display the Action Selector

window to define the alarm command when the
alarm for the block is active.

To define the object’s data item, enter an

action command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command
or workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Interlogic Determines the way the Interlock signal

(value = 1) is sent:

 New sends the Interlock signal when a

new alarm is detected, for the first scan
only.

 Any sends the Interlock signal for each

scan in which the alarm condition
persists.

Interlock Choose the target block which receives the

value of 1 (ON) when this block triggers an
alarm.

Interlock operates according to the mode

specified under Interlogic (see above).

Pulse 4.12 User Guide 961

Open Display Choose a display to open when the alarm is
triggered or the event occurs.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm is
active, via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

On Acknowledge

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block is
acknowledged.

To send an email notification when the alarm is

acknowledged using the Email activity, see
Email.

On Return to Normal

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block returns
to normal.

To send an email when the alarm returns to

normal notification using the Email activity,
see Email.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm
returns to normal via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

Report Status Select this option to generate a report when

the alarm condition returns to the normal
state.

Pulse 4.12 User Guide 962

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Value Master Block.

An Analog Value Master Block is an Analog

Value block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update
only the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 963

Digital Value Block - Alarms – Event Management
Parameters
In the Digital Value block Alarms’ Event Management tab, define the
Event Management events that will be triggered when the alarm occurs.

NOTE The Event Management tab is only available when the Event
Management Authorizations checkbox option is checked in
the User Manager.

Enabled Check to enable the alarm to trigger a

managed event.

Class Select the available Event Class - from those

already configured in the Event Center
Administration (Event Classes) that is
triggered by the alarm, i.e., the event
management procedure to be carried out by
the Event Center operator.

On Start

Show Video Check this option to show the video from the
camera associated with the event shown on
the workstation when the alarm occurs.

On Station ID(s) The ID number of the Pulse stations on which

video is played in conjunction with a managed
event - separated by a comma.

Pulse 4.12 User Guide 964

On Close

Actions\Workflows Set the actions or workflow to be carried out

when the event is closed.

Close Event Condition Set the condition to be fulfilled in order to

close the event.

Assign Cameras

Select the camera associated with the event and its associated features

Description The camera’s description

Playback The video playback

View No. The playback’s view number

Live The live video

View No. The live video’s number

Preset The video preset

Pulse 4.12 User Guide 965

Digital Pointer Blocks
Digital Pointer blocks receive a digital value from a coil, relay, or input, or
a bit in a register from a PLC or other peripheral device. They process
logical data whose values equal 0 (OFF) or 1 (ON). They are processed
only when used somewhere in the system.

Digital Pointer blocks support:

 Digital value input from devices

 Inversion of data values

 Digital value output to devices

Applications
Digital Pointer blocks can be used for most digital data monitoring:

 Sending ON/OFF commands to the plant

 Inversion of values (a value of 1 in the PLC is converted to 0 in

Pulse and vice versa)

 Display of values to the operator

 Display of text messages corresponding to each state, such as ON

for 1 and OFF for 0

 Password protected write-back of data entered from the Operator

Workstation

 Output of data to a target block

 Dynamic control of alarm parameters of another block

 Source of data for Calculation and Boolean blocks

Input
The Digital Pointer block can receive data from devices and analog or
digital internal variables to an input accumulator, from the operator, and
from other blocks through the Target block mechanism.

Alarm Signals from other blocks can be sent as data via the Interlock
mechanism.

Pulse 4.12 User Guide 966

Output
The Digital Pointer block can send data to devices, internal variables, or
the operator (updates).

Defining Digital Pointer Block Properties

Digital Pointer blocks receive a digital value from a coil, relay, or input, or
a bit in a register from a PLC or other peripheral device. They process
logical data values which equal 0 (OFF) or 1 (ON). Digital Pointer blocks
do not process alarms.

To add a Digital Pointer block

1 In the Tree view, right-click anywhere in the DigitalPointer branch

and then click New Block.

The Create New – Digital Pointer dialog box is displayed in the

workstation’s window.

2 In the Block Name box, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

We recommend that you specify meaningful block names (for

example: PUMP3, DEPTK17).

Pulse 4.12 User Guide 967

3 Define the block parameters.

4 Click Save to save the block in the project database.

Digital Pointer Block Parameters

In the Digital Pointer Block parameters, define the alarm’s properties:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node Node number of the station that handles this

alarm or event point

Pulse 4.12 User Guide 968

Address Enter the digital-type address of the item to
which the alarm refers.

The address could be:

 A driver address, and optionally, a driver-

specific conversion, or a Driver Server
conversion.

 An internal (dummy) variable

 A System (Dollar) Variable (and its Dot

Fields), and optionally, a Database
Server conversion (LIN or SQRT)

 Driver Server Dollar Variables and Dot

Fields

 A DDE address of an item of a 3rd party

DDE server

Security Security level (0-99) for users authorized to

receive and view the alarm.

Text

Text for 0 Text of up to eight characters and spaces

describing the digital 0 state (for example: OFF,
SHUT, NO, etc.). This text will appear in
displays, data entry, and alarm messages.

Text for 1 Text of up to eight characters and spaces

describing the digital 1 state (for example: ON,
OPEN, YES, etc.). This text will appear in
displays, data entry, and alarm messages.

Output

Invert Select this option to enable inverting of the

device value (negative logic).

Pulse 4.12 User Guide 969

Save as Master Block Click this button to display the Master Block
Arguments window and to create a Digital
Pointer Master Block.

A Digital Pointer Master Block is a Digital

Pointer block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update only
the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 970

Calculation Blocks
Calculation blocks perform calculations using constants or Analog and
Digital block values. Up to eight variables or constants can be included in
each calculation. The results of the calculation can be used for:

 Handling various High and Low alarm situations

 Dynamic storage of Short-Term Trends

 Permanent storage of Historical Trends

Applications
Use Calculation blocks to calculate a formula referencing up to eight
digital or analog variables, or constants. All of the standard mathematical
operations are available.

Input
Data is input indirectly, by specifying other blocks as operands.

Alarm Parameters (set points) can be changed by other blocks through

the Target block mechanism.

Trend Parameters can be changed by other blocks through the Target

block mechanism.

Output
Data is sent to a target block, trend tables, or the Operator Workstation
through updates.

Alarm Parameters of another block can be changed via the Target block
mechanism.

Alarm Signals can be sent to the alarm system, through the Interlock
mechanism, to another block.

Pulse 4.12 User Guide 971

Handling "Divide by Zero" Condition
If you want the Database Server to return zero when the Calculation block
is divided by zero, change the setting “FormulaErrorIsZero” from 0 to 1.
When set to 0, the result of a zero division is the block’s current value.

To set the Calculation block to return zero if it is divided by zero

1 From the project’s Configuration folder, open the pcimuser.ini

file in an editor.

2 In the [PcimDBSR] section, find the FormulaErrorIsZero

parameter.

3 Change the parameter’s value to 1.

NOTE When this parameter’s value is set to 0, dividing a Calculation

block by 0 returns the block’s current value.

4 Save and close the pcimuser.ini file.

Defining Calculation Block Properties

Use Calculation blocks to perform calculations with analog and digital
block values and constants, producing an analog result. Up to eight
operands (Analog Value, Analog Pointer, and Digital Value blocks, and
constants) can be included in each calculation. Calculation blocks monitor
alarms and produce trends.

To add a Calculation block

1 In the Tree view, right-click anywhere in the Calculation branch and

then click New Block.

The Create New – Calculation dialog box is displayed in the

workstation’s window.

Pulse 4.12 User Guide 972

2 In the Block Name field, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

We recommend that you specify meaningful block names (for

example: PUMP3, DEPTK17).

3 In the block’s General tab, define the block parameters.

4 In the block’s Formula tab, build the formula that this block will
calculate. To assemble the formula, define operands (S through Z)
and the supported operators and mathematical functions, see
Calculation Block - Formula Parameters.

5 In the block’s Alarms tab, create and define the alarms associated
with this block.

6 Click the + button to add an alarm to the list.

7 Define the Alarms’ General parameters.

8 Define the Alarms’ Tree Settings.

9 Define the Alarms’ Actions parameters (not applicable to Events).

10 Select Enable Alarms to allow Pulse to trigger alarms and

generate the listing of alarm data.

11 Click Save to save the block in the project database.

Pulse 4.12 User Guide 973

Calculation Block - General Parameters
In the Calculation block’s General tab, define the block parameters:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node Node number of the station that handles this

alarm or event point.

Timings

Scan Time The interval between successive processing of

the block, in the range of 1-255 seconds. The
default is 1 second.

Phase Time The initial time delay from the loading of the
database to the first processing of the block, in
the range 1-255 seconds. The default time unit
is one second.

Pulse 4.12 User Guide 974

History

Factor The number of readings (0-255) to be

averaged for each point recorded in the
historical trend file:

 If the averaging is not required, enter 0.

 If the averaging is required permanently,

enter between 1 and 254.

 If averaging is not initially required, but

need to be operational during runtime
using the Target block mechanism, enter
255.

Step Enter the minimum change in value required to

record a factored point in the historical trend.
Choose from valid Historical Trend Steps (0%
to 1.0% in 0.1% steps, and 1.0% to 100% in
0.5% steps).

The Historical Trend Step is specified as a

percentage of the Alarm Range (High alarm to
Low alarm, regardless of whether or not the
Alarm is enabled).

Target

Target Block Target blocks are database blocks which

receive data values from other initiating blocks.

The destination within the target block (and the

effect) of the data values sent from the
initiating block are specified in the initiating
block’s Targetlogic.

Pulse 4.12 User Guide 975

Target Logic Select an alarm component, which value is
written to the target block whenever the alarm
is initiated:

 Input – Sets the value of the target

block to the value of the initiating block
(the input option was included to support
old versions of P-CIM).

 Output - Sets the output value of the

target block to the value of the initiating
block. As a result, the value is written to
a PLC or other external field device.

 Alarm Enable – Sets the Alarm Enable

mechanism of the target block to ON
when the value of the initiating block is
non zero; and sets the Alarm Enable
mechanism of the target block OFF,
when the value of the initiating block is
zero.

 Alarm High – Sets the Alarm High set

point of the target block to the value of
the initiating block.

 Alarm Low - Sets the Alarm Low set

point of the target block to the value of
the initiating block.

 Alarm RoC (Rate of Change) – Sets

the Alarm Rate of Change set point of
the target block to the value of the
initiating block.

 Step Trend Factor (S. T.) – Sets the

S. T. factor of the target block to the
value of the initiating block.

 History Trend Factor (H. T.) – Sets

the H. T. factor of the target block to the
value of the initiating block.

Pulse 4.12 User Guide 976

Calculation Block - Formula Parameters
In the block’s Formula tab, build the formula that this block will calculate.
To assemble the formula, define operands (S through Z) and the
supported operators and mathematical functions, see Defining Calculation
Block Properties.

Formulas are evaluated according to standard mathematical precedence:

 Expressions in parentheses are evaluated first.

 Expressions as function arguments are evaluated before the

function itself.

 Multiplication and division are performed before addition and

subtraction.

If you want the Database Server to return zero when the Calculation block
is divided by zero, change the setting “FormulaErrorIsZero” from 0 to 1.
When set to 0, the result of a zero division is the block’s current value,
see Handling "Divide by Zero" Condition.

Formula Assemble a calculation formula using the S-Z

placeholders and mathematical operators and
functions.

Pulse 4.12 User Guide 977

“S” through “Z” S - Z are a set of placeholders which represent
the names of blocks in the formula.

Choose the name of the block represented by

this symbolic name in the formula.

The following is a list of operators and mathematical functions which you

can use to assemble formulas.

Operator/Function Symbol Character Name

Add + plus

Subtract - minus

Multiply * asterisk

Divide / slash

Power ^ caret

Sine SIN( )

Cosine COS( )

Square root SQRT( )

Logarithm LOG( )

Natural logarithm LN( )

Parentheses, to group ()
expressions

Pulse 4.12 User Guide 978

Calculation Block - Alarms - General Parameters
In the Calculation Block Alarms’ General tab, define the alarm’s type and
trigger conditions.

Name Type a name for the alarm.

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an alarm

message, along with standard alarm
information.

Priority The level of precedence or importance of this

alarm, between 0 and 99, where 0 is
considered the highest priority.

Event Select this option to make this condition an

event message.

Pulse 4.12 User Guide 979

Condition

Alarm Type Choose an alarm state:

HIGH, LOW, ROC (Rate of Change), HIHI,

LOLO, RANGE, or EQUAL

Value The value that triggers this alarm condition.

Dead Band The amount that the value has to increase (if
alarm is LOW or LOLO) or to decrease (if alarm
is HIGH or HIHI) in order to restore the normal
state and turn off the alarm condition.

NOTE Not available for ROC alarms.

Alarm Wait The amount of time before Pulse generates the

alarm.

The user can define the Alarm Wait field

accurately with its 00:00:00 time format.

Pulse 4.12 User Guide 980

Calculation Block - Alarms - Tree Settings
Parameters
The tree is a structure for organizing the alarm and event blocks. It allows
operators to see alarms in various contexts, such as functional, location,
and category.

Functional Choose the alarm’s or event’s placement in the

Functional alarm tree (associated with factors
such as division, plant, line, and so on).

Location Choose the alarm’s or event’s placement in the

Location alarm tree (associated with the
physical location of the managed area
(campus, building, production floor, and so on).

Category Choose the alarm’s or event’s placement

according to a category attribute. The category
ranges between 0 and 999.

Pulse 4.12 User Guide 981

Calculation Block - Alarms - Actions Parameters
In the Calculation Block Alarms’ Actions tab, define the actions/events
that will be triggered/initiated when this alarm occurs.

Show Select this checkbox option to display the

alarm notification in the Alarm Summary.

Print Select this checkbox option to send the alarm

message to a printer.

Log Select this checkbox option to display this

alarm’s instances in the Logger Window.

Sound Select this checkbox option to produce a sound

when the alarm is triggered.

On Alarm

Alarm Command on Click to display the Action Selector

Double-Click window to define the alarm command or
workflow when the mouse is double-clicked on
alarm.

Pulse 4.12 User Guide 982

On Active

Always Click to display the Action Selector

window to define the alarm command when the
alarm for the block is active.

To define the object’s data item, enter an

action command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command
or workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Interlogic Determines the way the Interlock signal

(value = 1) is sent:

 New sends the Interlock signal when a

new alarm is detected, for the first scan
only.

 Any sends the Interlock signal for each

scan in which the alarm condition
persists.

Interlock Choose the target block which receives the

value of 1 (ON) when this block triggers an
alarm.

Interlock operates according to the mode

specified under Interlogic (see above).

Pulse 4.12 User Guide 983

Open Display Choose a display to open when the alarm is
triggered or the event occurs.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm is
active, via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

On Acknowledge

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block is
acknowledged.

To send an email notification when the alarm is

acknowledged using the Email activity,
see Email.

On Return to Normal

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block returns
to normal.

To send an email when the alarm returns to

normal notification using the Email activity,
see Email.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm
returns to normal via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

Report Status Select this option to generate a report when

the alarm condition returns to the normal
state.

Pulse 4.12 User Guide 984

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Value Master Block.

An Analog Value Master Block is an Analog

Value block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update
only the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 985

Calculation Block - Alarms – Event Management
Parameters
In the Calculation block Alarms’ Event Management tab, define the
Event Management events that will be triggered when the alarm occurs.

NOTE The Event Management tab is only available when the Event
Management Authorizations checkbox option is checked in
the User Manager.

Enabled Check to enable the alarm to trigger a

managed event.

Class Select the available Event Class - from those

already configured in the Event Center
Administration (Event Classes) that is
triggered by the alarm, i.e., the event
management procedure to be carried out by
the Event Center operator

On Start

Show Video Check this option to show the video from the
camera associated with the event shown on
the workstation when the alarm occurs.

Pulse 4.12 User Guide 986

On Station ID(s) The ID number of the Pulse stations on which
video is played in conjunction with a managed
event - separated by a comma

On Close

Actions\Workflows Set the actions or workflow to be carried out

when the event is closed

Close Event Condition Set the condition to be fulfilled in order to

close the event.

Assign Cameras

Select the camera associated with the event and its associated features

Description The camera’s description

Playback The video playback

View No. The playback’s view number

Live The live video

View No. The live video’s number

Preset The video preset

Pulse 4.12 User Guide 987

Boolean Blocks
Logical Boolean calculations can be used to specify control or alarm
handling. Boolean blocks perform logical calculations using values from
Digital and Analog blocks, as well as Boolean constants. Up to eight logical
variables and/or constants can be included in each calculation.

Applications
Use Boolean blocks to calculate a logical formula referencing up to eight
digital variables or constants. All of the standard Boolean operations are
available.

Input
Data is input indirectly, by specifying other blocks as operands.

Alarm Parameters can be changed by input of data from other blocks

through the Target block mechanism.

Output
Data is sent to a target block, to the operator through updates.

Alarm Parameters of another block can be changed via the Target block
mechanism. Alarm Signals can be sent to the alarm system, through the
Interlock mechanism, to another block.

Defining Boolean Block Properties

Use Boolean blocks to perform logical calculations on digital block values
and constants (0 and 1), producing a digital result. Up to eight digital
operands, Digital Value, Digital Pointer blocks, and logical constants (0
and 1) can be included in each calculation. Boolean blocks monitor alarms.

To define Boolean Block properties

1 In the Tree view, right-click anywhere in the Boolean branch and

then click New Block.

The Create New – Boolean dialog box is displayed in the

workstation’s window.

Pulse 4.12 User Guide 988

2 In the Block Name field, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

We recommend that you specify meaningful block names (for

example: PUMP3, DEPTK17).

3 In the block’s General tab, define the block parameters.

4 In the block’s Formula tab, build the formula that this block will
calculate. To assemble the formula, define operands (S through Z)
and the supported Boolean constants and mathematical functions,
see Boolean Block - Formula Parameters.

5 In the block’s Alarms tab, create and define the alarms and events
associated with this block.

6 Click the + button to add an alarm to the list.

7 Define the Alarms’ General parameters.

8 Define the Alarms’ Tree Settings.

9 Define the Alarms’ Actions parameters (not applicable to Events).

10 Select Enable Alarms to allow Pulse to trigger alarms and

generate the listing of alarm data.

11 Click Save to save the block in the project database.

Pulse 4.12 User Guide 989

Boolean Block - General Parameters
In the Boolean block’s General tab, define the block parameters:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node Node number of the station that handles this

alarm or event point.

Text

Text for 0 Text of up to eight characters and spaces

describing the digital 0 state (for example:
OFF, SHUT, NO, etc.). This text will appear in
displays, data entry, and alarm messages.

Text for 1 Text of up to eight characters and spaces

describing the digital 1 state (for example: ON,
OPEN, YES, etc.). This text will appear in
displays, data entry, and alarm messages.

Pulse 4.12 User Guide 990

Target

Target Block Target blocks are database blocks which

receive data values from other initiating blocks.

The destination within the target block (and the

effect) of the data values sent from the
initiating block are specified in the initiating
block’s Targetlogic.

Target Logic Select an alarm component, which value is

written to the target block whenever the alarm
is initiated:

 Input – Sets the value of the target

block to the value of the initiating block
(the input option was included to support
old versions of P-CIM).

 Output - Sets the output value of the

target block to the value of the initiating
block. As a result, the value is written to
a PLC or other external field device.

 Alarm Enable – Sets the Alarm Enable

mechanism of the target block to ON
when the value of the initiating block is
non zero; and sets the Alarm Enable
mechanism of the target block OFF,
when the value of the initiating block is
zero.

 Alarm High – Sets the Alarm High set

point of the target block to the value of
the initiating block.

 Alarm Low - Sets the Alarm Low set

point of the target block to the value of
the initiating block.

 Alarm RoC (Rate of Change) – Sets

the Alarm Rate of Change set point of
the target block to the value of the
initiating block.

 Step Trend Factor (S. T.) – Sets the

S. T. factor of the target block to the
value of the initiating block.

Pulse 4.12 User Guide 991

  History Trend Factor (H. T.) – Sets
the H. T. factor of the target block to the
value of the initiating block.

Timings

Scan Time The interval between successive processing of

the block, in the range of 1-255 seconds. The
default is 1 second.

Phase Time The initial time delay from the loading of the
database to the first processing of the block, in
the range 1-255 seconds. The default time unit
is one second.

History

Enable Select this option to record the alarm in the

history file.

Pulse 4.12 User Guide 992

Boolean Block - Formula Parameters
In the block’s Formula tab, build the formula that this block will calculate.
To assemble the formula, define operands (S through Z) and the
supported Boolean operators, see Defining Boolean Block Properties.

Boolean formulas are evaluated according to standard mathematical

precedence:

 Expressions in parentheses are evaluated first.

 NOT is evaluated first, then AND and XOR, then OR are evaluated.

For example, in the illustration below, the expression (-S*(T+U))^V is

evaluated as follows:

 T OR U => A

 NOT S => B

 A AND B => C

 C XOR V => result

Pulse 4.12 User Guide 993

Formula Assemble a formula using the “S” – “Z”
placeholders and Boolean operators.

“S” through “Z” “S” – “Z” are a set of placeholders which

represent the names of blocks or constant
values in the formula.

Choose the name of the block represented by

this symbolic name in the formula.

To specify a constant value, enter 0 or 1.

The following is a list of Boolean operators which you can use to assemble
formulas.

Operator/Function Symbol Character Name

NOT + Plus

OR - minus

AND * Asterisk

XOR ^ caret

Parentheses, to group ()
expressions

Pulse 4.12 User Guide 994

Boolean Block - Alarms - General Parameters
In the Boolean block Alarms’ General tab, define the alarm’s type, and
trigger conditions.

Name Type a name for the alarm.

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an alarm

message, along with standard alarm
information.

Priority The level of precedence or importance of this

alarm, between 0 and 99, where 0 is
considered the highest priority.

Event Select this option to make this condition an

event message.

Condition

Alarm Type Choose the state of the block value which

triggers this alarm:

ON, OFF, COS (value changes in either

direction)

Pulse 4.12 User Guide 995

Alarm Wait The amount of time before Pulse generates the
alarm.

The user can define the Alarm Wait field

accurately with its 00:00:00 time format.

Boolean Block - Alarms - Tree Settings Parameters

The tree is a structure for organizing the alarm and event blocks. It allows
operators to see alarms in various contexts, such as functional, location,
and category.

Functional Choose the alarm’s or event’s placement in the

Functional alarm tree (associated with factors
such as division, plant, line, and so on).

Location Choose the alarm’s or event’s placement in the

Location alarm tree (associated with the
physical location of the managed area
(campus, building, production floor, and so on).

Category Choose the alarm’s or event’s placement

according to a category attribute. The category
ranges between 0 and 999.

Pulse 4.12 User Guide 996

Boolean Block - Alarms - Actions Parameters
In the Boolean block Alarms’ Actions tab, define the actions/events that
will be triggered/ initiated when this alarm occurs.

Show Select this checkbox option to display the

alarm notification in the Alarm Summary.

Print Select this checkbox option to send the alarm

message to a printer.

Log Select this checkbox option to display this

alarm’s instances in the Logger Window.

Sound Select this checkbox option to produce a sound

when the alarm is triggered.

On Alarm

Alarm Command on Click to display the Action Selector

Double-Click window to define the alarm command or
workflow when the mouse is double-clicked on
alarm.

Pulse 4.12 User Guide 997

On Active

Always Click to display the Action Selector

window to define the alarm command when the
alarm for the block is active.

To define the object’s data item, enter an

action command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command
or workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Interlogic Determines the way the Interlock signal

(value = 1) is sent:

 New sends the Interlock signal when a

new alarm is detected, for the first scan
only.

 Any sends the Interlock signal for each

scan in which the alarm condition
persists.

Interlock Choose the target block which receives the

value of 1 (ON) when this block triggers an
alarm.

Interlock operates according to the mode

specified under Interlogic (see above).

Pulse 4.12 User Guide 998

Open Display Choose a display to open when the alarm is
triggered or the event occurs.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm is
active, via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

On Acknowledge

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block is
acknowledged.

To send an email notification when the alarm is

acknowledged using the Email activity, see
Email.

On Return to Normal

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block returns
to normal.

To send an email when the alarm returns to

normal notification using the Email activity,
see Email.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm
returns to normal via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details
see The Email Dispatcher.

Report Status Select this option to generate a report when

the alarm condition returns to the normal
state.

Pulse 4.12 User Guide 999

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Value Master Block.

An Analog Value Master Block is an Analog

Value block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update
only the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 1000

Boolean Block - Alarms – Event Management
Parameters
In the Boolean block Alarms’ Event Management tab, define the
Event Management events that will be triggered when the alarm occurs.

NOTE The Event Management tab is only available when the Event
Management Authorizations checkbox option is checked in
the User Manager.

Enabled Check to enable the alarm to trigger a

managed event.

Class Select the available Event Class - from those

already configured in the Event Center
Administration (Event Classes) that is
triggered by the alarm, i.e., the event
management procedure to be carried out by
the Event Center operator.

On Start

Show Video Check this option to show the video from the
camera associated with the event shown on
the workstation when the alarm occurs

On Station ID(s) The ID number of the Pulse stations on which

video is played in conjunction with a managed
event - separated by a comma

Pulse 4.12 User Guide 1001

On Close

Actions\Workflows Set the actions or workflow to be carried out

when the event is closed

Close Event Condition Set the condition to be fulfilled in order to

close the event.

Assign Cameras

Select the camera associated with the event and its associated features

Description The camera’s description

Playback The video playback

View No. The playback’s view number

Live The live video

View No. The live video’s number

Preset The video preset

Pulse 4.12 User Guide 1002

Alarm Blocks
In an Alarm block, you can define up to 80 digital alarms. An Alarm block
reads five registers, each containing 16 bits, from up to five different
PLCs. The block relates to all bits as separate alarms which have different
alarm properties (for example, status can be defined: ON, OFF, or Change
of State).

Unlike Value, Boolean, and Calculation blocks, Alarm blocks send interlock
bits output directly to a device. However, alarm blocks do have some
limitations. Since all bits are scanned at once, they are not appropriate if
some bits require more frequent scanning than others.

For each such alarm, various handling procedures can be defined:

 Presenting an alarm message in the Alarm Explorer and the Logger

Window

 Printing an alarm message

 Storing an alarm message on file (Daily Log)

 Masking a bit (disable its alarm)

 Reporting return-to-normal status

Input
Data is received from devices or analog internal variables.

Output
Data (alarm state) is sent to the Operator Workstation via updates.

Alarm Signals are sent to the alarm system, and Interlock signals are sent
to devices.

Application
Use alarm blocks to monitor large numbers of alarms from digital (binary)
sources. Usually, these sources are bits that are set by the device when
an alarm occurs. They require less memory and less scanning time than is
needed if a separate Digital Value block was created for each alarm.

Alternatives
If you need to manipulate bit values from the Operator Workstation, use
Digital Value blocks instead of Alarm blocks.

Pulse 4.12 User Guide 1003

Defining Alarms Block Properties
Alarm blocks process digital data. Use Alarm blocks to handle large
numbers of alarms from digital/binary sources. Each Alarm block reads 5
addresses (registers) of 16 bits each (up to eighty digital alarms), from up
to five different PLCs, and relates to each bit as a separate alarm. For
each bit, a different alarm status can be defined: ON, OFF, or COS.

Before setting up an Alarm Block, it is recommended to outline a detailed

plan which includes all relevant PLCs and the alarm bits associated with
each one.

To define Alarm Block properties

1 In the Tree view, right-click anywhere in the Alarm branch and then
click New Block.

The Create New – Alarm dialog box is displayed in the workstation’s

window.

2 In the Block Name field, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

We recommend that you specify meaningful block names (for

example: PUMP3, DEPTK17).

Pulse 4.12 User Guide 1004

3 For each 16-bit Register tab (1-5), define the data Address that the
block reads.

4 For each bit (up to 16 per register), create and define a unique
digital alarm associated with this register, see Setting the Alarm’s
Bit Alarm Properties.

5 Select the register’s Enable option to allow Pulse to trigger alarms

and generate the listing of alarm data for that register’s data
source.

6 Click Save to save the block in the project database.

Alarm Block - General Parameters

In the Alarm block’s General tab, define the block parameters:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node Node number of the station that handles this

block’s alarms.

Pulse 4.12 User Guide 1005

Timings

Scan Time The interval between successive processing of

the block, in the range of 1-255 seconds. The
default is 1 second.

Phase Time The initial time delay from the loading of the
database to the first processing of the block, in
the range 1-255 seconds. The default time unit
is one second.

If a block is turned off and on scan, its phase

time becomes irrelevant in terms of staggered
scan times.]

Use PLC Time Stamp Select to read the date and time of the alarm
from the PLC.

Output

Enable Interlock Select this option to enable the sending of an

Interlock signal (value = 1) when this block
triggers and alarm.

Interlock Address Enter the address which receives the Interlock

signal.

Pulse 4.12 User Guide 1006

Alarm Block – Registers 1, 2, 3, 4, and 5
A register is a data file that stores bits of information in a PLC. Pulse uses
the registers to contain alarm condition configurations.

Alarm blocks can contain up to five registers, which in turn can contain up
to 16 alarm bits each, for a maximum capacity of 80 alarm bits per block.

Each alarm bit can hold a unique digital alarm associated with its
register’s data source. For each bit, you need to specify its alarm handling
configuration.

Alarm Bit windows can be accessed directly via the Block Directory or via
the associated Alarm block.

To create and define alarm bits

1 Enter the relevant Register tab (in accordance with the address of
the data source).

2 Select the Enable checkbox of a free bit number.

3 Complete the rest of the bit’s entry information as follows:

Pulse 4.12 User Guide 1007

 Bit Name After clicking Enable, a default unique name
appears in this column.

To change the name, highlight it and type

the new name. Block names may be up to
34 characters long. The first character must
be a letter (A to Z). The following characters
may be letters (A to Z), numbers (0-9), or
hyphens (-). Lower case letters are
automatically converted to upper case.

We recommend that you specify meaningful

block names (for example: PUMP3,
DEPTK17).

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an

alarm message, along with standard alarm
information.

A description previously provided for a bit is

available as a description item from the
drop-down list.

A description can also be set for multiple bits

by right-clicking on the description and
selecting Apply Description to All Bits
from the pop-up menu.

Type Choose the state which triggers this alarm:

ON, OFF, COS (value changes in either

direction)

Text for 0 Text of up to eight characters and spaces

describing the digital 0 state (for example:
OFF, SHUT, NO, etc.). This text will appear
in displays, data entry, and alarm messages.

Text for 1 Text of up to eight characters and spaces

describing the digital 1 state (for example:
ON, OPEN, YES, etc.). This text will appear in
displays, data entry, and alarm messages.

Security Security level (0-99) for users authorized to

receive and view the alarm.

4 Click Save to store the changes in the project database.

Pulse 4.12 User Guide 1008

Setting the Alarm’s Bit Alarm Properties
Alarm blocks can contain up to five registers, which in turn can contain up
to 16 alarm bits each, for a maximum capacity of 80 alarm bits per block.

Each alarm bit can hold a unique digital alarm associated with its
register’s data source. For each bit, you need to specify its alarm handling
configuration.

Alarm Bit windows can be accessed directly via the Block Directory or via
the associated Alarm block.

After adding the Alarm Bit entry to the register, you can modify its alarm
configuration.

To create and define the alarm bit conditions

1 In the relevant Register tab, select the Enable checkbox of a free

bit number.

2 Complete the rest of the bit’s entry information; see Alarm Block -
General Parameters.

3 Right-click anywhere in the relevant bit entry and click Alarm

Properties.

The Alarm Bit Condition dialog box for defining alarm properties is
displayed.

Pulse 4.12 User Guide 1009

4 Set the required General, Tree Settings, and Actions Properties
for the selected alarm bit.

• Alarm Block - Bit Alarm Condition - General Properties

• Alarm Block - Bit Alarm Condition - Tree Settings Parameters

• Alarm Block - Bit Alarm Condition - Actions Parameters

5 Click OK to implement the change.

Pulse 4.12 User Guide 1010

Alarm Block - Bit Alarm Condition - General
Properties
In the Alarm Bit Condition dialog box’s General tab, define the alarm’s
type and trigger conditions.

Name Type a name for the alarm.

Description Enter the description text of up to 255

characters and spaces.

The alarm description is displayed in an alarm

message, along with standard alarm
information.

Priority The level of precedence or importance of this

alarm, between 0 and 99, where 0 is
considered the highest priority.

Event Select this option to make this condition an

event message.

Pulse 4.12 User Guide 1011

Condition

Alarm Type Choose the state of the block value which

triggers this alarm:

ON, OFF, COS (value changes in either

direction)

Alarm Wait The amount of time Pulse waits before

generating an alarm.

You can define the Alarm Wait field accurately

with its 00:00:00 time format.

Pulse 4.12 User Guide 1012

Alarm Block - Bit Alarm Condition - Tree Settings
Parameters
The tree is a structure for organizing the alarm and event blocks. It allows
operators to see alarms in various contexts, such as functional, location,
and category.

Functional Choose the alarm’s or event’s placement in the

Functional alarm tree (associated with factors
such as division, plant, line, and so on).

Location Choose the alarm’s or event’s placement in the

Location alarm tree (associated with the
physical location of the managed area
(campus, building, production floor, and so on).

Category Choose the alarm’s or event’s placement

according to a category attribute. The category
ranges between 0 and 999.

Pulse 4.12 User Guide 1013

Alarm Block - Bit Alarm Condition - Actions
Parameters
In the Alarms’ Bit Alarm Actions tab, define the actions/events that will
be triggered/initiated when this alarm occurs.

Show Select this checkbox option to display the

alarm notification in the Alarm Summary.

Print Select this checkbox option to send the alarm

message to a printer.

Log Select this checkbox option to display this

alarm’s instances in the Logger Window.

Sound Select this checkbox option to produce a sound

when the alarm is triggered.

Pulse 4.12 User Guide 1014

On Alarm

Alarm Command on Click to display the Action Selector

Double-Click window to define the alarm command or
workflow when the mouse is double-clicked on
alarm.

On Active

Always Click to display the Action Selector

window to define the alarm command when the
alarm for the block is active.

To define the object’s data item, enter an

action command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command
or workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Interlogic Determines the way the Interlock signal

(value = 1) is sent:

 New sends the Interlock signal when a

new alarm is detected, for the first scan
only.

 Any sends the Interlock signal for each

scan in which the alarm condition
persists.

Pulse 4.12 User Guide 1015

Interlock Choose the target block which receives the
value of 1 (ON) when this block triggers an
alarm.

Interlock operates according to the mode

specified under Interlogic (see above).

Open Display Choose a display to open when the alarm is

triggered or the event occurs.

Email Select this checkbox option to send this specific

block’s alarm notification(s), when the alarm is
active, via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details,
see The Email Dispatcher.

On Acknowledge

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block is
acknowledged.

To send an email notification when the alarm is

acknowledged using the Email activity, see
Email.

On Return to Normal

Actions/Workflow Click to display the Action Selector

window to define the action command or
workflow when the alarm for the block returns
to normal.

To send an email when the alarm returns to

normal notification using the Email activity,
see Email.

Pulse 4.12 User Guide 1016

Email Select this checkbox option to send this specific
block’s alarm notification(s), when the alarm
returns to normal via the Email Dispatcher.

The alarm notification that will be sent via the

Email Dispatcher is per block. The email will be
sent to the recipient configured in the Email
Dispatcher Configurator, for more details
see The Email Dispatcher.

Report Status Select this option to generate a report when

the alarm condition returns to the normal
state.

Save as Master Block Click this button to display the Master Block
Arguments window and to create an Analog
Value Master Block.

An Analog Value Master Block is an Analog

Value block template with inherited block
parameter definitions and a number of free
block arguments inherited from the existing
block. The created Master Block allows the user
to create an instance of a block and update
only the free arguments. Any other block fields
which are not defined as free arguments will
hold the values as saved in the Master Block.

Pulse 4.12 User Guide 1017

Alarm Block – Bit Alarm Condition– Event
Management Parameters
The Alarm Bit block’s Event Management tab is where you can define
the Event Management events that will be triggered when the alarm
occurs.

NOTE The Event Management tab is only available when the Event
Management Authorizations checkbox option is checked in
the User Manager.

Enabled Check to enable the alarm to trigger a

managed event.

Pulse 4.12 User Guide 1018

Class Select the available Event Class - from those
already configured in the Event Center
Administration (Event Classes) that is
triggered by the alarm, i.e., the event
management procedure to be carried out by
the Event Center operator.

On Start

Show Video Check this option to show the video from the
camera associated with the event shown on
the workstation when the alarm occurs.

On Station ID(s) The ID number of the Pulse stations on which

video is played in conjunction with a managed
event - separated by a comma.

On Close

Actions\Workflows Set the actions or workflow to be carried out

when the event is closed.

Close Event Condition Set the condition to be fulfilled in order to

close the event.

Assign Cameras

Select the camera associated with the event and its associated features

Description The camera’s description

Playback The video playback

View No. The playback’s view number

Live The live video

View No. The live video’s number

Preset The video preset

Pulse 4.12 User Guide 1019

StringPointer Blocks
String Pointer blocks are used to convert numerical data into text. They
can receive up to twenty 16-bit word values from registers in a PLC or
other peripheral device and convert them into a text string of up to 40
characters. They can also convert a text string input by the operator into
register values to be sent to the PLC or other device. String Pointer blocks
are only processed when used somewhere in the Pulse system.

Part or the entire message sent or retrieved by the block can be defined
as a constant. The constant can be used to identify the device in the
operator display. Different conversions can be specified in the block,
according to the way the device generates and reads characters.

Applications
String pointer blocks are intended for use with devices that can generate
text strings in registers.

Input and Output

String Pointers receive input values from devices and send output values
as strings to the operator via updates. They can also be used by operators
to write strings as values to devices.

Defining StringPointer Block Properties

Use String Pointer blocks to convert 16-bit words of a single device (port
and PLC) into text and vice versa. String Pointer blocks handle up to
twenty 16-bit words and convert them into a text string of up to 40
characters.

You can specify part of the string value of a String Pointer block as a
constant character (or pair).

When in use, String Pointer blocks are scanned at intervals of one time
unit. The default time unit is one second.

Pulse 4.12 User Guide 1020

To add a StringPointer block

1 In the Tree view, right-click anywhere in the StringPointer branch

and then click New Block.

The Create New – String Pointer dialog box is displayed in the

workstation’s window.

2 In the Block Name field, type a unique name for the block. Block
names may be up to 34 characters long. The first character must be
a letter (A to Z). The following characters may be letters (A to Z),
numbers (0-9), or hyphens (-). Lower case letters are automatically
converted to upper case.

We recommend that you specify meaningful block names (for

example: PUMP3, DEPTK17).

3 In the block’s General tab, define the block parameters.

4 In the block’s Addresses tab, enter the references of up to twenty

registers to be used as sources and/or destinations of data.

5 Click Save to save the block in the project database.

Pulse 4.12 User Guide 1021

StringPointer Block - General Parameters
In the StringPointer block’s General tab, define the block parameters:

General

Description Enter the description text of up to 255

characters and spaces.

The block description is displayed in an alarm

message, along with standard alarm
information.

Node Node number of the station that handles this

block’s alarms.

Security Security level (0-99) for users authorized to

receive and view the alarm.

Pulse 4.12 User Guide 1022

Strings

String Format Specify how characters are located in the

numerical data (16- bit words) received from
the PLC. The format represents the mapping of
one or two 8-bit characters in the two bytes.

The available options are:

 Low - one character in the low byte

(result "A")

 High - one character in the high byte

(result "B")

 LowHigh - two characters, first in the

low byte (result "AB")

 HighLow - two characters, first in the

high byte (result "BA")

Bits in Char Choose the number of bits (7 or 8) per

character.

 SevenBits - use the standard ASCII set

(0 to 127)

 EightBits - use the extended ASCII set

(0 to 255)

Pulse 4.12 User Guide 1023

StringPointer Block - Addresses Parameters
In the StringPointer block Addresses tab, enter the references for up to
twenty registers to be used as sources and/or destinations of data in the
respective box.

Address Prefix Enter the common prefix for the accessed data
addresses.

 For device data (direct access), enter the

common port and station (port:station).

 For internal (dummy) data, enter the

common analog table (A:).

Pulse 4.12 User Guide 1024

Address Enter the references of up to twenty registers to
(1 through 20) be used as sources and/or destinations of data
in the respective boxes:

 For device data, enter the register

address.

 For internal (dummy) data, enter the

entry number of the analog variable.

 For constant characters, enter one or two

characters (according to the String
Format) proceeded by a single quote ['].

Save as Master Block Click this button to display the Master Block
Arguments window and to create a String
Pointer Master Block.

A String Pointer Master Block is a String Pointer

block template with inherited block parameter
definitions and a number of free block
arguments inherited from the existing block.
The created Master Block allows the user to
create an instance of a block and update only
the free arguments. Any other block fields which
are not defined as free arguments will hold the
values as saved in the Master Block.

Pulse 4.12 User Guide 1025

SER (Sequence of Events Recorder)
The SER has a graphical user interface (GUI). It is based on a new block
type called SER. The SER block contains fields for the PLC registers for the
alarm data (time, value, and event ID).

Each event ID (PLC register) is attached with an alarm condition value.

The value (PLC value register) is inserted to the ALM_VALUE field in the
Alarm log table. The Event ID is the alarm condition name.

Pulse can use unlimited SER Blocks in the application but SER is limited to
the database capacity of 32000 blocks.

SER logic only supports one mode, which shows events in the Alarm
Explorer log, uses Pulse blocks and alarm conditions.

To create a SER block (new GUI)

1 On the Database Explorer Database tree, right-click on the Ser

block and select New Block from the pop-up menu.

The Create New - Ser dialog box is displayed.

2 Provide a unique block name in the Block Name field; the block
name will be associated with the event.

3 In the General tab, provide the following parameters:

General tab

Enable Select this checkbox option to enable the

functionality for the selected SER section.
Deselect this option to disable it.

Pulse 4.12 User Guide 1026

 Description Enter the SER block description or select
an available description from the drop-
down list (if any).

Security Set the security level of the SER block

providing it with its level of authorization
from 0 to 99.

Event ID Address The address of the event identification

number.

Enter the address of the event

identification number.
For example, Event ID = 3:1:40202, A:1

It is recommended to set the Semaphore

and the Event ID to the same address. In
this case, Event ID = 0 means that there
are no events.

Show Event ID Check this checkbox option to display the

Event ID.

Value Address Define the address of the value of the

event.

Enable Value Check this checkbox option to enable the

defined value.

Semaphore Address Enter the address of the semaphore such

as SEM=3:1:402001.

MMDD Address The default is empty. If typed-in, the

event ID is displayed in the message in
square brackets, such as [EventID].

HHMM Address Enter the address of the Hours and

Minutes part of the event presentation
time stamp, such as HHMM=3:1:402003.

SSMS Address Define the address of the Seconds and

Milliseconds event time stamp register.
The interpretation is governed by the Sub-
second Resolution setting.

Pulse 4.12 User Guide 1027

 Target Block Target blocks are database blocks which
receive data values from other initiating
blocks.

The destination within the target block

(and the effect) of the data values sent
from the initiating block are specified in
the initiating block’s Targetlogic.

Select the target SER block from the drop-

down list. The available target blocks(s)
are the SER blocks that were already
created and appear under the Ser tree.

4 Click Save and go to the Events tab.

5 In the Events tab, provide the following parameters:

Events Prefix

Description Enter a description of the event.

Align Select Left or Right from the drop-down

list options.

Event ID The Event ID sequential number.

Description Enter a description for the event.

Name The event number, i.e., Event:1, Event:2,

etc.

Location Enter the location of the alarm or select

from the drop-down list.

Pulse 4.12 User Guide 1028

 Functional Specifies if the event's alarm bit is
Functional or otherwise

Category Displays the category of the alarm, the

default is 'Category 0'

6 Click Save, Save As or Close to continue.

Pulse 4.12 User Guide 1029

Alarm Bit
Alarm blocks can contain up to five registers, which in turn can contain up
to 16 alarm bits each, for a maximum capacity of 80 alarm bits per block.

Each alarm bit can hold a unique digital alarm associated with its
register’s data source. For each bit, you need to specify its alarm handling
configuration.

Alarm Bit windows can be accessed directly via the Block Directory, via
the associated Alarm block or via the Block Types tree.

Master Blocks
A Master Block is a template of a block inherited from an existing block
type, which define a number of free block arguments. The user can create
an instance of a block and update only the free arguments from the
created master block. Any other block fields that are not defined as free
arguments will hold the values as saved in the Master Block.

The Master Block extension is ‘sbl’ and its files are located in the
‘Afcon\Pulse\[Project]\Gallery’ folder.

Application
The Master Block simplifies repeatedly creating types of blocks sharing
similar characteristics but with some parameter values that are different.

Pulse 4.12 User Guide 1030

Defining a Master Block
The Master Block is created from the Block Types tree in Database
Explorer.

It can also be created by clicking on the Save as Master Block button in

the block editor.

Pulse 4.12 User Guide 1031

Master Blocks can be created from the following block types:

 Analog Value

 Analog Pointer

 Digital Value

 Digital Pointer

 Calculation

 Boolean

 Alarm

 String Pointer

By default, some fields are selected automatically as free mandatory

arguments (i.e., Block Name, Address, etc.) depending on the block
type. A free argument field is highlighted and is displayed in the Master
Block Arguments window. Free argument will be added/removed by
right click on a field and selecting the desired action.

Pulse 4.12 User Guide 1032

The Master Block is displayed in the Database Explorer’s Block Types
tree under the Master Blocks branch.

Creating a Block from a Master Block

When creating a new block from Master Block, free arguments are
displayed in the Master Block Arguments window for the user to
provide the required values. The block that is created is referenced to the
Master Block.

To create a new block from a Master Block

1 In the Tree view, right-click on the Master Block you want to base
the new block from and select New Block or click the Save As
Master Block button in the source block’s dialog box.

The Master Block Editor dialog box is displayed in the workstation’s

window.

Pulse 4.12 User Guide 1033

2 Define the new value(s) if required and click OK.

The new block is created and listed under the respective block in
the Block Types tree.

When saving a new block, a verification check is performed to check if the

existing Block Type is the same and is related to the same Master Block
and whether a block with the same name already exists. If such a block
exists, the existing block is overwritten.

If the blocks are from different Block Types or are not related to the same
Master Block, the user is notified that the block already exists.

Pulse 4.12 User Guide 1034

Editing a Master Block
When changes are made on the Master Block, all blocks created from it
are updated. A notification is displayed informing that there are existing
blocks that have to be updated and are prompted whether to proceed and
save the changes made in the Master Block and its existing blocks (if the
user does not save, the Master Block is not updated.

Database Explorer Tree

 The Block Types tree displays the Master Blocks instances when
the Master Blocks’ branch is expanded in the Developer workstation
window.

 Each Master Block has an icon according to its block type.

 The user can view, duplicate or edit the properties of a block

instance (free arguments, block conditions, etc.), using the Block
Types’ context menu.

Pulse 4.12 User Guide 1035

Block Explorer
In the Database Explorer, you can open tables listing all blocks in the
database and/or all blocks of a specific type. You can view and modify
general information about these blocks directly.

 In the Database Explorer, right-click on the block type name and

then click Explore (replacing a Block Explorer that’s already open)
or Explore in New Window (leaving other Block Explorers open
too).

A form, similar to the example below, is displayed in the

workstation’s window.

• Right-click the top of the Block Types tree and select

Explore to display all blocks in the Database.

• Right-click a specific Block Type and click Explore to

display all blocks of the selected type.

Alarms An enabled + button indicates that alarm

conditions have been defined for the block.
Click the block to open a table describing the
conditions. To close the table, click the -
button that replaced the + button.

Block Type Type of block described by the entry.

Block Name Name of the block described by the entry.

Address Communication address of the data handled

by the block.

Pulse 4.12 User Guide 1036

Scan Time The interval between successive processing of
the block, in the range of 1-255 seconds. The
default is 1 second.

Description Enter the block description text of up to 255

characters and spaces.

Alarm Enable Select to enable the block to process alarms.

Enable History Select to enable the collection of historical

records.

Security Security level (0-99) for users authorized to

receive and view the alarm.

Adding Multiple Database Blocks

The Add Multiple Blocks command enables users to add blocks whose
parameters are similar to a block that’s already configured. Instead of
starting to configure every new block with either no defined settings or
the default settings, users can start on an already configured block and
modify only one or a few settings. This can significantly reduce the time
required to populate the database.

By default, the Multiple Block mechanism increases the Block Name and
Addresses automatically based on the Block Name Formula and
Address Formula provided.

For example:

Block Name: DV

Address: 1:1:1

Block Name Formula: DV[0+1]

Address Formula: 1:1:[2+1]

automatically increase as follows:

DV0 with the address 1:1:2, DV1 with the address 1:1:3, etc. blocks are
added.

Pulse 4.12 User Guide 1037

To add multiple blocks

1 In the Tree view, browse and select the block which properties will
serve as the basis for the new blocks.

-or-

On the Block Types window, browse and select the block which
properties will serve as the basis for the new blocks.

2 Right-click the block and click Add Multiple Blocks.

The Multiple Block dialog box is displayed.

3 Enter the number of blocks to add in the Quantity field.

4 Provide the Block Name Formula (i.e., DV[0+1]).

5 Provide the Address Formula (i.e., 1:1[2+1]).

6 Click OK.

The requested number of blocks is added to the Tree View and

automatically increases as follows (based on the given example):

DV0 with the address 1:1:2, DV1 with the address 1:1:3, etc.
blocks are added.

Pulse 4.12 User Guide 1038

Viewing Database Properties
The Database Explorer displays general information about the project’s
database and its contents, such as network enable, node number, location
of the database, and quantity of data blocks, connection timeout and
more.

To view the database properties

1 With the Database Explorer open, open the File ribbon and click
Properties.

The Database Properties window is displayed.

2 Click OK or Cancel to exit the window.

Pulse 4.12 User Guide 1039

Pulse DDE Server and Client
Pulse can share DDE data with any external DDE client and server
application that resides on the Pulse Server computer or on a local client
computer.

Pulse DDE Server

PulseDDE is a solution for Pulse as a DDE Server based on the following:

 PulseDDE.exe runs on the Pulse server or Pulse clients. It provides

the DDE server services for its external DDE clients or for block
addresses. The PulseDDE.exe.config is its configuration file. The
module is a standard Pulse client (WCF) and a standard DDE server.

 The PulseDDE logs events into the Event Viewer when events such
as the disconnection of the Pulse server occur. The PulseDDE also
handles recovery properly.

 The PulseDDE and the configuration files are installed in the

C:\Afcon\Pulse folder during Pulse installation. The Client
downloads, based on ClickOnce, both files automatically into the
Client folder.

 The Client runs the PulseDDE using the Run command; it starts
manually before a DDE Client connects to it. The PulseDDE utilizes
a Pulse runtime license but when running simultaneously with the
Pulse workstation on the same PC, they both use one runtime
license only.

 The Pulse server can run the PulseDDE from P-CIM startup
(Pcim.ini) allowing it to run in Session 0. DDE works in log off mode
as well.

 When the PulseDDE is running on the server, it allows the Database

server to use any Pulse Publisher advised item in the block address,
e.g., The Alarm Publisher counters can be retrieved using the
PulseDDE providing that it is running on a DBSR session. On a Pulse
standalone running on Vista or higher operating systems, it may
run on Microsoft Excel in Session 0 or for the DBSR that runs on
Session 0.

PulseDDE|pfwalarnNG.pcim!Ack(…)

PulseDDE|DataSheet.OLEDB!DataTag1

Pulse 4.12 User Guide 1040

NOTE If the DDE link that does not include ‘.’, the text is considered
to be between ‘|’ and ‘!’ as a DBSR topic.

For example:

PulseDDE|pcim!a:5 is like PulseDDE|dbsr.pcim!a:5

 The Pulse items using the syntaxes below can be advised from the
Microsoft Excel running on the Pulse workstation that is networked
and without a local server.

PulseDDE| pfwalarnNG.pcim!Ack(…)

PulseDDE|dbsr.pcim!#hist(av1,smpl,…)

 The PulseDDE runs on the user session and not in Session 0 of the
services in Windows Vista, Windows 7, Windows 2008, and higher
operating systems. This enables communication with DDE clients,
such as Microsoft Excel, running on the same Windows session.

 On Terminal sessions, the logged in user has administrator

privileges to successfully connect to the DDE.

 The server has an optional GUI to monitor items. The GUI is

displayed when the user activates it from the system tray icon,
without a password. The instance running in Session 0 does not
have a GUI.

 The PulseDDE provides security when writing to Pulse items.

 The PulseDDE running on a workstation shares the same license

with the workstation.

Pulse as DDE Server

External DDE Clients (such as Microsoft Excel) running on the Pulse Server
or on the Pulse Client workstation advice for Pulse items in DDE protocol
(not NetDDE which is usually disabled).

Pulse as DDE Client

The Pulse workstation advices for items of External DDE servers that run
on the server station. It is implemented by database blocks DDE
addresses (when the DDE server runs on the Pulse server station) or
‘direct’ DDE addresses via the DDE Adaptor Publisher (when the DDE
server is running on the server station).

Pulse 4.12 User Guide 1041

DDE Adaptor Publisher
The DDE Adaptor Publisher is a DDE client that supports the following
types of DDE exchange with a DDE server application:

 Read data from Server (advise)

 Write data to Server (poke)

 Send commands to Server (execute)

 Send keystrokes to Server (SendKeys)

 Allows using external DDE addresses of external DDE servers (e.g.,

communication drivers on the server with direct addresses in the
display). It is a publisher that is a DDE client and a WCF server.

 The DDE Adaptor Publisher depends on the P-CIM server, like any
other publisher.

 Counts Pulse licenses to monitor input/output limitations.

 During P-CIM migration of direct DDE addresses, the projects

migrated from P-CIM with direct DDE addresses in the displays and
actions use the following syntax:

MyDDEServer|MyDDETopic!MyDDEItem

Such items are migrated to:

MyDDEServer.MyDDETopic!MyDDEItem

 In database blocks, the actual DDE server name is used.

Pulse Kernel
The Pulse Kernel (DBSR) is a DDE Server that supports the following types
of DDE exchange with a Client application:

 Return data to Client (advise or request)

 Accept data from Client (poke)

The Pulse Kernel is also a DDE client for the raw data managed by blocks.

Pulse 4.12 User Guide 1042

DDE Basics Defined
A DDE link always involves two sides: client and server.

For data exchanges, a data address in the server is referenced by the

following components: Server, Topic, and Item.

The actual syntax for Server, Topic, and Item are usually found in the
documentation of the server.

Retrieving Data from the Server

To retrieve data from a server, configure an Indicator or a Trends Pen and
specify the DDE parameters (DDE, Server, Topic, Item) using the server's
published syntax. Use the guidelines below that apply to most cases.

Prefix Specify DDE as the prefix.

Server Specify the name of the program, e.g., EXCEL

for Excel.

Topic Specify the full path of the file, e.g.,

C:\EXCEL\SHEET5.XLS for a worksheet.

Item Specify the reference in the file, e.g., R2C3 or

B3 for a worksheet cell.

Format The DDE Adaptor Publisher expects data in Text

format (CF_TEXT).

Number Notation When the Operator Workstation expects a

number, it looks for the literal representation of
a decimal number, in integer, fixed point, or
scientific notation, starting from the first
character. Thus, the strings "1234", "-1.23",
and "1.23e5" will be interpreted correctly, but
"12ABC" will be interpreted as 12, and "ABC"
will be interpreted as 0.

Pulse 4.12 User Guide 1043

Writing Data to Server
To write back data to a server, configure a Control and specify the DDE
parameters (Server, Topic, Item) using the server's published syntax. For
Input Text and Slider, use the syntax guidelines above.

Action Button For an Action Button, leave the Server and

Topic boxes blank. Specify the command (e.g.,
Set, Inc, etc.) and fill in the DDE argument of
the command in the format:

DDE|server.topic!item

Use the guidelines in Retrieving Data (above)

for each of the three identifiers.

Sending Commands to another Program

Some programs may support “execute” commands over DDE - look for the
DDE EXECUTE (or similar) term in the associated documentation. When
doing one of the following (Creating Button Controls, Triggering Actions by
Events) specify:

Prefix Specify DDE as the prefix.

Server The server name of the application.

Topic The topic name (document) in the application.

Action The literal command expected by the

application, enclosed in square brackets, for
example:

[FIND(abcd)]

Some applications expect commands sent to topic SYSTEM.

Pulse 4.12 User Guide 1044

Using Microsoft Excel as Server for Pulse
Operator Workstation
This section contains guidelines for using Excel as a server for the Pulse
Operator Workstation and Data Scope.

Settings
Make sure that Excel is enabled for remote requests (Options, Workspace,
and Ignore Remote Requests is off).

Accessing Data
The Server Computer or system which makes its resources or data
available to the inquiring clients for example P-CIM server in a server-
client P-CIM network which grants the clients access to the real time and
historical data, Topic and Item specifications required to access
(read/write) the value of particular worksheet cell are:

Prefix Specify DDE as the prefix.

Server EXCEL

Topic Path and name of worksheet, e.g.,

C:\EXCEL\INVNTRY.XLS

Item Cell reference, in the current format supported by

Excel (A1 or R1C1), or name assigned in worksheet.

Topic SYSTEM
Excel also features the topic SYSTEM that contains generic items, and
accepts commands.

Pulse 4.12 User Guide 1045

Using Pulse Kernel as a DDE Client
You can use the Database Server of the Pulse Kernel to communicate with
a generic external DDE Server as if it were a communications driver
connected to the Pulse Server. That is, you can reference a data item of
that server as the "Address" parameter of a Database block.

You can use this feature to process data provided by the following entities
in Database blocks:

 Generic DDE servers such as Microsoft Excel, communication

drivers with DDE interface, and so on.

 The Pulse communications driver

 The Pulse Kernel itself (acting as "client" to its own "server" facet).

To design, configure and use this functionality

1 Obtain the name of the server, topic, and item of the data item you
want to process in the block - consult the documentation of the
server application in question.

2 Start the server in question and make sure that the topics and item
you want to communicate with are available.

3 Configure the blocks in the Database Explorer - in the Address box

of the block; enter the phantom port and PLC number, and the item
name.

4 Save the block configurations.

5 Reference the new blocks in the Developer Workstation.

NOTE To be client to its own "server" facet - including blocks - the

user has to log in the server to itself as client "MNGRKEY".

Designing - Identifying the Syntax of the Server

To use the Pulse Kernel as a DDE Client that exchanges data with a
generic DDE Server, obtain the documentation of the DDE Server in
question and identify from it its server name and the names of its topics
and items. You will need those names to reference server data in the
Address box of database blocks (in Database Explorer).

Pulse 4.12 User Guide 1046

Configuration - Creating Database Blocks
NOTE Before creating database blocks referencing the DDE Server,
make sure that the DDE Server runs and that the topic
referenced is available.

To reference data of a generic DDE server when creating a block in

Database Explorer, enter the data reference in the Address box of the
block in the following format:

server|topic!item

Example

To access cell R1C1 of the Excel worksheet C:\EXCEL\P-CIM\SRVR.XLS, enter:

EXCEL|C:\EXCEL\P-CIM\SRVR.XLS!R1C1

Configuring and using the Syntax Shortcut

If you have to reference items of the same server and topic, you can use
the shortcut described below. It can save you typing the server and topic
names by:

1 Assigning a phantom port number for the server and topic

combination.

2 Entering the phantom port number in PCIMUSER.INI and re-starting

Pulse.

3 Identifying the server and topic combination by that port number -

in all applications working with Pulse (such as OPC Browser).

Assigning a Pulse Port to Server

Assign a "phantom" Pulse port number (for example, in the range 5-9) to
the DDE Server. You will reference this server by that port number in
Pulse and associated applications.

Pulse 4.12 User Guide 1047

Specifying the DDE Server in PCIMUSER.INI
Enter the "phantom" port setting in the file pcimuser.ini, section
[DBSRDDEIOPORTS], in the format shown below:

port=++server|topic!

port Phantom port number assigned to this DDE

server

= The equal sign character

++ Two plus sign characters

server The server name of the DDE server

| Vertical bar character

topic The topic name of the DDE server

! Exclamation mark character

Example

To reference Excel with the worksheet C:\EXCEL\P-CIM\SRVR.XLS as

phantom port 8, enter:

8=++EXCEL|C:\EXCEL\P-CIM\SRVR.XLS!

Restarting the Database Server

Restart the Pulse Server so that it reads the changed settings in
pcimuser.ini.

Using Pulse Kernel as a DDE Server

The Pulse Kernel can function as a DDE server. It completes the server-
end of Advise, Request, and Poke exchanges initiated by the DDE Client
applications, such as Microsoft Excel.

Starting the Pulse Kernel

The Pulse Server must be running in order to be used as a DDE server.

Pulse 4.12 User Guide 1048

Referencing Data Items
The Pulse Kernel has three topics: PCIM, VB, and SYSTEM (not case-
sensitive). The first two are identical in contents - use VB from Visual
Basic. The latter contains "directory" information.

Referencing Data Items of Topic PCIM

The topic PCIM contains items associated directly or indirectly with the
"field": Database blocks, driver addresses (PLC registers), internal
(dummy) variables, system variables, and special functions. The syntax of
the Item specification of each such class is overviewed below.

Database Blocks Specify the block name (as configured in the

Database Explorer) to create a DDE link to the
real-time value of the block. You may also
access configuration, status, and derived values
associated with blocks by referencing
blockname.fieldname, see Dot Fields.

Driver Addresses Specify the Direct Access syntax indicated in

the respective driver guide. The generic syntax
is:

Port:PLC:Address or Port:PLC:Address:Bit

Internal (Dummy) Specify the type ("A" for analog, "D" for
Variables digital), a colon (:), and the number. For
example:

Analog values: A:1, A:2, A:3, and so on

Digital values: D:1, D:2, D:3, and so on

System Variables Specify the name of the system variable (their

names start with a dollar sign, e.g., $Time),
see System Dollar Variables for complete listing
and detailed description.

Functions Specify the function and its arguments, see

@ Functions.

Online Conversions Specify the function and its arguments, see

Defining Conversion Functions.

Pulse 4.12 User Guide 1049

Using Microsoft Excel as Client
This section contains guidelines for using Microsoft Excel as a client of the
Pulse (DDE) Server.

Reading Data
DBSR or Alarm Publisher or Datasheet Publisher data is read into a
worksheet cell by simply referencing it in the formula, in the format shown
below.

=PulseDDE|DBSR.PCIM!'itemname'

or

PulseDDE|PfwAlarmNG!ActNack(Functional)

Enclose the name of the item in single quotes when it contains

punctuation marks.

Writing Data
You must use the POKE function in a macro sheet to write to DBSR. There
are two steps, illustrated below.

Log in to DBSR

This preliminary step is required to write to database blocks and their dot
fields, and it has to be done once only, at the beginning of the session.

sch=INITIATE("DBSR","PCIM")

=POKE(sch,"$Login",A17)

=TERMINATE(sch)

pcim,pcim

 Statement 1 initiates the conversation. The sch variable (any name

will do) identifies the conversation.

 Statement 2 writes (pokes). Note that the value (3rd argument) is

specified by reference only. In this case, it references cell A17 that
contains "pcim,pcim" - the user name and associated password
(installed default for level 0).

 Statement 3 terminates the conversation.

Pulse 4.12 User Guide 1050

Writing the Data

This step does the actual writing to the DBSR item (or items).

sch=INITIATE("DBSR","PCIM")

=POKE(sch,"VALVE1",SHEET2.XLS!C12)

=TERMINATE(sch)

 Statement 1 initiates the conversation. The sch variable (any name

will do) identifies the conversation.

 Statement 2 writes (pokes). Note that the value (3rd argument) is

specified by reference only. Repeat this step as many times as
required - before terminating the conversation.

 Statement 3 terminates the conversation.

Syntax for Writing Data to Microsoft Excel from

Pulse
Macro Code:

Private Sub Worksheet_Change(ByVal Target As Range)

channelNumber = Application.DDEInitiate(app:="DBSR", topic:="PCIM")

Set rangetopoke = Worksheets("Sheet1").Range("A1")

Application.DDEPoke channelNumber, "A:25", rangetopoke

Application.DDETerminate channelNumber

End Sub

Legend:

• “Sheet1” = name of your sheet

• “A1” = name of request cell

• “A:25” = restoring the value from your request cell (A1).

Each change updates your item (A:25)

Pulse 4.12 User Guide 1051

Accessing Excel Data over DDE
Reference Excel recognizes cell references over a DDE link
in only two formats:

 The "R1C1" format (the Lotus-like format

"A1" is not supported).

 The name given to the cell.

Reading Excel returns over DDE the "as displayed" value

(as opposed to the "calculated" value). This is
important when:

 The value is truncated or rounded off

according to the Number Format applied.

 The value is displayed in Excel as

"#####" - because it cannot be
displayed in full within the present width
of the cell.

Writing Writing to a cell overwrites the previous

contents of the cell with the value written to.
This can potentially overwrite a formula with a
plain value!

Communicating with the DDE Server from Pulse on

Windows 7
In the Windows Vista operating system and higher versions, Pulse runs on
the System account while other software such as Excel is running on the
User account.

To run the DDE connection in Pulse, the DDE Server must run in the
System account. In order for the DDE Server to run in the System
account, the DDE server has to be added to the Pulse startup.

To add the DDE Server to Pulse Startup

1 Go to the Project Setup window by clicking Start > Programs >

AFCON Pulse > Pulse Setup > Project.

2 In the Project Setup window access the path PCIM-Software >

PCIM[10.xx] > Projects > PulseProject > Settings > Kernel
Startup and click Startup Modules - Sorted list.

The Startup Modules - Sorted list window is displayed.

Pulse 4.12 User Guide 1052

3 Define the Program Parameters as follows:

• Program Name: runlnk (you have to browse for this file)

• Arguments: D:\ddeServer.xls or D:\ddeServer.xlsx or

D:\MyDDEServer.exe (where ‘D’ is the drive name)

• Mode: <run as> (select the <run as> option from the
Mode drop-down list.

4 Click Add to add the DDE Server to run in the System account.

5 Click Save to keep the settings.

6 Restart Pulse.

7 In the Pulse Data Scope, the DDE syntax has to be as shown in the
image below.

Pulse 4.12 User Guide 1053

DDE Commands
DDE commands set the value of an advised data item. They share a
common syntax described below. Examples are provided with individual
command descriptions.

Set Sets a DDE variable to a certain value

Inc Increments a DDE variable by a certain amount

Dec Decrements a DDE variable by a certain

amount

Inv Inverts a digital DDE variable (0 to 1, 1 to 0)

Syntax

The typical DDE command syntax is illustrated below:

[DDE Command] [Item Address] [Value]

or

[DDE Command] [Item Address 1] [Value of Item Address 2]

DDE Command Command to set the value of the data item,

such as Set, Inc, Dec, or Inv.

Item Address Variable affected by the command.

Value Specify a value or constant for this argument.

Pulse 4.12 User Guide 1054

DDE Command - Set
Use this command to set the value of the first specified DDE data item to
either the specified value or the value of a second DDE data item that
follows in the argument.

If the value or a second DDE item is not specified, the default value = 1.

NOTE This command uses the last known value of the destination
variable - when it is a bit of a word (and of the "value" - when
it is a variable as well) - in order to work as expected, make
sure that Pulse has at least one recent value of that variable,
see Coordinating Read-Change-Write Commands.

Examples

To set item a:1 to value 7

Set |!a:1 7

To set item a:1 to the value of item a:2

Set |!a:1) ?GetValue(|!a:2)?

To set block AV1 to the value of cell R3C4 in Excel worksheet

C:\abc\xyz.xls

Set (|!AV1) ?GetValue(EXCEL|C:\abc\xyz.xls!R3C4)?

To set block SP4 (type String Pointer) to value abcxyz

Set |!SP4 ?GetValue("abc xyz")?

To set block SP4 to value abc"xyz

Set |!SP4 ?GetValue("abc””xyz")?

Pulse 4.12 User Guide 1055

DDE Command - Inc
Use this command to increase the value of the first specified DDE data
item by either the specified value or the value of a second DDE data item
that follows in the argument.

If the value or a second DDE item is not specified, the default value = 1.

NOTE This command uses the last known value of the destination
variable - when it is a bit of a word (and of the “increment” -
when it is a variable as well) - in order to work as expected,
make sure that Pulse has at least one recent value of that
variable, see Coordinating Read-Change-Write Commands.

DDE Command - Dec

Use this command to decrease the value of the first specified DDE data
item by either the specified value or the value of a second DDE data item
that follows in the argument.

If the value or a second DDE item is not specified, the default value = 1.

NOTE This command uses the last known value of the destination
variable - when it is a bit of a word (and of the "decrement" -
when it is a variable as well) - in order to work as expected,
make sure that Pulse has at least one recent value of that
variable, see Coordinating Read-Change-Write Commands.

DDE Command - Inv

Use this command to digitally invert the specified DDE data item. For
digital values, 0 is inverted to 1, and 1 to 0. For analog values, 0 is
inverted to 1, and non-zero values are inverted to 0.

This command uses the last known value of the destination variable - in
order to work as expected, make sure that Pulse has at least one recent
value of that variable, see Coordinating Read-Change-Write Commands.

Pulse 4.12 User Guide 1056

Coordinating Read-Change-Write Commands
NOTE The DDE button commands Dec, Inv, Inc and Set operate
using the last known value of the variables referenced in the
command - in order to work as expected, make sure that Pulse
has a recent value of each variable referenced in the
command.

To have a recent value of a variable, Pulse must read it continually (or at

least very shortly before the value is required elsewhere).

For Pulse to read a variable continuously, configure one of the following:

 Reference that address in an Analog Value or Digital Value block -

when the address is on scan, such a block is solved continually,
causing the current data value to be read continually.

 Reference that address as an Operator Workstation AutoAction

"Trigger" - triggers are evaluated continually (regardless of whether
AutoActions are enabled or not), causing the current data value to
be read continually, see the procedure below to configure an
AutoAction for this purpose.

To configure a trigger-only AutoAction

1 In the Developer Workstation, go to the Manage ribbon and click

Operator Personalization.

The Operator Personalization Settings dialog box is displayed.

Pulse 4.12 User Guide 1057

2 In the AutoActions tab, go to the table on the lower part of the
tab and type the AutoAction’s name into the Name cell.

3 In the Trigger cell, enter the item that you want to be read
continually.

4 In the Action cell, enter the item of the action that you want the
AutoAction to carry out.

5 Click OK to save the AutoAction and close the Operator

Personalization Settings dialog box.

Pulse 4.12 User Guide 1058

Dot Fields
Dot fields provide access to configuration parameters of database tags
(blocks, direct access addresses, and dummy variables), and to real-time
value and status. Dot fields extend the tag syntax and provide access to
particular information items associated with the tags. The syntax is:

TAGNAME.DOTFIELD

NOTE The names of the dot fields are not case sensitive - certain
letters are shown here in upper case to enhance readability.

For example:

The Low alarm threshold of an analog value block named TEMP5 is

accessed as TEMP5.AlmLow.

The validity (for example, “OK” or “Bad”) of the value of the same
block is accessed as TEMP5.ValueOK, and this returns 1 for "OK"
or 0 for "Bad".

Pulse Dot Fields

 Dot Field .AccumStarts

 Dot Field .AccumTime

 Dot Field .Ack

 Dot Field .AckAct

 Dot Field .Address

 Dot Field .AlmAct

 Dot Field .AlmDB

 Dot Field .AlmEnable

 Dot Field .AlmHigh

 Dot Field .AlmHiHi

 Dot Field .AlmLoLo

 Dot Field .AlmLow

 Dot Field .AlmROC

 Dot Field .AlmStatus

 Dot Field .AlmType

Pulse 4.12 User Guide 1059

 Dot Field .AlmZone

 Dot Field .BlkDesc

 Dot Field .BlkStatus

 Dot Field .Clamp

 Dot Field .ClampHigh

 Dot Field .ClampLow

 Dot Field .ComDrvBit

 Dot Field .ComDrvDatPtr

 Dot Field .ComDrvIoCd

 Dot Field .ComDrvName

 Dot Field .ComDrvPort

 Dot Field .ComDrvRef

 Dot Field .ComDrvStation

 Dot Field .DstBlkFlg

 Dot Field .DstBlkName

 Dot Field .DstBlkSeg

 Dot Field .DstBlkType

 Dot Field .EguConv

 Dot Field .EguHigh

 Dot Field .EguLow

 Dot Field .EguUnit

 Dot Field .Enable1

 Dot Field .Enable2

 Dot Field .Enable3

 Dot Field .Enable4

 Dot Field .Enable5

 Dot Field .HTFactor

 Dot Field .HTPtr

 Dot Field .HTStep

 Dot Field .HTtFactor

Pulse 4.12 User Guide 1060

 Dot Field .IntLckDst

 Dot Field .IntLckEnb

 Dot Field .Invert

 Dot Field .OutVal

 Dot Field .PassWdLvl

 Dot Field .PhaseTime

 Dot Field .Reg1

 Dot Field .Reg2

 Dot Field .Reg3

 Dot Field .Reg4

 Dot Field .Reg5

 Dot Field .ScaleHigh

 Dot Field .ScaleLow

 Dot Field .ScanCnt

 Dot Field .ScanStatus

 Dot Field .ScanTime

 Dot Field .SmoothAcc

 Dot Field .SmoothCurr

 Dot Field .SmoothInit

 Dot Field .Status

 Dot Field .SubType

 Dot Field .TagClass

 Dot Field .TagType

 Dot Field .TagVar

 Dot Field .TextOff

 Dot Field .TextOn

 Dot Field .UsePlcTime

 Dot Field .Value

 Dot Field .ValueOK

Pulse 4.12 User Guide 1061

Saving Changes Made at Runtime
You can save the current database configuration during runtime - to
record changes made via Block Fields. To do this, you can use one of the
following methods:

 Adding a SaveDB activity to a workflow, see Working with the

Workflow Manager.

 Add the following to the Item field of an action button or

AutoAction:

Set |!$SaveDB 1

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AccumStarts

Applicable tags AV, DV

Stands for Time since Maintenance counter of changes

started (counter state changes from 0 to 1).

Available if the Maintenance option is enabled

for the block.

Type Read, analog, integerl

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1062

Dot Field .AccumTime
Applicable tags AV, DV

Stands for Accumulated time. Retrieves the accumulated

period in which the block value is non-zero
since the Kernel started collecting maintenance
information about the block. When the block
changes from a non-zero value to zero (or the
Pulse server normally closes), ACCUM_TIME is
set as:

CurrentSystemTime START_TIME.

Available if the Maintenance option is enabled

for the block.

Type Read, analog, integerl

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1063

Dot Field .Ack
Applicable tags AV, DV, BIT, CL, BL

Stands for Alarm condition acknowledged state

Type Read/Write, digital

Read State, data type per clipboard format

requested by client:

Table 1:

not
acknowledged acknowledged

Oper. Workstation
Property

Output Text - AlmNAck AlmAck

Formatted text

All other 1 0

3rd party client - "1" "0"

CF_TEXT

Write To acknowledge, data type per clipboard

format requested by client:

Table 2:

acknowledged

Oper. Workstation
Property

Input Text - AlmAck or 1

Formatted text

All other 1

3rd party client - "1"

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1064

Dot Field .AckAct
Applicable tags AV, DV, BIT, CL, BL

Stands for Alarm is active and not acknowledged

Type Read, digital

Read Per clipboard format requested by client:

Table 3:

NO YES

Oper. Workstation
Property

Output Text - NORMAL AlmActNack

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Address

Applicable tags AV, AP, DV, DP

Stands for Address of block

Type Read, analog/digital

Read Per clipboard format requested by client

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1065

Dot Field .AlmAct
Applicable tags AV, DV, BIT, CL, BL

Stands for Alarm condition: normal or active

Type Read, digital

Read Per clipboard format requested by client:

Table 4:

normal active

Oper. Workstation
Property

Output Text - NORMAL AlmAct

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmDB

Applicable tags AV, CL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1066

Dot Field .AlmEnable
Applicable tags AV, DV, BIT, CL, BL

Stands for Alarm processing enabled or disabled

Type Read/Write, digital

Read State, data type per clipboard format

requested by client:

Table 5:

disabled enabled

Oper. Workstation
Property

Output Text - AlmDsb AlmEnb

Formatted text

All other 0 1

3rd party client - “0” “1”

CF_TEXT

Write The command (data type same as Read)

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmHigh

Applicable tags AV, CL

Stands for High alarm threshold

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1067

Dot Field .AlmHiHi
Applicable tags AV, CL

Stands for Extreme high alarm threshold

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmLoLo

Applicable tags AV, CL

Stands for Extreme low alarm threshold

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmLow

Applicable tags AV, CL

Stands for Low alarm threshold

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1068

Dot Field .AlmROC
Applicable tags AV

Stands for ROC (rate of change) alarm threshold

Type Read, analog, float

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmStatus

Applicable tags AV, DV, BIT, CL, BL

Stands for Unique alarm status

Type Read, analog, integer, special

Read Per clipboard format requested by client:

Table 6:

AV Block no alarm Low High ROC

Oper. Workstation
Property

Output Text - NORMAL LOW HIGH ROC

Formatted text

All other 0 6 7 8

3rd party client - “0” “6” “7” “8”

CF_TEXT

Pulse 4.12 User Guide 1069

 Table 7:

CL Block no alarm Low High

Oper. Workstation
Property

Output Text - NORMAL LOW HIGH

Formatted text

All other 0 6 7

3rd party client - “0” “6” “7”

CF_TEXT

Table 8:

DV/BIT, BL Block no alarm Low High COS

Oper. Workstation
Property

Output Text - NORMAL LOW HIGH COS

Formatted text

All other 0 9 10 11

3rd party client - “0” “9” “10” “11”

CF_TEXT

Table 9:

AL Block any

Oper. Workstation
Property

Output Text - NORMAL

Formatted text

All other 0

3rd party client - “0”

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1070

Dot Field .AlmType
Applicable tags DV, BIT, BL

Stands for Alarm type: OFF, ON, COS

Type Read, analog, integer, special

Read Per clipboard format requested by client

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .AlmZone

Applicable tags AV, DV, CL, BL

Stands for Alarm zone ordinal number 1 to 10

Type Read, analog, integer

Read Number, 1 - 10

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .BlkDesc

Applicable tags AV, DV, CL, BL, BIT

Stands for Description - the string

Type Read/Write, String

Read AV block 39 chars, DV block 39 chars, CL block

25 chars, BL block 25 chars

Write AV block 39 chars, DV block 39 chars, CL block

25 chars, BL block 25 chars

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1071

Dot Field .BlkStatus
Applicable tags AV, AP, DV, DP, BIT, CL, BL, SP, AL

Stands for Status, abbreviated, one of the following

indications:

On scan, Off scan, Database Error, I/O Error,

Fatal I/O Error, LGV Error, OK

Type Read, analog, integer, special

Read Per clipboard format requested by client:

Table 10:

Database Fatal I/O

On Scan Off Scan Error Error

Oper. Workstation
Property

Output Text - ScanOn ScanOff ErrorDB FatalIO

Formatted text

All other 1 2 3 4

3rd party client - “1” “2” “3” “4”

CF_TEXT

Table 11:

IO Error LGV Error OK

Oper. Workstation
Property

Output Text - ErrorIO ErrorLG V OK

Formatted text

All other 5 6 7

3rd party client - “5” “6” “7”

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1072

Dot Field .Clamp
Applicable tags AV

Stands for Clamp enabled or disabled

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 12:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ClampHigh

Applicable tags AV

Stands for Clamp High limit

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1073

Dot Field .ClampLow
Applicable tags AV

Stands for Clamp Low limit

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvBit

Applicable tags DV

Stands for Bit # in Address

 0 if no bit number is specified in Address

 1-16 as specified in Address

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvDatPtr

Applicable tags AV, AP, DV, DP

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvIoCd

Applicable tags AV, AP, DV, DP

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1074

Dot Field .ComDrvName
Applicable tags AV, AP, DV, DP, SP

Stands for Driver name implied from port number section

in Address

Type Read, string

Read String, 6 chars. max.; DM = "DUMMY"

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvPort

Applicable tags AV, AP, DV, DP, SP

Stands for Port number section in Address - 0-255; DM =

0

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvRef

Applicable tags AV, AP, DV, DP, SP

Stands for Port number section in Address; DM = 0

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ComDrvStation

Applicable tags AV, AP, DV, DP, SP

Stands for Station number section in Address - 0-255

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1075

Dot Field .DstBlkFlg
Applicable tags AV, DV, CL, BL

Stands for Targetlogic, encoded

Type Read/Write, analog, integer

Read Number

Write Number, plausibility against other block fields

is not checked

Table 13:

Analog Destination Digital Destination Code

Input Input 0

Output Output 1

Alarm Enable Alarm Enable 2

Alarm High Alarm Type ON 3

Alarm Low Alarm Type OFF 4

Alarm ROC Alarm COS 5

S/T Factor N/A 6

H/T Factor N/A 7

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .DstBlkName

Applicable tags AV, DV, CL, BL

Stands for Name of target block

Type Read, string

Read String, 9 char. max.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1076

Dot Field .DstBlkSeg
Applicable tags AV, DV, CL, BL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .DstBlkType

Applicable tags AV, DV, CL, BL

Stands for Target block type, encoded

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .EguConv

Applicable tags AV

Stands for Conversion, encoded

0=NONE, others 1-n, driver dependent

Type Read/Write, analog, integer

Read Number, 0-n

Write Number, 0-n, plausibility against other block

fields is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1077

Dot Field .EguHigh
Applicable tags AV, AP, CL

Stands for High scale

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .EguLow

Applicable tags AV, AP, CL

Stands for Low scale

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .EguUnit

Applicable tags AV

Stands for Engineering units

Type Read/Write, string

Read 4 chars. max.

Write 4 chars. max.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1078

Dot Field .Enable1
Applicable tags AL

Stands for Address 1 Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 14:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1079

Dot Field .Enable2
Applicable tags AL

Stands for Address 2 Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 15:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1080

Dot Field .Enable3
Applicable tags AL

Stands for Address 3 Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 16:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1081

Dot Field .Enable4
Applicable tags AL

Stands for Address 4 Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 17:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1082

Dot Field .Enable5
Applicable tags AL

Stands for Address 5 Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 18:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .HTFactor

Applicable tags AV, CL

Stands for H. T. Factor - 0-255

Type Read/Write, analog, integer

Read Number, 0-255

Write Number, 0-255 (applicable only if block was

originally configured with H. T. factor 1-255).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1083

Dot Field .HTPtr
Applicable tags AV, CL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .HTStep

Applicable tags AV, CL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .HTtFactor

Applicable tags AV, CL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .IntLckDst

Applicable tags AV, DV, CL, BL

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1084

Dot Field .IntLckEnb
Applicable tags AL

Stands for Interlock Enable

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 19:

disabled enabled

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1085

Dot Field .Invert
Applicable tags AV, AP, DV, DP

Stands for Invert, Yes or No, encoded

Type Read/Write, digital

Read Per clipboard format requested by client:

Table 20:

No Yes

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .OutVal

Applicable tags AV, AP, DV, DP

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1086

Dot Field .PassWdLvl
Applicable tags AV, AP, DV, DP, SP

Stands for Access level - 0-99

Type Read/Write, analog, integer

Read Number

Write Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .PhaseTime

Applicable tags AV, AP, DV, DP, CL, BL, SP, AL

Stands for Phase time in time units, 1-255

AP, DP and SP return 1

Type Read, analog, float

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Reg1

Applicable tags AL

Stands for Value of Address 1 (16 bits)

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1087

Dot Field .Reg2
Applicable tags AL

Stands for Value of Address 2 (16 bits)

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Reg3

Applicable tags AL

Stands for Value of Address 3 (16 bits)

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Reg4

Applicable tags AL

Stands for Value of Address 4 (16 bits)

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Reg5

Applicable tags AL

Stands for Value of Address 5 (16 bits)

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1088

Dot Field .ScaleHigh
Applicable tags AV, AP, CL

Stands for High scale

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ScaleLow

Applicable tags AV, AP, CL

Stands for Low scale

Type Read/Write, analog, float

Read Number

Write Number, plausibility against other block fields

is not checked.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1089

Dot Field .ScanCnt
Applicable tags AP, DP, SP

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .ScanStatus

Applicable tags AV, AP, DV, DP, BIT, CL, BL, SP, AL

Stands for Block scanning - On or Off

Type Read/write, digital

Read Per clipboard format requested by client:

Table 21:

Off On

Oper. Workstation
Property

Output Text - OFF ON

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

Write The setting (data type same as Read).

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1090

Dot Field .ScanTime
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL

Stands for Scan time in time units, 1-255

AP, DP and SP return 1

Type Read, analog, integer

Read Number

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .SmoothAcc

Applicable tags AV

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .SmoothCurr

Applicable tags AV

Stands for Internal parameter

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .SmoothInit

Applicable tags AV

Stands for Smoothing

Type Read/Write, analog, integer

Read Number, 1-255

Write Number, 1-255

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1091

Dot Field .Status
Applicable tags AV, AP, DV, DP, CL, BL, SP, BIT

Stands for Status, abbreviated

Type Read, analog, integer

Read Number that represents 16 binary flags, Some

flags has special meaning for CL and BL blocks.
See also notes for applicability to particular
block types.

DM & IO tags return .Status = 0

Table 22:

AV/ AP/ DV/

DP/ SP BL/ CL AL

Bit Hex Indicates Indicates Indicates

0 0001 In use In use In use

1 0002 In scan state In scan state In scan state

2 0004 In scan chain In scan chain In scan chain

3 0008 N/A N/A N/A

4 0010 Error (non I/O) Error Error (non I/O)

5 0020 I/O fatal error Fatal error I/O fatal error

6 0040 I/O error N/A I/O error

7 0080 LGV error Target error N/A

8 0100 Target Target N/A

configured 1 configured

9 0200 Short Term Short Term Pending Alarms

Trend 2 Trend 3

10 0400 Hist. Trend Hist. Trend N/A

Support Support

11 0800 Target Error 4 Target Error N/A

12 1000 N/A Formula Error N/A

Pulse 4.12 User Guide 1092

 AV/ AP/ DV/
DP/ SP BL/ CL AL

Bit Hex Indicates Indicates Indicates

13 2000 Never scanned - Never scanned - Never scanned -

transitional transitional transitional
indication indication indication
immediately immediately immediately
after boot after boot after boot

14 4000 Is scanned now Is scanned now Is scanned now

15 8000 N/A N/A N/A

NOTES

1 AV, DV, BL, CL only

2 AV only

3 CL only

4 AV, DV only

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1093

Dot Field .SubType
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL, BIT

Stands for Specific type, encoded 0-20

Type Read, analog, integer

Read See table below

Table 23:

TagClass TagType SubType

AV 1 1 0

AP 1 1 1

DV 2 1 2

DP 2 1 3

CL 1 1 4

BL 2 1 5

AL 1 1 8

BIT 2 1 20

SP 3 1 9

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1094

Dot Field .TagClass
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL, BIT

Stands for Class - Analog, Digital, or String, encoded as 1,

2, or 3

Type Read, analog, integer

Read See table below

Table 24:

TagClass TagType SubType

AV 1 1 0

AP 1 1 1

DV 2 1 2

DP 2 1 3

CL 1 1 4

BL 2 1 5

AL 1 1 8

BIT 2 1 20

SP 3 1 9

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1095

Dot Field .TagType
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL, BIT

Stands for Type - Block, I/O, or Dummy, encoded as 1, 2,

or 3

Type Read, analog, integer

Read See table below

Table 25:

TagClass TagType SubType

AV 1 1 0

AP 1 1 1

DV 2 1 2

DP 2 1 3

CL 1 1 4

BL 2 1 5

AL 1 1 8

BIT 2 1 20

SP 3 1 9

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1096

Dot Field .TagVar
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL, BIT

Stands for Type of value presentation (DDE Clipboard

Format) - encoded as 1 to 7

Type Read, integer

Read 1=Byte; 2=Short Integer; 3=Long Integer;

4=Float; 5=String; 6=Memory; 7=Double
Float

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .TextOff

Applicable tags DV, DP, BL,BIT

Stands for Text for 0.

Type Read/Write, string (Read for BIT)

Read String, 8 chars. max.

Write String, 8 chars. max.

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .TextOn

Applicable tags DV, DP, BL,BIT

Stands for Text for 1.

Type Read/Write, string (Read for BIT)

Read String, 8 chars. max.

Write String, 8 chars. max.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1097

Dot Field .UsePlcTime
Applicable tags AV, AP, DV, DP, BL,BIT

Stands for Displays the time stamp received from the PLC

Type Read, string

Read Date format, time format

For a full list of Dot Fields, see Pulse Dot Fields.

Dot Field .Value

Applicable tags AV, AP, DV, DP, CL, BL, SP, BIT

Stands for The tag value

Type Read - digital, analog or string as applicable

Read Same as the value for the tag - digital values

return 0 and 1 in all clipboard formats.

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1098

Dot Field .ValueOK
Applicable tags AV, AP, DV, DP, CL, BL, SP, AL, BIT

Stands for The validity of the tag value - BAD or OK

Type Read, digital

Read Per clipboard format requested by client:

Table 26:

BAD OK

Oper. Workstation
Property

Output Text - BAD OK

Formatted text

All other 0 1

3rd party client - "0" "1"

CF_TEXT

For a full list of Dot Fields, see Pulse Dot Fields.

Pulse 4.12 User Guide 1099

Dollar Variables
System (Dollar) variables are provided from within the Pulse Kernel and
are operational even when the database is not being solved (for example,
when the Database Publisher service was started from within Windows
without first starting up Pulse).

NOTE Unless otherwise specified, system variables are read-only.

Names of system variables are not case-sensitive. System

variables are served every 1000 milliseconds.

Variables marked as Internal are for internal system purposes and

should not be modified.

This section contains the following topics:

 Pulse Dollar Variables

 Accessing Complex Dollar Variables

 Week Number Variables

 Old Square Brackets Syntax

Pulse Dollar Variables

 $Accum

 $AckCnt

 $ActionDbgEnb

 $ActionDbgFileEnb

 $ActiveServerName

 $AdvCnt

 $AdvIndx

 $AdvMax

 $AlarmClk

 $AnchorDate

 $AnlAdvCnt

 $ArchiveNow

 $BitsAdvCnt

 $BWeek

Pulse 4.12 User Guide 1100

 $ByPassMsmQ

 $Century

 $ComputerName

 $CreateDrvrDataFile

 $CWeek

 $Date

 $DateDBF

 $DateStr

 $DATO

 $Day

 $DBAlarms

 $DBHigh

 $DBHist

 $DBHistOVF

 $DBLoad

 $DBSolve

 $DemoHalt

 $DemoMode

 $DemoTime

 $DF

 $DigAdvCnt

 $DispatchAlarm

 $DL

 $DS

 $ExportPriceTags

 $ExportPriceTags

server|topic!

View the list of tags that are counted for license purposes by using advise
item |!$ExportPriceTags in Data Scope and then adding the value ‘1’ to
it.

Pulse 4.12 User Guide 1101

The DbsrPriceTags.txt file is then generated in the project’s Daily Log
folder.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

 $FreeHdrTop

 $FreeMem

 $FreePhysMem

 $GAlarmClk

 $GlobalMessage

 $GMSG

 $GTimer

 $HidePcimIcons

 $Hours

 $IDate

 $IPAddr1

 $IPAddr2

 $IPAddr3

 $IPAddr4

 $IPAddrStr

 $IPPrimary

 $IPSecondary

 $IsClone

 $IsGreen

 $IsHaspBatteryOk

 $IsPassiveRunning

 $IsPulse

 $ItemCnt

 $ItemMax

 $ITime

 $LAA

 $LANA

Pulse 4.12 User Guide 1102

 $LastAlarm

 $LastAlarmAck

 $LastAlarmEx

 $LastAlarmNack

 $LastAlarmZone

 $LastEvent

 $LiteLevel

 $LogIn

 $LogOut

 $MasterNodeNum

 $MaxNodes

 $Minutes

 $Month

 $MSeconds

 $NodeNum

 $Nodes

 $NoSekNodes

 $PcimVer

 $Ping

 $Port

 $ProjectName

 $QueryOpen

 $RDate

 $ReadHisSql

 $ReleaseVIP

 $ReLoadDB

 $ReMax

 $ReStartDr

 $ReTblTop

 $Rev

Pulse 4.12 User Guide 1103

 $RevDate

 $RTime

 $SDTSolveEnable

 $Seconds

 $SEK

 $SekNodes

 $ServerActive

 $ServerRole

 $ServerStatus

 $SignOff

 $SignOn

 $SLastEvent

 $StartDate

 $StdDocumentName

 $Ticks

 $Time

 $Timer

 $TimeStr

 $Toggle

 $TotalBlkAlmDisable

 $TotalBlkAlmEnable

 $TotalBlkAlmOn

 $TotalBlkNotAck

 $TotalBlkScanOff

 $TotalBlkScanOn

 $TotalIOAdvised

 $TotalIOCount

 $TotalNodes

 $TotalProjectIo

 $Type

Pulse 4.12 User Guide 1104

 $UserAlarm

 $Ver

 $WDay

 $WMI

 $YDay

 $Year

 $YWeek

 $ZDate

Pulse 4.12 User Guide 1105

Accessing Complex Dollar Variables
The complex dollar variables:

$Accum Array of 32 timers, 32-bit, bit-

addressable

$AlarmClk Increment a value when time is HHMMSS

$GTimer Programmable timer

$Toggle Array of 32 time-based toggles

and their dot fields can be written to (using a Poke type of transaction)
only after the variable itself was (and is still being) read over DDE (using
an Advise type of transaction).

Tip

In order to set such variables and their dot fields from the Operator
Workstation (e.g., using the command Set in an Action Button), configure
also an Animation property (e.g., Output Text, Size, Fill, etc.) accessing
the variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1106

Week Number Variables
server|topic!

The table below illustrates the functioning of $BWeek, $CWeek, and

$YWeek.

Month Dec. Jan. Jan. Jan. Jan. Jan. Jan. Jan. Jan.

Day 31 1 2 3 4 5 6 7 8

$YWeek 52/53 1 1 1 1 1 1 1 2

Week Day Wed. Thu. Fri. Sat. Sun. Mon. Tue. Wed. Thu.

$BWeek 52/53 52/53 1 1 1 2 2 2 2

$CWeek 52/53 1 1 1 1 2 2 2 2

Week Day Tue. Wed. Thu. Fri. Sat. Sun. Mon. Tue. Wed.

$BWeek 52/53 52/53 1 1 1 1 2 2 2

$CWeek 52/53 1 1 1 1 1 2 2 2

Week Day Mon. Tue. Wed. Thu. Fri. Sat. Sun. Mon. Tue.

$BWeek 52/53 52/53 1 1 1 1 1 2 2

$CWeek 52/53 1 1 1 1 1 1 2 2

Week Day Sun. Mon. Tue. Wed. Thu. Fri. Sat. Sun. Mon.

$BWeek 52/53 52/53 1 1 1 1 1 1 2

$CWeek 52/53 1 1 1 1 1 1 1 2

Week Day Sat. Sun. Mon. Tue. Wed. Thu. Fri. Sat. Sun.

$BWeek 52/53 52/53 1 1 1 1 1 1 1

$CWeek 52/53 1 2 2 2 2 2 2 2

Week Day Fri. Sat. Sun. Mon. Tue. Wed. Thu. Fri. Sat.

$BWeek 52/53 52/53 52/53 1 1 1 1 1 1

$CWeek 52/53 1 1 2 2 2 2 2 2

Pulse 4.12 User Guide 1107

Month Dec. Jan. Jan. Jan. Jan. Jan. Jan. Jan. Jan.

Week Day Thu. Fri. Sat. Sun. Mon. Tue. Wed. Thu. Fri.

$BWeek 52/53 52/53 52/53 52/53 1 1 1 1 1

$CWeek 52/53 1 1 1 2 2 2 2 2

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Old Square Brackets Syntax

The old syntax with square brackets is still supported, namely:

 Syntax: $Accum[0], $Accum[1] to $Accum[31]

 Syntax: $DF[0] (or $DF[]), $DF[1] to $DF[99]

 Syntax: $DL[0] (or $DL[]), $DL[1] to $DL[99]

 Syntax: $DS[0] (or $DS[]), $DS[1] to $DS[9]

 Syntax: $GAlarmClk[0], $GAlarmClk[1] to $GAlarmClk[31]

 Syntax: $GTimer[0], $GTimer[1] to $GTimer[31]

 Syntax: $Toggle[0], $Toggle[1] to $Toggle[31]

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1108

$Accum
server|topic!

The Database Publisher provides an array of thirty-two (32) $Accum

variables. Each $Accum variable is an independent two-stage up counter
driven at each Database Solver cycle. The operation is depicted in the
illustration below.

The variables involved with its operation are:

$Accum Syntax: $Accum0 (or $Accum), $Accum1 to

$Accum31 (the Old Square Brackets Syntax is
still supported)

Type: numeric (long integer) Range: 0 to 4,

294, 967, 295

Read from: present count of second stage

Write to: initial count of second stage

$Accum.Bn Syntax: .B01 to .B09 (or .B1 to .B9), .B10 to

.B32

Type: numeric (integer)

Range: 0 to 1

Read from: respective bit of count of second

stage

Write to: respective bit of count of second

stage

Pulse 4.12 User Guide 1109

 $Accum.Cycle Type: numeric (integer)

Range: 0 to 2,147,483,647 (231-1)

Read from: first stage preset

Write to: first stage preset

Default: 1

$Accum.Enable Type: numeric (integer)

Range: 0 to 1

Read from: enable status: 0=disabled, 2 =

enabled

Write to: to enable =1 / to disable = 0

Default: enabled (2)

$Accum.MaxVal Type: numeric (long integer)

Range: 0 to 4,294,967,295 (232-1)

Read from: second stage upper preset

Write to: second stage upper preset

Default: 2,147,483,647 (231-1)

$Accum.MinVal Type: numeric (long integer)

Range: 0 to 4,294,967,295 (232-1)

Read from: second stage lower preset

Write to: second stage lower preset

Default: 0

Pulse 4.12 User Guide 1110

Operation

All the 32 $Accum variables ($Accum0 to $Accum31) exist and start to

operate (see defaults above) when the Pulse Server starts up. Each one
operates independently.

If disabled, the particular $Accum variable is "frozen" - all its dot fields
maintain their respective values indefinitely.

If the particular $Accum variable is enabled:

 The accumulator of the first stage advances every server cycle;

when it reaches $Accum.Cycle, it is reset to 0.

 The accumulator of the second stage ($Accum itself) advances

every cycle of the first stage; when it reaches $Accum.MaxVal, it
is reset to $Accum.MinVal.

Guidelines

Important - see Accessing Complex Dollar Variables.

 To disable (stop) or enable (restart) a particular $Accum, write 0

or resp. 1 to its .Enable field. For example, to stop the second
$Accum, write 0 to $Accum1.Enable.

 To change one of the presets, write the value to the respective

field.

 To read the present count (of the second stage), read the value of
$Accum. For example, to read present count of the second
$Accum, read $Accum1.

 To read a particular bit of the present count (of the second stage),
read the value of $Accum.Bn. For example, to read the least
significant bit of the present count of the second $Accum, read
$Accum1.B1 (or $Accum1.B01).

Pulse 4.12 User Guide 1111

Tips

Bit Toggle Rate When counting, each bit position toggles

between 0 and 1 at a power of 2 rate:

 The least significant bit (.B1 or .B01)

toggles every count.

 The next bit (.B2 or .B02) toggles every

other (second) count.

 The next bit (.B3 or .B03) toggles every

fourth count.

 And so forth

Maximum Value Set the maximum value (.MaxVal) one count

higher than the maximum count required - the
second stage is reset to the minimum value
(.MinVal) instantaneously when it reaches
MaxVal. For example, for a count of 0 through
7, set .MaxVal to 8.

Minimum Value You may set a minimum value higher than the
maximum value - in this case, the counter will
complete one cycle only - it will not recycle. If
the $Accum count was initially lower that
MaxVal, it will advance to MaxVal, then will be
reset to MinVal and stop there indefinitely.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AckCnt
server|topic!

Returns the number of acknowledged operations. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ActionDbgEnb
server|topic!

Writing 0 or 1 to this variable respectively closes or opens the Command

Log Window (DBSR ACTD Window), temporarily overriding the permanent
setting, Action Debug Enable Flag, which is defined in the project’s
pcim.ini file (default is 0).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1112

$ActionDbgFileEnb
server|topic!

Writing 0 or 1 to this variable respectively stops or resumes logging to file

done by the Command Log Window (DBSR ACTD Window), temporarily
overriding the permanent setting Action Debug to File Enable Flag,
which is defined in the project’s pcim.ini file (default is 0).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ActiveServerName
server|topic!

In a Hot Redundancy configuration, this variable returns the active

server’s name as a text string. When written in the active server, the
result is the same as $ComputerName, which returns the queried
computer’s name. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AdvCnt
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AdvIndx
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AdvMax
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1113

$AlarmClk
server|topic!

The system variable $AlarmClk acts as a programmable alarm clock. It

signals at the designated wake up time.

There are 32 $AlarmClk's in the Pulse Kernel, and one $AlarmClk is

available per client, which means that each client that advises on
$AlarmClk has a different variable.

The variables involved with its operation are:

$AlarmClk Type: numeric (long integer)

Range: 0 to 4,294,967,295

Read from: the number of wakeups

Write to: the initial number of wakeups (to

restart the number to a particular value)

$AlarmClk.Enable Type: numeric (integer)

Range: 0 / 1

Read from: its status (OFF or ON) as

respectively 0 or 1

Write to: 0 or 1 to respectively turn it OFF or

ON

$AlarmClk.Repeat Type: digital

Range: 0 /1

Read from: repeat setting (OFF or ON)

Write to: 0 or 1 to respectively turn repeat

setting OFF or ON

$AlarmClk.Ring Type: digital

Range: 0 /1

Read from: ring indication

Write to: ring reset (write 0 to turn off)

Pulse 4.12 User Guide 1114

 $AlarmClk.Wakeup Type: 6 digit time string format HHMMSS
(hours, minutes and seconds in military
notation)

Range: 000000 to 235959

Read from: the designated wakeup time

Write to: the designated wakeup time

Repeat Mode

Repeat functionality is via the variables: .Repeat and .Ring.

.Repeat Returns/accepts the "repeat" mode setting as 0

or 1

.Ring Returns/accepts the "ring" indication as 0 or 1

In the repeat mode ($AlarmClk.Repeat=1):

 The "alarm clock" rearms itself continually (that is, it does not reset
$AlarmClk.Enable when wake up occurs).

 The "alarm clock" rings by setting $AlarmClk.Ring to 1 at wake up

time. $AlarmClk.Ring stays at 1 until midnight when it resets to 0.
The diagram below illustrates this behavior.

NOTE $AlarmClk.Ring can be reset to 0 during this period, but it

"bounces" back to 1 within approximately 1 second.)

Usage

Important - see Accessing Complex Dollar Variables.

 Create the alarm clock by accessing $AlarmClk via an advise link.

The alarm clock continues to "exist" as long as the link exists.

 Preset the alarm clock to the wakeup time by setting

$AlarmClk.WakeUp to the required value.

 Optionally preset the value of $AlarmClk.

Pulse 4.12 User Guide 1115

 The alarm clock is initially disabled. Enable it by setting
$AlarmClk.Enable to 1.

 Rearm after "wake-up" by setting $AlarmClk.Enable to 1.

Operation

 The value of $AlarmClk is incremented by 1 after the alarm clock

is enabled.

 When the alarm clock reaches wakeup time, it increments by 1 the

value of $AlarmClk and resets $AlarmClk.Enable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AnchorDate
server|topic!

Returns/accepts the anchor date as an eight digit decimal number in the

format YYYYMMDD and is used in conjunction with $IDate and $RDate.

The default anchor date is configured via the token AnchorDate, in section
[PCIMDBSR], in the project’s pcimuser.ini file. The factory default anchor
date is January 1, 1900 (19000101).

Writing to $AnchorDate overrides the setting from the pcimuser.ini file

for the current session only. The Pulse server starts up with the file
setting.

NOTE The Anchor Date feature follows the way date in represented
as a number in Microsoft Excel.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$AnlAdvCnt
Server PFWDRVR topic PCIM - |!

Returns the total number of currently requested Analog items. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1116

$ArchiveNow
server|topic!

Log messages and system messages are archived according to the criteria
defined in the PfwAlDef.ini file section [ARCHIVE] parameter Archive
Enable. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$BitsAdvCnt
Server PFWDRVR topic PCIM - |!

Returns the total number of currently requested items in bits.

For example, if there are 4 requested Analog items, $BitsAdvCnt will

return 64 (i.e., 16 X 4).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$BWeek
server|topic!

Returns the business week number. The first business week is the one
that includes the first working day (Monday-Friday) after January 1st. The
$BWeek count starts at 1 and increments on Monday, see Week Number
Variables. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ByPassMsmQ
server|topic!

Writing 0 or 1 to this variable commands the Database Publisher to send

historical data to, respectively, the MSMQ, or exports the historical data to
a CSV file and places it directly in the SQL database. This option is
applicable when the SQL database supports the Bulk Copy feature and
when the data is being collected for a single SQL table. Read/Write.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1117

$Century
server|topic!

Returns the century. i.e., 21 from the beginning of the year 2001. Read
only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ComputerName
server|topic!

Returns the queried computer’s name in a Hot Redundancy configuration.

Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$CreateDrvrDataFile
server|topic!

Writing to this item commands the Pulse kernel to create a driver data
file, which will be used to during Pulse Server startup to initialize the
kernel with the stored driver data.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$CWeek
server|topic!

Returns the calendar week number. The first calendar week is the one
that includes January 1st between Sunday and Saturday. The $CWeek
count starts at 1 and increments on Monday, see Week Number Variables.
Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Date
server|topic!

Returns computer date represented as a number with the decimal digits in

YYMMDD format. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1118

$DateDBF
server|topic!

Returns the date in the format YYYYMMDD, e.g., 20100102 on January

2nd, 2010. Read only.

This is the format a date is stored in a date-type field of a dBASE (DBF)

file.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DateStr
server|topic!

Returns the date as a string in International Short Date Format. Read

only.

For example, returns "01/02/10" on January 2nd, 2010, if the current

Windows setting is:

Order MDY

Separator / (slash)

Day Leading Zero (selected)

Month Leading Zero (selected)

Century (not selected)

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DATO
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1119

$Day
server|topic!

Returns day (of month) component of computer date as a number with

the decimal digits in DD (1-31) format. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DBAlarms
server|topic!

Writing 0 or 1 to this variable respectively stops or resumes alarm

generation from the database blocks at this station, temporarily overriding
the permanent setting DBHighIssueAlarms (accessible from
[PcimDBSR] section of the project’s pcimuser.ini file.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DBHigh
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DBHist
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DBHistOVF
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1120

$DBLoad
server|topic!

Returns the number of times that the Pulse database was reloaded during
the current Operator Workstation session. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DBSolve
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DemoHalt
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DemoMode
server|topic!

Returns 1 if the product is operated in Demo Mode or 0 if not. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DemoTime
server|topic!

Returns number of minutes remaining in Demo Mode or -1 if not

applicable. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1121

$DF
server|topic!

This is an array of 100 float-type variables. A particular variable is

accessed as $DFn - where "n" is in the range 0-99. $DF0 can also be
referenced as $DF.

The Old Square Brackets Syntax is still supported.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DigAdvCnt
Server PFWDRVR topic PCIM - |!

Returns the total number of currently requested Digital items.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DispatchAlarm
server|topic!

This variable writes Pager/Email enabled alarm messages to the ODBC

buffer in the following format:

Node Æ Zone Æ Date Æ Time Æ TagName Æ AlarmText Æ Value Æ Description

Read Only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$DL
server|topic!

This is an array of 100 long-type variables. A particular variable is

accessed as $DLn - where "n" is in the range 0-99. $DL0 can also be
referenced as $DL.

The Old Square Brackets Syntax is still supported.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1122

$DS
server|topic!

This is an array of 10 string-type variables, each 80 characters long. A

particular variable is accessed as $DSn - where "n" is in the range 0-9.
$DS0 can also be referenced as $DS.

The Old Square Brackets Syntax is still supported.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ExportPriceTags
server|topic!

View the list of tags that are counted for license purposes by using advise
item |!$ExportPriceTags in Data Scope and then adding the value ‘1’ to
it.

The DbsrPriceTags.txt file is then generated in the project’s Daily Log

folder.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$FreeHdrTop
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$FreeMem
server|topic!

Returns the amount of free memory (in bytes). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$FreePhysMem
server|topic!

Returns the amount of free physical memory (in bytes). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1123

$GAlarmClk
server|topic!

The system variable $GAlarmClk acts as a programmable alarm clock. It

signals at the designated wake up time.

There are 32 $GAlarmClk's in the Pulse Kernel, and one $AlarmClk is

available per client, which means that each client that advises on
$AlarmClk has a different variable.

The variables involved with its operation are:

$GAlarmClk Syntax: $GAlarmClk0 (or $GAlarmClk),

$GAlarmClk1 to $GAlarmClk31

The Old Square Brackets Syntax is still

supported. Type: numeric (long integer)

Range: 0 to 4,294,967,295

Read from: the number of wakeups

Write to: the initial number of wakeups (to

restart the number to a particular value)

$GAlarmClk.Enable Type: numeric (integer)

Range: 0 / 1

Read from: its status (OFF or ON) as

respectively 0 or 1

Write to: 0 or 1 to respectively turn it OFF

or ON

$GAlarmClk.Repeat Type: digital

Range: 0 /1

Read from: repeat setting (OFF or ON)

Write to: 0 or 1 to respectively turn repeat

setting OFF or ON

Pulse 4.12 User Guide 1124

 $GAlarmClk.Ring Type: digital

Range: 0 /1

Read from: ring indication

Write to: ring reset (write 0 to turn off)

$GAlarmClk.Wakeup Type: 6 digit time string format HHMMSS

(hours, minutes and seconds in military
notation)

Range: 000000 to 235959

Read from: the designated wakeup time

Write to: the designated wakeup time

Repeat Mode

Repeat functionality is via the variables: .Repeat and .Ring.

.Repeat Returns/accepts the "repeat" mode setting as 0

or 1

.Ring Returns/accepts the "ring" indication as 0 or 1

In the repeat mode ($GAlarmClk.Repeat=1):

 The "alarm clock" rearms itself continually (that is, it does not reset
$GAlarmClk.Enable when wake up occurs).

 The "alarm clock" rings by setting $GAlarmClk.Ring to 1 at wake

up time. $GAlarmClk.Ring stays at 1 until midnight when it resets
to 0. The diagram below illustrates this behavior.

NOTE $GAlarmClk.Ring can be reset to 0 during this period, but it

"bounces" back to 1 within approximately 1 second.)

Usage

 Preset the alarm clock to the wakeup time by setting

$GAlarmClk.WakeUp to the required value.

 Optionally preset the value of $GAlarmClk.

Pulse 4.12 User Guide 1125

 The alarm clock is initially disabled. Enable it by setting
$GAlarmClk.Enable to 1.

 Rearm after "wake-up" by setting $GAlarmClk.Enable to 1.

NOTE You do not have to "create" a $GAlarmClk - all of the array of

32 $GAlarmClk variables exits.

Operation

 The value of $GAlarmClk is incremented by 1 after the alarm clock

is enabled.

 When the alarm clock reaches wakeup time, it increments by 1 the

value of $GAlarmClk and resets $GAlarmClk.Enable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$GlobalMessage
server|topic!

Use this variable to create strings (up to 500 characters) such as Action
commands that are advisable to all nodes on the network.

Maximum range of messages: 100 [0-99]. Range is configured in the

project’s Pcim.ini file>section [PcimDBSR]>parameter
MaxGlobalMessage (default is 32).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$GMSG
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1126

$GTimer
server|topic!

NOTE This variable replaces the obsolete $Timer.

The Pulse Kernel provides an array of thirty two (32) $GTimer variables.
You can configure the number of $GTimer variables (up to 1000
variables) by adding manually the token MaxGTimer to section [PcimDbsr]
in the project’s pcimuser.ini file.

Each $GTimer acts as a 3-stage timer with a 1-second time base. The
operation is depicted in the illustration below.

The variables involved with its operation are:

$GTimer Syntax: $GTimer0 (or $GTimer), $GTimer1

to $GTimer31 (the Old Square Brackets
Syntax is still supported).

Type: numeric (long integer)

Range: 0 to 4,294,967,295

Read from: the number of 3rd stage counts

(=2nd stage rollovers)

Write to: the initial 3rd stage count

Pulse 4.12 User Guide 1127

 $GTimer.Enable Type: numeric (integer)

Range: 0 to 1

Read from: its status (OFF or ON) as

respectively 0 or 1

Write to: 0 or 1 to respectively turn timer OFF

or ON

$GTimer.Reset Type: numeric (integer)

Range: 0 to .StopVal

Read from: the reset value

Write to: restart 1st stage at 0, and set

accumulator (.AccVal) and start value
(.StartVal) of 2nd stage

$GTimer.AccCycle Type: numeric (integer)

Range: 0 to .Cycle

Read from: the current count of 1st stage

Write to: set accumulator of 1st stage

$GTimer.Cycle Type: numeric (integer)

Range: 0 to 4,294,967,295

Read from: the stop count preset of 1st stage

Write to: set stop count preset of 1st stage

$GTimer.StartVal Type: numeric (integer)

Range: 0 to .StopVal

Read from: the start count preset of the 2nd

stage

Write to: set start count preset of the 2nd

stage

Pulse 4.12 User Guide 1128

 $GTimer.AccVal Type: numeric (integer)

Range: 0 to .StopVal

Read from: the current count of 2nd stage

Write to: set current count of 2nd stage

$GTimer.StopVal Type: numeric (integer)

Range: 0 to 4,294,967,295

Read from: the stop count preset of 2nd stage

Write to: set stop count preset of 2nd stage

Usage

 Preset the stop count of the 1st stage of the timer by setting
$GTimer.Cycle to the required value.

 Optionally preset the start value of the 2nd stage of the timer by
setting $GTimer.StartVal to the required value. The default is 0.

 Preset the stop count 2nd stage of the timer by setting

$GTimer.StopVal to the required value (it must be greater than
.StartVal).

 Optionally preset the value of the 3rd stage by setting $GTimer to

the required value.

 The timer is initially disabled. Enable it by setting $GTimer.Enable

to 1.

NOTE You do not have to "create" a $GTimer - the entire array of 32

$GTimers exist.

Operation

After the timer is enabled, the value of $GTimer is incremented by 1.

 The 1st stage counts up the 1-second input "pulses" from 0 to

.Cycle. The current count is reflected by .AccCycle. At rollover,
returns to 0 and drives the 2nd stage.

 The 2nd stage counts up 1st stage rollover "pulses" from .StartVal
to .StopVal. The current count is reflected by .AccVal. At rollover,
returns to .StartVal and drives the 3rd stage.

 The 3rd stage counts up 2nd stage rollover "pulses." The current
count is reflected by $GTimer itself.

Pulse 4.12 User Guide 1129

Resetting .Enable "freezes" the timer.

NOTE Presetting the 1st stage to 0 (.Cycle) causes it to pass,

transparently, each input 1-second "pulse" as a rollover
"pulse" at the output.

Presetting the 2nd stage to a zero or negative range

(.StopVal<=.StartVal) causes it to pass, transparently, each
input "pulse" as a rollover "pulse" at the output.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$HidePcimIcons
server|topic!

Set to 1 (default) to hide Pulse system icons from the Windows Desktop
Notification Area (or tray), or to 0 to display the icons. Read/Write.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Hours
server|topic!

Returns the hours component of the computer’s time of day as a number

with the decimal digits in HH (24 hour) format (0-23). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IDate
server|topic!

Returns the ordinal number of today, where the anchor date is considered
as Day 1. It is also equivalent to the number of days that passed since
anchor date - plus one. If the anchor date is set in the future, $IDate
returns 1 if the anchor date is today, -2 if it is tomorrow, etc. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IPAddr1
server|topic!

In a Hot Redundancy configuration, this variable returns the first number

(network number) of the active server’s virtual IP address (IPv4 notation).
Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1130

$IPAddr2
server|topic!

In a Hot Redundancy configuration, this variable returns the second

number of the active server’s virtual IP address (IPv4 notation). Read
only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IPAddr3
server|topic!

In a Hot Redundancy configuration, this variable returns the third number

of the active server’s virtual IP address (IPv4 notation). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IPAddr4
server|topic!

In a Hot Redundancy configuration, this variable returns the fourth

number of the active server’s virtual IP address (IPv4 notation). Read
only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IPAddrStr
server|topic!

When run from the client node in a Hot Redundancy configuration, this
variable returns a string containing the active server’s virtual IP address.
Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IPPrimary
server|topic!

In a Hot Redundancy configuration, this variable returns the IP address of

the active Pulse server. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1131

$IPSecondary
server|topic!

In a Hot Redundancy configuration, this variable returns the IP address of

the passive Pulse server. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IsClone
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IsGreen
server|topic!

Returns TRUE if the local computer is the active server (in a Hot
Redundancy configuration) or if Redundancy is not defined.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IsHaspBatteryOk
The $IsHaspBatteryOk variable is used as a HASP-SEK battery status
indicator.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IsPassiveRunning
server|topic!

In a Hot Redundancy configuration, this variable notifies whether the

passive server is running. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$IsPulse
server|topic!

Returns 1 if the application is an AFCON Pulse product.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1132

$ItemCnt
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ItemMax
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ITime
server|topic!

Returns time of day as the number of seconds since midnight (0-86399;

there are 86400 seconds in a 24-hour day). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LAA
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LANA
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LastAlarm
server|topic!

Returns most recent alarm in the system (string of up to 80 characters),

as shown in the Alarm Handler. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1133

$LastAlarmAck
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LastAlarmEx
server|topic!

Returns all of the alarm messages that occur for as long as the $variable
is advised. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LastAlarmNack
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LastAlarmZone
server|topic!

Returns the last alarm that occurred in the specified zone. Up to 10 zones,
which can be set up according to your monitored facility’s departmental
organization, are supported. Read only.

For example:

$LastAlarmZone.1, $LastAlarmZone.2, $LastAlarmZone.3, ...,

$LastAlarmZone.10

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1134

$LastEvent
server|topic!

Returns most recent event in the system (string of up to 80 characters),

as shown in the Alarm Explorer.

A client may poke a string to it (68 characters maximum). The Database

Publisher will produce a Daily Log event message with the string,
preceded by the time stamp and the node number (i.e., the number of the
station that generated the alarm). For example, if the client pokes:
"Message from client XYZ", the resultant Daily Log message will be:
"(02) 11:23:45 Message from client XYZ".

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LiteLevel
server|topic!

Returns product level in the range 0 to 3. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LogIn
server|topic!

A client must log in to the Pulse Server with a proper user name and
password in order to write to database blocks and their fields. This is done
by poking $LogIn with a string in the format "username,password".

$LogIn returns the user name string, or "??????" if none.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$LogOut
server|topic!

Write only. A client application that logged in to the Pulse Server (by
poking to $LogIn) is expected to eventually logout by poking to $LogOut
any value.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1135

$MasterNodeNum
server|topic!

Returns number of node on Pulse Network that holds the site license SEK.
Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$MaxNodes
server|topic!

Returns the number of Pulse non-SEK nodes that can be served by this
Pulse Server node.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Minutes
server|topic!

Returns minutes component of time of day as a decimal number in MM

(0-59) format. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Month
server|topic!

Returns month component of date as a decimal number in MM (1-12)

format. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$MSeconds
server|topic!

Returns the number of milliseconds that have elapsed. Read only.

Returns the current time elapsed in milliseconds.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1136

$NodeNum
server|topic!

Returns node number of this Pulse server on the network. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Nodes
server|topic!

The dollar variable $Nodes was replaced by the following:

 $MaxNodes

 $NoSekNodes

 $SekNodes

 $TotalNodes

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$NoSekNodes
server|topic!

Returns the number of Pulse non-SEK nodes that are currently served by
this Pulse node.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$PcimVer
server|topic!

Returns the version number of the current Pulse application.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1137

$Ping
server|topic!

Use this command to check the connection to a workstation PC. This

command returns 1 if the target IP address replies, and 0 if no reply
arrives.

Syntax = |!$ping.IP address

where IP address is the target computer. For example,

|!$ping.130.1.70.254.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Port
Server PFWDRVR topic PCIM - |!

This is a meta-variable. Adding the port number directly after "$Port" (for
example, $Port1, $Port7), followed by an applicable dot field accesses
information about the specified port.

For example, to check whether or not port 1 is active, write:

$Port1.Active.

NOTE The $Port variable must be accompanied by a dot field.

The variables involved with its operation are:

Syntax: |!$Port[Port No.].PLC[PLC No.].AdvCnt

It is a Database Server $Variable showing the number of advised

items per PLC.

Example: |!$Port5.Plc1.AdvCnt

The example shows that the $Variable is used to retrieve the

number of the advised items in Port 5 of PLC 1.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1138

$ProjectName
server|topic!

Returns the default project’s name and path. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$QueryOpen
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$RDate
server|topic!

Returns date and time of day as a real number, where the integer part is
equal to $IDate, and the fraction is equal to $RTime. As such, it is
compatible with the way date is expressed in Microsoft Excel, in numeric
format. Read only.

NOTE The precision provided by a real number is only 7 correct digits

(regardless of the position of the decimal point). Thus, if the
system anchor date ($AnchorDate or Date - Anchor) is the
default (1/1/1900), the integer part of $RDate is 4-digits long
(e.g., 3500 on Oct. 28, 1995), leaving only about 3 or 4
correct digits for the fraction (that is, down to the 1/100 or
1/10000 of the day - whereas a single second is 1/86400, i.e.,
in the order of magnitude of 1/100000).

To refer to date and time numerically with the utmost precision, do one of
the following:

 Use a more recent anchor date - e.g., 1/1/1980 or 1/1990 - so that

the present date is only in the hundreds or thousands days range,
leaving more significant digits for the time fraction.

 Use the time-only ($RTime) and date-only $IDate or $ZDate)

variables separately.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1139

$ReadHisSql
server|topic!

Use this variable to command the Pulse Server to retrieve history records
from the SQL database. Read/Write.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ReleaseVIP
server|topic!

Use this variable to command the local host Pulse server to release its
virtual IP address, for use by another server. Write 1 to release the VIP,
or write 0 to allow the local server to take the VIP again. Write only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ReLoadDB
server|topic!

Write 1 following this variable to command the Pulse Server to reload its
database.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ReMax
Server PFWDRVR topic PCIM

Returns maximum requested items allowed (default = 2048).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ReStartDr
server|topic!

Write this command to restart the Supreme Report Runtime module.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1140

$ReTblTop
Server PFWDRVR topic PCIM - |!

Returns the maximum number of requested items in one Driver Server

session.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Rev
server|topic!

Returns software revision number of Pulse Server as 1-digit integer + 2-

digit fraction number. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$RevDate
server|topic!

Returns software revision date of Pulse Server as 6 digit number in

YYMMDD format. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$RTime
server|topic!

Returns time of day as a fraction of the day (a number in the range 0.0 -
0.99999). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$SDTSolveEnable
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1141

$Seconds
server|topic!

Returns time of day seconds as a decimal number in SS (0-59) format.

Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$SEK
server|topic!

The variable itself returns the Software Enable Key level number (last 2
digits of the part number of the P-CIM for Windows product).

$SEK supports the fields:

.BadCycle Internal parameter

.DemoCycles Internal parameter

.Err Internal parameter

.InitLevel Internal parameter

.Message A literal message to user indicating

operation mode (about current S.E.K.
state). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$SekNodes
server|topic!

Returns the number of Pulse SEK nodes that are currently served by this
Pulse node.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ServerActive
server|topic!

In a Hot Redundancy configuration, this variable returns the local server’s

current status: 1 = Active, 0 = Passive.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1142

$ServerRole
server|topic!

In a Hot Redundancy configuration, this variable returns the queried

server’s role as a textual string: Active, Passive or None.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ServerStatus
server|topic!

In a Hot Redundancy configuration, this variable returns the server’s

current status as a textual string: Active, Passive.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$SignOff
server|topic!

Value 0 Indicates "signed on" as Site License

client on Pulse Network.

Value 1 Indicates "signed off" (not signed on) as

Site License client on Pulse Network

Writing 0 Attempts to "sign on" as Site License

client on Pulse Network.

Writing 1 Attempts to "sign off" as Site License

client on Pulse Network.

Complementary to $SignOn.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1143

$SignOn
server|topic!

Value 0 Indicates "signed off" as Site License

client on Pulse Network.

Value 1 Indicates "signed on" (not signed on) as

Site License client on Pulse Network

Writing 0 Attempts to "sign off" as Site License

client on Pulse Network.

Writing 1 Attempts to "sign on" as Site License

client on Pulse Network.

Complementary to $SignOff.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$SLastEvent
server|topic!

Retrieves the most recent event message.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$StartDate
server|topic!

Displays the exact time and date that the Pulse Server started up.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$StdDocumentName
server|topic!

Internal variable.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1144

$Ticks
server|topic!

Returns number of ticks since the Pulse Server was started (65536/hour,
or approximately 18/second).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Time
server|topic!

Returns time of day represented as a decimal number in HHMMSS (24-

hour) format.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Timer
This variable is obsolete. Use $GTimer instead.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TimeStr
server|topic!

Returns time of day in string in International Time Format. Read only.

For example, 1:2:30 AM returns at 010230 hours if the current Windows

setting is:

12 hour 00:00-11:59 AM

24 hour 12:00-23:59 PM

Separator : (colon)

Leading Zero 9:1509:15

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1145

$Toggle
server|topic!

The Pulse Kernel provides an array of thirty-two (32) $Toggle variables.

Each $Toggle variable is an independent two-stage up counter driven at
each Database Solver cycle. The second stage counts from 0 to 1, being,
in effect, a binary toggle. The operation of $Toggle is illustrated below.

The variables involved with its operation are:

$Toggle Syntax: $Toggle0 (or $Toggle), $Toggle1

to $Toggle31 (the Old Square Brackets
Syntax is still supported).

Type: numeric (integer) Range: 0 to 1

Read from: present toggle state of second

stage

Write to: set initial toggle state of second

stage

$Toggle.Cycle Type: numeric (integer)

Range: 0 to 2,147,483,647 (231-1)

Read from: first stage preset

Write to: set first stage preset

Default: 1

Pulse 4.12 User Guide 1146

 $Toggle.Enable Type: numeric (integer)

Range: 0 to 1

Read from: enable status: 0=disabled, 2 =

enabled

Write to: to enable =1 / to disable = 0

Default: enabled (2)

Operation

Important - see Accessing Complex Dollar Variables.

All of the 32 $Toggle variables ($Toggle0 to $Toggle31) exist and start

to operate (see defaults above) when the Pulse server starts running.
Each one operates independently.

When disabled, the particular $Toggle is "frozen" - all its dot fields
maintain their respective values indefinitely.

When the particular $Toggle is enabled:

 The accumulator of the first stage advances every server cycle;

when it reaches $Toggle.Cycle, it is reset to 0.

 The accumulator of the second stage ($Toggle itself) toggles every

cycle of the first stage.

Tips

 To disable (stop) or enable (restart) a particular $Toggle, write 0

or resp. 1 to its .Enable field. For example, to stop the second
$Toggle, write 0 to $Toggle1.Enable.

 To change one of the presets, write the value to the respective

field. To read the present state (of the second stage), read the
value of $Toggle. For example, to read present state of the second
$Toggle, read $Toggle1.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalBlkAlmDisable
server|topic!

Returns the total number of blocks with "Alarm Enable" OFF. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1147

$TotalBlkAlmEnable
server|topic!

Returns the total number of blocks with "Alarm Enable" ON. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalBlkAlmOn
server|topic!

Returns the total number of blocks that have an "On Alarm" condition.
Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalBlkNotAck
server|topic!

Returns the total number of alarms that are not acknowledged (returns 0
if all alarms are acknowledged or there are currently no active alarms in
the system at all). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalBlkScanOff
server|topic!

Returns the total number of blocks that are currently OFF Scan. Read
only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalBlkScanOn
server|topic!

Returns the total number of blocks that are currently ON Scan. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1148

$TotalIOAdvised
server|topic!

Returns the current total number of advised I/O items.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalIOCount
server|topic!

In case of an I/O limitation in the Pulse SEK, this variable returns the
number of I/O items used.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalNodes
server|topic!

Returns the sum of the values of $SekNodes + $NoSekNodes.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$TotalProjectIo
server|topic!

The $TotalProjectIo $variable returns the total number of used

input/output advised items of a project regardless of the SEK’s
Input/Output limitation.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$Type
Server PFWDRVR topic PCIM

This driver server variable returns the station type. The station type is
indicated by a text made of two parts:

Software product and number of I/O supported by the product. For

example: "Pulse station, unlimited I/O".

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1149

$UserAlarm
A system variable that logs an alarm on demand. After its creation, a
$UserAlarm alarm appears throughout the system as a regular predefined
alarm. $UserAlarm data must have the following:

Node/ ACK_
Date Time Block OPcode Status Value Name

20/08/03 16:03:32 5:AV1_C Alarm 0-7 12-54

HECK

Normal 0-7 35.17

ACK John

Alarm Status Codes:

• ALM_STAT_CLEAR 0

• ALM_STAT_ON 1

• ALM_STAT_OFF 2

• ALM_STAT_HIGH 3

• ALM_STAT_LOW 4

• ALM_STAT_ROC 5

• ALM_STAT_HIHI 6

• ALM_STAT_LOLO 7

 Date and time must be in regional settings format.

 There must be a character space between each text field.

 Value and Status fields should not be included if OpCode is Ack.

 The Ack_Name field should not be included if OpCode is NOT Ack.

 When a node number is missing, Pulse assumes that this is the

local node number.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1150

$Ver
server|topic!

Returns software version of the Pulse kernel server (dbsr.exe). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$WDay
server|topic!

Returns day of week as a number in the range 0-6 (Sunday=0, ...,

Saturday=6). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$WMI
server|topic!

Stands for Who Am I, read only. For a logged in client, it returns the client
identification number maintained by the Pulse Server. The server
identifies clients starting from 0, in the order that they logged in. A non-
logged in client receives -1 for $WMI.

Client login or logout produces an event message in the Daily Log,

including this identification number.

Hint

Configure client applications to produce, at key instances, event messages

including the $WMI identifier (by poking to $LastEvent).

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$YDay
server|topic!

Returns ordinal number of the day in the year, where January 1st is day
1. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1151

$Year
server|topic!

Returns year as a two-digit decimal number in YY (20YY) format. Read

only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$YWeek
server|topic!

Returns week number in year. Strictly speaking, this is not a week count
but rather a seven day count, starting on January 1st as $YWeek =1 (see
Week Number Variables). Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

$ZDate
server|topic!

Returns ordinal number of today, where the anchor date is considered day
0 (the default anchor date is January 1, 1900). It is also equivalent to the
number of days that have passed since the anchor date. If the anchor
date is set in the future, $ZDate returns 0; if the anchor date is today, -1;
if it is tomorrow, etc. Read only.

For the complete list of Dollar Variables, see Pulse Dollar Variables.

Pulse 4.12 User Guide 1152

@ Functions
This section describes functions supported by the Pulse Kernel.

Syntax

The name of a Pulse Kernel function starts with the "@" character, and the
argument(s), if any, follow enclosed in a pair of parentheses, and are
separated by commas. A function invocation has the symbolic syntax:

@fun(var1,var2, ... ,varN)

The Pulse Kernel function can be invoked as the Item in the DDE address
format: Server, Topic, and Item. For example, to trigger an action that
will occur on December 22, 2009, you add the following function to the
Item:

@AtDate(091222)

Operation

Unless otherwise specified, a function is bidirectional. It performs the

operation on the data flowing both from the server to the client and from
the client to the server. The terms read and write are used in this
subject to specify the direction as follows:

Read Data flows from the server to the client

Write Data flows from the client to the server

The name of the function usually expresses the operation in the Read
direction. In the Write direction, the function performs the inverse
operation.

Pulse 4.12 User Guide 1153

Conversions and Functions
A single conversion may be applied to the result of a function.

The syntax of the combined invocation is illustrated below, using the

conversion LIN as an example for the Item field of a DDE link
specification:

@fun(var1,var2,..,varN),LIN(Slow,Shigh,Clow,Chigh)

NOTE Application of a conversion to an argument of a function is not

supported.

This section contains the following topics:

 @ Function List

 The Generic Lookup Table

@ Function List
 @AtDate

 @AtDateTime

 @AtTime

 @CBL

 @CBW

 @CWL

 @D/A

 @F2F

 @F2L

 @IDate and @IDateS

 @L2F

 @L2L

 @N2S

 @PWL

 @S2F

 @S2L

 @S2S

Pulse 4.12 User Guide 1154

@AtDate
Reading this function returns to the client the value of 1 during the time
interval that the actual date matches the argument of the function, and
the value of 0 when not.

Use this function to trigger AutoActions repeatedly, at the same date,

right after midnight.

Syntax

The syntax of the function is:

@AtDate(YYMMDD)

where YYMMDD is the date specification.

In each date numeral position, you can enter either a specific numeral
that is valid for the respective position, or an “x” character to represent
any valid numeral. You must specify all 6 numeral positions, including
leading zeros.

Examples

To trigger monthly, on the 5th

@AtDate(XXXX05)

The function will turn ON (1) on the 5th of every month and every year
(right after midnight of the 4th), and will stay on the whole day until
midnight of the 5th.

To trigger every April 30th

@AtDate(XX0430)

The function will turn ON (1) on April 30th of every year (right after
midnight of the 29th), and will stay so throughout the whole day until
midnight of April 30.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1155

@AtDateTime
Reading this function returns to the client the value of 1 during the time
interval that the actual date and time of day match the argument of the
function, and the value of 0 when not.

Use this function to trigger AutoActions repeatedly, at the same date and
time of day.

Syntax

The syntax of the function is:

@AtDateTime(YYMMDDHHMMSS)

where YYMMDDHHMMSS is the date and time of day specification.

In each date numeral position, you can enter either a specific numeral
that is valid for the respective position, or an “x” character to represent
any valid numeral. You must specify all 12 numeral positions, including
leading zeros.

Examples

To trigger monthly, on the 5th, at noon

@AtDateTime(XXXX051200XX)

The function will turn ON (1) on the 5th of every month and every year
(right after midnight of the 4th), and will stay on the whole day until
midnight of the 5th.

The function will turn ON (1) on the 5th of every month at 12:00:00 hours
(noon), and will stay on until 12:01 (one full minute).

To trigger every April 30th, at 8:00 AM

@AtDateTime(XX04300800XX)

The function will turn ON (1) on April 30th of every year (right after
midnight of the 29th), and will stay so throughout the whole day until
midnight of April 30.

The function will turn ON (1) on April 30th at 08:00:00 hours (8 AM

exactly), and will stay so until 08:01 of the same day (one full minute).

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1156

@AtTime
Reading this function returns to the client the value of 1 during the time
interval that the actual time of day matches the argument of the function,
and the value of 0 when not.

Use this function to trigger AutoActions daily, at the same time of day.

Syntax

The syntax of the function is:

@AtTime(HHMMSS)

where HHMMSS is the time of day specification in 24-hour format.

In each date numeral position, you can enter either a specific numeral
that is valid for the respective position, or an “x” character to represent
any valid numeral. You must specify all 6 numeral positions, including
leading zeros.

Examples

To trigger daily at 15:30:00 (3:30 PM)

@AtTime(1530XX)

The function will turn ON (1) at 15:30:00 and will stay on until 15:31 (one
whole minute).

To trigger daily, every hour, at 30 minutes past the hour

@AtTime(XX30XX)

The function will turn ON (1) at 30 minutes past the hour, and will stay on
until 31 minutes past the hour.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1157

@CBL
(Combine Bytes to Long)

Reading this function returns a long number that is the bitwise

combination of the byte value of the four variables referenced as function
arguments (varin1, varin2, varin3, and varin4). In addition, it places the
same long value in the optional varout variable.

Writing to this function breaks down the written value into four bytes and
sets the four function arguments to the respective values.

For example, this function’s operation is illustrated in hex notation below.

varin4 varin3 varin2 varin1 varout and result

0x67 0x45 0x23 0x01 => 0x01234567

Syntax

The syntax of the function is:

@CBL([varout], [varin1] [,varin2] [,varin3] [,varin4])

@CBL The name of the function

varout Optional - variable to be set to the

"combine" result (read operation). It is not
affected when writing to the function.

varin1 Data for result bits 0-7, name of variable,

or a constant in the range 0-255.

varin2 Same as above, for result bits 8-15

varin3 Same as above, for result bits 16-23

varin4 Same as above, for result bits 24-31

The names of the arguments chosen for the explanation express their
respective meaning when the function is read from (combine operation).

All byte positions must be filled up to the highest of interest - value of

unfilled positions are presumed to be 0 (0x00).

Operation

 Read - the results of the function at client (Cvalue) and server

(varout) are:

Pulse 4.12 User Guide 1158

 Cvalue := varin1 + varin2 * 256 + varin3 * 256*256 + varin4 * 256*256*256

-or-

Cvalue := (((varin4 * 256 + varin3) * 256) + varin2) * 256 + varin1

varout := Cvalue

The function expects an unsigned byte variable, or a constant

between 0 and 255 for each byte position of varin.

 Write - the results of the function at the server are:

varin1 := 1st (lowest) byte of Cvalue

varin2 := 2nd byte of Cvalue

varin3 := 3rd byte of Cvalue

varin4 := 4th (highest) byte of Cvalue

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1159

@CBW
(Combine Bytes to Word)

Reading this function returns a word-size number that is the bitwise

combination of the byte value of the two variables referenced as function
arguments (varin1 and varin2). In addition, it places the same word in the
optional varout variable.

Writing to this function breaks down the written value into two bytes and
sets the two function arguments to the respective values.

For example, this function’s operation is illustrated in hex notation below.

varin2 varin1 varout and result

0x23 0x01 => 0x0123

Syntax

The syntax of the function is:

@CBW([varout], [varin1] [,varin2])

@CBW The name of the function.

varout Optional - variable to be set to the

"combine" result (read operation). It is not
affected when writing to the function.

varin1 Data for result bits 0-7, name of variable,

or a constant in the range 0-255.

varin2 Same as above, for result bits 8-15.

The names of the arguments chosen for the explanation express their
respective meaning when the function is read from (combine operation).

All byte positions must be filled up to the highest of interest - value of

unfilled positions are presumed to be 0 (0x00).

Pulse 4.12 User Guide 1160

Operation

 Read - the results of the function at client (Cvalue) and server

(varout) are:

Cvalue := varin1 + varin2 * 256

varout := Cvalue

The function expects an unsigned byte variable, or a constant

between 0 and 255 for each byte position of varin.

 Write - the results of the function at the server are:

varin1 := 1st (lowest) byte of Cvalue

varin2 := 2nd (highest) byte of Cvalue

For the complete list of @ Functions, see @ Function List.

@CWL
(Combine Words to Long)

Reading this function returns a long number that is the bitwise

combination of the word- size value of the two variables referenced as
function arguments (varin1 and varin2). In addition, it places the same
long value in the optional varout variable.

Writing to this function breaks down the written value into two words and
sets the two function arguments to the respective values.

For example, this function’s operation is illustrated in hex notation below.

varin2 varin1 varout and result

0x4567 0x0123 => 0x01234567

Pulse 4.12 User Guide 1161

Syntax

The syntax of the function is:

@CWL([varout], [varin1] [,varin2])

@CWL The name of the function.

varout Optional - variable to be set to the

"combine" result (read operation). It is not
affected when writing to the function.

varin1 Data for result bits 0-15, name of variable,

or a constant in the range 0-65535.

varin2 Same as above, for result bits 16-31.

The names of the arguments chosen for the explanation express their
respective meaning when the function is read from (combine operation).

All word positions must be filled up to the highest of interest - value of

unfilled positions are presumed to be 0 (0x0000).

Operation

 Read - the results of the function at client (Cvalue) and server

(varout) are:

Cvalue := varin1 + varin2 * 65536

varout := Cvalue

The function expects an unsigned byte variable, or a constant

between 0 and 65535 for each byte position of varin.

 Write - the results of the function at the server are:

varin1 := 1st (lowest) word of Cvalue

varin2 := 2nd (highest) word of Cvalue

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1162

@D/A
(Digital to Analog)

Reading this function performs the equivalent of a real world D/A

converter - encoding and producing the analog (numeric) result of the
binary weighted values of up to 32 digital (OFF/ON) input variables.
Optionally, the function sets a variable specified to the value of the result.

Writing to this function performs the equivalent of a real world A/D

converter - decoding the analog (numeric) input into binary values and
setting up to 32 respective digital (OFF/ON) output variables.

Potential uses for this function include encoding several digital "signals"
into an aggregate numeric analog "signal". This “signal” can then be used
to drive a color, bar (size), or textual indicator.

Syntax

The syntax of the function is:

@D/A([varout], [varin0] [,varin1] [,varin2]... [,varin31])

@D/A The name of the function.

varout Optional - variable to be set to the result

analog value (D/A operation). It is not
affected when the function is written to
(A/D operation).

varin0 Data for bit weight 20 (that is, 1), name of

variable, or the constant 0 or 1.

varin1 Same as above, for weight 21 (that is, 2).

varin2 Same as above, for weight 22 (that is, 4).

varinN Same as above, for weight 2n.

varin31 Same as above, for weight 231 (that is,

2,147,483,648).

The names of the arguments chosen for the explanation express their
respective meaning when the function is read from (D/A operation).

All bit positions must be filled up to the highest of interest.

Pulse 4.12 User Guide 1163

Operation

 Read - the results of the function at client (Cvalue) and server

(varout) are:

Cvalue := varin0 * 1 + varin1 * 2 + varin2 * 4 + varin3 * 8 + varin4 * 16 + etcetera

varout := Cvalue

The function expects a digital variable, or the constant 0 or 1, for

each bit position of varin.

• The value of an analog variable is considered 1 when it is

non-zero.

• The value of a string variable result is evaluated as zero, if it

does not start with a number (for example, "ABC"); if it
starts with a number (for example, "123ABC"), the number
substring is evaluated as specified above for an analog
variable.

 Write - the results of the function at the server are:

varin0 := bit 0 of Cvalue

varin1 := bit 1 of Cvalue

varinn := bit n of Cvalue

etcetera

The function expects a digital variable, or the constant 0 or 1, for

each bit position (varin).

• A constant has no effect for the particular bit position.

• An analog variable is set to 0 or 1.

• A string variable is set to "0" or "1".

Pulse 4.12 User Guide 1164

Application Example 1 - Present Motor Status in Color

The requirements of this example are:

Three digital variables represent the status of a motor:

Variable OFF state ON state

AUTO MANUAL mode AUTO mode

RUN motor STOPPED motor RUNNING

TRIP protection NOT protection TRIPPED

TRIPPED

The eight possible states of the motor are represented by eight respective
colors as presented in the States table below. The combinations where
RUN and TRIP are both 1 (ON), which normally is impossible, have to be
considered as well, as they may indicate a serious malfunction.

AUTO RUN TRIP State # Color

0 0 0 0 Black

0 0 1 1 Red

0 1 0 2 Green

0 1 1 3 Violet

1 0 0 4 Yellow

1 0 1 5 Magenta

1 1 0 6 Blue

1 1 1 7 Cyan

Design

The design is evident from the presentation requirement and comprises

the assignment of the respective binary weights to the three variables
(TRIP: 1, RUN: 2, AUTO: 4), and the manual "encoding" of their
aggregates states into the analog range of 0 to 7 (shown under the
column State # in the previous table).

Pulse 4.12 User Guide 1165

Animation

In the Developer Workstation, select the graphical object representing the

motor, and configure the Fill Color Animation property as follows:

Server |

Topic !

Item @D/A(,TRIP,RUN,AUTO)

Color by Analog value

After selecting the Analog Value type, configure the thresholds and color
bands so that there are seven thresholds (1.00, 2.00, 3.00, ....7.00), each
representing a State #, and each state is represented by its respective
color (as specified in the States table earlier in this example).

There should be only seven thresholds, the lowest being 1 (1.00). The
range below 1.00, including 0.00, is covered by the first color band
(black).

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1166

@F2F
(Float to Float Lookup)

Reading this function returns a floating point number, translated from the
server floating point number through a table lookup operation and,
optionally, sets a variable specified to the floating point number value.

Writing a floating point number to the function translates it to a floating

point number through a separate table lookup operation and sends it to
the server.

Potential applications in the Operator Workstation include encoding

discrete numerical values from the data sources into corresponding
numerical values for presentation, and the complementary - decoding
numerical values commands entered by the operator into corresponding
numerical values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@F2F([varout], varin, file, table [,table_r [,prec]])

@F2F The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

Pulse 4.12 User Guide 1167

 table_r Optional - name of write (reverse) lookup
table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits.

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

The Precision

The precision applies to the number input to the function for either
(Server to Client, Client to Server) translation - the raw number is first
expressed in decimal notation with the precision specified, then looked up
in the table.

Operation

 Read - the numerical value of varin is expressed in decimal

notation, with the precision (prec) specified and it is looked up as a
token in the file and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

NOTE The precision specified is applied in both directions.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1168

@F2L
(Float to Long Lookup)

Reading this function returns a long integer, translated from the server
floating point number through a table lookup operation and, optionally,
sets a variable specified to the long integer value.

Writing a long integer to the function translates it to a floating point

number through a separate table lookup operation and sends it to the
server.

Potential applications in the Operator Workstation include encoding

discrete numerical values from the data sources into corresponding
numerical values for presentation, and the complementary - decoding
numerical values commands entered by the operator into corresponding
numerical values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@F2L([varout], varin, file, table [,table_r [,prec]])

F2L The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

Pulse 4.12 User Guide 1169

 table_r Optional - name of write (reverse) lookup
table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of decimal

digits

 "0" (the default) = whole numbers.

 Negative number = number of trailing

zeros.

The Precision

The precision applies to the number input to the function for either
(Server to Client, Client to Server) translation - the raw number is first
expressed in decimal notation with the precision specified, then looked up
in the table.

NOTE The decimal digits used to express a long integer value will
always be zeros.

Operation

 Read - the numerical value of varin is expressed in decimal

notation, with the precision (prec) specified and it is looked up as a
token in the file and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

NOTE The precision specified is applied in both directions.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1170

@IDate and @IDateS
Functions @IDate and @IDateS convert between field data representing a
date in number- of-days-since format and standard date formats for the
operator.

Designing the 'Base' Date

In the project’s pcimuser.ini file, section [PCIMDBSR], the parameter

FunctionAnchorDate (default 19800101) defines the 'base' date used by
those functions throughout the application (leave it unchanged if it fits
your requirements). If you can control the actual 'base' date used by the
application, make it as close as possible to 'present', so values
representing 'number-of-days-since' are small. This way, you increase the
'lifetime' of the application, i.e., the point in time at which the value
reaches the numeric limit of variable used. For example, if the variable
representing 'number-of-days-since' is a 16-bit signed register in the PLC,
its upper limit is 32,767 (days), or almost 90 years.

Using the @IDate Function

This function converts a field value representing NOFDSA (number-of-

days-since-anchor) into an eight-digit number (YYYYMMDD), such as
200912203 for December 3, 2009. The syntax of the function is:

@IDate ( [Target Item], Source Item )

where:

Target Item Optional argument - an address to receive

the value of @IDate, and can handle 8
decimal digits, i.e., of type 'long'.

Source Item The address whose value represents the

date in NOFDSA format.

Using the @IDateS Function

This function converts a field value representing NOFDSA (number-of-

days-since-anchor) into a date string in the computer’s Short Date Style
format (as set in Control Panel, Regional Settings, Date), such as 12/3/09
for December 3, 2009 (with Short Date Style M/d/yy). The syntax of the
function is:

@IDateS ( [Target Item], Source item )

where:

Target Item Optional argument - an address to receive

the value of a @IDate function of type
'string'.

Pulse 4.12 User Guide 1171

 Source Item The address whose value represents the
date in NOFDSA format.

For the complete list of @ Functions, see @ Function List.

@L2F
(Long to Float Lookup)

Reading this function returns a floating point number, translated from the
server long integer through a table lookup operation and, optionally, sets
a variable specified to the floating point value.

Writing a floating point number to the function translates it to a long

integer through a separate table lookup operation and sends it to the
server.

Potential applications in the Operator Workstation include encoding

discrete numerical values from the data sources into corresponding
numerical values for presentation, and the complementary - decoding
numerical values commands entered by the operator into corresponding
numerical values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@L2F([varout], varin, file, table [,table_r [,prec]])

L2F The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

Pulse 4.12 User Guide 1172

 file Path, name and extension of the file that
contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

table_r Optional - name of write (reverse) lookup

table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

The Precision

The precision applies to the number input to the function for either
(Server to Client, Client to Server) translation - the raw number is first
expressed in decimal notation with the precision specified, then looked up
in the table.

NOTE The decimal digits used to express a long integer value will
always be zeros.

Operation

 Read - the numerical value of varin is expressed in decimal

notation, with the precision (prec) specified and it is looked up as a
token in the file and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

Pulse 4.12 User Guide 1173

 The value associated with the token is written to varin at the
server.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

NOTE The precision specified is applied in both directions.

For the complete list of @ Functions, see @ Function List.

@L2L
(Long to Long Lookup)

Reading this function returns a long integer, translated from the server
long integer through a table lookup operation and, optionally, sets a
variable specified to the long integer value.

Writing a long integer to the function translates it to a long integer

through a separate table lookup operation and sends it to the server.

Potential applications in the Operator Workstation include encoding

discrete numerical values from the data sources into corresponding
numerical values for presentation, and the complementary - decoding
numerical values commands entered by the operator into corresponding
numerical values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@L2L([varout], varin, file, table [,table_r [,prec]])

L2L The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

Pulse 4.12 User Guide 1174

 file Path, name and extension of the file that
contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

table_r Optional - name of write (reverse) lookup

table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

The Precision

The precision applies to the number input to the function for either
(Server to Client, Client to Server) translation - the raw number is first
expressed in decimal notation with the precision specified, then looked up
in the table.

NOTE The decimal digits used to express a long integer value will
always be zeros.

Operation

 Read - the numerical value of varin is expressed in decimal

notation, with the precision (prec) specified and it is looked up as a
token in the file and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

Pulse 4.12 User Guide 1175

 The value associated with the token is written to varin at the
server.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

NOTE The precision specified is applied in both directions.

For the complete list of @ Functions, see @ Function List.

@N2S
(Number to String Lookup)

Reading this function returns a string, translated from the server number
through a table lookup operation and, optionally, sets a variable specified
to the string value.

Writing a string to the function translates it to a number through a

separate table lookup operation and sends it to the server.

Potential applications in the Operator Workstation include encoding

discrete numerical values from the data sources into corresponding
numerical values for presentation, and the complementary - decoding
numerical values commands entered by the operator into corresponding
numerical values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@N2S([varout], varin, file, table [,table_r [,prec]])

N2S The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

Pulse 4.12 User Guide 1176

 file Path, name and extension of the file that
contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

table_r Optional - name of write (reverse) lookup

table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

The Precision

The precision applies to the number input to the function for the number
to string (Server to Client, Client to Server) translation - the raw number
is first expressed in decimal notation with the precision specified, then
looked up in the table.

Operation

 Read - the numerical value of varin is expressed in decimal

notation, with the precision (prec) specified and it is looked up as a
token in the file and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default string Undefined is returned if the "Default" token is
not found.

 Write - the string value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

Pulse 4.12 User Guide 1177

 The token "Default" is looked up if the original token is not found.
The default value 0 is returned if the "Default" token is not found.

For the complete list of @ Functions, see @ Function List.

@PWL
(Piece wise Linear Approximation)

Reading this function returns a number, interpolated from the server

number through a table lookup and piece wise linear approximation
operation and, optionally, sets a variable specified to the result value.

Writing a number to the function translates it to a number through a

separate table lookup and piece wise linear approximation operation and
sends it to the server.

Potential applications in the Operator Workstation include translating

discrete number values from the data sources - through a calibration table
- into corresponding numbers for presentation, and the complementary -
numeric commands entered by the operator decoded into corresponding
number values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Special Requirements

The lookup table can contain up to 100 entries, where each entry
represents a point on the transfer function. The entries are labeled
contiguously with tokens "00" to "99" and specified as value the X and Y
coordinates of the associated point on the graph - as illustrated below.
The X values have to be in ascending order.

The @PWL function operates correctly only with a monotonous transfer

function, i.e., that does not change direction.

Pulse 4.12 User Guide 1178

Transfer Function Diagram

Transfer Function Table

[Table]
00=X0, Y0
01=X1, Y1
02=X2, Y2
...
etc.
...
98=X98, Y98
99=X99, Y99

The reverse table, if required, is specified using the same method, with
the X and Y entries reversed, as illustrated below. The Y values have to be
in ascending order.

Reverse Lookup Table

[Table_r]
00=Y0, X0
01=Y1, X1
02=Y2, X2
...
etc.
...
98=Y98, X98
99=Y99, X99

Pulse 4.12 User Guide 1179

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@PWL([varout], varin, file, table [,table_r [,prec]])

PWL The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

table_r Optional - name of write (reverse) lookup

table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of decimal

digits

 "0" (the default) = whole numbers.

 Negative number = number of trailing

zeros.

Operation

 Segment - this term, used in the description below, refers to the

linear graph implied between two adjacent entries (Xn, Yn and
Xn+1, Yn+1) in the lookup table - as illustrated below.

Pulse 4.12 User Guide 1180

 Read - the segment containing the value of varin is looked up as a
pair of adjacent tokens in the file and table specified.

The Y value is interpolated according to the X position of varin on

the segment and is returned to the client as the value of the
function, and is assigned to varout.

The Y0 value (associated with the lowest token "00") is returned if

varin is less than X0. Conversely, the Ynn value (associated with
the highest token "nn") is returned if varin is equal or greater than
Xnn.

 Write - the segment containing the value written by the client is

looked up as a pair of adjacent tokens in the same file, in the
reverse table specified (table_r or default).

The X value is interpolated according to the Y position of the value

written by the client on the segment and is written to varin.

The X0 value (associated with the lowest token "00") is returned if

the value written by the client is less than Y0. Conversely, the Xnn
value (associated with the highest token "nn") is returned if the
value written by the client is equal or greater than Ynn.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1181

@S2F
(String to Float Lookup)

Reading this function returns a floating point number, translated from the
server long integer through a table lookup operation and, optionally, sets
a variable specified to the floating point number value.

Writing a floating point number to the function translates it to a string

through a separate table lookup operation and sends it to the server.

Potential applications in the Operator Workstation include encoding

discrete string values from the data sources into corresponding numerical
values for presentation, and the complementary - decoding numerical
values commands entered by the operator into corresponding string
values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@S2F([varout], varin, file, table [,table_r [,prec]])

S2F The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

Pulse 4.12 User Guide 1182

 table_r Optional, name of write (reverse) lookup
table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

The Precision

The precision applies to the number input to the function for floating point
to string (Client to Server) translation - the raw number is first expressed
in decimal notation with the precision specified, then looked up in the
table.

Operation

 Read - the string value of varin is looked up as a token in the file

and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

The token "Default" is looked up if the original token is not found.

The default value Undefined is returned if the "Default" token is
not found.

NOTE The precision specified is applied in the Write direction only.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1183

@S2L
(String to Long Lookup)

Reading this function returns a long integer, translated from the server
string through a table lookup operation and, optionally, sets a variable
specified to the long integer value.

Writing a long integer to the function translates it to a string through a

separate table lookup operation and sends it to the server.

Potential applications in the Operator Workstation include encoding

discrete string values from the data sources into corresponding numerical
values for presentation, and the complementary - decoding numerical
values commands entered by the operator into corresponding string
values sent to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@S2L([varout], varin, file, table [,table_r [,prec]])

S2L The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

Pulse 4.12 User Guide 1184

 table_r Optional, name of write (reverse) lookup
table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of decimal

digits

 "0" (the default) = whole numbers.

 Negative number = number of trailing

zeros.

The Precision

The precision applies to the number input to the function for long to string
(Client to Server) translation - the raw number is first expressed in
decimal notation with the precision specified, then looked up in the table.

NOTE The decimal digits used to express a long integer value will
always be zeros.

Operation

 Read - the string value of varin is looked up as a token in the file

and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value 0 is returned if the "Default" token is not found.

 Write - the numerical value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

The token "Default" is looked up if the original token is not found.

The default value Undefined is returned if the "Default" token is
not found.

NOTE The precision specified is applied in the Write direction only.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1185

@S2S
(String to String Lookup)

Reading this function returns a string, translated from the server string
through a table lookup operation and, optionally, sets a variable specified
to the string value.

Writing a string to the function translates it to a string through a separate

table lookup operation and sends it to the server.

Potential applications in the Operator Workstation include encoding

discrete string values from the data sources into corresponding string
values for presentation, and the complementary - decoding string values
commands entered by the operator into corresponding string values sent
to the field.

Lookup Table

The function requires a lookup table for the read (Server to Client)
direction. A complementary lookup table is required for the write (Client to
Server) direction - in the same file. The generic lookup table structure is
defined in The Generic Lookup Table.

Syntax

The syntax of the function is described below. The names of the

arguments chosen for the explanation express their respective meaning
when the function is read (Server to Client translation).

@S2S([varout], varin, file, table [,table_r [,prec]])

S2S The name of the function.

varout Optional - name of the server variable to be

set to the Read direction result. It is not
affected when writing to the function.

varin Name of Read direction input variable.

file Path, name and extension of the file that

contains the lookup table(s). Path is
optional - the default Utilities folder is
defined in the Project Setup.

table Name of Read direction lookup table.

Pulse 4.12 User Guide 1186

 table_r Optional, name of write (reverse) lookup
table (in file).

Default - name of table above, with suffix

_r.

prec Optional - the numeric precision:

 Positive number = number of

decimal digits

 "0" (the default) = whole numbers.

 Negative number = number of

trailing zeros.

Operation

 Read - the string value of varin is looked up as a token in the file

and table specified.

The value associated with the token is returned to the client as the
value of the function, and is assigned to varout.

The token "Default" is looked up if the original token is not found.

The default value Undefined is returned if the "Default" token is
not found.

 Write - the string value written by the client is expressed in

decimal notation, with the precision (prec) specified and is looked
up as a token in the same file, in the reverse table specified
(table_r or default).

The value associated with the token is written to varin at the

server.

The token "Default" is looked up if the original token is not found.

The default value Undefined is returned if the "Default" token is
not found.

For the complete list of @ Functions, see @ Function List.

Pulse 4.12 User Guide 1187

The Generic Lookup Table
The lookup table is a text file in Windows INI file format. However, files
used in conjunction with lookup functions do not necessarily have to have
the ".INI" extension, nor reside in the Windows directory. You may put
different tables in the same file.

The Lookup Table Structure

A lookup table is made of the table name followed by or more table
entries. The name, and any entry, each have to be on a separate line.

The Lookup Table Name

The name has to be enclosed in square brackets ([Name]). Its length
(excluding the brackets) must not exceed 39 characters - it is advised not
to exceed 37 characters, in order to be able to take advantage of the
default name of the inverse table ("_r" suffix appended to the name of the
"forward" translation table).

The name must begin with a letter, followed by any combination of letters
and digits - punctuation marks and spaces are not allowed. The name is
not case-sensitive. Each table has to have a unique name in the file.

The Table Entry

A table entry has the structure token=value, where:

token The lookup input

= The equal sign

value The lookup output

Each token name has to be unique in the table.

The token "Default" has a special meaning - the associated value is

returned when the lookup fails. The built-in defaults (used when the
"Default" token is not specified in the table) are 0 for numbers, and
Undefined for strings.

Example

The translation table below specifies Read and reads for the following
number-to- string function: @N2S(, FRUIT, file.ext, FRUITNAMES)

Pulse 4.12 User Guide 1188

 [FruitNames]
Default=None
1=Apple
2=Orange
3=Lemon
4=Strawberry

[FruitNames_r]
Default=0
Apple=1 Orange=2 Lemon=3 Strawberry=4

0 and None are the respective numeric and string defaults for this lookup
translation application.

Pulse 4.12 User Guide 1189

The Recipe Explorer
A recipe enables operators to perform different tasks, or variations of the
same task, using the same set of addresses. Recipes are typically made
up of groups, or a set of addresses and their corresponding values and
commands, which carry out a specific task. A recipe typically contains
multiple groups, each associated with a different task.

The tasks defined in the recipe may be configured to run automatically

during runtime, or to be triggered by an operator by clicking an action
button. Depending on the task which the operator chooses to carry out,
the Pulse Server loads the recipe’s data items to the PLC. Conversely, the
Server learns data from the PLC. The load/learn results may change
values in the PLC or the recipe file, respectively. As a result of this data
exchange, the chosen task is executed.

For example, a Yogurt factory makes three flavors: pineapple, strawberry

and plain. On the day that they produce pineapple-flavored Yogurt, the
operator clicks the Pineapple button. This sends the Pineapple recipe to
the PLC, which then triggers the pineapple flavor to be added to the
Yogurt mixture. On other occasions, the operator may click the button
triggering the other flavors.

You create and modify recipes and save recipe files in Pulse’s Recipe
Explorer. Multiple groups from the same recipe can be saved in the same
Recipe file. Additionally, recipes can be exported/imported in CSV format
and opened/modified in spreadsheets and other database management
applications.

Pulse 4.12 User Guide 1190

To open the Recipe Explorer

In the Developer Workstation’s explorer panel on the left (Project

navigator), click the Recipes button.

The Recipe Explorer is displayed.

The current project and the recipe being edited are identified in the Title
bar. The recipe name is used to reference the recipe in all editing and
runtime operations.

Pulse 4.12 User Guide 1191

This section contains the following topics:

 Defining a Recipe

 Importing and Exporting Recipes from/to CSV Files

 Creating the CSV Recipe in Excel

 Exporting Display Items to Recipe

 Setting Up Recipes during Development

 Loading a Recipe (Developer Workstation)

 Learning a Recipe (Developer Workstation)

 Comparing Recipe Groups

Defining a Recipe
In the Recipe Explorer, you create and edit recipes. When you create a
new recipe, you start by defining a group (version of the recipe) and then
adding as many different groups to the recipe as you require.

To create a new recipe

1 In the Recipe Explorer’s Home ribbon, click New or go to the

Recipes tree, right-click on Recipes and select New from the pop-
up menu.

An untitled recipe form is displayed.

Pulse 4.12 User Guide 1192

2 In the Description field, type a description for the recipe.

3 Create a group and define its properties. By default, the first group
is named “Group1”. To rename this group, right-click the group
name and click Rename. Type the new name and click OK.

This name is used to reference the group in all editing and runtime
operations.

When you create additional groups, right-click in the Group list and
then click New Group. Type the new group name and click OK.

4 Edit the properties accordingly.

Group

Name The name of the group, as defined in step 3

above.

IO Wait Specify the delay time (in seconds) for Learn

and Compare operations. Use it to allow for
fresh data to be read by the driver from the
PLC or controller.

Timeout Specify the timeout (1 to 60 seconds) allowed

while waiting for a DDE link to be established.
Consider the computer and server(s) workload
when defining this parameter.

Pulse 4.12 User Guide 1193

Group

Comment Type a comment or annotation for the group.

ID Number Type a unique number to be sent to the ID

Destination variable after each of this group’s
operations, in order to identify the group.

ID Dest. Item Enter a variable to receive the ID Number (see

above). Enter the address in DDE format -
preferably the same variable for all groups.

Status Dest. Item Enter a variable to receive operation status.

Enter the address in DDE format - preferably
the same variable for all groups.

Action On Success Select the action to occur to indicate if the

recipe operation is successful.

Action On Fail Select the action to occur to indicate if the

recipe operation fails.

Action On Timeout Select the action to occur to indicate if the

timeout period passed before a DDE link could
be established

When defining the Actions on Success/Fail/Timeout, you can define the

data item as follows:

To define the object’s data item, enter an action command or workflow.

 You can type it manually.

When manually typing a command to execute a workflow, add a

workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard syntax.

-or-

 Open the Action Selector to assemble and/or choose the

command or workflow.

NOTE After you enter a workflow, it appears in the relevant edit box
in the following syntax:

[WorkflowName] [arguments]

Pulse 4.12 User Guide 1194

5 In the Settings table, define the PLC addresses and notes for the
entire recipe, and their respective values for this group. The first
entry is at the top of the execution order; the second entry is
second in the execution order, and so on through the last entry.
When multiple entries appear in the Settings table, you can
change the execution order each by selecting a row and clicking
Move Up and Move Down.

Settings

Address Type the item address where the value is

loaded to or learned from.

All the groups share the same set of addresses

- only the respective values may vary for each
group.

Load Source Type the value to load, according to the

following criteria:

 Leave blank - not used (not loaded or

learned)

 Number - loads a constant value (which

is replaced when the value from the PLC
is learned).

 Variable - the value is loaded to the PLC

from this variable and learned from the
PLC to this variable. Enter the address of
the variable in DDE format.

NOTE If RO is checked, the “value learned

to variable” is not applicable.

 Expression - the value of an expression

is loaded to the PLC (learn not
applicable) - enter the expression.

RO Select this option to make this setting read-

only. This option is applicable when the load
source is a variable (you specified the address
of a variable).

NOTE Type a note or annotation for the

setting.

Pulse 4.12 User Guide 1195

NOTE Adding a setting adds the same address and note to all other
groups with a blank value.

Address and name changes are global for the entire recipe (are
reflected in all the groups).

6 To save a new recipe, open the File ribbon and click Save > Save
As. In the Save As dialog box, type the recipe name, and then
click OK.

To edit an existing recipe

1 In the Recipe Explorer’s left navigation panel, double-click the

recipe name.

The recipe form is displayed.

2 Make any required changes to any parameters in any of the recipe’s

groups (see the previous procedure for parameter descriptions).

3 In the File ribbon, click Save.

Importing and Exporting Recipes from/to CSV

Files
The Import and Export Recipe facilities allow you to edit recipes in
Microsoft Excel, and then import them to Pulse, or to export them back to
CSV.

The use of Excel enhances your recipe editing with the following features:

 Viewing several or all the groups at one glance.

 Using Excel’s calculation features to calculate the values to be

eventually downloaded by Pulse.

For example, you can use the Excel’s Solver program’s linear
programming algorithm to optimize the cost of raw materials used in the
product.

Pulse 4.12 User Guide 1196

Creating the CSV Recipe in Excel
In Microsoft Excel, you can create and edit importable recipes in two
layout formats: horizontal and vertical. This term denotes the matrix
dimension of the groups. The two formats are described in detail in the
respective detailed help.

General Rules
In the Excel worksheet, you enter all the parameters of the recipe,
starting from cell R1C1 (A1). The recipe definition occupies the range of
rows and columns as tabulated below, where "G" denotes the number of
groups, and "S" the number of settings of the recipe.

Columns Rows

Horizontal format G+2 S+5

Vertical format S+4 G+2

Some of the cells in this range, and all the cells beyond it are not used.

You may enter any data or formulas in those cells - the Import operation
disregards the data and the Export operation places blank data.

NOTE To avoid confusion, use only one of the two formats -

horizontal or vertical - within the same application.

Pulse 4.12 User Guide 1197

Creating a Vertical Layout Recipe Worksheet
In this format each group occupies a separate row. This format is
illustrated below.

1 2 3 4 5 6 7

1 vert Desc

2 # # Addr1 Addr2 AddrX

Settings Groups

3 Note1 Note2 NoteX

4 Group1 Cmnt1 IOWait1 TimOt1 val1-1 val2-1 valX-1

5 Group2 Cmnt2 IOWait2 TimOt2 val1-2 val2-2 valX-2

6 Group3 Cmnt3 IOWait3 TimOt3 val1-3 val2-3 valX-3

7 GroupY CmntY IOWaitY TimOtY val1-Y val2-Y valX-Y

Row 1

Column 1 Enter the word "vert" This indicates the vertical

layout.

Column 2 Enter the recipe description.

The remaining cells in this row are not used.

Row 2

Column 1 Enter the number of settings in the recipe.

Column 2 Enter the number of groups in the recipe.

Column 3 Not used.

Column 4 Not used.

Column 5 Enter the Address of the first setting.

Column X Enter the Address of the (X-4)th setting.

Pulse 4.12 User Guide 1198

Row 3

Column 1 Not used.

Column 2 Not used.

Column 3 Not used.

Column 4 Not used.

Column 5 Enter the note of the first setting

Column X Enter the note of the (X-4)th setting.

Row 4

Column 1 Enter the name of the first group

Column 2 Enter the comment of the first group.

Column 3 Enter the IO Wait of the first group.

Column 4 Enter the timeout of the first group.

Column 5 Enter the value of the first setting - of the first

group.

Column X Enter the value of the (X-4)th setting - of the

first group.

Row 5

As for Row 4, but for the second group.

Row Y

As for Row 4, but for the (Y-3) group.

Pulse 4.12 User Guide 1199

Creating a Horizontal Layout Recipe Worksheet
In this format each group occupies a separate column. This format is
illustrated below.

1 2 3 4 5 6

1 horz Description

2 # Settings # Groups Group1 Group2 Group3 GroupX

3 Cmnt1 Cmnt2 Cmnt3 CmntX

4 IOWait1 IOWait2 IOWait3 IOWaitX

5 TimOt1 TimOt2 TimOt3 TimOtX

6 Addr1 Note1 val1/1 val2/1 val3/1 valX/1

7 Addr2 Note2 val1/2 val2/2 val3/2 valX/2

8 Addr3 Note3 val1/3 val2/3 val3/3 valX/3

9 Addr4 Note4 val1/4 val2/4 val3/4 valX/4

10 AddrY NoteY val1/Y val2/Y val3/Y valX/Y

Row 1

Column 1 Enter the word "horz".

This indicates the horizontal layout.

Column 2 Enter the recipe description.

The remaining cells in this row are not used.

Row 2

Column 1 Enter the number of settings in the recipe.

Column 2 Enter the number of groups in the recipe.

Column 3 Enter the name of the first group.

Column X Enter the name of the (X-2)th group.

Pulse 4.12 User Guide 1200

Row 3

Column 1 Not used.

Column 2 Not used.

Column 3 Enter the comment of the first group.

Column X Enter the comment of the (X-2)th group.

Row 4

Column 1 Blank (disregarded by Import).

Column 2 Blank (disregarded by Import).

Column 3 Enter the IO Wait of the first group.

Column X Enter the IO Wait of the (X-2)th group.

Row 5

Column 1 Not used.

Column 2 Not used.

Column 3 Enter the timeout of the first group.

Column X Enter the timeout of the (X-2)th group.

Row 6

Column 1 Enter the address of the first setting.

Column 2 Enter the note of the first setting.

Column 3 Enter the value of the first setting - in the first

Group.

Column X Enter the value of the first setting - in the

(X-2)th group.

Row 7

As for Row 6, but for the second setting.

Row Y

As for Row 6, but for the (Y-5) setting.

Pulse 4.12 User Guide 1201

Importing a CSV Format File into a Recipe
You can import a recipe definition from a worksheet (i.e., Microsoft Excel)
in CSV format into the Recipe Explorer. The CSV file and the project’s RCP
files can be located in different folders.

To import recipe information from a worksheet in CSV format

1 Go to the File ribbon and click the Import icon or right-click

on a Recipe name under the Recipes tree and select Import from
the pop-up menu.

The Import Recipe dialog box is displayed.

2 Click the button in the File Name field and browse for the CSV
file to import.

3 Check the Merge checkbox to overwrite the recipe (optional). If

you select the Merge option, provide a new recipe name for the
merged recipe.

Leave the Merge checkbox unchecked if you are importing the CSV
file as a new recipe.

4 Click OK.

5 Make any required changes to any parameters in any of the recipe’s

groups (see the previous procedure for parameter descriptions).

6 From the File menu, click Save or Save As to save the recipe in
Pulse recipe format.

Pulse 4.12 User Guide 1202

Exporting a Recipe to a CSV Format File
You can export a recipe from the Recipe Explorer to a worksheet (i.e.,
Microsoft Excel) in CSV format.

To export recipe information to a worksheet in CSV format

1 Open the recipe to export and go to the File ribbon and click the

Export icon or right-click on a Recipe name under the

Recipes tree and select Export from the pop-up menu.

The Export Recipe dialog box is displayed.

2 Select the new *.csv file name from the File Name field.

3 Select whether the CSV file will open in a Horizontal or Vertical

layout from the Layout options.

4 Check the Merge checkbox to overwrite the recipe (optional). If

you select the Merge option, provide a new recipe name for the
merged recipe.

5 Click OK.

The new *.csv file is saved.

Pulse 4.12 User Guide 1203

Exporting Display Items to Recipe
Developer users can now export items of a Display or items of a Display
with resources to Recipe.

Display item(s) can be exported to Recipe. Display item(s) with

Resource(s) that were selected in the Resources Selector window can be
exported to Recipe.

To export a Display to Recipe

1 In the Developer Workstation, open the Display and export the

Display to Recipe by going to the File ribbon and selecting Export
> [name of the display] > To Recipe.

The Save Recipe As window is displayed. The default Recipe name

on the field is the Display name.

2 Accept the default name or enter a new recipe name in the Save
Recipe As dialog box and click OK.

The exported Recipe is listed under the Recipes section and the
exported items under 'Group1'.

To export a display with resource as Recipes

1 In the Developer Workstation, open the Display with Resources and

export the Display to Recipe by going to the File ribbon and
selecting Export > [name of the display] > To Recipe.

The Resource Selector window is displayed.

Pulse 4.12 User Guide 1204

2 Click on the checkbox(es) to select the resource(s) you want to
export to Recipe.

The Save Recipe As window is displayed. The default Recipe name

on the field is the Display name and the name of the recipe
[DisplayName_RecipeName].

3 Accept the default name or enter a new Recipe name in the Save
Recipe As dialog box and click OK.

The exported Recipe is listed under the Recipes section and the
exported items under 'Group1'.

Setting Up Recipes during Development

A recipe operation is initiated when the action button, or the autoaction in
which the recipe operation is configured, is respectively pressed or
triggered.

This section includes the following topics:

 Recipe Operations without Operator Choice (Automatic Initiation)

 Recipe Operations with Operator Choice (Dialog Box)

 Loading a Recipe (Developer Workstation)

 Learning a Recipe (Developer Workstation)

 Comparing Recipe Groups

Recipe Operations without Operator Choice

(Automatic Initiation)
A recipe command configured without operator choice (all command
arguments pre- configured) is executed without additional operator
intervention - when the recipe operation is initiated, it is executed in the
background.

Recipe Operations with Operator Choice (Dialog

Box)
A recipe command configured with operator choice (some command
arguments omitted) is executed with operator intervention - when the
recipe operation is initiated, the operator is presented the recipe Wizard
dialog box from which to choose the missing arguments.

Pulse 4.12 User Guide 1205

Loading a Recipe (Developer Workstation)
Use the LoadRcp command to load (download) a particular Group of a
recipe, sending the setting values from the recipe file to their respective
PLC addresses. The LoadRcp command skips settings with blank value.

When initiating a load recipe operation configured with operator choice on

an Animation object, the Operator Workstation presents the Load Recipe
wizard. According to the configuration of the particular operation, users
can select:

 The recipe and then the group

 Only the group of a preselected recipe

To define a Load Recipe action

 In the Developer Workstation, enter one of the following command

syntaxes into an Action field or an AutoAction:

LoadRcp To present a dialog box listing all the recipes

in the project, from which the operator can
choose a particular recipe and group, or
abort.

LoadRcp [RECIPE] To present a dialog box listing all the groups

in a specific recipe, from which the operator
can choose a particular group, or abort.

LoadRcp [RECIPE] To run the recipe automatically without

[group name] further operator intervention. This command
loads a specific group from a specific recipe.

Pulse 4.12 User Guide 1206

Learning a Recipe (Developer Workstation)
Use the LearnRcp command to learn (upload) a particular Group of a
recipe from the PLC to the Recipe file, i.e., edits the recipe group with
actual values from the PLC.

When initiating a learn recipe operation configured with operator choice on

an Animation object, the Operator Workstation presents the Learn Recipe
wizard. According to the configuration of the particular operation, users
can select:

 The recipe, template group and destination group

 The template group and destination group

 Only the destination group

To define a Learn Recipe action

 In the Developer Workstation, enter one of the following command

syntaxes into an Action field or an AutoAction:

LearnRcp To present a dialog box listing all the recipes

in the project, from which the operator can
choose a particular recipe, a particular
template group, and specify a destination
group, or abort.

LearnRcp To present a dialog box listing all the groups

[RECIPE] in the specific recipe, from which the
operator can choose a particular template
group and specify a destination group, or
abort.

LearnRcp To learn a specific group of the specific

[RECIPE] [group recipe and modify its respective values.
name]

LearnRcp To learn the recipe automatically without

[RECIPE] [group further operator intervention. This command
name to learn] learns a specific group of the specific recipe,
[group name to and modifies the respective values of a
modify] second group (the action creates the second
group if does not exist in the recipe).

Pulse 4.12 User Guide 1207

Comparing Recipe Groups
Use the CompRcp command in the Developer Workstation to compare
between two groups of a recipe in the Developer Workstation. A potential
application of this command is to verify that a LoadRcp command
executed properly (for example, was not disturbed by communication
problems, or some of the settings were not changed by other means).

During runtime, the recipe compare operation compares the values of

corresponding addresses in the two groups. The comparison succeeds if all
value pairs match - or fails if any value pair does not match.

When initiating a compare recipe operation configured with operator

choice, the Operator Workstation presents the Compare Recipe wizard.
According to the configuration of the particular operation, users can
select:

 The recipe, the first and second groups.

 The first and second groups.

 Only the second group.

To define a Compare Recipe action

 In the Developer Workstation, enter one of the following command

syntaxes into an Action field or an AutoAction:

CompRcp To compare the specified group of the

dbsr|pulse!OK specified recipe against an operator-
[RECIPE] [group specified group, and place the result in
name] dbsr|pulse!OK. During runtime, a dialog
box is displayed listing all the groups in
-or- the recipe, from which the operator can
choose a particular group (or abort).
CompRcp |!OK
[RECIPE] [group
name]

Pulse 4.12 User Guide 1208

 CompRcp To compare the two specified groups of
dbsr|pulse!OK the specified recipe against each other,
[RECIPE] [1st group and place the result in dbsr|pulse!OK.
name] [2nd group
name

-or-

CompRcp |!OK
[RECIPE] [1st group
name] [2nd group
name]

Pulse 4.12 User Guide 1209

Data Logger
The Pulse Data Logger collects any item data and saves it to a compatible
user database or to a spreadsheet such as Microsoft Excel. The data is
collected through triggered or time events. It can then be retrieved from
the database using standard SQL queries, which you can use for multiple
purposes.

The Data Logger can be used as follows:

 Generating reports

 Creating graphs

 Creating table lists, etc.

Data Logger Functionality

The user can gain multiple benefits from the Data Logger functionality:

 Historical and report groups can be set from the Pulse Client within
the Developer Workstation.

 Historical data (i.e., direct addresses) can be collected from any

item and not just for blocks.

 Users can save their data to external databases or spreadsheets

and may use third party applications to retrieve specific data.

Pulse 4.12 User Guide 1210

Data Logger Groups
There are two types of Data Logger groups:

 Historical Group

 Report Group

Historical Group
The Historical Group data is logged to a pre-defined Pulse database. The
user can define multiple Historical groups and multiple tags added to each
group. The collection of data is initiated by pre-defining a logging function
such as time intervals, value change, and other functions.

Items that are set in a Historical group are automatically integrated as

groups in Historical Trends.

Report Group
The Report Group data is logged to a user-defined database. The user can
define multiple Report groups and multiple tags added to each group. The
data is collected by setting up Item tags and then defining one or multiple
triggers to initiate the collection. The trigger modes can be data capture at
a certain scheduled time, change in value or a specific event.

Pulse 4.12 User Guide 1211

Activating the Data Logger
When the Data Logger is enabled, it allows the user to save History data
to any compatible user database or to a form of spreadsheet instead of
just the default .HIS files used in prior versions of Pulse.

To activate the Data Logger functionality:

1 Open Project Setup and create a new project where you want to
run the Data Logger or select an existing project.

2 Set the new project as the default project.

3 Go to PCIM-Software > PCIM[x.x] > Projects > [Project

Name - for Data Logger] > Settings > Historical Data and
double-click Historical Data - Enable Collection.

The Historical Data - Enable Collection window is displayed.

Pulse 4.12 User Guide 1212

4 Select one of the following options from the Enable Historical
Data Collection drop-down list:

• Data Logger History Enabled - Select this option when

switching from Database Server (DBSR) mode to Data
Logger mode. The following Historical Data - Enable
Collection dialog box is displayed when switching to Data
Logger mode.

Select one of the following type of action to perform for all

blocks:

 Overwrite 'Data Logger' existing history settings

with 'DBSR' history settings. - Overwrites the
existing target history settings with the source
settings.

 Add 'DBSR' history settings to the 'Data Logger'

history settings. - Adds the source history settings to
blocks, which do not have history settings in the target
mode.

 Leave 'Data Logger' history settings as is. -

Leaves the target history settings as it is.

Pulse 4.12 User Guide 1213

 • DBSR History Enabled - Select this option when switching
from Data Logger mode to Database Server (DBSR) mode.
The following Historical Data - Enable Collection dialog
box is displayed when switching to Database Server
(DBSR) mode.

Select one of the following types of action to perform for all

blocks:

 Overwrite 'DBSR' existing history settings with

'Data Logger' history settings. - Overwrites the
existing target history settings with the source
settings.

 Add 'Data Logger' history settings to the 'DBSR'

history settings. - Adds the source history settings to
blocks, which do not have history settings in the target
mode.

 Leave 'DBSR' history settings as is. - Leaves the

target history settings as it is.

• History Disabled - Select to disable historical data

collection.

5 Click OK to continue.

Pulse 4.12 User Guide 1214

Historical Data Collection for Database Blocks
The collected and saved History values are saved to the default Pulse
database. Historical data collection can be used with the following blocks
for previous and present versions of Pulse:

 Analog Value

 Digital Value

 Calculation

 Boolean

Enabling Historical Data Collection

To enable Historical data collection

1 Log into the Developer Workstation and go to the Database

Explorer.

2 Create a new block by right-clicking on a block type and selecting

New Block from the pop-up menu

or

Use a block that was previously created.

Collecting historical data can also be applied to old blocks but they
have to be configured to do so first. Previous history is not
migrated.

3 In the Create New dialog box, define the block parameters.

4 Click to select the Enable History checkbox option in the History

area to enable collecting historical data from the block.

When enabling the History option for an Analog Value or Calculation

block, the user can also define the following parameters otherwise
default values are set:

• Logging Interval - The time interval between data

recordings

Pulse 4.12 User Guide 1215

 • Logging Dead Band - The range of the value the user sets
that is considered as a 'dead band'. The dead band is the
value range that is not logged.

For example, if the value set by the user is '1', then the data
recorded is from '2' or '-1', values like .5 or 1.5 are not
logged.

• Use Logging Average - Select this checkbox option to

display the average log value between the logging intervals.

Pulse 4.12 User Guide 1216

Historical Logger Groups
The Historical Logger Group is defined from the Pulse Developer
Workstation. The user can define a historical group collection for a specific
set of items that can be used in Historical Trends (Historical Trend Graphs
and Smart Information) or any third party application for various
purposes. Any item's history data can be collected without the need for
blocks, i.e., direct addresses.

Creating a Historical Logger Group

To create a Historical Logger Group

1 Go to the Data Logger Explorer and expand the Groups folder.

2 Create a new Historical group by going to the tree and right-clicking

on Groups > Historical and selecting New from the pop-up menu
option.

The Historical Logger Group dialog box is displayed. It consists of

the General and Tags tabs. The user can set the actions and values
range in the General tab and set the tag parameters in the Tags
tab.

Pulse 4.12 User Guide 1217

3 Enter a description for the Historical Logger Group in the
Description field.

4 Define the following parameters in the General tab:

Enable Logging Enables historical logging when the checkbox

is checked.

Buffering Set the time in seconds to disable the buffer

duration when when logging is disabled.
logging disable

Actions

Log On Failed Select this Action checkbox option to log

when a failure is recorded.

Action On Failed Set the required action from the Action

Selector when a failure is recorded.

Log Values Range

Enable Log Select this checkbox option to enable the

Values Range parameters for logging the values that are
within or out of range.

Pulse 4.12 User Guide 1218

 Log In Range Select this option to log values that are within
the specified range; this parameter is only
active when the Enable Log Values Range
option is selected.

Log Out of Select this option to log the values that are
Range out of the specified range; this parameter is
only active when the Enable Log Values
Range option is selected.

From Provide the lowest value in this field.

To Provide the highest value in this field.

5 Define the following parameters in the Tags tab:

Dead Band Data Logger only logs the value when it is

(absolute value) equal or greater than the dead band value.

Logging Select the AnyChange, CurrentValue,

Function Average, Lowest, or Highest option from
the drop-down list.

When the CurrentValue, Average, Lowest,

or Highest option is selected, the Logging
Interval parameter is displayed.

Pulse 4.12 User Guide 1219

 Logging Interval Define the logging interval period between
logging sessions.

Import from TSV Click this button to browse for the *.tsv file
to import.

Export to TSV Click this button to export the list to a *.tsv

file.

Tag Name The name of the tag

Address The address designated to the tag, i.e., AV1

or 1:1:40001.

Description Provide a tag description.

Pulse 4.12 User Guide 1220

Report Logger Groups
Report Logger is defined from the Pulse Developer Workstation. The user
can define a Report group collection for a specific set of items, save the
data to any user-defined database or spreadsheet that can be used by any
third party application for various uses. Item history data are collected for
blocks and for other items such as direct addresses.

Creating a Report Logger Group

To create a Report Logger Group

1 Go to the Data Logger Groups tree, right-click on Report and

select New from the pop-up menu.

The Report Logger Group dialog box is displayed.

2 Enter a description for the Report Logger Group in the Description

field.

The Report Logger Group dialog box consists of the following tabs:

• General tab - Where the general parameters such as

timeouts, description, actions and log parameters are
defined.

• Triggers tab - Where triggers and their parameters are

defined.

• Connection tab - Provide the connection parameters here.

• Tags tab - Define the tag and tag parameters here.

3 Define the following parameters in the General tab:

Tags Timeout Provide the timeout period for the tag here
(0 - 60 seconds)

Tags Loading Provide the waiting time when loading a tag

Wait (0 - 60 in this field.
seconds)

Load Tags before Check this checkbox option to load tag data
Report before capturing the report tag values.

Actions

Log on Success Select this Action checkbox option to log the

successful event to the Data Logger event
log.

Pulse 4.12 User Guide 1221

 Action on Set an action to execute, from the Action
Success Selector when an event is successful.

Log on Failed Select this Action checkbox option to log a

failed event to the event log.

Action on Failed Set an action to execute from the Action

Selector when a failure is recorded.

Log on Timeout Select this Action checkbox option to log on a

timeout event to the event log.

Action on Set an action to execute from the Action

Timeout Selector when a timeout is recorded.

Pulse 4.12 User Guide 1222

4 Define the following parameters in the Triggers tab:

The collection of data is initiated by triggers. The Triggers tab is

used to add and specify the trigger's mode and properties to initiate
the collection of data.

Trigger Name The name of the Report trigger; the name is

unique to each group.

Trigger Mode Select BySchedule (default),

ByItemChange, or ByEvent from the drop-
down list.

5 Define the following parameters when the BySchedule option is

selected:

Starts on Pulse Select this option to activate the trigger for

Startup the Data Logger Report during Pulse startup.

Start at Select this option and set the time schedule

when the Data Logger Report should start
collecting data.

Pulse 4.12 User Guide 1223

 End Time Set the time schedule when the Data Logger
Report should end logging data, if no end
time is selected, the data is only logged at
start time.

Select the day(s) when the Data Logger Report trigger is activated
by clicking on the day of the corresponding checkbox(es): Sunday,
Monday, Tuesday, Wednesday, Thursday, Friday, and
Saturday

Repeat Task Select this checkbox option to repeat the

Every trigger according to the frequency set on the
drop-down list (from 1 to 60) and select the
type of frequency time, i.e., by seconds,
minutes or hours

If ByItemChange is selected as the Trigger Mode, then the Data

Logger Report is triggered when the specified tag item value is
changed.

If ByEvent is selected as the Trigger Mode, then the Data Logger

Report is triggered when an event occurs. Define the following
parameters for this mode:

Event Mode Select ByAnyChange, FromZeroToAny, or

FromAnyToZero from the drop-down list to
set the type of trigger for the event mode.

Event Expression Define the expression for the event.

Skip First Click to select this checkbox option to cause

Trigger Data Pulse to skip the first event Report trigger.

Pulse 4.12 User Guide 1224

6 Define the following parameters in the Connection tab:

Provider Select one of the following type of database

connection from the drop- down list:

 SQLServer

 Access

 Oracle

 ODBC

 CSV

SQLServer - Structured Query Language, the programming

language for managing data held in Relational Database
Management System

When SQL is selected, define the following parameters:

Data Source Define the path of the data source location.

Pulse 4.12 User Guide 1225

 Security

Windows Check this checkbox option to authenticate

Authentication user ID via Windows instead of using a user
name and password.

User Enter the SQL user name, the default is 'sa'.

This parameter is available when Windows
Authentication is not selected.

Password Enter the SQL password, the entry appears in

asterisks. This parameter is available when
Windows Authentication is not selected.

Initial Catalog Select tempdb, model, mad or any of the

available database from the drop-down list

Target Table Set this parameter from the Item Manager

window.

Connection Displays the string of the connection

String

Connect Timeout Define the interval of time between

connections.

Command Define the interval of time between

Timeout commands.

Test Connection Click this button to see if the connection is

working; if successful, a Connection
Success message is displayed.

Access - A Microsoft Office data management system that stores

data in its own format based on the Access Jet Database Engine. It
can import or link directly to data stored in the Pulse application
and database

When Access is selected, define the following parameters:

Data Source Define the path of the data source location.

Target Table Set this parameter from the Item Manager

window

Connection Displays the string of the connection

String

Connect Timeout Define the interval of time between

connections.

Pulse 4.12 User Guide 1226

 Command Define the interval of time between
Timeout commands.

Test Connection Click this button to see if the connection is

working; if successful, a Connection
Success message is displayed.

Oracle - An object-relational database management system

When Oracle is selected, define the following parameters:

Data Source Define the path of the data source location.

Security

User Enter the SQL user name, the default is 'sa'.

This parameter is available when Windows
Authentication is not selected.

Password Enter the SQL password, the entry appears in

asterisks. This parameter is available when
Windows Authentication is not selected.

Target Table Set this parameter from the Item Manager

window.

Connection Displays the string of the connection.

String

Connect Timeout Define the interval of time between

connections.

Command Define the interval of time between

Timeout commands.

Test Connection Click this button to see if the connection is

working; if successful, a Connection
Success message is displayed.

Pulse 4.12 User Guide 1227

 ODBC - Open Database Connectivity - accesses any user defined
Pulse database management system

When ODBC is selected, define the following parameters:

Data Source Select one from the following data source:

 DR Lexicon Web

 Visio Database Samples

 dBASE Files

 Excel Files

 MS Access Database

Security

User Enter the SQL user name, the default is 'sa'.

This parameter is available when Windows
Authentication is not selected.

Password Enter the SQL password, the entry appears in

asterisks. This parameter is available when
Windows Authentication is not selected.

Target Table Set this parameter from the Item Manager

window.

Connection Displays the string of the connection.

String

Connect Timeout Define the interval of time between

connections.

Command Define the interval of time between

Timeout commands.

Test Connection Click this button to see if the connection is

working; if successful, a Connection
Success message is displayed.

CSV - Comma-Separated Values - stores tabular data (numbers

and text) in plain text form

When CSV is selected, define the following parameters:

Target Table Set this parameter from the Item Manager

window.

Pulse 4.12 User Guide 1228

 Connect Timeout Define the interval of time between
connections.

Command Define the interval of time between

Timeout commands.

7 Define the following parameters in the Tags tab:

The Tag tab is used to compose the table in which the item data
values and Item properties are saved.

Import from TSV Click this button to browse for a *.tsv file to
import.

Export to TSV Click this button to export to a *.tsv file.

Pulse 4.12 User Guide 1229

 Fetch Table Click this button to fetch the schema from the
database and display the data on the Report
Logger table. Select a database from the
Fetch the Table dialog box and click OK to
confirm.

The existing data on the table is overwritten

8 Click the '+' to add a tag; the following table parameters are shown
in the table:

Primary Key Click to select this checkbox option if the tag

should be a primary key.

Use Index Select this checkbox option if the tag should

be used as an index.

Field Name Set the field name from the Item Manager
window.

Item Set the parameter from the Item Manager

window.

The address of the tag and item name, i.e.,

|!AV_FANSPEED

Data Type The type of tag data.

Width The width of the tag or the number of digits

consisting the width

Decimal The number of the decimal places

Default Value The default value of the tag, if any.

Allow DBNull Select this checkbox option to show a null

value in the database field.

Pulse 4.12 User Guide 1230

9 Define the following parameters in the Tags tab:

Auto Increment

Auto Increment Specify a column with automatically

Column Name incremented values (row value); if this option
is selected, the Column Name field becomes
active.

Record Current Time

Current Time Select this option to use the current time, if

Column Name this option is selected, the Current Time
Index parameter is available.

Current Time Select this checkbox option to use a current

Index system index for the time.

Pulse 4.12 User Guide 1231

Viewing the Historical and Report Logger Groups
from the Item Manager Window
The Historical and Report Logger Groups can be viewed from the Item
Manager window.

To view the Historical Logger Group

 Go to the Item Manager and look under Hosts > Masterhost >
Data Logger > History.

To view the Report Logger Group

 Go to the Item Manager and look under Hosts > Masterhost >
Data Logger > Report.

Pulse 4.12 User Guide 1232

The Developer Workstation
Interface
This section contains the following topics:

 Quick Access Toolbar (Developer Workstation)

 Using the Toolbox Panel

 Working with Layers

 Working with Themes

 Defining Display Properties

 Defining Template Properties

 Defining Cell Properties

 Defining Smart Cell Properties

 Display Templates

 Display Resources

 Find and Replace Utility

Pulse 4.12 User Guide 1233

Quick Access Toolbar (Developer
Workstation)
The Developer Workstation has its own unique Quick Access Toolbars. The
Quick Access Toolbar contains shortcuts to some of Pulse’s common
commands, enabling you to execute these commands quickly. This toolbar
is always available, regardless of the ribbon which is currently displayed in
the workstation.

Developer Workstation Quick Access Toolbar (Graphics Mode)

Developer Workstation Quick Access Toolbar (Database Mode)

You may place the Quick Access Toolbar either above or below the main
interface’s ribbon.

To change the Quick Access Toolbar’s location

1 Click the down arrow at the far right end of the toolbar.

2 Click Show Quick Access Toolbar Below the Ribbon.

The Quick Access Toolbar relocates accordingly.

To add a command to the Quick Access Toolbar

 In the Developer Workstation, open the relevant ribbon, right-click

the command button and then click Add to Quick Access
Toolbar.

To remove a command from the Quick Access Toolbar

 In the Quick Access Toolbar, right-click the relevant button and

then click Remove from Quick Access Toolbar.

Pulse 4.12 User Guide 1234

Quick Access Toolbar Commands
The following commands are available in the Developer Workstation Quick
Access Toolbar:

Go to the Operator Workstation.

After making changes to the database, click this button to

restart the server and activate the changes.

Navigates to either the Graphics or to the Database mode,

depending on the current mode.

 Graphics mode - Open a new Graphics display.

 Database mode - Add a new block to the

database. Click the arrow and select the type of
block from the submenu.

Opens an existing display for further viewing or editing

Saves the current display. Click the arrow to open a

submenu with the following commands:

 [Display Name] - Saves the current display

 Save As - Saves the current display to a different

name

 As Template - Saves the current display as a

template

 Save - to process

 All - Saves all open displays

Find and Replace a value in the current display or in

other locations within the Pulse database

Click the Tools icon to open the Data Scope. Click the
arrow to open a submenu providing access to the
following modules:

Data Scope, Item Explorer, Alarm Explorer, Server

Manager, Schedule Manager, User Manager, Logger
Window

Logs into the Pulse Server

Pulse 4.12 User Guide 1235

 Locks the Developer Workstation so that it cannot be
edited or moved until someone unlocks it

Opens Pulse’s Help. Click the arrow to open a submenu

providing access to the Help according to the Table of
Contents or a Search utility, as well as the About Pulse
Workstation dialog box.

Using the Toolbox Panel

Use the Toolbox Panel as a source for easily adding objects to the active
display in the Developer Workstation. The Toolbox Panel contains the
same Graphic Objects, Instruments, Cells, ActiveX Controls, and .NET
Framework Controls as are available from the Insert ribbon.

Additionally, you can add and remove Active X and .NET Framework
Controls from the Toolbox Panel and the Insert ribbon. By adding the
item, you are making it available for use from both locations. Conversely,
by removing the item, it disappears from both locations (although remains
in the library and can be made available at other times).

To open the Toolbox panel

 From the Developer Workstation’s Personalize ribbon, click the

Toolbox icon.

The Toolbox panel is displayed on the right side of the workstation

screen.

Pulse 4.12 User Guide 1236

To add an object to the display

1 In the Toolbox, click the object category’s “+” button to expand the
category and display its available objects.

2 Select the object, and then place the mouse pointer inside the
display area.

3 Drag the pointer to another location to draw the object.

4 Adjust the object’s dimensions until you’re satisfied with the result,
see Choosing a .NET Framework or ActiveX Control from the
Toolbox.

Working with Layers

Pulse allows you to create layers on the display, which enables runtime
users to have control over certain elements without affecting the
appearance or location of other elements.

Layers are placed over and under each other and can be manipulated
separately. During runtime, users are able to see those layers which their
access levels permit. Runtime users can also expose and hide layers (if
permitted according to the Security policy).

The Developer Workstation includes a Layers Editor, in which you create,

select, modify, change order, rename, and delete layers.

The layers are stacked according to a numerical order which you can
define in the Layer Editor. The Default Layer is always the first layer, with
a value of 0, and whose order cannot be changed. However, you can
manipulate the order of all additional layers by assigning them Numbers
1, 2, 3, and so on.

Pulse 4.12 User Guide 1237

Adding and Editing Layers
To access the Layers editor

 From the Developer Workstation’s Personalize ribbon, click

Layers.

The Layers tree is displayed.

Pulse 4.12 User Guide 1238

From the Layers tree, you can do the following:

 Create a layer

 Select all elements in a layer

 Edit a layer’s properties

 Rename a layer

 Show and hide a layer

 Delete a layer

 Show the visibility state of each layer

Creating a Layer
To create a layer

 In the Layers tree, right-click and click New.

The name of the new layer appears at the bottom of the tree. All
new layers are automatically added at the bottom of the stack,
although you may change the order in the Layers Editor.

Pulse 4.12 User Guide 1239

Editing a Layer’s Properties
To edit a layer’s properties

1 In the Layers tree, right-click the layer name and click Edit.

The Layer Editor dialog box is displayed.

2 Define Layer parameters as follows:

Number Define the number position of the layer in

the stack. You can assign numbers 1, 2,
3, etc., to specify the layer’s position.

NOTE “0” is reserved for the Default

Level whose position is always
at the top and cannot be
changed.

Name Type a name for the layer. This name

appears in the Layers tree.

Usability Lock Choose the security levels of the users

who may work inside the selected layer.

Visibility Lock Choose the security levels of the users

who are allowed to view the selected
layer.

Description Type a description for the layer.

3 Click OK.

Pulse 4.12 User Guide 1240

Showing and Hiding a Layer
To show and hide a layer

1 To make a layer visible in the display, select (check) the layer.

2 To make a layer invisible in the display, deselect (uncheck) the

layer.

Selecting All the Elements in a Layer

To select all elements in a layer

NOTE The Select All command is only available from an open

display.

1 In the Layer tree, right-click the layer name and click Select All.

A selection box surrounds all associated elements.

-or-

In the Developer Workstation’s Edit ribbon, click Select and

then click By Layer.

The Layers dialog box is displayed.

2 Select the layer from the Select Layer drop-down list.

3 Click OK.

The relevant elements are now selected in the display.

Pulse 4.12 User Guide 1241

Renaming a Layer
To rename a layer

1 In the Layer tree, right-click the layer name and click Rename.

The layer’s name is highlighted in the tree.

2 Type a new name.

Deleting a Layer
To delete a layer

 In the Layer tree, right-click the layer name and click Delete.

The layer disappears from the display and the tree without
confirmation.

Showing the Visibility State of Each Layer

To show the visibility state of each layer

Pulse supports for built-in OWS items showing the visibility state of each
layer:

OWS|PCIM!LayerNumber<X>.Visible = 0/1

The LayerBox and the ShowLayer activity are set to 0/1 for the item

ows|pcim!LayerNumber<X>.Visible

when the layer state changes.

1 At Runtime, click the Personalize ribbon and click the Layers icon.

The Layers window is displayed showing the layers.

2 Click the Tools ribbon and click Item Explorer.

The Item Explorer window is displayed.

3 Click the link Hosts > OWS.

Each layer’s item and status are displayed.

Pulse 4.12 User Guide 1242

Flexible Default Layer
The user can now assign any layer in the Layers tree to be the default
layer. Every new object created will be assigned automatically to the new
default layer.

For example, if Layer 2 is assigned as the new default layer then all the
objects created after Layer 2 was assigned as the default layer will be
located in Layer 2.

To set any layer as the default layer

1 From the Developer Workstation’s Personalize ribbon, click

Layers.

The Layers tree is displayed.

2 Select and right-click on the layer you want to assign as the new
default layer.

3 Select Set as Default from the pop-up menu.

The new layer is labeled and set as the default layer.

Pulse 4.12 User Guide 1243

Working with Themes
Themes allow you to set, for use in different situations, different graphic
properties (Fill, Line, and Text Appearance) for the same set of graphic
objects in a single display. In a theme, you can create styles, which can
be made up of any Fill, Line, and Text Appearance properties as required.
A theme can have more than one style, and you can then apply the
various styles to graphic objects in the display.

Multiple themes allow you to use the same display, albeit with different
graphic properties, if required for different situations. You can use the
same style names in all the themes, and vary the graphic properties
definitions in all of them.

For example, you can create a display of two blue ellipses in which one
has a dark shade and the second one has a light shade. Save the
properties of each ellipse as styles “Dark” and “Light” and save them
together in a “blue” theme. Then, create another theme called “red” and
apply it to the display. Change the “Dark” style to dark red and the “Light”
style to light red.

Then, when you need the blue theme, apply it to the display. When you
need the red theme, apply it to the display. You can create as many
themes as you need.

If a theme is attached to the display, only those styles assign7ed to it are

available for use with the display. You cannot apply a style with a different
name from a different theme.

If you assign a theme to a display which is already associated with a

different theme, the display’s objects adopt the new theme styles. If an
object style, associated with the previous theme, is not previously
included in the new theme, that style will automatically be added to that
new theme, retaining its style name (of course, you may want to change
that added style’s properties in the new theme).

Pulse 4.12 User Guide 1244

Creating and Editing Themes
Use the Themes and Styles editor to create themes and styles.

From the Themes tree, the following is possible:

 Accessing the Themes and Styles Editor

 Creating a New Theme

 Renaming a Theme

 Deleting a Theme

 Editing an Existing Theme

 Creating a New Style

 Editing an Existing Style

 Renaming a Style

 Deleting a Theme

 Editing an Existing Style

 Applying a Theme and Style to the Current Display

A style includes setting the following sets of physical properties:

 Setting Object Fill Properties

 Setting Text Fill Properties

 Setting Object Line Properties

 Setting Text Line Properties

 Setting Text Appearance Properties

Pulse 4.12 User Guide 1245

Accessing the Themes and Styles Editor
To access the Themes and Styles editor

 From the Developer Workstation’s Personalize ribbon, click

Themes Styles.

The Themes tree is displayed.

Creating a New Theme

To create a new theme

1 In the Themes tree, right-click the Themes root and then click
Create New Theme.

The Edit Theme dialog box is displayed.

Pulse 4.12 User Guide 1246

2 Enter the following information:

Name Type the theme’s name; the name will

appear in the Theme tree.

Description Provide a description for the theme.

3 Click OK.

The theme’s name now appears in the Theme tree, and you may
apply it to your displays.

Renaming a Theme
To rename a theme

1 In the Theme tree, right-click the theme name and click Rename
Theme.

The theme’s name is highlighted in the tree.

2 Type a new name.

Deleting a Theme
To delete a theme

1 In the Theme tree, right-click the theme name and click Delete
Theme.

2 Click Yes to confirm.

Editing an Existing Theme

To edit an existing theme

1 In the Theme tree, right-click the theme name and click Edit
Theme.

The Edit Theme dialog box is displayed.

2 Change the Description as required.

3 Click OK.

Pulse 4.12 User Guide 1247

Creating a New Style
To create a new style

1 In the Theme tree, right-click the theme name and click New
Style.

The Edit Style from Default dialog box is displayed.

2 Define Style parameters as follows:

Style Name Provide a name for the style; this name will
appear in the Theme tree.

Style Description Provide a description for the style.

3 Define the rest of the style properties which will characterize the
objects to which you associate this style. The properties are the
same as those graphic properties which you can assign to individual
objects.

Pulse 4.12 User Guide 1248

 For descriptions of these properties, click any of the following links:

• Setting Object Fill Properties

• Setting Text Fill Properties

• Setting Object Line Properties

• Setting Text Line Properties

• Setting Text Appearance Properties

4 To define another set of object properties for the style, click the
appropriate icon in the Edit Style dialog box’s toolbar.

5 Click OK.

The style’s name now appears in the Theme tree, and you may
apply it to objects on your displays.

Pulse 4.12 User Guide 1249

Editing an Existing Style
To edit an existing style

1 In the Theme tree, click the “+” sign to the left of the theme
name.

2 Right-click on one of the theme’s style and select Edit Style.

The Edit Style dialog box is displayed.

3 Edit the Style Description and/or any of the graphics properties;

see Renaming a Theme for the procedure description.

4 To define another set of object properties for the style, click the
appropriate icon in the Edit Style dialog box’s toolbar.

5 Click OK.

The modified properties take effect in any objects to which this

style is assigned.

Renaming a Style
To rename a style

1 In the Theme tree, click the “+” sign to the left of the theme’s
name.

2 Right-click the style name and select Rename Style.

The style’s name is highlighted in the tree.

3 Type a new name.

Deleting a Style
To delete a style

1 In the Theme tree, right-click the style name and click Delete
Style.

2 Click Yes to confirm.

Pulse 4.12 User Guide 1250

Applying a Theme and Style to the Current Display
To apply a theme and style to the current display

NOTE To apply a style, you have to first apply its associated theme
to the display.

1 In the Theme tree, right-click the theme name and click Apply
Theme On Display.

You can now apply any of this theme’s styles to graphic objects in
the current display.

2 Select an object.

3 Right-click a style name in the Theme tree and click Apply Style.

The object now has the properties defined in this style.

A style includes setting the following sets of physical properties:

 Setting Object Fill Properties

 Setting Text Fill Properties

 Setting Object Line Properties

 Setting Text Line Properties

 Setting Text Appearance Properties

Pulse 4.12 User Guide 1251

Defining Display Properties
In the Display Properties dialog box, define the display’s appearance
and positioning, as well as autoactions and resources associated with it.
These settings determine how the display is displayed in the Operator
Workstation.

NOTE You can define properties for a display only if it is open.

Defining the Properties of the Selected Display

To define the properties of the selected display

1 Open the display in the Developer Workstation.

2 Right-click inside the display, or right-click the display’s name in the

left navigation pane, and then click Display Properties.

The Display Properties dialog box is displayed.

3 Define the properties, opening all tabs if necessary, to complete the

display’s configuration.

Pulse 4.12 User Guide 1252

4 Click Apply to implement changes while keeping this dialog box
open.

5 Click OK to implement changes and close the dialog box.

You can define the following types of parameters for the display:

 General

 Window Style

 AutoActions

 Resources

 Security

General
In the General tab, you can define the appearance of the display space,
such as its opening mode and background color scheme.

Pulse 4.12 User Guide 1253

Set the display’s General parameters as follows:

Description Type a free text string to describe the display.

Mode Select the way the display opens and remains

visible on the screen.

 Popup - As long as the display is open,

it remains visible above any other display
that is not also a popup.

NOTE A pop-up display is automatically

selected in the Operator
Workstation, so attempting to select
a non pop-up one is ineffective.
However, the operator can use all
the visible controls in all the open
displays.

If the Operator Workstation screen

has one popup display, it is always
the current one. If there is more
than one popup display, the last
accessed popup is the current one.
If there are no pop-up displays, the
last accessed display is the current
one.

 Overlap - The display may be

overlapped by other displays.

 Replace - When this display opens, the

most recent current display closes.

 ReplaceAll - When this display opens,

all other open displays close.

 Invisible - The display is hidden.

 Dialog - the window is displayed with a

thick, dialog- box style border.

Theme Name Name of the theme assigned to the display, see

Flexible Default Layer.

Template Name of the template from which the display

originated, see Defining Template Properties.

Pulse 4.12 User Guide 1254

First Position Define this parameter only if the operators will
work in the Operator Workstation exclusively
with the keyboard. This setting defines the
control in the display that is initially highlighted
when the display is opened (if the display has
more than one control, such as Input Text,
Action Button, or Slider).

Background

Color Choose a color for the background surrounding

all objects in the display.

Image Layout If the background is an image, choose the way

that the image appears.

 None - no image in background.

 Stretch - single image covers the

display’s entire surface area.

 Tile - several instances of the image

cover the display, depending on the
image file’s size.

 Center - single image is located in the

middle of the display.

Image Browse and choose an image to appear as the

display’s background.

Pulse 4.12 User Guide 1255

Window Style

Define the following Window Style properties for the selected display:

Window Location and Size

Mode Choose the mode for defining the display’s start

position:

 CenterScreen - Location is the center of

the workstation window. User defines the
display’s size.

 Manual - User defines the display’s size

and location.

 WindowsDefaultBounds - The size and

location are determined by the PC’s
operating system.

 WindowsDefaultLocation - Location is
determined by the PC’s operating system.
User defines the display’s size.

Pulse 4.12 User Guide 1256

The following fields are applicable when the Window State is set to
Normal. They are used to define the location and dimensions of the
display window in the Operator Workstation window during the Normal
state.

Left The number of pixels from the left edge of the

workstation window.

Top The number of pixels from the top edge of the

workstation window.

Border Style Sets the displays border style.

 None - no borders will be displayed as

well as the title bar. The window is not
sizable.

 FixedSingle - the window is displayed

with a fixed single border. The window is
not sizable

 Fixed3D - the window is displayed with a

fixed 3D border line. The window is not
sizable

 FixedDialog - the window is displayed

with a thick, dialog- box style border. The
window is not sizable.

 Sizable - The window is sizable.

 FixedToolWindow - A tool window

border that is not resizable.

 SizableToolWindow - A resizable
window border.

 SizableWithoutCaption - A resizable
window border and no title bar.

Minimized Select this checkbox option to minimize the

Window Style.

Display Size

Width The width, in pixels, of the display during the

Normal state.

Height The height, in pixels, of the display during the

Normal state.

Pulse 4.12 User Guide 1257

Auto Stretch Select this checkbox option to automatically
stretch the window style.

AutoScroll Select this checkbox option to automatically

scroll the window.

AutoActions
In the AutoActions tab, define any actions or workflows that Pulse
automatically executes, in relation to the selected display, upon Display
Open or Close, or upon receiving a defined trigger command or an event
occurrence.

This differs from Operator Workstation AutoActions which are triggered by

items that relate only to the workstation, regardless of which display is
open.

Pulse 4.12 User Guide 1258

Define the following AutoActions properties for the selected display:

On Open Select the action or workflow to execute when

the selected display opens.

To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use the

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command or
workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

On Close Select the action or workflow to execute when

the selected display closes.

On Event

In the table, define predefined triggered events, triggered by data

changes.

Active Select this checkbox option to make the

AutoAction active.

Filter row Define the filter row to filter AutoAction

information.

Name Type the AutoAction's name.

Pulse 4.12 User Guide 1259

Mode Select the AutoAction's activation mode. Select
one of the following options:

 Greater than - AutoAction triggered

when the value is greater than defined.

 Less than - AutoAction triggered when

the value is less than defined.

 Change from 0 to 1 - AutoAction

triggered on value change from 0 to 1.

 Change from 1 to 0 - AutoAction

triggered on value change from 1 to 0.

 Any Change - AutoActions triggered on

any value change.

 Change to 0 - AutoAction triggered on

value change to 0.

 Change to non zero - AutoAction

triggered on value change to non zero.

 In range - AutoAction triggered when

the value is in the defined range.

 Equal - AutoAction triggered when the

value is equal to the one defined.

 Not empty text string - AutoAction

triggered when a text string contains
characters.

 Empty text string - AutoAction

triggered when a text string is received
empty.

 Contains string - AutoAction triggered

when text contains sub strings.

Trigger Select how the AutoActions will be triggered.

Type in the item's path or browse to select an
item from the Item Manager.

Start Value Type in the item's start value used as reference

to the selected mode.

End Value Type in the item's end mode (if applicable).

Pulse 4.12 User Guide 1260

Action Specify the action to complete when the
AutoAction is triggered. Select either a
workflow or a Pulse action.

To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command or
workflow (.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Skip first triggered Select this option to cause Pulse to ignore the
data very first trigger data, therefore not executing
the autoaction at that time.

Pulse 4.12 User Guide 1261

Resources
You can create or edit a resource and associate it with the selected display
in the Resources tab. For more information about working with display
resources, see Display Resources.

Associate a resource with the display as follows:

Use Resources If the display already is associated with a

resource, select this option to enable the usage
of the resource’s set of keys and values with
the display.

Edit Click Edit to open the Display Resource

Manager, in which you define the associated
resource’s set of keys and values,
see Display Resources.

Pulse 4.12 User Guide 1262

Security
In the Security tab, define the security levels for Visibility and Usability of
the selected display.

Usability Lock The display may be used only by users whose

security level equals or is higher than the level
specified here.

Visibility Lock The display is visible only to users whose

security level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 1263

Defining Template Properties
In the Template Properties dialog box, enter a description for the
template, which lists its purpose or contents or any other pertinent
information.

To define template properties

1 In the Graphics panel, click on the Templates tab.

2 Right-click the template name and then click Template

Properties.

NOTE The Template Properties option is only active when the

template is open.

The Template Properties dialog box is displayed.

3 Define the properties, open all tabs if necessary, to complete the

display’s configuration.

Pulse 4.12 User Guide 1264

4 Click Apply to implement changes while keeping the dialog box
open.

5 Click OK to implement changes and close the dialog box.

You can define the following types of parameters for the display:

 General

 Window Style

 AutoActions

General
In the General tab, you can define the appearance of the display space,
such as its opening mode and background color scheme.

Pulse 4.12 User Guide 1265

Set the Display’s General parameters as follows:

Description Type a free text string to describe the display.

Mode Select the way the display opens and remains

visible on the screen.

 Popup - As long as the display is open,

it remains visible above any other display
that is not also a popup.

NOTE A popup display is automatically

selected in the Operator
Workstation, so attempting to select
a non popup one is ineffective.
However, the operator can use all
the visible controls in all the open
displays.

If the Operator Workstation screen

has one popup display, it is always
the current one. If there is more
than one popup display, the last
accessed popup is the current one.
If there are no popup displays, the
last accessed display is the current
one.

 Overlap - The display may be

overlapped by other displays.

 Replace - When this display opens, the

most recent current display closes.

 ReplaceAll - When this display opens,

all other open displays close.

 Invisible - The display is hidden.

 Dialog - the window is displayed with a

thick, dialog- box style border.

Theme Name Name of the theme assigned to the display,

see Flexible Default Layer.

Template Name of the template from which the display

originated, see Defining Template Properties.

Pulse 4.12 User Guide 1266

First Position Define this parameter only if the operators will
work in the Operator Workstation exclusively
with the keyboard. This setting defines the
control in the display that is initially highlighted
when the display is opened (if the display has
more than one control, such as Input Text,
Action Button, or Slider).

Background

Color Choose a color for the background surrounding

all objects in the display.

Image Layout If the background is an image, choose the way

that the image appears.

 None - no image in background.

 Stretch - single image covers the

display’s entire surface area.

 Tile – (default) several instances of the

image cover the display, depending on
the image file’s size.

 Center - single image is located in the

middle of the display.

Image Browse and choose an image to appear as the

display’s background.

Pulse 4.12 User Guide 1267

Window Style

Define the following Window Style properties for the selected display:

Window Location and Size

Mode Choose the mode for defining the display’s start

position:

 CenterScreen - Location is the center of the

workstation window. User defines the display’s
size.

 Manual - User defines the display’s size and

location.

 WindowsDefaultBounds - The size and

location are determined by the PC’s operating
system.

 WindowsDefaultLocation - Location is
determined by the PC’s operating system. User
defines the display’s size.

Pulse 4.12 User Guide 1268

The following fields are applicable when the Window State is set to
Normal. They are used to define the location and dimensions of the
display window in the Operator Workstation window during the Normal
state.

Left The number of pixels from the left edge of the

workstation window.

Top The number of pixels from the top edge of the

workstation window.

Border Style Sets the displays border style.

 None - no borders will be displayed as well as

the title bar. The window is not sizable.

 FixedSingle - the window is displayed with a

fixed single border. The window is not sizable

 Fixed3D - the window is displayed with a fixed

3D border line. The window is not sizable

 FixedDialog - the window is displayed with a

thick, dialog- box style border. The window is
not sizable.

 Sizable - The window is sizable.

 FixedToolWindow - A tool window border

that is not resizable.

 SizableToolWindow - A resizable window

border.

 SizableWithoutCaption - A resizable window

border and no title bar.

Minimized Select this checkbox option to minimize the Window

Style.

Display Size

Width The width, in pixels, of the display during the Normal

state.

Height The height, in pixels, of the display during the Normal

state.

Auto Stretch Select this checkbox option to automatically stretch

the window style.

Pulse 4.12 User Guide 1269

AutoScroll Select this checkbox option to automatically scroll the
window.

AutoActions
In the AutoActions tab, define any actions or workflows that Pulse
automatically executes, in relation to the selected display, upon Display
Open or Close, or upon receiving a defined trigger command or an event
occurrence.

This differs from Operator Workstation AutoActions which are triggered by

items that relate only to the workstation, regardless of which display is
open.

Pulse 4.12 User Guide 1270

Define the following AutoActions properties for the selected display:

On Open Select the action or workflow to execute when

the selected display opens.

To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command or
workflow.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

On Close Select the action or workflow to execute when

the selected display closes.

On Event

In the table, define predefined triggered events, triggered by data

changes.

Active Select this checkbox option to make the

AutoAction active.

Filter row Define the filter row to filter AutoAction

information.

Name Type the AutoAction's name.

Pulse 4.12 User Guide 1271

Mode Select the AutoAction's activation mode. Select
one of the following options:

 Greater than - AutoAction triggered

when the value is greater than defined.

 Less than - AutoAction triggered when

the value is less than defined.

 Change from 0 to 1 - AutoAction

triggered on value change from 0 to 1.

 Change from 1 to 0 - AutoAction

triggered on value change from 1 to 0.

 Any Change - AutoActions triggered on

any value change.

 Change to 0 - AutoAction triggered on

value change to 0.

 Change to non zero - AutoAction

triggered on value change to non zero.

 In range - AutoAction triggered when

the value is in the defined range.

 Equal - AutoAction triggered when the

value is equal to the one defined.

 Not empty text string - AutoAction

triggered when a text string contains
characters.

 Empty text string - AutoAction

triggered when a text string is received
empty.

 Contains string - AutoAction triggered

when text contains sub strings.

Trigger Select how the AutoActions will be triggered.

Type in the item's path or browse to select an
item from the Item Manager.

Start Value Type in the item's start value used as reference

to the selected mode.

End Value Type in the item's end mode (if applicable).

Pulse 4.12 User Guide 1272

Action Specify the action to complete when the
AutoAction is triggered. Select either a
workflow or a Pulse action.

To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use

standard syntax.

-or-

 Open the Action Selector to

assemble and/or choose the command or
workflow (.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Skip first triggered Select this option to cause Pulse to ignore the
data very first trigger data, therefore not executing
the autoaction at that time.

Pulse 4.12 User Guide 1273

Defining Cell Properties
A cell is a collection of graphic objects and clipart objects and their
properties that are grouped together into one entity and saved for reuse
during design time. The creation of cells can save Application Engineers
the repetitive work required to configure several sets of similar object
groups.

NOTE Instruments and .NET Framework controls cannot be included

inside a cell.

You create a cell by opening a new cell from the Cells tree in the
Developer Workstation’s Graphics mode. Then, you can either insert
graphic objects or clipart, or copy multiple objects from another display
and paste them into the cell. After a cell is created, it is considered one
object, but the properties that were attached to each of its components
remain associated only with that same component. The Item addresses
and actions of each component become I/Os of this cell - to be adapted to
each particular instance in which this cell is applied.

When inserting a cell in a display, you need to assign a unique name to

this cell instance, and if necessary, modify the cell’s advised items (I/O).

Individual components of a cell may only be modified in its Cell window.

The modifications will take effect in subsequent uses of the cell.

The project’s cells collection is accessible from the Cells tree in the
Developer Workstation’s Graphics mode.

To generate a report listing the cell’s objects and their properties, right-
click the cell name and click Report, see Display Report.

Pulse 4.12 User Guide 1274

To populate a new cell

1 From the File ribbon’s New group, click Cell.

A blank window is displayed.

2 Right-click on the blank window and select Save As.

The Save As Cells dialog box is displayed.

3 In the Name box, type a name for the new cell and click OK.

Pulse 4.12 User Guide 1275

4 Insert graphic objects or clipart, or copy multiple objects from
another display and paste them into the cell.

5 Define object properties, including advised items (I/O).

6 In the File ribbon, click Save > Save.

To make changes in an existing cell

1 In the Cell Explorer tree, right-click the cell name and then click
Open.

-or-

From the File ribbon, click Open. In the Open Cells dialog box,
select the cell and then click OK.

2 Insert graphic objects or clipart, or copy multiple objects from

another display and paste them into the cell, or delete any objects,
or change properties.

3 In the File ribbon, click Save > Save.

To define the cell’s data items

1 After you populate the cell with objects and defined their relevant
data items, right-click inside the cell window and click Cell
Properties.

The Cell Properties dialog box is displayed.

Pulse 4.12 User Guide 1276

 All defined items in the cell are displayed together with a prompt
which is displayed when the user passes over the object with the
mouse in the Operator Workstation. You can edit this prompt.

2 The cell properties are:

Name The cell’s name (read-only).

Description A free text string describing the cell

Version The number of times the cell has been

saved (read-only).

Item This column lists all the data items

configured in the cell (read- only).

Prompt Text that is displayed when the user

passes over an object controlled by the
specific data item in the Operator
Workstation.

3 Click OK.

To delete a cell

 In the Cell Explorer tree, right-click the cell name and then click
Delete.

A message cautions that deleting a cell that was embedded in any

display may corrupt instances in the display(s). You may continue
to edit the cell instance’s data item but do not change the included
objects or any of their other properties (graphic, animation).

To continue deleting, click Yes.

Pulse 4.12 User Guide 1277

Breaking a Cell
A cell containing grouped items can now be broken using the Break Cell
option from the Cell’s context menu. The user is able to change the
object’s location or properties.

NOTE Any changes made to the cell that was “broken” in the display
will not affect the original cell.

To use the Break Cell option

 Right-click on the cell and select Break Cell from the pop-up menu.

The cell in the display is broken into separate objects.

Pulse 4.12 User Guide 1278

Defining Smart Cell Properties
This section discusses the new Smart Cells, Master Blocks and UAG (Unity
Application Generator, from Schneider Electric) features and the following:

 Fundamental blocks and connectivity of Smart Cells, Master Blocks

and interfacing to UAG

 Developing and configuring a Smart Cell

 Master Blocks database entities for Smart Cells

 Interface with Schneider Electric’s UAG

 Applications of Smart Cells in Galleries (parameterized libraries)

About Smart Cells

Pulse Designer Smart Cells are parameterized cells with useful advanced
features. The driving motivation behind smart cells is cell parameter
(Argument, Value) automation and better project design quality. An
additional benefit of parameterized cells is connectivity to external PLC
programs. Smart Cells introduces flexible parameterized variables.

Smart cells accomplish two key benefits: better design quality and
effective cell reuse with Galleries (libraries). In complex and large
projects, standardizing PLC models with smart cells increases quality. A
parameterized model can be developed once and used many times.
Similar PLC models (from one product line) with similar features can be
designed once and used many times. Increase cell reuse is effective in
projects with the same PLC models. They are also useful in creating
company specific or PLC product line Galleries (i.e. model library). This
capability will help both project managers and PLC manufacturers design
accurate Galleries with the ability to parameterize variables.

Definitions and Introduction

Smart Cell
A cell with multiple Arguments (parameters) where only the argument’s
value are replaced in each cell instance, (Unlike Cells where the complete
advised item/expression advised item is replaced during instantiation).

The extension of the Smart Cell is 'scel' and the files are located in the
'Afcon\Pulse\ [Project]\Gallery' folder.

Pulse 4.12 User Guide 1279

Faceplate
A display which defines the Smart Cell’s interface look, logical controls
(programmable .Net Controls), and instrumentation features. The
Faceplate is opened by clicking on the Smart Cell instance in Operator
runtime mode. The Faceplate can contain Arguments which will be defined
by the Smart Cell properties during design placement or runtime. The
purpose of the Faceplate is to give more capability to a specific design
element (i.e., Smart Cell of generator that gives you some details on the
generator’s function and operation). When clicking on the generator, the
Faceplate is opened and you get more details on the generator.

The extension of the Faceplate file is 'dsf' and the files are located in the
'Afcon\Pulse\ [Project]\Displays' folder.

Master Block
Master Block is a way to connect signals from a Smart Cell to the project
display. When a signal needs to be stored or monitored. Master Block
signals can be used in the project display. Signals which are stored for
later processing or archiving also use Master Block Arguments. Signals
which need monitoring for warning or error alarms also use Master Block
Arguments. Master Block Arguments are inherited from the Smart Cell. In
addition, more Arguments can be defined (i.e., internal signals). Master
Block Arguments can be defined as free parameters and receive their
value from the Smart Cell (dynamic signals.) Master Block Arguments can
also be defined as fixed (not free) and hold their values fixed.

The extension of the Master Block is 'sbl' and the files are located in the
'Afcon\Pulse\ [Project]\Gallery' folder.

Pulse 4.12 User Guide 1280

Smart Cell
Smart Cells solve a limitation in standard Pulse Cells. In Pulse Cells,
advised item and advised expression item are replaced during
instantiation. This exposes cell’s internal logic and allows access to change
the cell’s logic and parameters. This ability can cause an inadvertent cell
corruption. If one cell’s logic is corrupted (edited, changed), it is difficult
to find and correct such change. Smart Cells enable Arguments (signals,
parameters, alarms) to be hidden from the designer when used. This
makes the logical and functional elements safer to use. At the same time,
whatever parameters (Arguments) need to be set or updated during
runtime (Operator Mode), are still available to the designer and operator.

Standard Pulse cells have an entity feature. This entity feature

(ThisObject) is a useful feature. It gives users the ability to assign each
cell instance a unique name. Other arguments, do not use the name as a
unique parameter associated only with one specific instance. Essentially, a
Standard Pulse Cell is limited to a single unique argument name. This
limitation is one feature Smart Cells corrected. Now users can
parameterize as many arguments as needed.

Pulse 4.12 User Guide 1281

The Smart Cell Arguments dialog box has a database form (in the
center of the dialog box) where users enter the Smart Cell name,
description, and Master Block Name. In the database form, fields for
Argument, the Description and Master Block Name association are
defined. These steps generate parameterized arguments. Notice how the
Arguments are not assigned values. These will be assigned when the
Smart Cell is instantiated in the project display. These Arguments can also
be assigned values at runtime when a display is opened in Operator
mode.

In comparison to standard Pulse Cells, Smart Cell Arguments replace alias

variables shared by a cell and its faceplate. Alias variables can be difficult
to manage in a large design. A designer needs to assign a unique name to
each variable manually. Assignment needs to be done individually for each
instance and each parameter.

When parameterized argument items are needed (animation properties,

dynamic properties, actions and workflows), Smart Cell Arguments are
defined. In the animation definition form, arguments are assigned names
of the Argument name (previously defined in the Smart Cell Arguments
dialog box) inside curly {} braces. Connecting the Argument name to the
Item name in the properties form is done through the name. Names are
case sensitive.

The argument can be a part of a parameterized item, expression,

function, converted item, bit in a register, concatenated to (ThisObject)
and (this) terms, etc.

Pulse 4.12 User Guide 1282

The Smart Cell Designer (editing a Display) gives options to edit a Smart
Cell’s properties (Add/Edit/Delete Smart Cell Arguments). The Smart Cell
Arguments dialog box gives a user a list of Arguments found in the
Smart Cell object and in a Faceplate. Arguments can also be edited
manually.

An instantiated Smart Cell Argument parameter editor gives the Smart

Cell Argument list and description. The table gives a parameter type to
the Master Block. This connects the Master Block Argument with the
specific instantiated Smart Cell. In the instantiated Smart Cell Argument
edit table curly brackets are not used in the Argument name.

The instantiated Smart Cell Arguments dialog box form is used in three
modes:

Automatically Arguments are displayed from the Smart Cell and

Faceplate animation definitions. Arguments cannot be
deleted by the user. If animation definitions are
deleted, then Smart Cell properties Arguments can be
removed.

Manually Argument can be added and remove manually. Manual

Arguments are used as Faceplate static properties.
These can be alias values, a simple text or any
parameter Argument needed.

For example, create Smart Cell with manual Argument

'Caption'. Place new Label control in the Faceplate and
in the Text property, define your Argument: {Caption}.
Instantiate the Smart Cell in a display and in the 'Alias
Value' write your “Caption”.

InstanceName A system hidden argument which supplies the Smart

Cell instance name as a string type, e.g., if you
instantiate Smart Cell twice on display, each of the
instances will have a unique name. The
{InstanceName} argument in the faceplate, displays
the instance name. The name can be used in animation
(by adding '|!') and in static properties. For Smart Cell
instance name in a Smart Cell, use the key word
'(thisobject)'.

Pulse 4.12 User Guide 1283

Smart Cell Argument Examples

A Smart Cell with two 'advised items': {arg1} and {arg1},,lin(0,10,0,100)

the Smart Cell item will have one Argument: arg1. The conversion will be
applied on the item that was assigned to {arg1} in the smart cell instance
during instantiation.

A Smart Cell with two 'advised items': {arg1} and {arg1}:5 the Smart
Cell item will have one Argument: arg1.

A Smart Cell with three 'advised items': {arg1} and {arg2} and
?Getvalue({arg1}) + Getvalue({arg2}) the Smart Cell item will have two
Arguments: arg1 and arg2 and it will not include the expression that sums
it.

Smart Cell Navigator

Smart Cells will be listed in the Project Navigator under the Smart Cells
Explorer tree.

Pulse 4.12 User Guide 1284

Smart Cell context menu gives the following options:

 Open

 Repair and Open

 Close - Enabled just for open Smart Cell.

 Save - Enabled just for open Smart Cell.

 Save As... - Enabled just for open Smart Cell.

 Delete

 Rename

 Print

 Export

 Report

 Smart Cell Properties - Enabled just for open Smart Cells.

 To edit a Smart Cell’s Argument, Open a Smart Cell by right-

clicking the Smart Cell name and selecting Open from the drop-
down menu.

Pulse 4.12 User Guide 1285

 When a Display is open for editing, the Display Explorer tree shows
the available Smart Cell instances

 Smart Cells have a unique icon different from Displays, Templates,

or Cells

 The Smart Cell drop-down menu options are Open, Repair and
Open, Close, Save, Save As, Delete, Rename, Print, Export, Report,
and Smart Cell Properties.

 Opening a Smart Cell from the Display Explorer opens a display to

edit and save it.

 Changes on the Smart Cell instance takes effect once a display is

saved.

Smart Cell Faceplate

A Faceplate is created as a Display page. By creating a new Faceplate,
first a new Template is created. The Faceplate template uses different
symbols suited for display: buttons, display windows, meters, animated
graphics, and more. When a Faceplate is saved, the action creates a
Display. Connection between a Smart Cell and its Faceplate is by name
only. Therefore a Smart Cell, its Face Plate, and its Display have identical
names. If you save a new Template (which defines a Faceplate) and a
Display instance already exists (based on a Faceplate Template) Pulse
Developer will respond with a save override warning message.

A simple way to create a Smart Cell Faceplate to click the Edit Faceplate
button in the Smart Cell Arguments dialog box. This opens a new
Faceplate Display.

Pulse 4.12 User Guide 1286

Once a new Faceplate Display window is open, the elements needed are
instantiated (buttons, display windows, meters, graphics, etc.) and the
faceplate is saved. Using this procedure, no renaming, or connections are
needed to be made manually.

Pulse 4.12 User Guide 1287

Defining a Smart Cell Faceplate

A Faceplate is the parameter definition display feature of a Smart Cell. In

the “Display,” the Smart Cell functions are defined. Smart Cell regular
display is used in Operator’s view. The Smart Cell display shows the
parameters a designer wants to display a cell’s parameters. In the above
example: Speed, Heat, and Pressure. The Operator view gives the
designer the ability to show parameters in textual and graphical form. The
Smart Cell display design is limited to Graphic Objects. In a Smart Cell
Faceplate Pulse Instruments, .Net Framework Controls and
Industrial Gadgets are available to define logic, operation, display, and
output values. These can use the Properties (Arguments or parameters)
defined in the Smart Cell or other parameters and arguments (in addition
to the ones already defined.)

When a Smart Cell is instantiated (placed in a project display), all the

parameters for the cell are presented in a form.

Inserting a Smart Cell in a Design Display

A Smart Cell is inserted (instantiated) into a display using the Smart Cells
button. The Smart Cell’s arguments are shown (popped up) after the cell
is inserted.

A Smart Cell can be inserted into a display from Insert ribbon > Smart
Cells or from the Smart Cells Explorer.

When a Smart Cell is inserted (by a designer, or the UAG Migration

Wizard), the Smart Cell Arguments Pop-up table automatically opens. The
table’s columns are:

Pulse 4.12 User Guide 1288

 Arguments (RO): The name of the argument as inserted in the
animation.

 Description (RO): The description of the argument in case the

user set it.

 Item (RO): The Alias Token

 Alias Value: The Alias String (the actual item input)

 Master Block Type: In case the Master Block Type was defined
(not 'None'); this is the place to fill the Master Block arguments or
leave it with the default.

Pulse 4.12 User Guide 1289

The new Smart Cell instance creates a new alias (Item column value in
the Smart Cell Properties table). A token is the value in the Item column
and a string is the value of the Alias Value column. The Alias Value string
is the connection of the Smart Cell signal to the project’s display value.
This is what a designer configures at insertion time. In case arguments
also use a Master Block, the arguments can be defined in the table at the
same time (i.e., input the Master Block parameter value). When the
Master Block arguments are not defined, the block is created with the
default values. The alias will be a combination of the Smart Cell’s address
and the Master Block’s address.

The alias and the block (if the block is defined as a Master Block) are
created when the display is saved any time after the Smart Cell is
configured. When a Smart Cell is defined with a Master Block, an option to
activate the database is given at the end of the saving process.

Smart Cell Name Validation

Smart Cells with Master Block instances have equivalent cell names. The
Smart Cell name is used as the Master Block name. When a Master Block’s
arguments are edited, Smart Cell names are validated to match the
Master Block names. Users cannot bypass this verification process by
editing the names in the Advanced Properties pane.

Smart Cell Runtime Argument Resolution

Smart Cell Arguments which are resource keys in the Faceplate have
equivalent value. These are resolved at the time the Smart Cell is run.

Pulse 4.12 User Guide 1290

Master Block
Creating Master Blocks
A Master Block can be created from the BlockTypes tree in the
Database Explorer. Additionally, it can be created by clicking on the
Create as Master Block button in the blocks editors.

The first form to use when creating a Master Block is the Edit Master
Block form. Some fields are selected by default. They are the minimum
necessary field a Master Block needs to be stored ('Block Name',
'Address', etc.). Arguments can be added by right-clicking on the field and
selecting [define as master block argument] from the context menu.
Argument can be deleted by right-clicking and selecting [remove
argument from list] or by selecting X on the field name shown in the
Master Block Arguments list display.

Pulse 4.12 User Guide 1291

Once the Master Block is created. It will be displayed in the database view
BlockType tree > Master Block branch.

Pulse 4.12 User Guide 1292

Creating Master Blocks from Smart Cell
When creating a Master Block from Smart Cell, a dialog box with the free
arguments already defined will pop-up. The new block will be connected to
the Master Cell.

When saving a Master Block for the first time, Pulse checks for an existing
Master Block with the same name. If the BlockType is the same and
associated with the same Smart Cell, the existing Master Block is
overwritten. If the BlockType is different or not associated with the same
Smart Cell, the user is notified of a block of the same name already
exists.

Pulse 4.12 User Guide 1293

Database Tree Explorer
 In Developer mode (during a display editing), the BlockType tree
explorer displays Master Blocks instances when the 'Master Blocks'
branch is expanded.

 The Master Blocks names are represented by a specific graphic icon

according to its block type (Analog Value, Digital Value, etc.)

 In the BlockType context menu, a user is able to 'Open' a Master

Block for editing (i.e., instance properties, free arguments, block
conditions, etc.), duplicate an instance, etc.

Editing Master Blocks

Changes to a Master Block (adding an Argument or changing a Value),
immediately updates derived block instances. A message to the user
notifies of existing blocks which are updated. Once accepted, saving the
changes in Master Block and instances of the block takes place (if the user
chooses not to save, the Master block is not updated).

Pulse 4.12 User Guide 1294

Display Resources
A Display Resource is a reusable template that represents multiple similar
devices or a group of objects. It includes the data of specific objects in a
display (such as string values, items, real and integer numbers, colors,
actions, and actions arguments, trend attributes). Creating resources
allows you to reuse an existing display multiple times with different
resource values attached to its resource keys, without needing to recreate
similar displays or copy several objects from one display to another.

As a result, display resources reduce the number of displays that you

need to store in the project, help save time during project development,
and make it easier and more efficient to maintain the project.

Resources are composed of key-value pairs. The Key is a unique identifier

of a data item and the value may be either dynamic (receiving its value
from an advised item) or static (such as a button label). When creating a
display with multiple resources, you can insert a Key name in an object’s
Animation Properties, and during runtime, the value that the object
returns is affected by the active resource file, in addition to other dynamic
properties.

Creating a Resource
To create a resource

1 In the Project Navigator pane, open the Graphics mode.

2 Right-click a display name and select Add Resource.

3 To rename the resource, right-click the resource name and select

Rename.

4 Type the new name (overwriting the previous name).

Pulse 4.12 User Guide 1295

Editing a Resource
To edit a resource

1 In the Project Navigator pane, double-click the resource name.

The Display Resource Manager dialog box is displayed.

2 In the Key column, type a key name.

NOTE To specify this key in an object’s Animation Properties, enter it

in the Item field between curly brackets {}. For example,
{AddColor} or DoWorkflow {Workflow_B}.

3 In the Value column, specify the item name (or select it in the
Item Manager ) which controls the value of the corresponding
key.

4 Define the security levels for Visibility Lock and Usability Lock.

5 Click Apply to save and keep the dialog box open or OK to save
and close the dialog box.

Pulse 4.12 User Guide 1296

Using Resources in a Project
You can save time in display development and future maintenance by
creating multiple resources in a single display. You can also add multiple
resources from a single display by using a formula or consecutively. The
display’s elements and objects update during runtime in accordance to the
active resource. Use of a different resource may result in changes in the
displayed data values.

For example, you can create an object in the main display which opens
another display referencing the object’s data. After that, you can create
additional objects which open the same display, yet show the data that’s
specific for them. The display which opens for each object is based on the
resource, which contains the addresses of the connected data sources,
and their associated keys and values.

During runtime, the operator clicks on one of the objects and receives the
appropriate data. The operator then clicks on another object in this same
group and receives data from a different data source. The presentations of
the data look the same but the data varies, according to the selected
object in the main display.

Adding Multiple Resources

There are two methods of adding multiple resources:

 Adding multiple resources consecutively

 Adding multiple resources by formula

Pulse 4.12 User Guide 1297

Adding Multiple Resources Consecutively
The Add Multiple Resources consecutively option multiplies the
selected resource by the specified quantity. Each multiplied resource will
then have a consecutive value, e.g., if the original resource (for example,
is Resource 1) has a key with a value of |!a:1 multiplied by 3, three
resources will be added, Resource2 with a value of |!a:2, Resource3 with
a value of |!a:3, and Resource4 with a value of |!a:4.

To add multiple resources consecutively:

1 First, create a resource which the rest of the resources to be

multiplied will be based on.

2 Right-click the Display name and select Add Resource.

The first resource is added called Resource1.

3 Double click on Resource1 and the Display Resource Manager

dialog box is displayed.

4 Enter a description in the Description field, provide a key name in

the Key column, and then enter a corresponding value for the key
in the Value column. In this example, the |!a:1 value is provided.

Pulse 4.12 User Guide 1298

5 Click Apply and then click OK.

6 Go to the display and right-click on Resource1 then select Add

Multiple Resources consecutively from the drop-down menu.

The Resource Multiplication message is displayed informing you that

the Resource file has changed and whether you want to save the
changes.

7 Click Yes to continue.

The Resource Multiplication message is displayed informing you that

the procedure will override all resources falling under the same
rule.

8 Click Yes to continue.

The Multiple Resource dialog box is displayed.

9 Enter the quantity of resource to multiply in the Quantity field, in

this example, enter 3 as the quantity.

10 Click OK.

The resource is multiplied according to the quantity you specified,

in this case multiplied by 3. Three resources are added, Resource2
with a value of |!a:2, Resource3 with a value of |!a:3, and
Resource4 with a value of |!a:4.

Pulse 4.12 User Guide 1299

Adding Multiple Resources by Formula
The Add Multiple Resources by formula option multiplies the selected
resource based on the formula or mathematical expression provided in the
Value field corresponding to the Key. The expression contains a bracket
or brackets with two integers and an operator (multiplication (x), division
(/), addition (+) or subtraction (-) sign). The expression provided in the
selected resource (Resource1 for example) is the basis of the iterated
value(s) in the multiplied resources.

NOTE At runtime, a formula can be added on-the-fly to an element

without having to define it as a resource.

To add multiple resources by formula:

1 First, create a resource which the rest of the resources to be

multiplied will be based on. Right-click the Display name and select
Add Resource.

The resource is added, if it is the first resource, it is called

Resource1.

2 Double click on Resource1 and the Display Resource Manager

dialog box is displayed.

3 Enter a description in the Description field, provide a key name in

the Key column, and then enter a corresponding value for the key
in the Value column. Enter an expression that can be iterated.

The following sample expressions are provided:

• |!a:[1 + 1]

• 1:1:[01 + 1]

• ab[300 - 3]cd[400 / 2]

• [-5 * 3]

Pulse 4.12 User Guide 1300

4 Click Apply and then click OK.

5 Select the display and right-click on the resource and select Add
Multiple Resources by formula from the drop-down menu.

The Resource Multiplication message is displayed informing you that

the procedure will override all resources falling under the same
rule.

6 Click Yes to continue.

The Multiple Resource dialog box is displayed.

Pulse 4.12 User Guide 1301

7 Enter the quantity of resource to multiply in the Quantity field, in
this example, enter 3 as the quantity.

8 Click OK.

The resource is multiplied according to the quantity you specified,

in this case multiplied by 3. Three resources are added; refer to the
following table as an example.

KEY RESOURCE1 RESOURCE2 RESOURCE3 RESOURCE3

(VALUE) (VALUE) (VALUE) (VALUE)

ACTION |!a:[1 + 1] |!a:2 |!a:3 |!a:4

k2 1:1:[01 + 1] 1:1:02 1:1:03 1:1:04

k3 ab[300 - ab297cd200 ab294cd100 ab291cd050

3]cd[400 / 2]

k4 [-5 * 3] -15 -45 -135

Pulse 4.12 User Guide 1302

Importing/Exporting to TSV via the Display
Resource Manager
You can Import from or Export to TSV to/from the display’s resources
using the Export Resources and Import Resources options in the
Display Resource Manager dialog box.

To import/export TSV files

1 In the Display Resource Manager dialog box, go to the

Resource Name list and select a resource.

2 Right-click on the resource and select Export Resources or

Import Resources from the drop-down menu.

Pulse 4.12 User Guide 1303

Opening a Resource by Action
You can set an action for a graphic object or instrument which opens a
resource.

To define the opening of a resource file

NOTE The number and types of keys in a resource must fit its
associated display object’s configuration. Any attempt to open
a display with an incompatible resource file results in an error
and is recorded as an application event in the application log.

1 Open the object’s or instrument’s settings to the Action Button or

Actions Workflow tab.

2 Type the appropriate command string. Use one of the following

options:

NOTE The character “G” stands for “Group” and must be included in
the applicable syntaxes.

Open DisplayName

If the resource name is not specified, the display’s default resource

opens.

Open DisplayName +G:ResourceName

Opens a second instance of the current display with the specified

resource (the current display name does not include the resource
name).

Open DisplayName -G:ResourceName

Replaces the current display with the same display plus the
specified resource (the current display name does not include the
resource name).

Open DisplayName.ResourceName

Opens a second instance of the current display with the specified

resource (the current display name includes the resource name).

Pulse 4.12 User Guide 1304

The following illustration shows an example:

Adding Multiple Resources at Runtime

Specify the number of resources to add in the Quantity field of the

Multiple Resource dialog box.

Pulse 4.12 User Guide 1305

Display Templates
A template is a starting point for building displays in the Developer
Workstation. Application Engineers can populate templates with defined
graphic objects, database blocks, workflows, and so on. When opening a
template in design-time, it includes those predefined elements and their
properties and/or advised items.

Building displays from templates saves lots of time and labor when
designing displays for similar production lines or floor layouts.

Pulse includes 17 built-in display templates:

 AnaIn (Analog Input)

 AnaIn_A (Analog Input - with Alarms)

 AnaIn_G (Analog Input - with Trend Graph)

 AnaOut (Analog Output)

 AnaOut_G (Analog Output - with Trend Graph)

 DiIn (Digital Input)

 DiOut (Digital Output)

 Motor_1Way (One Way Motor)

 Motor_1Way2Speed (One Way Motor, Two Speed)

 Motor_2Way (Two Way Motor)

 Motor_2Way2Speed (Two Way Motor with Two Speed)

 Motor_VS (Motor with Variable Speed)

 PID (PID Control)

 Pump

 Pump_VS (Pump with Variable Speed)

 Valve_Pro (Proportional Valve)

 Valve_SV (Solenoid Valve)

Pulse 4.12 User Guide 1306

AnaIn (Analog Input)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation modes:

item action
buttons 0 = Auto (Automatic
mode) If the Mode key
is set to 0, the Control
Mode changes to
Automatic mode and
does not allow adjusting
the slider and the value
level.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual. The
value level can be
manually adjusted
through the slider for
simulation purposes.

Pulse 4.12 User Guide 1307

Resource Resource Type Interface Description
Key Type Key

PV Digital Slider The Process Value of the

item elements. It affects the
slider, fluid fill ranges,
and value.

Indicator ENG_ String Engineering Displays the Engineering

UNITS Units Units of the element(s)
Indicator

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider and the
maximum fluid fill
range.

Min Range Number Min value Represents the

indicator element’s minimum
calibration range. It
affects the slider and the
minimum fluid fill range.

Pulse 4.12 User Guide 1308

AnaIn_A (Analog Input - with Alarms)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode String Mode Operation modes:

action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set
to 0, the Control Mode
changes to Automatic
mode and does not
allow adjusting the
slider and the value
level.

1 = Manual (Manual
mode)
If the Mode key is set
to 1, the Control Mode
changes to Manual.
The value level can be
manually adjusted
through the slider for
simulation purposes.

Pulse 4.12 User Guide 1309

Resource Resource Type Interface Description
Key Type Key

PV Analog Slider The Process Value of

item the elements. It affects
the slider, fluid fill
ranges, and value.

Bypass String Bypass Enables masking the

action alarm
buttons
0 = Unmasked
1 = Masked

Indicator ENG_ String Engineering It displays the

UNITS units Engineering Units of
indicator the element.

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider and
the maximum fluid fill
range.

Min Range Number Min value Represents element’s

indicator minimum calibration
range. It affects the
slider and the
minimum fluid fill
range.

Alarm HH Analog Value High High Alarm

Conditions item display Setpoint Value

H Analog Value High Alarm Setpoint

item display Value

L Analog Value Low Alarm Setpoint

item display Value

LL Analog Value Low Low Alarm

item display Setpoint Value

Pulse 4.12 User Guide 1310

AnaIn_G (Analog Input - with Trend Graph)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set
to 0, the Control Mode
changes to Automatic
mode and does not
allow adjusting the
value level and the
slider.

1 = Manual (Manual
mode)
If the Mode key is set
to 1, the Control Mode
changes to Manual. The
value level can be
manually adjusted
through the slider for
simulation purposes.

PV Analog Slider The Process Value of

item the elements. It affects
the slider, fluid fill
ranges, and value.

Pulse 4.12 User Guide 1311

Resource Resource Type Interface Description
Key Type Key

Indicator ENG_ String Engineering Displays the

UNITS Units Engineering Units of
Indicator the element

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider, the
maximum fluid fill
range, and the range of
the Trend graph.

Min Range Number Min value Represents element’s

indicator minimum calibration
range. It affects the
slider, the maximum
fluid fill range, and the
range of the Trend
graph.

Pulse 4.12 User Guide 1312

AnaOut (Analog Output)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation modes:

item action
buttons 0 = Auto (Automatic
mode)

If the Mode key is set

to 0, the Control Mode
changes to Automatic
mode and does not
allow adjusting the
value level and the
slider.

1 = Manual (Manual
mode)

Pulse 4.12 User Guide 1313

Resource Resource Type Interface Description
Key Type Key

If the Mode key is set

to 1, the Control Mode
changes to Manual. The
value level can be
manually adjusted
through the slider for
simulation purposes.

Cout Analog Control The Control Output

item action value element that
buttons affects the slider, the
fluid fill range, and
value.

Indicator ENG_ String Engineering Displays the

UNITS Units Engineering Units of
Indicator the element

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider and
the maximum fluid fill
range.

Min Range Number Min value Represents element’s

indicator minimum calibration
range. It affects the
slider and the minimum
fluid fill range.

Pulse 4.12 User Guide 1314

AnaOut_G (Analog Output - with Trend Graph)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set
to 0, the Control Mode
changes to Automatic
mode and does not
allow adjusting the
value level and the
slider.

1 = Manual (Manual
mode)
If the Mode key is set
to 1, the Control Mode
changes to Manual. The
value level can be
manually adjusted
through the slider for
simulation purposes.

Pulse 4.12 User Guide 1315

Resource Resource Type Interface Description
Key Type Key

Cout Analog Control The Control Output

item action value element that
buttons affects the slider, the
fluid fill range, and
value.

Indicator ENG_ String Engineering Displays the

UNITS Units Engineering Units of
Indicator the element

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider, the
maximum fluid fill
range, and the Trend
range.

Min Range Number Min value Represents element’s

indicator minimum calibration
range. It affects the
slider, the minimum
fluid fill range, and the
Trend range.

Pulse 4.12 User Guide 1316

DiIn (Digital Input)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Simulation Modes:

item action
buttons 0 = Auto (Automatic
mode) - Simulation Off
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode) Simulation On
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1317

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the simulation

item action output state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Indicator Din Digital Motor The status indicator

item status displays the input’s state
indicator
0 = Off, gray
1 = On, green

Pulse 4.12 User Guide 1318

DiOut (Digital Output)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Element’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode) - Simulation Off
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode) Simulation On
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Cout Digital Control Sets the output state

item action
buttons 0 = Off
1 = On

Pulse 4.12 User Guide 1319

Resource Resource Type Interface Description
Key Type Key

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Indicator Din Digital Motor The status indicator

item status displays the input’s state
indicator
0 = Off, gray
1 = On, green

Pulse 4.12 User Guide 1320

Motor_1Way (One Way Motor)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Motor’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1321

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the motor’s output

item action state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Indicator Cin Digital Motor The status indicator

item status displays the motor's Run
indicator state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Normal state - gray

(standby) or green
(active) depending on
the motor's state

1 = Alarm state - Red

Pulse 4.12 User Guide 1322

Motor_1Way2Speed (One Way Motor, Two Speed)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Motor’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1323

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the motor’s output

item action state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Speed Digital Speed Controls the motor’s

item action speed
buttons
0 = Slow
1 = Fast

Indicator Cin Digital Motor The status indicator

item status displays the motor’s Run
indicator state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Off - gray (standby)

or green (active)
depending on the
motor's state

1 = On - Alarm state -
Red

Pulse 4.12 User Guide 1324

Motor_2Way (Two Way Motor)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Motor’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1325

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the motor’s output

item action state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Direction Digital Direction Controls the motor’s

item action direction
buttons
0 = Forward
1 = Backward

Indicator Cin Digital Motor The status indicator

item status displays the motor’s Run
indicator state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Off - gray (standby)

or green (active)
depending on the
motor's state

1 = On - Alarm state -
Red

Pulse 4.12 User Guide 1326

Motor_2Way2Speed (Two Way Motor with Two
Speed)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Motor’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1327

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the motor’s output

item action state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Speed Digital Speed Controls the motor’s

item action speed
buttons
0 = Slow
1 = Fast

Direction Digital Direction Controls the motor’s

item action direction
buttons
0 = Forward
1 = Backward

Indicator Cin Digital Motor The status indicator

item status displays the motor’s Run
indicator state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Off - gray (standby)

or green (active)
depending on the
motor's state
1 = On - Alarm state -
Red

Pulse 4.12 User Guide 1328

Motor_VS (Motor with Variable Speed)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Motor’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set
to 0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set
to 1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Cout Analog Sets the VFD output

item
0 = Off
1 = On

Pulse 4.12 User Guide 1329

Resource Resource Type Interface Description
Key Type Key

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Dout Digital Control Sets the motor’s

item action output state
buttons
0 = Off
1 = On

PV Analog The Process Value of

item the elements. It affects
the slider, fluid fill
ranges, and value.

Setpoint Analog Sets the motor’s

item setpoint value

Indicator Cin Digital Motor The status indicator

item status displays the motor’s
indicator Run state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Off - gray
(standby) or green
(active) depending on
the motor's state

1 = On - Alarm state -
Red

ENG_ String Engineering Displays the

UNITS Units Engineering Units of
Indicator the element

Pulse 4.12 User Guide 1330

Resource Resource Type Interface Description
Key Type Key

Max Range Number Max value Represents the

indicator element’s maximum
calibration range. It
affects the slider and
the maximum fluid fill
range.

Min Range Number Min value Represents the

indicator element’s minimum
calibration range. It
affects the slider and
the minimum fluid fill
range.

Alarm H Analog Value High Alarm Setpoint

Conditions item display Value

L Analog Value Low Alarm Setpoint

item display Value

Pulse 4.12 User Guide 1331

PID (PID Control)

Pulse 4.12 User Guide 1332

Resource Resource Type Interface Description
Key Type Key

General Description String Displays the control loop

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Cout Analog Sets the control loop

item output

PV Analog The Process Value of the

item control loop. It affects
the slider, fluid fill
ranges, and value.

Setpoint Analog Sets the control loop

item manual setpoint value

Asp Digital Automatic/manual

item setpoint

0 = Auto (Automatic
mode), the setpoint
equals the process value

1 = Manual (Manual
mode), the setpoint
equals the setpoint that
was configured by the
user

Pulse 4.12 User Guide 1333

Resource Resource Type Interface Description
Key Type Key

Indicator ENG_ String Engineering Displays the loop input

UNITS Units Engineering Units
Indicator

Max Range Number Max value Represents the

indicator maximum loop input
calibration range. It
affects the slider and the
maximum fluid fill
range.

Min Range Number Min value Represents the

indicator minimum loop input
calibration range. It
affects the slider and the
minimum fluid fill range.

P Analog
item

I Analog
item

D Analog
item

Pulse 4.12 User Guide 1334

Pump

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Pump’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1335

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the pump’s output

item action state
buttons
0 = Off
1 = On

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Indicator Cin Digital Pump The status indicator

item status displays the pump’s Run
indicator state

0 = Off, gray
1 = On, green

Alarm Digital Alarm Indicates the pump’s

item indicator alarm state

0 = Normal state - gray

(standby) or green
(active) depending on
the motor’s state
1 = Alarm state - Red

Pulse 4.12 User Guide 1336

Pump_VS (Pump with Variable Speed)

Pulse 4.12 User Guide 1337

Resource Resource Type Interface Description
Key Type Key

General Description String Displays the Pump’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set
to 0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set
to 1, the Control Mode
changes to Manual
and the Control
buttons are enabled.

Cut Analog Sets the VFD output

item

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Doubt Digital Control Sets the pump’s

item action output state
buttons
0 = Off
1 = On

PV Analog The Process Value of

item the VFD. It affects the
slider, fluid fill ranges,
and value.

Setpoint Analog Sets the pump’s

item setpoint value

Pulse 4.12 User Guide 1338

Resource Resource Type Interface Description
Key Type Key

Indicator In Digital Pump The status indicator

item status displays the pump’s
indicator Run state

0 = Off, gray
1 = On, green = On,
green

Alarm Digital Alarm Indicates the motor’s

item indicator alarm state

0 = Off - gray
(standby) or green
(active) depending on
the motor's state

1 = On - Alarm state -
Red

ENG_UNITS String Engineering Displays the

Units Engineering Units of
Indicator the element

Max Range Number Max value Represents the

indicator pump’s maximum
calibration range. It
affects the slider and
the maximum fluid fill
range.

Min. Range Number Min. value Represents the

indicator pump’s minimum
calibration range. It
affects the slider and
the minimum fluid fill
range.

Alarm H Analog Value High Alarm Setpoint

Conditions item display Value

L Analog Value Low Alarm Setpoint

item display Value

Pulse 4.12 User Guide 1339

Valve_Pro (Proportional Valve)

Pulse 4.12 User Guide 1340

Resource Resource Type Interface Description
Key Type Key

General Description String Displays the Valve’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)

If the Mode key is set

to 0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)

If the Mode key is set

to 1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Cout Analog Sets the Valve output

item

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

PV Analog The Process Value of

item the Valve (Open
percentage). It affects
the slider, fluid fill
ranges, and value.

Setpoint Analog Sets the valve’s

item setpoint value

Alarm Digital Alarm Indicates the valve’s

item indicator alarm state

Pulse 4.12 User Guide 1341

Resource Resource Type Interface Description
Key Type Key

0 = Off - gray
(standby) or green
(active) depending on
the motor's state

1 = On - Alarm state -
Red

Alarm H Analog Value High Alarm Setpoint

Conditions item display Value

L Analog Value Low Alarm Setpoint

item display Value

Pulse 4.12 User Guide 1342

Valve_SV (Solenoid Valve)

Resource Resource Type Interface Description

Key Type Key

General Description String Displays the Valve’s

identification on the
topmost part of the
template

Control Mode Digital Mode Operation Modes:

item action
buttons 0 = Auto (Automatic
mode)
If the Mode key is set to
0, the Control Mode
changes to Automatic
mode and the Control
buttons are disabled.

1 = Manual (Manual
mode)
If the Mode key is set to
1, the Control Mode
changes to Manual and
the Control buttons are
enabled.

Pulse 4.12 User Guide 1343

Resource Resource Type Interface Description
Key Type Key

Cout Digital Control Sets the valve’s output

item action state
buttons
0 = Close
1 = Open

Bypass Digital Alarm Enables masking the

item bypass alarm
action
buttons 0 = Unmasked
1 = Masked

Indicator Cin Digital Valve The status indicator

item status displays the valve’s input
indicator state

0 = Close, gray
1 = Open, green

Alarm Digital Alarm Indicates the valve’s

item indicator alarm state

0 = Normal state - gray

(standby) or green
(active) depending on
the motor's state

1 = Alarm state - Red

Pulse 4.12 User Guide 1344

Find and Replace Utility
Use the Find and Replace utility to search the project for advised items,
text, and values matching only those criteria that you specify, such as
searching for the occurrence of a string in an animation property. The
search can cover locations such as data blocks, alarms, displays,
workflows, and resources. The choice of search elements affects the
available search criteria. To focus a search over a small cross-section, you
can request a match of specific properties, operators, and/or values.

After receiving results, you have the option of replacing it (them).

Additionally, you can double-click a results entry, which opens the found
item’s location.

To find and replace a search item

1 In the Edit ribbon (or Home ribbon), click the Find and
Replace icon.

The Find and Replace panel is displayed, docked on the right side of
the screen. To work more comfortably, move the panel away from
the side and resize it.

Pulse 4.12 User Guide 1345

2 In the Look In list, choose the elements where the search takes
place.

• Displays, Cells, Templates

• Alarms (all fields or common fields only)

• Current Display

• Scheduler, Server, Workstation AutoActions

• Whole Project

• All Open Displays, Cells, Templates

• Blocks (all fields or common fields only)

• Workflows

• Resource

• All Open Displays

NOTE Choosing Whole Project initiates a search through the following

properties of each element:

• Display - Item

• Cell - Item

• Template - Item

• Workflow - Text

• Scheduler Auto Actions - Item

• Server Auto Actions - Item

• Workstation Auto Actions - Item

• Resource - Value

• Blocks - Block Name

• Alarms - Alarm Name

3 Select a Property or multiple Properties to include in the search

criteria.

Pulse 4.12 User Guide 1346

4 In the Operator column, choose whether the value is the complete
string (“=”), meets the condition of another operator (such as “<“,
“>=”) or is contained within a line of additional text (“Contains”).

5 Specify what you are searching for. In the Item row’s Value column,
type the exact string.

6 Click Find.

Any instances of your search value will appear in a results list in the
dialog box’s right pane.

7 Click Replace to open the Find and Replace Results dialog box.

Pulse 4.12 User Guide 1347

8 Enter Find and Replace parameters as follows:

Find In Define the location or element to find the item

that needs replacement. For example, “Display
Name contains Floor” or “Block Type = Analog
Value.”

Replace What Define the item that needs replacement. The

value can be the complete string (“=”), is
contained within a line of additional text
(“Contains”), or may be found in any context
(“Any”).

With Enter the item that will replace all occurrences

of the found item.

9 Click Find Next to find the next instance of the search value,
according to the specified criteria.

-or-

Click Replace to replace the currently found instance of the search

value with the Replace value.

-or-

Click Replace All to replace all found instances of the search value
with the Replace value.

10 Click Save to save the “find and replace” parameters.

To go to a found object, block, or resource

 In the Results list, double-click a results entry.

The relevant display, resource, workflow, or data block is displayed

in the Workstation. Displays and workflows open with the relevant
object or item selected. Data blocks open in the Database Explorer.
Resources open in the Display Resource Manager.

Pulse 4.12 User Guide 1348

Workstation Management Modules
This section contains the following topics:

 Defining the Project Configuration

 Operator Personalization Workstation Settings

 Working with the Item Manager

 Defining Aliases

 Logger Policy

 Defining Logging Policies

 Defining System and Interface Localization

 Defining Conversion Functions

 Working with the Workflow Manager

 Blinking Colors

 Toolbars and Context Menus

 Defining Server AutoActions

Pulse 4.12 User Guide 1349

Operator Personalization Workstation
Settings
Use the Operator Personalization Settings window to configure settings
that relate to the operator workstation only (Runtime mode). These
settings include workstation layout settings, window style, AutoActions,
and mode.

You can change these settings only while working in the Developer
Workstation and you can change them at any time during project
development.

To change operator workstation settings

1 In the Developer Workstation, enter the Manage ribbon and click

Operator Personalization.

2 Enter any of the following tabs to change the properties:

• General

• Window Style

• AutoActions

• Accelerator Keys

• Status Indication

• User Application

3 After changing the properties, click Apply and enter another tab or
click OK and close the dialog box.

Pulse 4.12 User Guide 1350

General

Define the following General properties for the Operator Workstation.

Startup

Automatically open Select this option so that whenever opening

last display(s) the Operator Workstation, all displays that
were open the last time the Operator
Workstation shut down, will open again.

Operator Input

You can change the position of Animation Input Text dialog boxes
(position default is your screen center) to fit your application design.
This feature is mostly needed if you are using a multi-screen display
and you do not want the dialog boxes to be split between the
screens. The position is set in pixels and determines message/dialog
box distance from the x axis (i.e., left edge of the screen) and the y
axis (i.e., top edge of the screen).

Pulse 4.12 User Guide 1351

 Mode Sets the input text animation position
throughout the entire project;

 CenterDialog - places the input text

dialog box in the middle of the
workstation. This is the default
position.

 InsideTextBox - places the input

text dialog box inside the animation
graphic object.

 OffsetDialog - places the input text

dialog box in a relative position to the
top left corner of the workstation
screen. Selecting this option displays
the Left and Top parameters (see
below).

Enable Virtual Click on this checkbox to select/deselect the

Numeric Keypad Virtual Numeric Keypad option. When the
option is selected/enabled, then an
emulated numeric keypad can be accessed
at runtime, see Enabling the Virtual Numeric
Keypad below.

Other

Always on Top Select this option to place the operator

workstation on top of every other open
window.

Pulse 4.12 User Guide 1352

Enabling the Virtual Numeric Keypad
Pulse has a virtual numeric keypad that can be accessed when the user
prefers to use an on-screen emulated numeric keypad. This feature makes
entering numbers easier for those using this utility.

Pulse does not display the numeric keypad by default; it has to be set in
the Developer workstation and can be accessed in the Operator
workstation.

To enable the virtual numeric keypad

1 In the Pulse Developer workstation, go to the Manage ribbon and

click Operator Personalization.

The Operator Personalization Settings dialog box is displayed.

2 Go to the General tab and select the Enable Virtual Numeric

Keypad checkbox option.

3 Click OK.

Pulse 4.12 User Guide 1353

4 Create a new display and insert an object. In this example, create a
rectangle. Do this by going to the Insert ribbon and clicking
Rectangle from the Graphic Objects group. Go to the work area
and draw a rectangle.

5 Select and right-click on the rectangular object you just created and
select Animations > Text from the drop-down menu.

The Animation pane is displayed.

Pulse 4.12 User Guide 1354

6 On the Animation pane, enter a name for the object in the Name
field.

7 In the Use Format field, select Advanced from the drop-down list.

8 In the Mask Type field, select Numeric from the drop-down list.

9 Go to the File ribbon and click Save or press CTRL+S or click on

the Save icon.

The Save Displays window is displayed.

10 Enter a name in the Name field and click OK.

11 Go to the Operator workstation and select the display you just

saved.

12 Click on the object.

The Numeric Keypad is displayed.

Pulse 4.12 User Guide 1355

 The user in the Operator workstation can now use the emulated
numeric keypad on this display.

Window Style

Pulse 4.12 User Guide 1356

Define the following Window Style properties for the Operator
Workstation.

Size and Location

State Sets the operator workstation window style.

 Normal - sets the operator

workstation size in pixels.

 Minimized - minimizes the operator

workstation window.

 Maximized - maximizes the operator

workstation window.

Size Grip Choose whether to allow the operator to

resize the workstation screen:

 Auto - system decides

 Show - provides controls for resizing

the workstation window.

 Hide - does not provide controls for

resizing the workstation window.

The following fields are applicable when the workstation State is set
to Normal. They are used to define the location and dimensions of
the workstation window on the computer screen during the Normal
state.

Left The number of pixels from the left edge of

the screen.

Top The number of pixels from the top edge of

the screen.

Width/Height The width and height, in pixels, of the

workstation window during the Normal
state.

Pulse 4.12 User Guide 1357

 Auto Stretch The Auto Stretch Displays by
Displays by Workstation size option allows the
Workstation size following (provided that the option is
checked):

 Saving the display size of the

workstation at runtime.

 Saving the workstation screen

resolution size displaying the screen
in Maximized or Minimized display
size.

 Auto stretches the screen

automatically at runtime when the
workstation resizes.

Frame

Border Style Sets the displays border style.

 None - no borders will be displayed

as well as the title bar. The window is
not sizable.

 FixedSingle - the window is

displayed with a fixed single border.
The window is not sizable

 Fixed3D - the window is displayed

with a fixed 3D border line. The
window is not sizable

 FixedDialog - the window is

displayed with a thick, dialog-box
style border. The window is not
sizable.

 Sizable - The window is sizable.

 FixedToolWindow - A tool window

border that is not resizable.

 SizableToolWindow - A resizable
window border.

Window Control Box Select this option to enable the Maximize

and Minimize button on the display title bar.

Verbose Title Select this option to show the displays title.

Pulse 4.12 User Guide 1358

 Minimize Button Select this option to display the window's
Minimize button.

Maximize Button Select this option to display the window's

Maximize button.

Control Tools

Select elements which are open by default when the specified user
starts the Operator Workstation.

Project Navigator Choose to display the Project Navigator

pane, located on the Workstation’s left side,
in which you can select displays to open or
workflows to execute.

Displays Explorer Choose to display the Displays Explorer,

which is the tree in the Project Navigator
pane that lists all displays in the project.
You can select the displays in which to work.

Workflows Explorer Choose to display the Workflows Explorer,

which is the tree in the Project Navigator
pane that lists all workflows in the project.
You can select the workflow to execute.

Layers Selector Choose to display the Layers tree, in which

the operator can display or hide various
layers in the display on the workstation.

Menu Bar Choose to display a menu bar of commands

on the workstation.

Status Bar Choose to display a status bar, which

displays information to the user about a
selected object, function, or action.

Tool Bar Select a user-defined toolbar, from those

created using the Toolbars and Context
Menus Manager, see Toolbars and Context
Menus, to display on the Operator
Workstation.

Pulse 4.12 User Guide 1359

 Object Context Choose the default menu which is displayed
Menu when the user right- clicks a graphic object.
This option affects only objects that do not
contain a Context Menu defined in its
Animation Properties.

The menu options are:

 System - opens the default Pulse

Operator Workstation context menu.

 None - no menu is displayed.

 Current - the most recently set

context menu.

Replace System If a user-defined context menu was selected

Menu as the default, select this option to
completely replace the Pulse system context
menu with the customized menu.

Deselect this option to append the

customized menu commands to the Pulse
system context menu.

Pulse 4.12 User Guide 1360

AutoActions
In the AutoActions tab, define any actions that Pulse executes upon
receiving a defined trigger command or an event occurrence.

The operator workstation AutoActions refer only to the operator

workstation and are not dependent on a specific display being active. This
differs from Developer Workstation AutoActions which are triggered by
items that relate only to a specific display and run actions that are
relevant only to that same display.

Define the following AutoActions properties for the Operator Workstation.

Automation In this section you select which automated

tasks the operator workstation will perform.

 AutoActions - check to run

AutoActions

 AutoAlarm Workflow - check to run

AutoAlarm workflows

 Scheduled Actions - check to run

scheduled tasks

Pulse 4.12 User Guide 1361

  Event Management Workflow -
check to run the Event Management
workflow

 Basic Scripts Actions - check to run

basic scripts actions

 AutoAlarm Display - check to

activate AutoAlarm displays

 AutoAlarm Print - check to activate

AutoAlarm prints

 DataLogger Workflow - check to

run the Data Logger workflow

Define the following actions or workflows to execute when the display

is in various conditions: On Startup, On Shutdown, On Idle,
and/or On Idle End.

To define the object’s data item, enter an action command or

workflow.

• You can type it manually.

When manually typing a command to execute a
workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard syntax.

-or-

• Open the Action Selector to assemble and/or

choose the command or workflow.

NOTE After you enter a workflow, it appears in the relevant edit

box in the following syntax:

[WorkflowName] [arguments]

On Startup Select the action or workflow to execute on

operator workstation start up.

On Shutdown Select the action or workflow to run when

the operator workstation shuts down.

Pulse 4.12 User Guide 1362

 On Login Allows Operator personalization login
settings to be defined per user. The user
can have a personalized login settings
defined by the developer. The operator
personalization depends on the AutoAction
mode.

This is applicable if the AutoActions

checkbox (under the Automatic area) is
selected.

On Idle Select the action or workflow to run during

the operator workstation idle time. Select
the idle time duration in seconds using the
Delay for option.

On Idle End Select the action or workflow to run when

the idle time duration ends.

On Shift End Select the action or workflow to run when

the shift duration ends.

AutoActions Table

Filter row Define the filter row to filter AutoAction

information.

Active Click the checkbox to select the AutoAction

that will be active

Name Type the AutoAction's name.

Mode Select the AutoAction's activation mode.

Select one of the following options:

 Greater Than - AutoAction triggered

when the value is greater than
defined.

 Less Than - AutoAction triggered

when the value is less than defined.

 Change from 0 to 1 - AutoAction

triggered on value change from 0 to
1.

 Change from 1 to 0 - AutoAction

triggered on value change from 1 to
0.

Pulse 4.12 User Guide 1363

  Any Change - AutoActions triggered
on any value change.

 Change to 0 - AutoAction triggered

on value change to 0.

 Change to non zero - AutoAction

triggered on value change to non
zero.

 In Range - AutoAction triggered

when the value is in the defined
range.

 Equal - AutoAction triggered when

the value is equal to the one defined.

 Not empty text string - AutoAction

triggered when a text string contains
characters.

 Empty text string - AutoAction

triggered when a text string is
received empty.

 Contains string - AutoAction

triggered when text contains sub
strings.

Trigger Select how the AutoActions will be

triggered. Type in the item's path or browse
to select an item from the Item Manager.

Start Value Type in the item's start value used as

reference to the selected mode.

End Value Type in the item's end mode (if applicable).

Action Select the action to complete when the

AutoAction is triggered. Specify either a
workflow or a predefined Pulse action.

Skip First Trigger Select this checkbox option to cause Pulse

Data to ignore the very first trigger data,
therefore not executing the autoaction at
that time.

Pulse 4.12 User Guide 1364

You can right-click on the table and select one of the following commands:

 Add Multiple Rows

 Delete Row

 Export All Rows to TSV

 Import All Rows from TSV

Pulse 4.12 User Guide 1365

Duplicating AutoActions on the Server
The Add Multiple Rows option in the AutoActions table can duplicate
multiple copies of automatic actions/workflows.

To add multiple AutoActions rows

1 Right-click anywhere on the AutoActions table and select Add

Multiple Rows.

The Duplicate Trigger AutoAction dialog box is displayed.

2 Enter the number of AutoAction row copies to add on the Quantity

field.

3 Provide the Name Formula (i.e., AutoAction[2+1]).

4 Provide the Trigger Formula (i.e.,

Trigger:|PCIM!AutoAction1.almack
Action:Set|![AutoAction1] [4+1]).

5 Click OK.

The above example duplicates the following automatic

actions/workflows (up to 1000 AutoActions):

Trigger:|![BlockName].almack Action: [Set |![direct item] 1

Pulse 4.12 User Guide 1366

Deleting an AutoAction
The Delete Row option on the pop-up menu allows you to delete an
AutoAction row.

To Delete AutoActions

 Right-click anywhere on the AutoActions table and select Delete

Row.

The selected AutoAction is deleted.

Export All Rows to TSV

The Exporting All Rows to TSV command exports all the selected
AutoAction rows to TSV.

To export all rows to TSV

1 Right-click on a row or rows in the AutoActions table and select

Export All Rows to TSV on the pop- up menu.

2 Save the file as an Auto Actions TSV file type.

Import All Rows from TSV

The Importing All Rows from TSV command imports AutoActions from
TSV files.

To import all rows from TSV files

1 Right-click anywhere on the AutoActions table and select Import

All Rows from TSV on the pop-up menu.

2 Save the file as an AutoActions TSV file type.

Pulse 4.12 User Guide 1367

Accelerator Keys
You can assign Accelerator Keys or shortcut keys to run actions via the
Operator Personalization Settings dialog box Accelerator Keys tab.
Accelerator keys make it more efficient to work with Pulse Actions when
displays or toolbars are unavailable. Accelerator keys can be assigned per
group or per user.

To assign Accelerator keys for Actions

1 In the Operator Personalization Settings dialog box, click the

Accelerator Keys tab.

2 Select the users to load the settings from and define the security on
the left pane of the Operator Personalization Settings dialog
box.

3 Go to the right pane and click “+” to add a row.

4 Click on the downward arrow on the Accelerator Keys column to

display the Accelerator Keys dialog box.

Pulse 4.12 User Guide 1368

5 Assign the shortcut keys for the action and click OK.

6 Click the button in the Action column corresponding to the

newly defined accelerator keys to display the Action Selector
window.

7 Specify the action for the accelerator keys and click OK then OK
again.

The shortcut is created.

Pulse 4.12 User Guide 1369

Status Indication
In the Status Indication tab, define the way that Pulse indicates certain
conditions to the operator.

Error Message Timeout

Show Status Select this checkbox option to enable status

Indication indication.

Timeout (in seconds, Define the timeout for the status indication
0 – wait for user in seconds or enter 0 to wait for the user’s
action) action; applicable only when the Show
Status Indication checkbox option is
selected.

Each of the following conditions requires a unique way to indicate its

occurrence to the operator.

 Status Bad - the way that Pulse indicates an erroneous

condition or value.

 Status Unknown - the way that Pulse indicates an unknown

condition or value.

Pulse 4.12 User Guide 1370

  Status Last Good Value - the way that Pulse indicates the
last known suitable value.

Define the Status Indication properties for each of the conditions

described above.

Indication Text The text to use to indicate the item's status.

Blinking Select this option to enable blinking color.

Indication Color The color to use to indicate the item's

status.

Pulse 4.12 User Guide 1371

User Application
In the Operator Personalization User Application tab, you can add
commands that start external applications to the Developer Workstation’s
system context menu (right-click menu).

Click the “+” button to open an entry in the table.

Path Enter the path and filename of the

application.

Parameters Enter any required arguments.

Centered input screen for multiple displays

The position of the input text dialog box for multiple displays is displayed
on the center when multiple displays are open. This Pulse Operator
workstation feature makes it very convenient for the user to view and add
inputs to Pulse.

Pulse 4.12 User Guide 1372

Defining Aliases
Aliases are “free text” names that you use as shortcuts for addresses,
references, commands. In the Aliases Manager, you can create, define,
and modify aliases for the current project.

We recommend defining aliases at the beginning of project development.

While developing a project, you can use aliases as substitutes for address
text names, as illustrated in the figure in the procedure below. Since
aliases are easily replaced and modified, this saves time in project
maintenance.

An alias name can contain up to 255 characters and can include most
printable characters, including spaces, except for [ = ^ & ]. An alias is
not case sensitive.

When typing an alias in the application (for example, in the Data Scope
and Item Manager), insert it between two ampersand characters (& &).
For example:

&PulsePath& refers to: xx:\Pulse\ where the Pulse installation is

saved.

Pulse has a number of built-in aliases, which can be viewed and selected
in the Item Manager under the Alias category.

To add aliases to the project

1 In the Developer Workstation’s Manage ribbon, click the

Aliases icon.

The Aliases Manager is displayed.

Pulse 4.12 User Guide 1373

2 Click the “+” button to add an alias entry. In the Token column,
type the text name of the address or object which the alias will
represent.

3 In the String column, type the string which will be the alias. Click
the check mark button to stop editing.

4 Repeat steps 2 and 3 as many times as necessary.

5 Click Save and then OK to confirm. Click Close to exit the Aliases
Manager.

Pulse 4.12 User Guide 1374

To duplicate aliases to the project

1 Select a row or rows from the Aliases list in the Aliases Manager
window.

2 Right-click on the selected row(s) and select Duplicate from the

pop-up menu.

The selected row(s) is/are duplicated.

The Duplicate action creates a new row with Token “Copy- [Original
Token]”, String “[Original string]”.

3 Click Save for changes to apply.

To delete aliases from the project

1 Select a row or rows from the Aliases list in the Aliases Manager
window.

2 Right-click on the selected row(s) and select Delete from the pop-
up menu.

3 Click Save for changes to apply.

NOTE Any changes made to the Aliases Manager are not applied if
save is not performed.

Pulse 4.12 User Guide 1375

Working with the Item Manager
The Item Manager allows you to assemble an item command by
selecting items from the Pulse Server, its components, and other locations
on the network (Pulse items, P-CIM Kernel items, variables, tags,
functions, aliases, and more), creating strings and adding regular
expressions, and checking their validity before inserting them into a
properties field.

 You access the Item Manager by clicking the button next to

the Animation and Dynamic action properties field.

-or-

In the Developer Workstation, enter the Manage ribbon and click

Items.

This section contains the following topics:

 Assembling Items in Item Manager

 Item Manager - Hosts

 Creating an Alarm Filter for a Current/Log Alarms and System

Messages Item

 Defining an OPC Group in the Item Manager

 Item Manager - Aliases

 Item Manager - Functions

 Expression Solver Functions

 GetProperty Function - Selecting a Control Property

 Item Manager - Conversion

 Item Manager - Resources

Pulse 4.12 User Guide 1376

Assembling Items in Item Manager
You can assemble item commands from the following:

Hosts Libraries of configuration items, variables,

blocks, and system commands.

Aliases Free text names that you use as shortcuts for

addresses, references, commands.

Functions Tasks that return a value, computed from the

function's arguments, to the application.

Conversion Functions that convert a value from one data

type to another, such as raw data to
Engineering Units (EGU).

Resource Templates that represent and include properties

for multiple similar devices or a group of
objects, and can be reused.

The following figure shows an example of an action assembled in the Item

Manager:

Pulse 4.12 User Guide 1377

To assemble an item in the Item Manager

1 In the properties field, click .

The Item Manager dialog box is displayed.

2 Choose the mode that you want to work with.

Item Mode In this mode, you can only select one item at a
time.

Expression Mode In this mode, you can build an expression

made of multiple items combined with regular
expressions (available in a toolbar when you
click the Expression Mode button). The
Expression Mode helps you to complete the
functions, constants, or variables syntax marks
by building the correct formal syntax
expressions.

Pulse 4.12 User Guide 1378

3 On the left pane, browse through the tree to choose the item’s
category. Depending on your choice, select the appropriate action
or command or expression name. In some instances, you can edit
parameters for the selection on the right pane.

Your selection appears in the edit box near the top of the Item
Manager dialog box.

4 Continue assembling and writing the syntax, using regular

expressions as needed as well as PLC and port numbers.

5 To test the validity of the assembled syntax, click the

Check button.

Item Manager - Hosts

The Item Manager’s Hosts branch contains commands and actions
belonging to the Pulse Server and its various services and components.
You can find item names and, where applicable, arguments which you
may use when assembling items and expressions for assignment to
objects and blocks.

The Hosts branch’s sub branches represent every Pulse Server host on
your network. The top sub branch represents the Master Host, which is
the Pulse Server (containing at least the Configuration and Discovery
services) connected to the current Pulse Client workstation.

Pulse 4.12 User Guide 1379

Each host sub branch contains several nested sub branches representing
various services of its installed Pulse Server. As you browse through the
tree branches, available relevant items and functions appear in the Items
Names pane. To assemble an Item to assign to an object or block, double-
click any relevant item names - in the Item Manager’s edit box, these are
appended to a string that includes the relevant server name and service
name.

Some items and functions listed in the Items Names box may also use an
additional argument, which is displayed in the Feature Names pane. This
is usually available when selecting an OPC group or specifying an alarm
filter. Double-clicking the Feature Names component opens an editor for
the applicable task:

 Creating an Alarm Filter for a Current/Log Alarms and System

Messages Item

 Defining an OPC Group in the Item Manager

Pulse 4.12 User Guide 1380

Pulse 4.12 User Guide 1381
Creating an Alarm Filter for a Current/Log Alarms
and System Messages Item
When creating an alarm item which will display the Current Alarms in the
Data Scope or a Pulse display, you can create view filters for displaying
only specific alarms that meet certain criteria, and hide the rest. In the
Build Filter dialog box, select the alarm attributes (fields) and data
arguments which will serve as part of the filter criteria.

Pulse 4.12 User Guide 1382

To build a Current Alarm filter

The Build Filter dialog box is available from the Item Manager’s
Hosts>[Hostname]>Alarms>Functional or Locational branch’s
CURRALARMS item.

1 When CURRALARMS is selected, double-click CurAlarm in the

Feature Names pane.

The Build Filter dialog box is displayed.

2 Build the filter criteria using the tools listed below. As you select
elements, the syntax appears in the Editor field, where you can
check if it meets your needs.

Fields Choose among attributes to include in the

filter.

Data Choose among the attribute values to include

in the filter.

Description When applicable, a sample of an applied

attribute is displayed.

Operator and Use the Operator and Operand buttons to

Operand buttons sharpen the filter criteria in order to improve
the effectiveness of the resulting Current Alarm
list.

Check; Copy; Use these basic editing commands while

Paste; Undo; creating your filter.
Redo; Delete;
Select All; Clear
All

3 Click OK.

The Build Filter dialog box closes. In the Item Manager, the selected
filter command appears in the Edit box.

Pulse 4.12 User Guide 1383

Defining an OPC Group in the Item Manager
In the Item Manager, you can attach OPC advised items to OPC groups.

To create an OPC Group in the Item Manager

1 In the Item Manager, browse to the OPC branch’s Favorites or

Local Category sub branch. In the Items Name pane, select the
advised item that you want to attach.

2 In the Feature Names pane, double-click OPCGroup to open the

OPC Group Manager.

3 Choose the Group to which to attach the advised item. The groups
have the following configuration properties:

Dead Band Specifies the required percentage of change in

the scale defined for the item in the OPC server
before notifying the OPC client of the data
changes.
Default = 0%.

Time Bias Indicates the time difference (i.e., different

time zones) between the server and the local
client.
Default = 0 minutes

Update Rate Indicates the frequency that notifications of

data changes in the group may be sent.
Default = 500 milliseconds

4 Click OK.

The selected group is appended to the item command in the Item

Manager’s edit box.

Pulse 4.12 User Guide 1384

Item Manager - Aliases
Aliases are “free text” names that you use as shortcuts for addresses,
references, commands. In the Aliases Manager, you can create, define,
and modify aliases for the current project, see Defining Aliases.

When selecting an alias in the Item Manager, it is inserted between two

ampersand characters (& &). For example:

&PcimPath& refers to: xx:\Pulse\ where the Pulse installation is

saved.

In addition to the aliases created in the Aliases Manager, Pulse has a

number of built-in aliases, which can also be selected in the Item
Manager.

Pulse 4.12 User Guide 1385

Searching for Aliases in the Item Manager
The Aliases List in the Pulse Item Manager has a new Look for filter
field that allows incremental searches.

As text is typed into the Look for field, the search mechanism
progressively searches for one or more possible matches for the text and
immediately displays the filtered text on the Look for list. The matching
texts in the Look for list are also highlighted.

The immediate response allows the user to stop completing the entire text
and choose from the available options from the list.

Pulse 4.12 User Guide 1386

Item Manager - Functions
Pulse provides a number of predefined functions for different
mathematical, date calculations or string manipulations. Pulse functions
can support a number of parameters of different types and return one
parameter.

The Item Manager includes an Expression Solver that checks the syntax of
configuration items, variables, tags, functions, aliases, and other
functions, as you assemble them into an item string. If the expression
syntax is valid and the usage is correct, the Expression Solver can verify
the ability to calculate the expression.

An expression must be enclosed between two question marks:

?expression?

For example, the following displays the sum of two analog value items:

?GetValue(|!a:1) + GetValue(|!a:2)?

To illustrate how to assemble an expression using Pulse functions, perform

the following procedure.

Pulse 4.12 User Guide 1387

To assemble the above expression

1 In the display, insert three graphic text objects:

• For the first object, assign as the item: |!a:1

• For the second object, assign as the item: |!a:2

• In the third object’s Item Field, click to open the Item

Manager and assemble the item as instructed below.

2 In the Item Manager, turn on Expression Mode.

3 In the Expression toolbar, click the two question marks. This

places the expression enclosure in the Item Manager edit box. Place
the mouse pointer between the question marks to mark the
insertion point for the expression.

4 In the Category tree, browse to Functions > Expression Solver

Functions.

5 In the Expression Solver Functions pane, click GetValue.

6 In the Insert Expression Function pane on the right, add an

advisedItemStr argument in the Value column. Enter |!a:1 and
click Apply.

At this point, the following string is written in edit box:

?GetValue(|!a:1)?

7 Add a space, a plus sign, and another space

8 In the Insert Expression Function’s Value column, change the

advisedItemStr argument to |!a:2 and click Apply.

The resulting expression string is:

?GetValue(|!a:1) + GetValue(|!a:2)?

9 To apply the syntax to the third object’s Item field, click the
check mark button.

10 Test your expression in the Operator Workstation by writing various

values to |!a:1 and |!a:2 and seeing what happens.

Pulse 4.12 User Guide 1388

This section contains the following topics:

 Expression Usage in Pulse

 Expression Solver Functions

Expression Usage in Pulse

In broad terms, an expression is a mathematical, logical or string formula
whose result is calculated during runtime and used as input for the current
update or other Operator Workstation programmatic feature.

You can use an expression to produce a computed value or a dynamic

command. An expression produces a computed result according to its
formula and the actual value of its operands. The context in which the
expression resides determines whether the result is regarded as a value
or a reference.

An expression is marked as a formula enclosed in a pair of question

marks. For example, (? formula ?).

You may use deferred aliases (aliases that substitute value during
runtime) in the Expression mode. Aliases are converted to a real value
before expression evaluation in runtime.

Producing a Computed Value

To use a value of a computation involving one or more variables during
runtime, specify the respective expression wherever a single value or
advised item (of a single variable) is expected.

The expression is computed and its result changes accordingly whenever

the current value of one or more of the operands changes. The result is
rendered as a string - the context that uses the result interprets this
string according to the expected value type: numeric, logical or string.

For example:

 Indicate graphically a computed value - You can specify an

expression with a mathematical, logical or string formula as an
advised item of an Operator Workstation indicator animation
property - during runtime, the property will graphically present the
result of the formula.

Pulse 4.12 User Guide 1389

 Trigger AutoActions on complex condition - You can specify an
expression with a comparison formula as trigger - during runtime,
the trigger will "fire" (and cause the action to be executed) when
the formula result becomes "true". For example, you can specify as
trigger the formula of "whether variable X is greater than variable
Y" (or than 100).

Using the Item Manager’s Expression Mode, you can specify a value
expression wherever an advised item is required, such as an object’s
Animation Properties, in a data block, or an AutoAction trigger.

To Produce a Dynamic Command

To use a command or command argument produced by a computation

involving one or more variables during runtime, specify the respective
expression wherever the name of a command or an argument (file name,
variable, advised item, etc.), is expected.

The expression is computed once - when the command is executed - and

its result reflects the value of its operands at that time. The result is
rendered as a string - the context that uses the result interprets this
string according to the expected value type: numeric, logical or string.

For example:

 Execute "button command" with dynamic parameters - You

can specify an expression with a mathematical, logical or string
formula as the argument of a command. During runtime, the
command will be executed according to the actual text value of that
argument. For example, you can specify in a reporting command a
string formula that results in a date string for the report output file
name argument - during runtime, the name of the report file
created will reflect the actual date.

 Execute a dynamic “action” - You can specify a string expression

that results at run time in a button command text. During runtime,
the text will be interpreted and executed accordingly. For example,
you can specify an expression containing the dBASE function IIF(),
whose true and false result arguments are two valid button
command strings - during runtime, the logical condition will be
evaluated, and the respective button command will be executed
according to the condition.

Using the Item Manager’s Expression Mode, you can specify a dynamic
command expression wherever a button command is required (such as
Open, Set, RepData), so that the expression evaluation results in the
requested command execution or argument value.

Pulse 4.12 User Guide 1390

Operators and Operands in Expressions
Operands can be any of the following:

 Numeric, logical or string or constants, such as:

resp., 123, .T. or .F., "abc"

 Advised items from any server in the system such as:

|!TEMP5, EXCEL|C:\EXCEL\MYSHEET.XLS!R3C5, etc.

 dBASE functions such as:

DATE(), SUBSTR(), etc.

Operators can be any of the following:

 Arithmetic and mathematical operators such as +, -, *, /, ^, etc.)

 Comparison operators such as >, <=, =, #, etc.

 String operators such as +, -, $

 Logical operators such as not, and, or

 Date operators: + and -

You can also use the following special symbols:

&…& To mark an alias string – The Alias delimiter

may be changed.

GetValue() To get the value from Pulse item – “ … “ – as a

string.

‘…‘ To mark a constant as a string type

(…) To write expression function parameters

For examples of expression usage, see Expression Solver Functions.

Pulse 4.12 User Guide 1391

Expression Solver Functions
This section lists the Pulse Expression Solver Functions.

ABS Returns the absolute value of a number

Syntax:

?ABS(getvalue([address]))?

?ABS(getvalue([block]))?

Example 1

?ABS(getvalue(|!a:1))?

Example 2

?ABS(-2.5)?

will return 2.5

ASC Returns the ASCII code for the first character

in a string expression.

Syntax: ASC(string expression)

where string expression = any string

expression

ATDATE Returns the value of 1 during the time

interval that the actual date matches the
argument of the function, and the value of 0
when not.

Syntax: AtDate(YYMMDD)

where YYMMDD is the date specification.

ATDATETIME Returns the value of 1 during the time

interval that the actual date and time of day
match the argument of the function, and the
value of 0 when not.

Syntax: AtDateTime(YYMMDDHHMMSS)

where YYMMDDHHMMSS is the date and time

of day specification.

Pulse 4.12 User Guide 1392

 ATN ATN returns the arctangent (in radians) of a
numeric expression (to convert degrees to
radians, multiply degrees by π/180 where
π=3.14159265359).

Syntax: ATN( numeric-expression )

where numeric-expression = the ratio

between the length of the side opposite the
angle and the side adjacent to the angle of a
right triangle.

ATTIME Returns the value of 1 during the time

interval that the actual time of day matches
the argument of the function, and the value
of 0 when not.

Syntax: AtTime(HHMMSS)

where HHMMSS is the time of day

specification in 24-hour format.

CBL Returns a long number that is the bitwise

combination of the byte value of the four
variables referenced as function arguments
(varin1, varin2, varin3, and varin4).

Syntax: CBL([varin1] [,varin2] [,varin3]

[,varin4])

where:

 varin1 = Data for result bits 0-7,

name of variable, or a constant in the
range 0-255.

 varin2 = Same as above, for result

bits 8-15.

 varin3 = Same as above, for result

bits 16-23.

 varin4 = Same as above, for result

bits 24-31.

Pulse 4.12 User Guide 1393

 CBW Returns a word-size number that is the
bitwise combination of the byte value of the
two variables referenced as function
arguments (varin1 and varin2).

Syntax: CBW([varin1] [,varin2])

where:

 varin1 = Data for result bits 0-7,

name of variable, or a constant in the
range 0-255.

 varin2 = Same as above, for result

bits 8-15.

CDOUBLE Internal function

Syntax: CDOUBLE(decimalValue)

CFLOAT Internal function

Syntax: CFLOAT(decimalValue)

CHR Returns the character corresponding to

specified ASCII code.

Syntax: CHR$(ascii-code)

where ascii-code = the ASCII code of the

required character

CINT Rounds a numeric expression to the nearest

integer.

Syntax: CINT(numeric-expression)

where numeric-expression = numeric

expression in the range -32768 to 32767

CITEM Gets string and returns an advised item.

Syntax: CItem(advisedItemStr)

Pulse 4.12 User Guide 1394

 COS Returns the cosine of an angle specified in
radians (to convert degrees to radians,
multiply degrees by π/180 where

π=3.14159265359).

Syntax: COS( angle )

where angle = an angle expressed in radians

CTOD Converts the character value in the format

"MM/DD/YY" into a dBASE date value.

Syntax: CTOD(‘string’)

CWL Returns a long number that is the bitwise

combination of the word-size value of the two
variables referenced as function arguments
(varin1 and varin2).

Syntax: CWL([varin1] [,varin2])

where:

varin1 = Data for result bits 0-15, name of

variable, or a constant in the range 0-65535.

varin2 = Same as above, for result bits 16-

31

DATE Returns the computer’s current system date,

according to regional settings (for example,
“mm-dd-yyyy”).

Syntax: DATE()

Pulse 4.12 User Guide 1395

 DATEADD Adds or subtracts a specified time interval
from a date

Syntax:

?DATEADD(‘datepart’,number,date)?

 ‘datepart’ - can be year, month, day,

hour, minute, second, millisecond

 number - number of the interval to

add

 date - valid date expression

Example:

?DATEADD(‘month’,-1,DATE())?

returns the date of the previous 1 month

DAY Returns the day of the date_value parameter

as a numeric value between 1 and 31.

Syntax: DAY(#dateTime#)

DTOA Performs the equivalent of a real world D/A

(Digital to Analog) converter - encoding and producing the
analog (numeric) result of the binary
weighted values of up to 32 digital (OFF/ON)
input variables.

Syntax: DTOA(varin0, [varin1] [,varin2]...

[,varin31])

Writing to this function performs the

equivalent of a real world A/D converter -
decoding the analog (numeric) input into
binary values and setting up to 32 respective
digital (OFF/ON) output variables.

Potential uses for this function include

encoding several digital "signals" into an
aggregate numeric analog "signal". This
“signal” can then be used to drive a color,
bar (size), or textual indicator.

Syntax: DTOA(decimalValueArray)

Pulse 4.12 User Guide 1396

 DTOC Converts the date value to a character value
in the Pulse International Short Date format
in accordance with the computer’s regional
settings (for example, "MM/DD/YY",
"DD.MM.CCYY", etc.).

Syntax: DTOC(#dateTime#)

EXP Returns e raised to a specified power, where

e is the base of natural logarithms.

Syntax: EXP( numeric-expression)

where numeric-expression is a number in the

range 709.78 to -744.44

GetAlias Gets the Alias Value by Alias Name

Syntax: GetAlias (‘AliasKey’)

GetComputerName Enables the user to display the Client's

computer name and/ or include it in an
expression (i.e., in a workflow, action, etc.)
related to the Client's computer name. The
Client's computer name is retrieved and is
used in conjunction with the action specified
in the expression.

Syntax: GetComputerName()

GetItem Returns an advised item object from a string.

Syntax: GetItem(advisedItemStr)

GetMouseX Gets the X position of the mouse cursor in

the screen coordinates.

Syntax: GetMouseX()

GetMouseY Gets the Y position of the mouse cursor in

the screen coordinates.

Syntax: GetMouseY()

Pulse 4.12 User Guide 1397

 GetProperty Returns a property of a specific control on a
specific display

To specify the property to retrieve, enter it in

the Value column of the Insert Expression
Function pane. Click to open the Select
Control Property dialog box, in which you can
browse through your project’s displays to
locate and select the required object
property. For more information, see
GetProperty Function - Selecting a Control
Property.

Syntax: GetProperty(‘PropertyName’)

For more details, see GetProperty Function -

Selecting a Control Property

GetScheduleList Returns the list of schedule file names with a

CRLF/Enter separator

Syntax: GetScheduleList()

Examples of schedule files names with

CRLF/Enter separator:

• Schedule_File1

• Schedule_File2

• Schedule_File3

GetScheduleName Returns the schedule rule name for the

specified advised item.

Syntax:
GetScheduleName(advisedItemStr)

GetValue Returns the advised item value from an

advised item object

Syntax: GetValue(advisedItemStr)

GetValueStatus Returns the status value

Syntax:

?GetValueStatus(AdvisedItemStr)?

Pulse 4.12 User Guide 1398

 GetValueTimeStamp Returns the time stamp value

Syntax:

?GetValueTimeStamp(AdvisedItemStr)?

GetWFProperty Returns a property value of the current

Workflow or Activity. The expression can be
used with Action and Activity properties and
more.

Syntax:
GetWFProperty(<FullPathPropertyName>)

For example:

 ?GetWFProperty('ActivityName1.Proper
tyName1')?

 ?GetWFProperty('Parameter1')?

 GetWFProperty('PropertyName')

GMTToLocalTime Converts the specified GMT time to the Local

Time equivalent.

Syntax: GMTToLocalTime(#dateTime#)

HEX Returns the hexadecimal string

representation of a number rounded to an
integer or long integer before it is evaluated.

Syntax: HEX(numeric-expression)

where numeric-expression = a numeral

Pulse 4.12 User Guide 1399

 IDATE Returns ordinal number of today, where the
anchor date is considered day 1. It is also
equivalent to the number of days that passed
since anchor date - plus one. If the anchor
date is set in the future, $IDate returns 1 if
the anchor date is today, -2 if it is tomorrow,
etc. Read only.

Syntax: IDATE(target,source)

where target = an address to receive the

value of @IDate, than can handle 8 decimal
digits, such as a date of type 'long'.

where source = an address whose value

represents the date in NOFDSA (number of
days since anchor) format.

IIF If log_value is true, returns the true_result

value, else the false_result value. Both the
true_result value and the false_result value
must be of the same type - otherwise, an
error results.

Syntax: IIF(boolCondition,ifTrue,else)

INSTR Returns the position of the first occurrence of

a string in another string.

Syntax:

INSTR(intStartIndex,’stringFullString’,’string
Substring’)

INT Returns the largest integer less than or equal

to a numeric expression (truncation).

Syntax: INT(numeric-expression)

where numeric-expression = a numeral

Pulse 4.12 User Guide 1400

 LEFT Returns a string containing the specified
number of leftmost characters of a string.

Syntax: LEFT$(stringexpression$,n%)

where stringexpression$ = a string

expression

where n% = the number of characters to

return, beginning with the leftmost string
character

LEN Returns the number of characters in a string

Syntax: LEN(stringexpression$)

where stringexpression$ = any string

expression

LocalTimeToGMT Returns the GMT Time equivalent of the

specified local time.

Syntax: LocalTimeToGMT(#dateTime#)

LOG Returns the natural logarithm of a numeric

expression

Syntax: LOG(numeric-expression)

where numeric-expression = a positive

numeric-expression

LTRIM Returns the char_value after removing all

leading blanks.

Syntax: LTRIM(‘string’)

MID Returns part of a string (a substring) -

compare with statement MID$ - that
replaces part of a string. See also LEFT and
RIGHT.

MONTH Returns the month of the date_value

parameter as a numeric value between 1 and
12.

Syntax: MONTH(#dateTime#)

Pulse 4.12 User Guide 1401

 MSECTIMER Returns the elapsed time since midnight in
milliseconds

Syntax: MSECTIMER()

OCT Returns string of octal representation of a

number, first rounded to an integer or long
integer (see also HEX).

Syntax: OCT$( numeric-expression )

where numeric-expression = a numeric

expression

PI Returns the value of mathematical constant π

(3.14159265359)

Syntax: PI

POWER Returns the result of the first number

powered exponentially by the second
number.

Syntax: POWER(doubleX,doubleY)

Replace Replaces all the occurrences of the oldValue

with the newValue in the specified string.

Syntax: Replace (‘text’, ‘oldvalue’,

‘newValue’)

RIGHT Returns a string containing the specified

number of rightmost characters of a string.

Syntax: RIGHT$(stringexpression$,n%)

where stringexpression$ = a string

expression.

where n% = the number of characters to

return, beginning with the rightmost string
character.

RND Returns a single-precision random number

between 0 and 1.

Syntax: RND()

Pulse 4.12 User Guide 1402

 SGN Returns value indicating a numeric
expression's sign: 1 for positive, 0 for zero, -
1 for negative.

Syntax: SGN( numeric-expression )

where numeric-expression = a numeric

expression

SIN Returns sine of angle specified in radians (to

convert degrees to radians, multiply degrees
by π/180 where π=3.14159265359).

Syntax: SIN( angle )

where angle = an angle expressed in radians

SPACE Returns a string of spaces (see also

STRING).

Syntax: SPACE$( number )

where number = the number of spaces in the

string

SQR Returns the square root of a numeric

expression

Syntax: SQR(numeric-expression)

where numeric-expression = a value greater

than or equal to zero

STOD Converts the char_value in the format

"CCYYMMDD" to a date value.

Syntax: STOD(‘string’)

STR Returns the string representation of a

number

Syntax: STR(numeric-expression)

where numeric-expression = a numeric

expression

Pulse 4.12 User Guide 1403

 STRING Returns a string of a specified length made
up of a repeating character.

Syntax: STRING$(length%,{ascii-code% |
stringexpression$})

where length = the length of the string

where ascii-code% = the ASCII code of the

repeating character

where stringexpression$ = any string

expression. STRING$ fills the string with the
first character in stringexpression$.

SUBSTR Returns the substring of char_value, as of

the start_pos character, and num_chars long.

Syntax:
SUBSTR(‘String’,StartPosition,Length)

For example:

SUBSTR( "ABCDEFGH", 5, 2 ) returns "EF".

NOTE The separators between the

parameters may vary according to
your computer’s Regional
Settings.

TAN Returns the tangent of an angle specified in

radians (to convert degrees to radians,
multiply degrees by π/180 where
π=3.14159265359).

Syntax: TAN( angle )

where angle = an angle expressed in radians

TIME Returns the system time as a string in

International Short Date Format.

Syntax: TIME()

TIMER Returns the elapsed time since midnight in

seconds

Syntax: TIMER()

Pulse 4.12 User Guide 1404

 TRIM Returns the char_value after removing all
trailing blanks

Syntax: TRIM(‘string’)

UPPER Returns the char_value after converting all

lower case letters to upper case.

Syntax: UPPER(‘string’)

VAL Returns a number from its string

representation

Syntax: VAL(stringexpression$)

where stringexpression$ = a string

representation of a number

YEAR Returns the year of the date_value

parameter as a four digit numeric value.

Syntax: YEAR(#dateTime#)

Expression Solver Examples

This section provides several examples of expression usage in Pulse.

Example 1

Expressions:

• |!?'abc'?

Results:

• “abc”

Pulse 4.12 User Guide 1405

Example 2

Expressions:

• ?getvalue(ows|pcim!item11) + getvalue(ows|pcim!item12)?

• ?getvalue(ows|pcim!item11) - getvalue(ows|pcim!item12)?

• ?getvalue(ows|pcim!item11) * getvalue(ows|pcim!item12)?

• ?getvalue(ows|pcim!item11) / getvalue(ows|pcim!item12)?

Results:

• mathematical calculation

Example 3

Expressions:

• |!?getvalue(\\Masterhost\DBSR|PCIM!A:1) &&
getvalue(|!a:2)?

• |!?getvalue(\\Masterhost\DBSR|PCIM!A:1) ||
getvalue(|!a:2)?

Results:

• “True”

• “False”

Example 4

Expressions:

• |!?cint(getvalue(ows|pcim!item44)) * 4?

• |!?cdouble(getvalue(ows|pcim!item55)) * 2?

Results:

• mathematical calculation

Pulse 4.12 User Guide 1406

Example 5

Expressions:

• |!?getvalue(citem('|!a:' + '3'))?

Results:

• Value of the item |!a:3

Example 6

Expressions:

• |!?GetValue(GetItem('|!$ds' + 1))?

• |!?GetValue(GetItem('|!$ds' + GetValue(ows|pcim!item2)))?

Results:

• Value of the item |!$ds1 , where the item ows|pcim!item2=1

Example 7

Expressions:

• ?getvalue(citem(getValue(citem('|!$ds1'))))?

Results:

• Value of the item |!$ds2 where the item |!$ds2 is value of

the item $ds1 (e.g., if $ds2 = abc , then the expression
result equal “abc”)

Example 8

Expressions:

• ?IIF(1,'set |!d:1
\?GetProperty(\'display1.object1.property1\')\?','set |!d:1
\?GetProperty(\'display1.object1.property2\')\?')?

Results:

• “set |!d:1 ?GetProperty('display1.object1.property1')?”

Pulse 4.12 User Guide 1407

Example 9

Expressions:

• ?GetProperty('display1.object1.property1')?

Results:

• Value of the property1

Example 10

Expressions:

• |!?GetValue(CItem(GetValue(GetItem('ows|pcim!item1'))))?

Results:

• When ows|pcim!item1 = “|!a:1”, the expression will return

value of the item |!a:1

• When ows|pcim!item1 = “|!a:2”, the expression will return

value of the item |!a:2

Pulse 4.12 User Guide 1408

GetProperty Function - Selecting a Control Property

The GetProperty function returns a property of a specific control on a

specific display. The function’s syntax is GetProperty(‘PropertyName’),
where ‘PropertyName’ is the property to retrieve.

To choose which property to retrieve, the Select Control Property dialog

box allows you to browse through your project’s displays and locate and
select the required object property.

Pulse 4.12 User Guide 1409

To select an object/control property

1 After selecting GetProperty while assembling an object

property/setting item, click to open the Select Control
Property dialog box.

2 In the Display Controls pane, double-click the display in which the

required property is located.

3 Choose one of the display’s objects in the list below the display
tree.

4 In the Properties pane, an expandable list of properties appears.

Click the + button next to the property name to expand it, if
necessary. Select the required property.

5 In the Property Path box, the full path of the selected property
appears.

Use “this” Select this option to replace the display and/or

format resource name (if applicable) with a “(this)”
string. The “(this)” string allows you to
maintain links to the property even if you
change the display name at a future name, or if
you use a resource in another display.

6 Click OK.

The Select Control Property dialog box closes. In the Item Manager,
the selected property’s path appears in the Value column of the
Insert Expression Function pane.

Pulse 4.12 User Guide 1410

Expression Solver Functions Incremental Search Filter

The Expression Solver Functions in the Pulse Item Manager has a

Look for filter field that allows incremental searches.

As text is typed into the Look for field, the search mechanism
progressively searches for one or more possible matches for the text and
immediately displays the filtered text on the Look for list. The matching
texts in the Look for list are also highlighted.

The immediate response allows you to stop completing the entire text and
choose from the available options from the list.

Pulse 4.12 User Guide 1411

Item Manager - Conversion
Conversion functions convert the value returned by a variable or a
function, according to the algorithm of the conversion and specified
constant arguments. The Item Manager provides the ability to assemble
an item string that includes one or more predefined conversions that
convert raw values into other parameters, such as engineering units.

Available conversions appear in the Conversion Functions pane. To add a

conversion to the Item, click any relevant conversion function and then
click Apply.

Some conversions may also require an additional argument, which is

displayed in the Insert Conversion Function pane. In such a case, enter a
relevant value in the column next to the argument type name and then
click Apply.

For more information, including descriptions of the various conversion

functions, see Defining Conversion Functions.

Pulse 4.12 User Guide 1412

Item Manager - Resources
A Display Resource is a reusable template that represents multiple similar
devices or a group of objects. It includes the data of specific objects in a
display (such as string values, items, real and integer numbers, colors,
actions, and actions arguments, trend attributes). Creating resources
allows you to reuse an existing display multiple times with different
resource values attached to its resource keys, without needing to recreate
similar displays or copy several objects from one display to another.

If the active display contains any resources, these resources will be

available in the Item Manager’s Resource branch. They are listed in the
Resource Names pane. Double-click the resource name to add it to the
Item syntax.

NOTE The resources are not available for other displays.

Pulse 4.12 User Guide 1413

Logger Policy
Defining Logging Policies
A Logger Policy defines the criteria a Log Message should fulfill in order to
be logged to a specific Destination. Log messages appear in the Logger
Window, see Pulse Logger Window and the Alarm Explorer,
see The Alarm Explorer.

In the Logger Policy dialog box, you can define the default logging
policies (type, category, severity, and a destination viewer) for the various
types of messages. Each defined policy applies a rule stating:
“For all x type messages of category y with a severity of z or
higher, will be sent to the specified viewer or log file.”

To define logger policies

1 In the Developer Workstation’s Manage ribbon, click the

Log Policy icon.

or

Go to the Project Setup window and click on the Configure

Logger Policy icon.

The Logger Policy window is displayed.

2 To add a new entry to the table, click the “+” button at the bottom
of the table.

Pulse 4.12 User Guide 1414

3 Define logger policy parameters as follows:

Type Choose the type of message:

 Debug
 Informational
 Warning
 Error
 Critical
 Audit Trail
 Application Event
 Application Activity
 Security Event
 Operator Message

Category Choose the Pulse system module associated

with the message.

Severity Set the severity threshold which determines

whether or not this type of message appears in
a log. The message will be logged if its severity
equals this level or higher.

Destination Select the viewer, file, and/or window where

the message will be logged. You may choose
more than one destination. The options are:

 Local Event Viewer

 Local daily TSV file
 Local Logger Window
 Local Message Box

Enable Local Log Select this option to enable a log file to be

stored on the local client and to be displayed in
the various log viewers.

Polling Interval Interval at which the messages are retrieved

(sec) and then logged.

4 To delete a policy, select the policy entry and click the “-“ button.

5 Click OK.

To apply the policy changes, you have to restart the module(s)

chosen in the Category column.

Pulse 4.12 User Guide 1415

Defining System and Interface Localization
You can adapt the Pulse client and server user interface (GUI) to make it
understandable and logical to users at your locale. By default, the
language and orientation of the Pulse system and application interface is
English but you can easily change them so that they are appropriate for
the personnel in your locale.

Localization can be applied to the following categories:

 System - translation of the workstations, modules, dialog boxes,

menus, and other interface elements.

 Application - translation of runtime data.

The Localization Manager provides the template for you to convert the
GUI to other language(s). The Localization Key column lists all the strings
(in the default language) in the workstation interfaces - next to them, you
can type the translations.

Localization Settings
Observe the following when you work with a language other than English:

 The Region and Language settings for the Pulse server and Pulse
client have to be the same. This applies when the Pulse server and
the Pulse client are located on separate computers.

 The Region and Language settings for the System account and
the User account have to be the same. If the settings are not the
same, copy the settings as demonstrated in the image below.

Pulse 4.12 User Guide 1416

 If the Regional Settings is not English, then go to the PcimUser.ini
file and change SupportINTL=0 to SupportINTL=1.

 The list separator in the Regional Settings should NOT be equal to

the Pulse action delimiter.

To work in the Localization Manager

1 In the Developer Workstation’s Manage ribbon, click the

Localization icon.

The Localization Manager dialog box is displayed.

Pulse 4.12 User Guide 1417

NOTE To enter translated strings for a specific locale, that locale
must be represented by a column in the Localization Manager
table. For instructions on adding a locale, see Adding Locales
to the Localization Manager.

2 In each cell in your locale’s column, type the appropriate translated

string, which will appear on the interface instead of the Localization
Key in the table’s first column.

3 To work on only a limited set, create a filter which will display a

subset of the total strings in the system. Expand the Filter
Options near the bottom of the Localization Manager:

Filter Type the characters or string which you want

to display

In Choose the column to apply the filter - the

Localization Key or a specific language column.

4 Click the Apply Filter button.

Pulse 4.12 User Guide 1418

5 To display runtime data in the additional language, click the
Application tab.

In the Localization Key column, type the default runtime string.

Then, in the locale’s column, type the appropriate translated string.

6 When you’re finished entering translated strings, click OK.

Optimizing Localization Storage

The Localization Manager optimizes the localization process by
matching all instances of the same string with one translation entry. For
example, there are several “btnOK” strings representing OK buttons
throughout the system. However, with Optimization enabled, you only
need to translate this string once - the same translation is associated with
all instances of this string.

To optimize the localization storage

1 In the Localization toolbar, click the Optimize button.

The Optimize Localization dialog box is displayed.

2 Any strings with identical suffixes and values appear in the Optimize
Localization dialog box. Click OK to optimize them to the identical
translation.

Pulse 4.12 User Guide 1419

Adding Locales to the Localization Manager
If a required language is not represented initially by a column in the
Localization Manager, you can add it easily by selecting it from the
Select Locales dialog box.

To add a language locale to the Localization Manager

1 In the Developer Workstation’s Manage ribbon, click

Localization.

The Localization Manager dialog box is displayed.

2 In the Localization toolbar, click the Add Language button.

The Select Locales dialog box is displayed.

3 Select the language(s) you want to add to the system and click OK.

Pulse 4.12 User Guide 1420

To translate texts to the newly added language

1 Select the new language as the System Language:

• In the Developer or Operator Workstation’s Personalize

ribbon, click System Language, and then choose the
language. Click Yes to confirm. Restart the Developer
Workstation.

-or-

• To associate a language in the configuration of a known user,

open the User Manager, select the user and set the System
Language parameter in the Edit User dialog box, see
Defining Users and their Security Levels.

2 In the Developer Workstation’s Manage ribbon, click the

Localization icon.

The Localization Manager dialog box is displayed.

3 Start translating from the text already present in the Localization

Manager. Additional text strings will become available as you open
each dialog box.

Pulse 4.12 User Guide 1421

Removing Languages from the Localization Manager
You can remove a language from the Localization Manager. A removed
language cannot be active on the Pulse application.

To remove a language locale from the Localization Manager

1 In the Developer Workstation’s Manage ribbon, click

Localization.

The Localization Manager dialog box is displayed.

2 In the Localization toolbar, click the Remove Language

button.

The Select Locales dialog box is displayed.

3 Select the language(s) you want to remove from the system or

application and click OK.

Pulse 4.12 User Guide 1422

Defining Conversion Functions
Conversion functions convert the value returned by a variable or a
function, according to the algorithm of the conversion and specified
constant arguments. The Pulse Server has a number of predefined
conversions that convert raw values into engineering units. Unless
otherwise defined, these conversions are bidirectional.

Conversion Syntax
A Pulse Server conversion can be invoked as the suffix of the Item in the
advised item specification of Server, Topic, and Item. The conversion
statement is separated from the Item specification by a double comma
and one or more spaces.

When adding a conversion to an item, consider the following guidelines:

 The conversion parameter(s) are separated from the Item by a

double comma followed by the conversion name, and its
parameters closed in parentheses.

 There is no special character that precedes the name of the

conversion (as opposed to "$" for system variables, "@" for
functions, etc.)

 The name of the conversion is not case-sensitive.

 Unless otherwise specified, a conversion is bidirectional. The

conversion is performed on the data flowing in both directions: from
the server to the client, and from the client to the server.

A conversion invocation’s typical syntax is formulated as follows:

conv(param1,param2,..,paramN)

The Item field of an advised item specification and a complete advised

item specification, both with a conversion applied, are illustrated below.

Item itemname,conv(param1,param2,..,paramN)

Link DBSR|PCIM!itemname,conv(param1,param2,..,paramN)

OPCSRV|Matrikon.OPC.Simulation.1!Random.Int1,,conv(para
m1,param2,..,paramN)

Simulator|Pcim!Tag1,,conv(param1,param2,..,paramN)

Pulse 4.12 User Guide 1423

Operation
Unless otherwise specified, a conversion is bidirectional. The conversion is
performed on the data flowing in both directions: from the server to the
client, and from the client to the server.

The terms read and write are used to specify the direction as follows:

Read Data flows from the server to the client

Write Data flows from the client to the server

The name of the conversion usually expresses the operation in the Read
direction. In the Write direction, the conversion performs the inverse
operation.

This section contains the following topics:

 Working With the Conversion Functions Manager

 Checking Conversion Execution Output

 Conversion - HighByte (HB)

 Conversion - HighWord (HW)

 Conversion - LowByte (LB)

 Conversion - LowWord (LW)

 Conversion - Signed (S)

 Conversion - Signed Long (SL)

 Conversion - Binary Coded Decimal (DBCD)

 Conversion - DByte (DByte)

 Conversion - Divide (DDIV)

 Conversion - Multiply (DMUL)

 Conversion - Nibble (DNIB)

 Conversion - Signed Divide (SDIV)

 Conversion - ShiftLeft (SHL)

 Conversion - ShiftRight (SHR)

 Conversion - Process Square Root (SQRT)

 Conversion - Alarm (DAlarm)

 Conversion - Linear (LIN)

Pulse 4.12 User Guide 1424

Working With the Conversion Functions
Manager
A Conversion Function is a data transformation that converts values of
one type parameter to values of another type of parameter. When writing
Item addresses and commands with conversion syntax, the conversion
statement is separated from the Item by a single comma and one or more
spaces.

You can apply any of the following conversions to an analog block's value
in both regular and reverse directions:

 A driver-specific conversion (e.g., to engineering units), that

operates in conjunction with the High Scale, Low Scale, and Invert
parameters.

 A Driver Server conversion - see Using Driver Server Generic

Conversions.

 A Pulse Server conversion (LIN or SQRT)

In the Conversion Functions Manager, you can do the following:

 View existing conversions and information about them.

 Test the result when you input specific values into a conversion
function.

 Add externally produced conversion functions - either written by the

user or provided from another source.

Pulse 4.12 User Guide 1425

To open the Conversion Functions Manager

1 In the Developer Workstation’s Manage ribbon, click

Conversions.

The Conversion Functions Manager dialog box is displayed.

The Conversion Functions Manager Existing Functions tab displays

the following information:

Name Name of the database conversion

Description Description of the conversion’s purpose

Usage Format of the conversion syntax

Number of Number of arguments that you need to add to

Arguments the conversion’s command. If you do not
specify any arguments when writing the
conversion command, the system will use
default values.

Pulse 4.12 User Guide 1426

 Type Origin of the conversion function:

 System - supplied by the Pulse

application

 User - either written by the user or

provided from an external source.

Try Click the appropriate Try link to test the

execution of the conversion with specific
values, see Checking Conversion Execution
Output.

Pulse 4.12 User Guide 1427

Adding a Customized Conversion Function
You can also add a customized conversion function to the project. The
conversion function must be a .NET 2.0 (or higher) framework component
derived from the IConversionFunction interface and written in a DLL
(Dynamic Link Library) file.

To add a customized conversion function

1 In the Developer Workstation’s Manage ribbon, click

Conversions.

The Conversion Functions Manager dialog box is displayed.

2 Enter the Adding New Function tab.

3 Browse and select the DLL file that contains the conversion
function(s) that you want to add. The name of the DLL file and the
number of functions added will appear in the table.

Pulse 4.12 User Guide 1428

Checking Conversion Execution Output
From the Conversion Functions Manager, you can execute the
conversion functions on specific values in order to receive the result.

To execute the conversion on specific values

1 In the Developer Workstation’s Manage ribbon, click Conversions.

The Conversion Functions Manager dialog box is displayed.

2 In the line of the conversion function you want to run, click the
appropriate Try link.

The Function Executer dialog box is displayed.

3 Provide the following information:

Execution mode Select the direction of the conversion

operation:
 Regular - converting from the first
parameter in the conversion function
to the last parameter.
 Reverse - converting the function
from the last parameter to the first
parameter.
 Type the Value that you want to
Inputs
convert.
 Then, add the appropriate Arguments
for the transformation. If you do not
specify any arguments, the system will
use default values.

4 Click Execute.

The result appears in the Output box.

5 Click Close to exit the Function Executor dialog box.

Pulse 4.12 User Guide 1429

Conversion - HighByte (HB)
This conversion accesses the high byte (8 bits) of a 16-bit word (register).

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,HB()

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns the upper byte word of a 16- bit register.

This conversion has no parameters.

Example

(Hex and binary values are formatted here to create visual correlation)

Item Hex Binary Decimal

|!1:1:40001 1234 0001 0001 0001 0001 4660

|!1:1:40001,,HB() 12 0001 0010 18

Pulse 4.12 User Guide 1430

Conversion - HighWord (HW)
This conversion accesses the high 16-bit word of a 32-bit register.

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:L40001 |!1:1:L40001,,HW()

Details

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns the upper 16-bit word of a 32-bit register.

This conversion has no parameters.

Example

(Hex and binary values are formatted here to create visual correlation)

Item Hex Binary Decimal

|!1:1:L40001 12345678 0001 0010 0011 0100 305419896

0101 0110 0111 1000

|!1:1:L40001,,HW() 1234 0001 0010 0011 0100 4660

Pulse 4.12 User Guide 1431

Conversion - LowByte (LB)
This conversion accesses the low byte (8 bits) of a 16-bit word (register).

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,LB()

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns the lower byte word of a 16- bit register.

This conversion has no parameters.

Example

(Hex and binary values are formatted here to create visual correlation)

Item Hex Binary Decimal

|!1:1:40001 1234 0001 0010 0011 0100 4660

|!1:1:40001,,LB() 34 0011 0100 52

Pulse 4.12 User Guide 1432

Conversion - LowWord (LW)
This conversion accesses the low 16-bit word of a 32-bit register.

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:L40001 |!1:1:L40001,,LW()

Details

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns the lower 16-bit word of a 32-bit register.

This conversion has no parameters.

Example

(Hex and binary values are formatted here to create visual correlation)

Item Hex Binary Decimal

|!1:1:L40001 12345678 0001 0010 0011 0100 305419896

0101 0110 0111 1000

|!1:1:L40001,LW(), 5678 0101 0110 0111 1000 22136

Pulse 4.12 User Guide 1433

Conversion - Signed (S)
This conversion interprets the raw value as a signed (2's complement)
integer for a 16 bit address (from -32768 to 32767).

This conversion is bidirectional, converting the value of the item when

read from and written to the server. This conversion is specified without
parameters.

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,S()

Example

Item Hex Binary Decimal

|!1:1:40001 A000 1010 0000 00000000 40960

|!1:1:40001,,S() A000 1010 0000 00000000 -24576

Pulse 4.12 User Guide 1434

Conversion - Signed Long (SL)
This conversion interprets the raw value as a signed (2's complement)
integer for a 32 bit address (from -2,147,483,648 to 2,147,483,647).

This conversion is bidirectional, converting the value of the item when

read from and written to the server. This conversion is specified without
parameters.

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:L40001 |!1:1:L40001,,SL()

Example

Item Hex Binary Decimal

|!1:1:L40001 A0000000 1010 0000 00000000 2,684,354,560

0000 000000000000

|!1:1:L40001,,SL() A0000000 1010 0000 00000000 -

0000 000000000000 1,610,612,736

Pulse 4.12 User Guide 1435

Conversion - Binary Coded Decimal (DBCD)
Binary Coded Decimal (BCD) is a method of encoding a number in a
binary word where each group of 4 bits represents a decimal digit of the
original number. For example, the number 6789 would be represented in
BCD in a 16-bit word as shown below (bits separated in groups of four in
diagram for clarity):

0110 0111 1000 1001

6 7 8 9

For comparison, the same value would be represented in plain binary

encoding as:

0001 1010 1000 0101

NOTE Plain binary encoding is the most efficient (requires the least
number of bits - 13 instead of 15 in this example); BCD
encoding is mainly used to easily discern the original decimal
number from its representation in bits.

Use the Binary Coded Decimal (BCD) conversion to handle a raw value in
which numbers are encoded in BCD format.

Syntax

The syntax of the conversion is:

DBCD(n)

DBCD name of conversion

where

n = number of bits, range 1 to 32; the practical range depends on the

word size of the raw data type in question (e.g., 16 or 32 bits).

Operation

Read Returns to the client the value from the lowest

n bits, assuming that the value is encoded in
those bits in BCD format.

Write Writes the input from the client into the lowest
n bits of the raw value in BCD format.

Pulse 4.12 User Guide 1436

Conversion - DByte (DByte)
Use the DByte conversion to access a particular byte (octet) of the raw
value.

Syntax

The syntax of the conversion is:

DByte(n)

DByte name of conversion

where

n = byte number, range 1 to 4; the practical range depends on the word

size of the raw data type in question (e.g., 16 or 32 bits - 2 or 4 bytes)

Operation

Read Returns to the client the value of the nth byte

of the raw value.

Write Writes as raw value the input from the client

into the lowest nth byte of the raw value.

Conversion - Divide (DDIV)

Use the DDIV conversion to divide the raw value by a constant number.

Syntax

The syntax of the conversion is:

DDIV(n)

DDIV the name of the conversion

where

n = divisor, range up to 6 digits, with or without decimal point.

Operation

Read Returns to the client the raw value divided by

n.

Write Writes as raw value the input from the client

multiplied by n.

Pulse 4.12 User Guide 1437

Conversion - Multiply (DMUL)
Use the DMUL conversion to multiply the raw value by a constant number.

Syntax

The syntax of the conversion is:

DMUL(n)

DMUL name of conversion

where

n = factor, range up to 6 digits, with or without decimal point

Operation

Read Returns to the client the raw value multiplied

by n.

Write Writes as raw value the input from the client

divided by n.

Conversion - Nibble (DNIB)

Use the DNIB conversion to access a particular nibble (4-bit group) of the
raw value.

Syntax

The syntax of the conversion is:

DNib(n)

DNib name of conversion

where

n = nibble number, range 1 to 8; the practical range depends on the word

size of the raw data type in question (e.g., 16 or 32 bits - 4 or 8 nibbles).

Operation

Read Returns to the client the value of the nth nibble

of the raw value.

Write Writes as raw value the input from the client

into the lowest nth byte of the raw value.

Pulse 4.12 User Guide 1438

Conversion - Signed Divide (SDIV)
The Signed Divide (SDIV) function is given to a database block or address.
It divides a signed raw value (arriving from the PLC), by the given
constant number. For example:

If AV1 = -100, the result of the following conversion:

DBSR|PCIM!AV1,,SDIV(20)is –5

Syntax

The syntax of the conversion is:

SDIV(n)
SDIV name of conversion

where

n = divisor

Conversion - ShiftLeft (SHL)

This conversion shifts the bits of a 16-bit word (register) to the left a
specified number of positions. The added bits are false (0).

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion.

For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,SHL()

This conversion is bi-directional, converting the value of the item when

read from and written to the server. This conversion is specified with one
parameter, representing the number of bits to be shifted to the left.

Example

Item Hex Binary Decimal

|!1:1:40001 1234 0001001000110100 4660

|!1:1:40001,,SHL(2) 48D0 0100100011010000 18640

Pulse 4.12 User Guide 1439

Conversion - ShiftRight (SHR)
This conversion shifts the bits of a 16-bit word (register) to the right a
specified number of positions. The added bits are false (0).

Syntax

To use a conversion, type a comma right after the PLC address, then the
conversion. For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,SHR()

This conversion is bi-directional, converting the value of the item when

read from and written to the server. This conversion is specified with one
parameter, representing the number of bits to be shifted to the right.

Example

Item Hex Binary Decimal

|!1:1:40001 1234 0001001000110100 4660

|!1:1:40001,,SHR(2) 048D 0000010010001101 1165

Pulse 4.12 User Guide 1440

Conversion - Process Square Root (SQRT)
The square root conversion produces in the Read direction the square root
of the original (server) value of the variable, normalized to (multiplied by)
the square root of the normalizing parameter. The parameter can be
specified with a precision of 15 significant digits, and the result is
calculated internally with the same precision - but rendered with only
seven significant digits.

In the Write direction, the conversion sets the variable to the square of
the value entered by the client, normalized to (divided by) the normalizing
parameter.

Potential applications include presenting variables that represent the

square of a physical entity - and returning corresponding settings.

Syntax

The syntax of the conversion is:

SQRT([norm])

SQRT The name of the conversion

where

norm (Optional) = normalizing parameter (positive constant). If not

specified, it is considered 1.

Operation

Read The result of the conversion at the client is:

Cvalue =

where ABS = Absolute value

Write The result of the conversion at the server is:

Svalue=Cvalue2/ABS(norm)

where ABS = Absolute value

Pulse 4.12 User Guide 1441

Application Example 1 - Square Root from Range 0-1000

The requirements for this example are:

 The value in the field (for example, from a PLC) spans between 0
and 1000, and represents the square of a physical entity that spans
between 0 and 31.62 units. The value has to be presented in a
display in physical units.

 The field value is obtained directly from the direct access reference
1:2:X1234 (port 1, PLC 2, data address X1234).

Design

None.

Animation

1 In the Animation Editor, select the graphic object (the text object)
representing the value, and configure the Output Text property as
follows:

Server DBSR

Topic PCIM

Item 1:2:X1234,,SQRT()

Format ##.##

Mode Formatted value

2 Hold down the <CTRL> Key, and click OK.

NOTE Do not enter any spaces between the comma "," and "SQRT".

Application Example 2 - Square Root from Range 0-1000 with

Operator Input

The requirements for this example are similar to Example 1, but now the
operator has to input a value (0-1000) to the field.

Design

None.

Pulse 4.12 User Guide 1442

Animation

1 In the Animation Editor, select the graphic object (the text object)
representing the value, and configure the Input Text property as
follows:

Server DBSR

Topic PCIM

Item 1:2:X1234,,SQRT()

Format ##.##

Mode Formatted value

NOTE Do not enter any spaces between the comma "," and "SQRT".

2 After selecting the Formatted value button, enter the limits as

follows:

Minimum value 0

Maximum value 1000

3 Hold down the <CTRL> Key, and click OK.

Conversion - Alarm (DAlarm)

Use the Alarm conversion to indicate whether the raw value is within or
outside the specified range.

Syntax

The syntax of the conversion is:

DAlarm(alarm_Lo,alarm_Hi)
DAlarm [Name of conversion]
alarm_Lo [Alarm low point]
alarm_Hi [Alarm high point]

The comma must be included.

Operation

Read only  Returns to the client 0 if the raw value is

within this range.

Returns to the client 1 if the raw value is

outside this range.

Pulse 4.12 User Guide 1443

Conversion - Linear (LIN)
The Linear conversion is bidirectional, converting the value of the item
when read from and written to the server. The conversion is specified with
four parameters, representing two points on the converting line. All four
parameters can be specified with a precision of 15 significant digits, and
the result is calculated internally with the same precision - but rendered
with only seven significant digits.

Potential applications include linear scaling of variables.

Syntax

The syntax of the conversion is:

LIN(Slow,Shigh,Clow,Chigh)

LIN The name of the conversion

Slow Server side low point

Shigh Server side high point

Clow Client side low point

Chigh Client side high point

 The Shigh parameter must not be equal to Slow. The Chigh

parameter must not be equal to Chigh.

 All three commas must be included.

 The "low" and "high" designations are arbitrary. The actual values
may be specified in reverse order.

Pulse 4.12 User Guide 1444

Operation

Read Read The result of the conversion at the client

(Cvalue) is:

Cvalue=(Svalue-Slow)/(Shigh-Slow)*(Chigh-
Clow)+Clow

If the conversion is specified with Shigh=Slow, then

Cvalue is clamped to Clow for any Svalue.

Write The result of the conversion at the server is:

Svalue=(Cvalue-Clow)/(Chigh-Clow)*(Shigh-
Slow)+Slow

If the conversion is specified with Chigh=Clow, then

Svalue is clamped to Slow for any Cvalue.

NOTE The conversion does not clamp in either direction; the four
parameters only indicate two points on the conversion line.

Application Example 1 - Convert Range 2200-4400 into Range 0-

100

The requirements for this example are:

 The value in the field (for example, from a PLC) spans between
2200 and 4400, and linearly represents a physical entity that spans
between 0 and 100 units. The value has to be presented in a
display in physical units.

 The field value is obtained directly from the direct access reference
1:2:X1234 (port 1, PLC 2, data address X1234).

Design

None.

Animation

1 In the Animation Editor, select the graphic object (the text

object) representing the value, and configure the Output Text
property as follows:

Server DBSR
Topic PCIM
Item 1:2:X1234,,LIN(2200,4400,0,100)
Format ###
Mode Formatted value

Pulse 4.12 User Guide 1445

2 Hold down the <CTRL> Key, and click OK.

NOTE Do not enter any spaces between the comma “,” and “LIN”.

Application Example 2 - Convert Range 2200-4400 into Range 0-

100 and Vice Versa

The requirements for this example are similar to Example 1, but now the
operator also has to input a value (0 to 100) to the field.

Design

None.

Animation

1 In the Animation Editor, select the graphic object (the text

object) representing the value, and configure the Input Text
property as follows:

Server DBSR

Topic PCIM

Item 1:2:X1234,,LIN(2200,4400,0,100)

Format ###

Mode Formatted value

NOTE Do not enter any spaces between the comma “,” and “LIN”.

2 After selecting the Formatted value button, enter the limits as

follows:

Minimum value 0

Maximum value 1000

3 Hold down the <CTRL> Key, and click OK.

Pulse 4.12 User Guide 1446

Conversion - ToHex
This conversion is used for bidirectional conversion of decimal value to
hexadecimal value.

Syntax

To use a conversion, type a comma right after the ToHex address, then
the conversion.

For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,TOHEX()

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns a hexadecimal value of the original value.

This conversion has no parameters.

Example

Item Decimal Item Hexadecimal

|!a:1 10 |!a:1,,ToHex() A

Pulse 4.12 User Guide 1447

Conversion - ToOct
This conversion is used for bidirectional conversion of decimal value to
octal value.

Syntax

To use a conversion, type a comma right after the ToOct address, then
the conversion. For example:

Without conversion With conversion

|!1:1:40001 |!1:1:40001,,TOOCT()

This conversion is bidirectional, converting the value of the item read from
or written to the server. When reading from the server, this conversion
returns an octal value of the original value.

This conversion has no parameters.

Example

Item Decimal Item Hexadecimal

|!a:1 10 |!a:1,,ToOct() 8

Pulse 4.12 User Guide 1448

Working with the Workflow Manager
A workflow is a collection of activities which Pulse executes in a defined
sequence. The workflow is triggered by an action (mouse click, data value
which passes a defined threshold, etc.) which is attached to an element or
object.

The Workflow Manager window displays a tree from which you can add
workflows and edit their properties (actions, order). You assemble and
edit the workflows in the Pulse Workflow Editor.

Adding and Editing Workflows

In the Workflows Manager, you can add and edit workflows.

To add or edit a workflow

1 From the Developer Workstation’s Manage ribbon, click

Workflows.

The Workflows Manager window is displayed. The Workflow

Manager window displays a tree from which you can add workflows
and edit their properties (activities, order).

Pulse 4.12 User Guide 1449

To add a workflow

1 In the Workflow Manager window, right-click and select New

Workflow.

The Pulse Workflow Editor is displayed.

2 On the Pulse Workflow Editor window’s right pane, select an

activity from the Pulse, General, or Custom category.

3 Drag the activity to the required location in the sequence on the

left. Make sure that the activity name is a unique identifier in the
workflow.

4 When you finish assembling the workflow, click Save As to save a

new workflow, or Save to save a modified workflow.

Pulse 4.12 User Guide 1450

Executing a Workflow at Runtime
To execute a workflow from the Workflows tree

1 Open the Project Navigator pane to the Workflows mode.

2 Right-click the specific workflow and click Execute Workflow from

the pop-up menu.

-or-

Double-click the specific workflow.

The workflow is executed.

Pulse 4.12 User Guide 1451

To execute a workflow from the Execute Workflow window

1 In the Home ribbon, click Execute.

The Execute Workflow dialog box is displayed.

2 Expand the Workflows folder, select the workflow, and click the
Execute button.

3 The workflow is executed.

Pulse 4.12 User Guide 1452

DoWorkflow Command
You can also execute a workflow using the DoWorkflow followed by the
workflow name. The DoWorkflow activates a Pulse workflow. You can add
this command to Action Button

Animation or to AutoActions. When writing this command, you need to

add an argument specifying the name of the workflow. For example, to
initiate workflow WF1, enter the following:

DoWorkflow WF1

Opening a Workflow in the Workflow Editor

You can open a workflow from the Pulse Workflow Editor.

To open a workflow in the Pulse Workflow Editor

1 In the Pulse Workflow Editor dialog box, select a workflow.

2 Go to the toolbar and click Open.

The Open Workflow window is displayed.

Pulse 4.12 User Guide 1453

3 Select the name of the workflow (scroll if necessary) and click OK.

The selected workflow chart and parameters are displayed on the

Workflow Editor’s left panel.

Saving a New Workflow

After creating a new workflow, save it to store and use it in the project.

To save a new workflow

1 In the Pulse Workflow Editor toolbar, click Save As.

The Save Workflow As dialog box is displayed.

2 Type the name of the new workflow and click OK.

The workflow is now in the project and appears in the Workflows

Manager tree.

Pulse 4.12 User Guide 1454

Adding Custom Actions to a Workflow
In addition to the activities supplied by Pulse, you can add custom-created
actions to a Pulse workflow.

To add a custom action to a workflow

1 In the Pulse Workflow Editor toolbar, click the Custom

Activities icon.

The Add/Remove Workflow Activities window is displayed.

2 Select the action entry and click OK. If necessary, browse to

another location to select the item.

The custom activity is now part of the workflow.

On the Pulse Workflow Editor window’s right pane, a new activity

category is added called Custom. The custom activity is added to
this category and can be used like any other activity in the
workflow.

Pulse 4.12 User Guide 1455

Activity
An activity is a single operation declared and executed within a workflow.

Pulse Activities
A Pulse activity is a single Pulse operation declared and executed within a
workflow. Each activity has an action which can be executed without
creating a whole workflow, by adding it to an action button animation or
an autoaction.

For more information on autoactions, refer to the following:

 For Display autoactions, refer to Defining Display Properties.

 For Operator workstation autoactions, refer to AutoActions.

 For Server autoactions, refer to Defining Server AutoActions.

Argument

A Pulse activity that has an argument can be used as an action that is not
within a workflow.

 An argument enclosed in square brackets [] represents optional

arguments.

 An argument enclosed in curly brackets {} represents a set of

values used as the argument.

NOTE IfLevel and IfConfirm are actions that were replaced by the
workflowAuthorizationLevel in the workflows and by the
Confirmation parameters in every activity but are still used as
actions. For more information, refer to IfLevel and IfConfirm
Actions.

Pulse 4.12 User Guide 1456

The following are the Pulse activities

 AlarmExplorer

 Alert

 AutoActions

 AutoAlarmActions

 AutoAlarmDisplay

 AutoAlarmPrint

 Basic

 BasicScriptActions

 Close

 CloseAllWindows

 CompRcp

 Datascope

 Dec

 DelDbfRecords

 DeployToFlashDrive

 DisEnbAlt

 DoAction

 DoButton

 DoWorkflow

 Email

 EMCenter

 EMEventCloseCodes

 EMEventsClasses

 EMPersonnel

 EMProperties

 EmptyCache

 EMShiftDetails

Pulse 4.12 User Guide 1457

 EMShifts

 EMTaskCloseCodes

 EMTasks

 EMUserEvents

 EnableDisp

 EndTask

 Exit

 FullScreen

 GetAdvisedItem

 Help

 Inc

 IniDelete

 InputMode

 Inv

 InvokeMethod

 ItemsExplorer

 Language

 LayersBox

 LearnRcp

 LoadDb

 LoadRcp

 LoadTrendGroup

 LockWorkstation

 LogData

 LogDynamicData

 LoggerWindow

 LogIn

 Maximize

 Minimize

Pulse 4.12 User Guide 1458

 NavigateInOperator

 ObjectContextMenu

 Open

 OpenLastAlarmDisplay

 OperActionLog

 PlaySound

 Print

 PrintAllOpenDisplays

 PrintDisp

 PrintText

 Purge

 ReadRcp

 ReloadActions

 RepData

 RepDataStop

 RepGen

 ReportTrend

 RepPrint

 RepRead

 RepReindex

 RepShow

 Restore

 RevertToSaved

 Run

 RunSchedule

 SaveDb

 SavePersonalization

 SaveRcp

 SchedActions

Pulse 4.12 User Guide 1459

 ScheduleManager

 ScheduleTo

 SendKeys

 ServerManager

 Set

 SetLocalTime

 SetProperty

 ShowLayer

 ShowTask

 Skin

 SupremeReport

 SwitchToDevelopment

 ToolBar

 UserManager

 WinCmd

 WindowsLayout

 WinExit

 WinHelp

 WorkstationWindowOptions

 Xdos

 Zoom

Pulse 4.12 User Guide 1460

AlarmExplorer
The AlarmExplorer activity opens a new client instance of the Alarm
Explorer tool.

The Client workstation has to be open when using the AlarmExplorer

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AlarmExplorer activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The AlarmExplorer activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The AlarmExplorer activity is

executed at runtime.

False - The AlarmExplorer activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1461

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message
window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1462

Alert
The Alert activity in a workflow is used to display a message that prompts
the operator, presents one, two, or three buttons and expects a response
by clicking one of the buttons.

When the user selects a single choice then only the OK button is
presented. It pauses the workflow execution for a while and resumes after
the operator clicks the button.

The operator can also choose between two or three buttons to determine
the workflow course of execution by clicking the respective buttons.

The Client workstation has to be open when using the Alert activity.

Argument

The following are the Alert arguments when it is used as an action and
not used within a workflow.

Alert MessageText [Caption][MessageButtons]

 Caption - optional argument; the text in the title bar of the

Activity Confirmation message window

 MessageButtons - optional argument; the text or the prompt in

the body of the message box

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Alert
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

Pulse 4.12 User Guide 1463

The Alert activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Alert activity is executed at

runtime.

False - The Alert activity is not executed

and not validated at runtime.

Alert

Caption The text in the title bar of the Activity

Confirmation message window.

Message The text or the prompt in the body of the

message box. It is recommended that the
operator chooses one of the buttons as a
prompt.

MessageBoxButtons Select from the following standard button

configurations:

 OK - the message box presents just an

OK button. The workflow execution
pauses until the operator clicks OK.

 OKCancel - the message box presents

two buttons: OK and Cancel

 AbortRetryIgnore - the message box

presents three buttons: Abort, Retry,
Ignore

 YesNoCancel - the message box

presents three buttons: Yes, No,
Cancel

 YesNo - the message box presents

two buttons: Yes, No

Pulse 4.12 User Guide 1464

  RetryCancel - the message box
presents two buttons: Retry, Cancel

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree and define the
configuration choices.

Parameter1 Click the icon to display the Bind

‘Parameterx’ to an activity’s property
Parameter2 window (where x = 1/2/3).
Parameter3  Select the Bind to an existing
member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1465

 Result

Result  None - Select this option so no action

is performed when the related button
in the message box is clicked.

 OK - Select this option to confirm the

operation when the related button in
the message box is clicked

 Cancel - Select this option to cancel

the operation when the related button
in the message box is clicked.

 Abort - Select this option to abort the

operation when the related button in
the message box is clicked.

 Retry - Select this option to retry the

operation when the related button in
the message box is clicked.

 Ignore - Select this option to ignore

the operation when the related button
in the message box is clicked.

 Yes - Select this option to confirm the

operation when the related button in
the message box is clicked.

Pulse 4.12 User Guide 1466

AutoActions
The AutoActions activity switches the AutoActions engine on or off in
the Operator Workstation or for a selected display(s).

The Client workstation has to be open when using the AutoActions

activity.

Argument

The following are the AutoActions arguments when it is used as an

action and not used within a workflow.

If the user provides a display name, this switches the autoactions engine
for that display(s). Otherwise, it switches the autoactions engine for the
entire workstation.

AutoActions [{display|wildcard}] {0|1} [-S]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

Specify which AutoActions script you want to enable or disable:

 Of a particular display - enter the name of the display

 Of the Operator Workstation script - leave this argument blank

 Of one or more displays - use a wildcard specification

• 0|1 - Enter 1 to enable or enter 0 to disable; leave blank to

toggle

• -S - Optional, use this flag to ignore or skip the first

occurrence of the trigger right after the script was enabled.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoActions activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

Pulse 4.12 User Guide 1467

The AutoActions activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The AutoActions activity is executed

at runtime.

False - The AutoActions activity is not

executed and not validated at runtime.

AutoActions

DisplayName Select the name of the display or the display

template.

SetTriggerStatus True - Select this option to set the trigger

status.

False - Select this option for the trigger

status not to be activated

more... - Click the icon to display the

Item Manager window to browse the Hosts
tree define the trigger status advised item.

SkipFirstTrigger True - Select this option to skip the first

trigger.

False - Select this option to activate the first

trigger.

more... - Click the icon to display the

Item Manager window to browse the Hosts
tree and define the advised item of the first
trigger.

Pulse 4.12 User Guide 1468

 Target Workstation - Select this option for the
trigger to activate the workflow on the
workstation.

Display - Select this option for the trigger to

activate the workflow on the display.

more... - Click the icon to display the

Item Manager window to browse the Hosts
tree and define the Advised Item.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1469

AutoAlarmActions
The AutoAlarmActions activity allows the Operator Workstation to
register activated Alarm actions.

The Client workstation has to be open when using the AutoAlarmActions

activity.

The AutoAlarmActions activity supports Expression and Bind property.

Argument

The following are the AutoAlarmActions arguments when it is used as

an action and not used within a workflow.

AutoAlarmActions [0/1]

• 0 - to turn the AutoAlarmActions feature off

• 1 - to turn the AutoAlarmActions feature on

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoAlarmActions activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The AutoAlarmActions activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1470

 Enabled True - The AutoAlarmActions activity is
executed at runtime.

False - The AutoAlarmActions activity is

not executed and not validated at runtime.

AutoAlarmActions

AutoAlarmActionsE Supports Expressions and Bind property.

nable
To bind property, double-click on the icon
to display the Bind
‘AutoAlarmActionsEnable’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1471

AutoAlarmDisplay
The AutoAlarmDisplay activity allows the Operator Workstation to
automatically pop-up the alarm display associated with an alarm
condition.

The AutoAlarmDisplay activity supports Bind property in its

argument(s).

The Client workstation has to be open when using the AutoAlarmDisplay

activity.

Argument

The following are the AutoAlarmDisplay arguments when it is used as

an action and not used within a workflow.

AutoAlarmDisplay [0/1]

• 0 - to turn the AutoAlarmDisplay feature off

• 1 - to turn the AutoAlarmDisplay feature on

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoAlarmDisplay activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The AutoAlarmDisplay activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The AutoAlarmDisplay activity is

executed at runtime.

False - The AutoAlarmDisplay activity is

not executed and not validated at runtime.

Pulse 4.12 User Guide 1472

 AutoAlarmDisplay

EnableAutoAlarm Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘EnableAutoAlarm’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1473

AutoAlarmPrint
The AutoAlarmPrint activity allows the Operator Workstation registers to
print Alarm messages.

The Client workstation has to be open when using the AutoAlarmPrint

activity.

The AutoAlarmPrint activity supports Expression and Bind property.

Argument

The following are the AutoAlarmPrint arguments when it is used as an

action and not used within a workflow.

AutoAlarmPrint [0/1]

• 0 - to turn the AutoAlarmPrint feature off

• 1 - to turn the AutoAlarmPrint feature on

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoAlarmPrint activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The AutoAlarmPrint activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The AutoAlarmPrint activity is

executed at runtime.

False - The AutoAlarmPrint activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1474

 AutoAlarmPrint

AutoAlarmPrintEna Supports Expressions and Bind property.

ble
To bind property, double-click on the icon
to display the Bind
‘AutoAlarmPrintEnable’ to an activity’s
property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Click the icon to display the Item Manager

window to define the expression.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1475

Basic
The Basic activity activates the specified Basic Script with its arguments.

The Basic activity is applicable on a standalone server only. The

standalone server has to be open when using the Basic activity.

Argument

The following are the Basic arguments when it is used as an action and
not used within a workflow.

Basic [path]script-name[.ext] operation [arg1 [arg2 [|!] ] ]

Use this command to enable running Basic scripts from P-CIM.

• path - the Path of the script file if it is not in its default

location (path of P-CIM token PcimUtil)

• script-name - the name of the script file

• ext - the extension of the script file if it is not the default

(LGC)

• operation - Operation keyword; enter RUN to run script,

enter TRACE to run the script with an open debug window
(override QueryOpen) or enter STOP to stop the script.

• arg1, arg2, etc. - optional, list of arguments

Using Script Arguments

Use argx script arguments to substitute script assignments at runtime.

The main purpose of the script arguments is to reuse the same script with
a different set of external (Pulse) variables and/or constants.

Each argx specified in the BASICSRV command substitutes the right side
contents of the respective script assignment in the order of assignment
lines specified in the script.

To specify an argument that contains spaces and/or punctuation marks,

enclose it in a single or double quotes, for example: “can't do” or “a
banana”).

To skip an argument, just specify |! (i.e., a blank DDE reference).

NOTE This substitution mechanism operates on a line-by-line basis in

the script. To use this feature, do not specify more than one
assignment per script line at the beginning of the script.

Pulse 4.12 User Guide 1476

Script Example

LET VAR1 = |!ABC

LET VAR2 = |!XYZ
LET PRESET = 100
VAR1 = VAR2 * PRESET * 2
END

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Basic
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Basic activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Basic activity is executed at

runtime.

False - The Basic activity is not executed and

not validated at runtime.

Arguments

Arguments Click the icon to display the String

Collector Editor window.

Enter one string per line in the collection and

click OK.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Pulse 4.12 User Guide 1477

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Operation

Operation Click the icon to display the Bind

‘Operation’ to an activity’s property
window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

ScriptName

ScriptName Click the icon to display the Bind

‘ScriptName’ to an activity’s property
window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1478

BasicScriptActions
The BasicScriptActions activity turns the BasicSRV script Actions of the
current Operator Workstation registration on or off.

The Client workstation has to be open when using the

BasicScriptActions activity.

Argument

The following are the BasicScriptActions arguments when it is used as

an action and not used within a workflow.

BasicScriptActions {0|1}

• 1 - Enables the Basic script actions

• 0 - Disables the Basic script actions

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

BasicScriptActions activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The BasicScriptActions activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The BasicScriptActions activity is

executed at runtime.

False - The BasicScriptActions activity is

not executed and not validated at runtime.

Pulse 4.12 User Guide 1479

 BasicScriptActions

EnableBasicScriptA True - Enables the Basic script actions

ctions
False - Disables the Basic script actions

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1480

Close
The Close activity closes the current display or another specified Pulse
display(s).

The Client workstation has to be open when using the Close activity.

This activity is combined out of two actions: Close and CloseAll.

 For Close action - If no display name is provided, the currently

focused display will be closed.

 For CloseAll action - If a display name is provided; all other

displays will be closed.

The Close activity supports Bind property in its argument(s).

Argument

The following are the Close arguments when it is used as an action and
not used within a workflow.

Close [display|wildcard]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Close
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Close activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1481

 Enabled True - The Basic activity is executed at
runtime.

False - The Basic activity is not executed and

not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc Supports Bind property in its argument(s).

DisplayName To bind property, double-click on the icon

to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1482

 ShouldCloseAll To bind property, double-click on the icon
to display the Bind ‘ShouldCloseAll’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1483

CloseAllWindows
The CloseAllWindows activity closes all open MDI windows including
displays and tools.

The Client workstation has to be open when using the CloseAllWindows

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

CloseAllWindows activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The CloseAllWindows activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The CloseAllWindows activity is

executed at runtime.
False - The CloseAllWindows activity is not
executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1484

CompRcp
The CompRcp activity compares two groups of recipes. A potential
application of this command is to verify that a LoadRcp command was
executed properly.

The Server has to be open when using the CompRcp activity.

Argument

The following are the CompRcp arguments when it is used as an action

and not used within a workflow.

Syntax

CompRcp DDE [Recipe [fromGroup [toGroup]]]

• DDE - the DDE address of the variable that receives the

result of the comparison (the result is 1 if the comparison
succeeds, or 0 if not)

• Recipe - the name of the recipe

• fromGroup - the name of the first group to be compared

• toGroup - the name of the second group to be compared

Use this action command to compare between two groups of a recipe. A

potential application of this command is to verify that a LoadRcp
command was executed properly (e.g., was not disturbed by any
communication problems or that some of the settings were not changed
by other means):

1 Download the recipe group that was originally intended (command

LoadRcp).

2 Upload the setting to another group (command LearnRcp).

3 Compare between the two groups (command CompRcp).

4 Act according to the comparison result expressed in the DDE

variable of CompRcp.

At runtime, the recipe compare operation compares the values of

corresponding addresses in the two groups. The comparison succeeds if all
value pairs match - or fails if any value pair does not match.

Pulse 4.12 User Guide 1485

Application Options

Omit arguments you want the operator to choose at run time. In this
case, the Operator Workstation displays dialog box(es) from which the
operator can select the missing arguments.

Examples

 To compare the groups PURGE and CLEAN of recipe BOILER and

place the result in dbsr|pcim!OK:

CompRcp dbsr|pcim!OK BOILER PURGE CLEAN

(or CompRcp |!OK BOILER PURGE CLEAN)

 To compare the group PURGE of recipe BOILER against an operator-

specified group, and place the result in dbsr|pcim!OK:

CompRcp dbsr|pcim!OK BOILER PURGE

(or CompRcp |!OK BOILER PURGE)

This presents a dialog box listing all the groups in recipe BOILER at
runtime, from which the operator can choose a particular group (or
abort).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

CompRcp activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The CompRcp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1486

 Enabled True - The CompRcp activity is executed at
runtime.

False - The CompRcp activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdviseItem Click the icon to display the Item

Manager window to browse the Hosts tree
and define the Advised Item.

FromGroup Select the object reference group from the

drop-down list or by clicking more... to
display the Item Manager window to
browse the Hosts tree and define the Advised
Item.

Recipe Select more... from the drop-down list to

display the Item Manager window to
browse the Hosts tree and define the Recipe
Advised Item.

ToGroup Select more... from the drop-down list to

display the Item Manager window to
browse the Hosts tree and define the
ToGroup Advised Item.

Pulse 4.12 User Guide 1487

Datascope
The Datascope activity opens a new client instance of the Data Scope
tool.

The Client workstation has to be open when using the Datascope activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

Datascope activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The Datascope activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Datascope activity is executed at

runtime.

False - The Datascope activity is not

executed and not validated at runtime.
Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1488

Dec
The Dec activity decrements the value of a variable. It decreases the
value of the first DDE data item specified by the value of the second DDE
data item or the value specified. The default, if the second parameter is
not specified, is 1.

The Server and the Client workstation have to be open when using the
Dec activity.

Argument

The Dec command uses the last known value of the destination variable
and of the decrement when it is a variable as well in order to work as
expected. Make sure that Pulse has a recent value(s) of the variable(s).

The following are the Dec arguments when it is used as an action and not
used within a workflow.

Dec DDE [value|DDE] [/server|/client]

• DDE - Enter the DDE specification in the format

“server|topic!item”.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Dec
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Dec activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Dec activity is executed at

runtime.

False - The Dec activity is not executed and

not validated at runtime.

Pulse 4.12 User Guide 1489

 RunAtServer True - Enables the Dec activity to be
executed on the server.

False - Disables the Dec activity to be

executed on the server.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdvisedItem Click the icon to display the Item

Manager window.

Subscribe to the data by opening 'items'

which are present in an open display.

Value Click the icon to display the Item

Manager window.

Define a value for the Advised Item.

Pulse 4.12 User Guide 1490

DelDbfRecords
The DelDbfRecords activity deletes specified records from a DBF file
according to the filter- expression.

The Server has to be open when using the DelDbfRecords activity.

Argument

The following are the DelDbfRecords arguments when it is used as an

action and not used within a workflow.

DelDbfRecords [path]dbf-name filter-expr

• path - optional argument; the path of the dbf file

• dbf-name - the name of the dbf file

• filter-expr - the filter expression

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

DelDbfRecords activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The DelDbfRecords activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The DelDbfRecords activity is

executed at runtime.

False - The DelDbfRecords activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1491

 Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

DelDbfRecords

DbfName Click the icon to display the Item

Manager window and set the Dbf name.

FilterExpression Click the icon to display the Item

Manager window and set the filter
expression.

Pulse 4.12 User Guide 1492

DeployToFlashDrive
The DeployToFlashDrive activity downloads the Pulse application to a
USB Flash drive.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

DeployToFlashDrive activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The DeployToFlashDrive activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The DeployToFlashDrive activity is

executed at runtime.

False - The DeployToFlashDrive activity is

not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1493

DisEnbAlt
The DisEnbAlt activity disables or enables key combinations.

Argument

The following are the DisEnbAlt arguments when it is used as an action

and not used within a workflow.

DisEnbAlt [-D] [-U:userName] [-P:password] [-

O:DomainName]

• -D - enables/disables the DisEnbAlt activity

• -U - the user name syntax

• -P - the password syntax

• -O - the domain name syntax

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

DisEnbAlt activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The DisEnbAlt activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The DisEnbAlt activity is executed at

runtime.

False - The DisEnbAlt activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1494

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

DisEnbAlt

DomainName Click the icon to display the Item

Manager window and set the domain name.

IsEnable True - Enables running the DisEnbAlt

activity

False - Disables the DisEnbAlt activity

Password Click the icon to display the Item

Manager window and set the password
syntax.

UserName Click the icon to display the Item

Manager window and set the user name
syntax.

Pulse 4.12 User Guide 1495

DoAction
The DoAction activity executes the specified action from the
AutoActions script of the Operator Workstation or of a specified display
regardless whether the display is currently open or closed in the Operator
Workstation.

NOTE The Client Operator Workstation resolves the action from the
specified display and decides whether to run it on the server or
the client.

It converts to the DoWorkflow activity and creates an

automatic workflow with a default name display button.

The DoAction activity supports Bind property in its argument(s).

Argument

The following are the DoAction arguments when it is used as an action

and not used within a workflow.

DoAction [display] autoaction

• display - Enter the name of the display file without the

extension - for example, “area1”.

If a display name is not provided, the action is resolved from the

workstation auto actions.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the DoAction
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The DoAction activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1496

 Enabled True - The DoAction activity is executed at
runtime.

False - The DoAction activity is not

executed and not validated at runtime.

RunAtServer True - Enables running the DoAction

activity on the server.

False - Disables running the DoAction

activity on the server.

Auto Action Supports Bind property in its argument(s).

AutoActionName To bind property, double-click on the icon

to display the Bind ‘AutoActionName’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Select more... from the drop-down list to

display the Item Manager window and set the
AutoAction name.

Pulse 4.12 User Guide 1497

 DisplayName To bind property, double-click on the icon
to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Select more... from the drop-down list to

display the Item Manager window and set
the AutoAction name.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed

False - No confirmation message is displayed

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1498

DoButton
The DoButton activity runs a Pulse button of a Pulse display. It executes
the specified Up or Down action of a specific Action button (identified by
the Symbol ID number of the object which is the Action Button) of a
display that is presently displayed (minimized or not) on the Operator
Workstation. The Symbol ID name is replaced by the Symbol ID number
when converting an application from 7.x to 8.x.

NOTE The Client Operator Workstation resolves the action from the
specified display and decides whether to run it on the server or
the client.

It converts to the DoWorkflow activity and creates an

automatic workflow with a default name display button.

The DoButton activity supports Bind property in its argument(s).

Argument

The following are the DoButton arguments when it is used as an action

and not used within a workflow.

DoButton display symbolID {Up|Down}

• display - Enter the name of the display file without the

extension - for example, “area1”.

• symbolID - the symbol identifier

• Up - this option executes the Up action button

• Down - this option executes the Down action button

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

DoButton activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The DoButton activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1499

 Description The description of the activity that appears
as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The DoButton activity is executed at

runtime.

False - The DoButton activity is not

executed and not validated at runtime.

RunAtServer True - Enables running the DoButton

activity on the server.

False - Disables running the DoButton

activity on the server.

Button

ActionType Select an action button type to be executed:

 Down - this option executes the Down

action button.

 Up - this option executes the Up action

button.

 Click - this option executes a click

action button.

 DoubleClick - this option executes a

double-click action button.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1500

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Display

DisplayName Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1501

 SymbolId

SymbolId Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘SymbolId’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1502

DoWorkflow
The DoWorkflow activity executes the specified Pulse workflow. The
workflow name consists of wildcards. If the workflow name is not defined,
a list of workflows is displayed with arg1 - arg10 workflow arguments that
are optional.

The Client workstation has to be open when using the DoWorkflow

activity.

Argument

The following are the DoWorkflow arguments when it is used as an

action and not used within a workflow.

DoWorkflow WorkflowName [arg1 arg2 … arg10]

• WorkflowName - the name of the workflow to run

• argx - the arguments

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

DoWorkflow activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The DoWorkflow activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Enabled True - The DoWorkflow activity is executed

at runtime.

False - The DoWorkflow activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1503

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc

WorkflowName Select the name of the workflow to run.

WorkflowToRun Params

Param1 Click the icon to display the Bind

‘Operation’ to an activity’s property
Param10 window.
Param2  Select the Bind to an existing
member tab to select a target
Param3
property of type 'System.String' from
Param4 an activity.

Param5  Select the Bind to a new member

tab to provide the name of the new
Param6 member to be created. The member
can be a field or a property of type
Param7 'System.String'.

Param8

Param9

Pulse 4.12 User Guide 1504

Email
The Email activity sends an e-mail message using SMTP.

NOTE The Email activity does not specifically require Microsoft

Outlook.

The Server and the Client workstation have to be open when using the
Email activity.

Argument

The following are the Email arguments when it is used as an action and
not used within a workflow.

Email [“{address|group-name}” “subject-text” [“body-

text”] [-R][-D][-L|- H][-#]] [/server|/client]

• subject-text - the email’s subject

• body-text - Normal; this option provides the email with

normal email attributes

• -R - ReadNotification; this option requires the email receiver

to notify the sender when the email is read.

• -D - DeliveredNotification; this option sends the sender a

notification when the email is delivered.

• -L - LowImportance; this option shows the email to be of low

importance

• -H - HighImportance - this option shows the email to be of

high importance

• -# - Provide a numerical value; the number of retries for the

email to be sent

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Email
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Email activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1505

 Description The description of the activity that appears
as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Email activity is executed at

runtime.

False - The Email activity is not executed

and not validated at runtime.

RunAtServer True - Enables running the Email activity on

the server

False - Disables running the Email activity on

the server

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Email

Body Click the icon to display the Item

Manager window and define the email body.

Pulse 4.12 User Guide 1506

 EmailAttributes Select the email attributes from the drop-
down list.

 Normal - this option provides the

email with normal email attributes

 ReadNotification - this option

requires the email receiver to notify
the sender when the email is read.

 DeliveredNotification - this option

sends the sender a notification when
the email is delivered.

 LowImportance - this option shows

the email to be of low importance

 HighImportance - this option shows

the email to be of high importance

 more... - Click more... to display the

Item Manager window and browse the
Hosts tree to define the email Advised
Item.

From

RetrysNumber Provide a numerical value; the number of

retries for the email to be sent

Subject Click the icon to display the Item

Manager window and define the email
subject.

To Click the icon to display the Item

Manager window and define the email
destination.

Pulse 4.12 User Guide 1507

EMCenter
The EMCenter activity invokes the Event Management Center tool with
the specified Operator, Supervisor, or Event Journal view.

The EMCenter activity is only active if an EM license is available.

Argument

The following are the EMCenter arguments when it is used as an action

and not used within a workflow.

EMCenter [-OP|-SV|-EJ]

• -OP - Operator; the Event Management Center tool is

invoked with the Operator view.

• -SV - Supervisor; the Event Management Center tool is

invoked with the Supervisor view.

• -EJ - EventsJournal; the Event Management Center tool is

invoked with the Event Journal view.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMCenter activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EMCenter activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMCenter activity is executed at

runtime.

False - The EMCenter activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1508

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

EMCenter

View Select one of the following views for the

EMCenter activity:

 Operator - The Event Management

Center tool is invoked with the
Operator view.

 Supervisor - The Event Management

Center tool is invoked with the
Supervisor view.

 EventsJournal - The Event

Management Center tool is invoked
with the Event Journal view.

Pulse 4.12 User Guide 1509

EMEventCloseCodes
The EMEventCloseCodes activity displays the Event Center
Administration tool Events Close Codes dialog box.

The EMEventCloseCodes activity is only active if an EM license is

available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMEventCloseCodes activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The EMEventCloseCodes activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The EMEventCloseCodes activity is

executed at runtime.
False - The EMEventCloseCodes activity is
not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1510

EMEventsClasses
The EMEventsClasses activity displays the Event Center Administration
tool Events Classes dialog box.

The EMEventsClasses activity is only active if an EM license is available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMEventsClasses activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The EMEventsClasses activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The EMEventsClasses activity is

executed at runtime.
False - The EMEventsClasses activity is not
executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1511

EMPersonnel
The EMPersonnel activity displays the Event Center Administration tool
Personnel dialog box.

The EMPersonnel activity is only active if an EM license is available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMPersonnel activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EMPersonnel activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMPersonnel activity is

executed at runtime.

False - The EMPersonnel activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1512

EMProperties
The EMProperties activity displays the Event Manager properties tool.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMProperties activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EMProperties activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMProperties activity is

executed at runtime.

False - The EMProperties activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1513

EmptyCache
The EmptyCache activity clears the user's local cache.

The Client workstation has to be open when using the EmptyCache

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EmptyCache activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EmptyCache activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EmptyCache activity is executed

at runtime.

False - The EmptyCache activity is not

executed and not validated at runtime.
Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1514

EMShiftDetails
The EMShiftDetails activity displays the Event Center Administration tool
Shift Details dialog box.

The EMShiftDetails activity is only active if an EM license is available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMShiftDetails activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EMShiftDetails activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMShiftDetails activity is

executed at runtime.
False - The EMShiftDetails activity is not
executed and not validated at runtime.
Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1515

EMShifts
The EMShifts activity displays the Event Center Administration tool
Shifts dialog box. The EMShifts activity is only active if an EM license is
available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the EMShifts
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The EMShifts activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMShifts activity is executed at

runtime.

False - The EMShifts activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1516

EMTaskCloseCodes
The EMTaskCloseCodes activity displays the Event Center Administration
tool Task Close Codes dialog box. The EMTaskCloseCodes activity is
only active if an EM license is available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMTaskCloseCodes activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The EMTaskCloseCodes activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The EMTaskCloseCodes activity is

executed at runtime.
False - The EMTaskCloseCodes activity is
not executed and not validated at runtime.
Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1517

EMTasks
The EMTasks activity displays the Event Center Administration tool Tasks
dialog box. The EMTasks activity is only active if an EM license is
available.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the EMTasks
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The EMTasks activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Enabled True - The EMTasks activity is executed at

runtime.

False - The EMTasks activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1518

EMUserEvents
The EMUserEvents activity displays the Event Center Administration tool
User Events dialog box at runtime.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

EMUserEvents activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The EMUserEvents activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EMUserEvents activity is executed

at runtime.

False - The EMUserEvents activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1519

EnableDisp
The EnableDisp activity enables or disables all controls in one or more
open displays. This command cannot override the data entry password
level of the display. The EnableDisp activity cannot enable controls when
they are disabled according to the password level of the operator versus
the data entry password level of the display. However the EnableDisp
activity can disable controls if enabled by that setting.

The EnableDisp activity supports Bind property in its argument(s).

The Client workstation has to be open when using the EnableDisp

activity.

Argument

The following are the EnableDisp arguments when it is used as an action

and not used within a workflow.

If a display name is not provided, the operation is made on the focused

display.

EnableDisp [{display|wildcard} [1|0]]

• display - Enter the name of a display, for example, “area1”.

Omitting to toggle the controls enable the status of the
current display.

• wildcard - Enter a DOS wild card specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

• Enter one of the following: nothing (omit) to toggle the

controls enable status of the display(s) specified by the
previous argument; Enter 0 to disable or 1 to enable.

Use this command to enable (1) or disable (0) all controls in one or more
open displays. This command cannot override the data entry password
level of the display. Namely, it cannot enable controls when they are
disabled according to the password level of the operator versus the data
entry password level of the display, but can disable controls when they
are enabled by that setting.

You can use the command without arguments, with the first argument
only, or with both arguments.

Examples

 EnableDisp - To toggle the enabled status of all connotes of the

current display

Pulse 4.12 User Guide 1520

 EnableDisp PANEL - To toggle the controls enabled status of the
display PANEL. It must be open for the command to be effective.

 To disable or to enable the controls of the display PANEL, it must

be open for the command to be effective:

• To disable: EnableDisp PANEL 0

• To enable: EnableDisp PANEL 1

 To disable or to enable the controls of all the displays named

PANEL* (just PANEL or PANEL followed by any character
combination).Each one must be open for the command to be
effective on that display:

• To disable: EnableDisp PANEL* 0

• To enable: EnableDisp PANEL* 1

• where wildcard is a DOS wild card specification.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the EnableDisp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The EnableDisp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EnableDisp activity is executed at

runtime.

False - The EnableDisp activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1521

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

EnableDisp Supports Bind property in its argument(s).

DisplayName To bind property, double-click on the icon

to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

DispStatus To bind property, double-click on the icon

to display the Bind ‘DispStatus’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1522

EndTask
The EndTask activity closes a running program at runtime and/or on the
server.

The EndTask activity supports Bind property in its argument(s).

The Server and the Client workstation have to be open when using the
EndTask activity.

Argument

The following are the EndTask arguments when it is used as an action

and not used within a workflow.

EndTask {PathProgram|“title-bar”} [/server|/client]

• PathProgram - This option selects the task identifier type

by its program path

• title-bar - Default, this option selects the task identifier type

by its windows title

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the EndTask
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The EndTask activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The EndTask activity is executed at

runtime.

False - The EndTask activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1523

 RunAtServer True - Enables the EndTask activity to run
on the server.

False - Disables the EndTask activity to run

on the server.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Task Info Supports Bind property in its argument(s).

TaskIdentifierType  ByWindowTitle - default, this option

selects the task identifier type by its
windows title

 ByProgramPath - this option selects

the task identifier type by its program
path

To bind property, double-click on the icon

to display the Bind ‘TaskIdentifierType’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1524

 Click the icon to display the Item
Manager window and define a task name.

TaskName To bind property, double-click on the icon

to display the Bind ‘TaskName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Click the icon to display the Item

Manager window and define a task name.

Pulse 4.12 User Guide 1525

Exit
The Exit activity exits the Operator Workstation.

The Client workstation has to be open when using the Exit activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Exit activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Exit activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Exit activity is executed at

runtime.

False - The Exit activity is not executed and

not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1526

FullScreen
The FullScreen activity inverts the current display state from full screen
to normal screen and vice versa.

The Client workstation has to be open when using the FullScreen activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the FullScreen
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The FullScreen activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The FullScreen activity is executed at

runtime.
False - The FullScreen activity is not
executed and not validated at runtime.
Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1527

GetAdvisedItem
The GetAdvisedItem activity receives the current value of the advised
item.

The Client workstation has to be open when using the GetAdvisedItem

activity.

Argument

The following is the GetAdvisedItem argument when it is used as an

action and not used within a workflow.

GetAdvisedItem DDE

• DDE - the DDE address of the variable that receives the

result of the comparison (the result is 1 if the comparison
succeeds or 0 if not).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

GetAdvisedItem activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The GetAdvisedItem activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The GetAdvisedItem activity is

executed at runtime.

False - The GetAdvisedItem activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1528

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdvisedItems Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Items.

Value This is a read-only field.

Pulse 4.12 User Guide 1529

Help
The Help activity displays the Pulse Help according to the specified
parameter.

Argument

The following are the Help arguments when it is used as an action and
not used within a workflow.

Help Contents|Search|About

• Contents - displays the Help activity with its contents

• Search - displays the Help activity with the Search options

• About - displays the Help activity with the About information

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Help activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Help activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Help activity is executed at

runtime.

False - The Help activity is not executed and

not validated at runtime.

RunAtServer True - The Help activity is enabled to run on

the server

False - The Help activity is disabled to run

on the server

Pulse 4.12 User Guide 1530

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Help

TypeOfHelp  Contents - displays the Help activity

with its contents

 Search - displays the Help activity

with the Search options

 About - displays the Help activity with

the About information

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to define the type of
help to display.

Pulse 4.12 User Guide 1531

Inc
The Inc activity increments the value of a variable.

Inc activity increases the value of the first DDE data item specified by the
value of the second DDE data item or the specified value. The default
value is 1 if the second parameter is not specified.

The Server and the Client workstation have to be open when using the
Inc activity.

Argument

The following are the Inc arguments when it is used as an action and not
used within a workflow.

Inc DDE [value|DDE] [/server|/client]

• DDE - the DDE address of the variable that receives the

result of the comparison (the result is 1 if the comparison
succeeds or 0 if not).

• value - the DDE value

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Inc activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Inc activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Inc activity is executed at

runtime.

False - The Inc activity is not executed and

not validated at runtime.

Pulse 4.12 User Guide 1532

 RunAtServer True - Enables running the Inc activity on
the server.

False - Disables running the Inc activity on

the server.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdvisedItem Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Value Click the icon to display the Item

Manager window to browse the Hosts tree to
define the value. The default value is 1 if the
second parameter is not specified.

Pulse 4.12 User Guide 1533

IniDelete
The IniDelete deletes an entire section or a single setting of an INI file.

The Server has to be open when using the IniDelete activity.

The IniDelete activity supports Expression and Bind property.

Argument

The following are the IniDelete arguments when it is used as an action

and not used within a workflow.

IniDelete {-S|-T} IniFileName Section [Token]

• -T - To delete a setting, use: IniDelete -T IniFileName

Section Token

• -S - To delete a section, use: IniDelete -S IniFileName

Section

If an argument contains spaces, enclose it in double open and close

quotation marks.

Specify the full path of the file in question and use one of the predefined
aliases.

Example 1

IniDelete -T &PcimUtil&PfwAlias.Txt Aliases Member

Delete setting Member from the section Aliases in the INI-format file
PFWALIAS.TXT - the file is the aliases dictionary of the project, so it is
located in the subject PcimUtil.

Example 2

IniDelete -S &PcimRcp&RECIPE.RCP Group1

Delete section GROUP1 from INI-format file RECIPE.RCP including all its
settings, the file is a recipe of the project, so it is located in the subject
PcimRcp.

Pulse 4.12 User Guide 1534

Example 3

IniDelete -S C:\ABC\XYZ.INI “CANDY BAR”

Delete section “CANDY BAR” (the section name contains one space, so it is
enclosed in double quotes) from INI-format file XYZ.INI including all its
settings - the file is subdirectory C:\ABC\.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the IniDelete
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The IniDelete activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The IniDelete activity is executed at

runtime

False - The IniDelete activity is not

executed and not validated at runtime

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Pulse 4.12 User Guide 1535

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

IniDelete Supports Expressions and Bind property

DeleteFlag To bind property, double-click on the icon

to display the Bind ‘DeleteFlag’ to an
activity’s property window.

IniFileName To bind property, double-click on the icon

to display the Bind ‘IniFileName’ to an
activity’s property window.

SectionName To bind property, double-click on the icon

to display the Bind ‘SectionName’ to an
activity’s property window.

SettingName To bind property, double-click on the icon

to display the Bind ‘SettingName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Click the icon to display the Item

Manager window to define the expression.

Pulse 4.12 User Guide 1536

InputMode
The InputMode dynamically changes the operation mode of all Input
Text controls in the application. The mode can be preset with the INI
setting InputValueMode.

The Client workstation has to be open when using the InputMode

activity.

Argument

The following are the InputMode arguments when it is used as an action

and not used within a workflow.

InputMode [{0|1|2|3|4|5|6}[,x,y]]

• x - the X INI setting InputValueMode

• y - the X INI setting InputValueMode

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the InputMode
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The InputMode activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter free text; this part may be left blank if

no description is required.

Enabled True - The InputMode activity is executed at

runtime.

False - The InputMode activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1537

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

DialogBoxSettings  CenterDialog - this option displays

the dialog box in the center

 OffsetDialog - this option displays an

offset dialog box

 InsideTextbox - this option displays

the message inside a text box

 AnyPlaceTextBox - this option

displays the text box randomly on the
screen

 more...- Click the icon to display

the Item Manager window and
browse the Hosts tree to define the
dialog box Advised Item.

X Click the icon to display the Item

Manager window to browse the Hosts tree
and define the X INI setting
InputValueMode.

Y Click the icon to display the Item

Manager window to browse the Hosts tree to
define the Y INI setting InputValueMode.

Pulse 4.12 User Guide 1538

Inv
The Inv activity inverts the value of a binary (0/1, False/True) variable. It
digitally inverts the specified DDE data item.

For digital values, 0 is inverted to 1, and 1 to 0.

For analog values, 0 is inverted to 1, and non-zero values are inverted to

0.

The Server and the Client workstation have to be open when using the Inv
activity.

Argument

The following are the Inv arguments when it is used as an action and not
used within a workflow.

Inv DDE [/server|/client]

• DDE - the DDE address of the variable that receives the

result of the comparison (the result is 1 if the comparison
succeeds or 0 if not).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Inv activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Inv activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Inv activity is executed at

runtime.

False - The Inv activity is not executed and

not validated at runtime.

Pulse 4.12 User Guide 1539

 RunAtServer True - Enables the Inv activity to run on the
server

False - Disables the Inv activity to run on

the server

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdvisedItem Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1540

InvokeMethod
The InvokeMethod activity invokes a method of the ActiveX and .NET
controls.

 The Method name includes the full path of an object.

 The method parameters are defined via a comma delimiter (e.g.,

InvokeMethod(“Display1.Object1.Method1”, param1, param2, …)

The Client workstation has to be open when using the InvokeMethod

activity.

Argument

The following are the InvokeMethod arguments when it is used as an

action and not used within a workflow.

InvokeMethod MethodName
InvokeMethod MethodParams

• MethodName - the method name; free text

• MethodParams - the method parameter(s)

The syntaxes display the control method window and define the control
method.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

InvokeMethod activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The InvokeMethod activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Pulse 4.12 User Guide 1541

 Enabled True - The InvokeMethod activity is
executed at runtime.

False - The InvokeMethod activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc

Arguments Enter the argument in free text

Method Click the icon to display the Select

control method window and define the
control method.

Result

Result Click the icon to display the Bind ‘Result’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1542

OpenUserEventDialog

The Pulse InvokeMethod activity has an OpenUserEventDialog()

parameter, which enables opening the Pulse Event Management via an
action button at runtime. The OpenUserEventDialog() parameter can
be configured from the Action Selector window or via a workflow.

To use the invokeMethod OpenUserEventDialog()

1 Insert a Pulse Event Management Instrument in the display.

2 Insert a Pulse Button Instrument into the display.

3 Double-click on the Pulse Button Instrument.

The Pulse Button Settings dialog box is displayed.

4 Click on the Actions Workflow tab and click on the “…” inside the
field to display the Action Selector window.

5 Click the button to the right of the Action command drop-

down list.

The Item Manager window is displayed.

6 Click Actions > Action Composer in the Choose a Category

tree.

7 Select InvokeMethod from the Action Composer list.

8 In the Insert Action Parameters table, go to the Misc area and

click “…” in the Method field.

Pulse 4.12 User Guide 1543

 The Select control method window is displayed.

9 Select the display name from the Displays tree and select the
control name from the Controls list.

Pulse 4.12 User Guide 1544

10 Select OpenUserEventDialog():Void from the Methods > Name
tree and click OK.

11 In the Item Manager window click Apply then click the

button.

The command is displayed in the Action Selector - Action command

field.

12 Click OK then OK again in the Pulse Button Settings dialog box.

13 Click Save.

NOTE The OpenUserEventDialog() is an invokeMethod

parameter that can also be used in a Workflow and configured
from the Pulse Workflow Editor window.

Pulse 4.12 User Guide 1545

ItemsExplorer
The ItemsExplorer activity displays a new Client instance of the Item
Explorer tool.

The Client workstation has to be open when using the ItemsExplorer

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ItemsExplorer activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ItemsExplorer activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The ItemsExplorer activity is

executed at runtime.
False - The ItemsExplorer activity is not
executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1546

Language
The Language activity enables Pulse to switch to a different language
(optional).

The Client workstation has to be open when using the Language activity.

Argument

The following is the Language argument when it is used as an action and

not used within a workflow.

Language [Language]

• Language - the language name to switch

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Language
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Language activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Language activity is executed at

runtime.

False - The Language activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1547

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Language

LanguageName  more... - click more... from the drop-

down list to display the Item
Manager window and browse the
Hosts tree to define the Advised Item
for the language to switch.

Pulse 4.12 User Guide 1548

LayersBox
The LayersBox activity shows/hides the system Layers box where the
user sets for the layers to be visible or invisible.

The LayersBox activity supports Expression and Bind property.

Argument

The following are the LayersBox arguments when it is used as an action

and not used within a workflow.

LayersBox [0|1] [x,y] [w,h]

• 1 - This option enables the layers to be visible.

• 0 - This option makes the layers invisible.

• x - the X coordinate value of the panel location

• y - the Y coordinate value of the panel location

• w - The panel size is based according to the given W = width

• h - The panel size is based according to the given H = height

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LayersBox
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LayersBox activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1549

 Enabled True - The LayersBox activity is executed at
runtime.

False - The LayersBox activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

LayersBox Supports Expressions and Bind property

LayersBoxLocation LayersBoxLocation shows the X and Y

coordinates value of the panel location.

For Expression, click the icon to display

the Item Manager window and browse the
Hosts tree to define the X, Y Advised Item.

 X - numerical value; the X coordinate

value

 Y - numerical value; the Y coordinate

value Supports Expressions and Bind
property.

To bind property, double-click on the icon

to display the Bind ‘LayersBoxLocation’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

Pulse 4.12 User Guide 1550

  Select the Bind to a new member
tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

LayersBoxSize LayersBoxSize shows the X and Y

coordinates value of the panel size

For Expression, click the icon to display

the Item Manager window and browse the
Hosts tree to define the X, Y Advised Item.

 X - numerical value; the X coordinate

value

 Y - numerical value; the Y coordinate

value

To bind property, double-click on the icon

to display the Bind ‘LayersBoxSize’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1551

 LayersBoxVisibility LayersBoxVisibility enables the layers to be
visible/invisible.

For Expression, click the icon to display

the Item Manager window to display the
Item Manager window and browse the
Hosts tree to define the visibility mode of the
Advised Item.

To bind property, double-click on the icon

to display the Bind ‘LayersBoxVisibility’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1552

LearnRcp
The LearnRcp activity learns and uploads a particular Group of recipe,
i.e., it edits the recipe group with actual values from the field.

The LearnRcp complementary command is LoadRcp.

At runtime, the recipe learns that the operation does the following:

 It creates the group specified as the toGroup argument if it does

not exist in the recipe.

 It reads the present value of the variable configured as Address for

each fromGroup setting skipping Settings with a blank Value.

 It overwrites the constant value in the file, in the group:

• Specified as the toGroup argument, or

• Specified as the fromGroup argument if the toGroup

argument was not specified The Server has to be open when
using the LearnRcp activity.

Argument

The following are the LearnRcp arguments when it is used as an action

and not used within a workflow.

LearnRcp [Recipe [fromGroup [[toGroup]]]

Syntax

• Recipe - the name of the recipe

• fromGroup - the name of the group used as a template

• toGroup - the group modified

Use this command to learn (upload) a particular Group of recipe, i.e., to

edit the recipe group with actual values from the field (the complementary
command is LoadRcp).

Pulse 4.12 User Guide 1553

At runtime, the recipe learns operation does the following:

 If the group specified as the toGroup argument does not exist in

the recipe, it creates it.

 It reads, for each Setting in the fromGroup, the present value of

the variable configured as Address, skipping Settings with blank
Value.

 Overwrites the constant value in the file, in the group:

• Specified as the toGroup argument, or

• Specified as the fromGroup argument if the toGroup

argument was not specified.

Application Options

Specify the toGroup argument to keep the "fromGroup" (the template)

unchanged.

You can use this command to provide flexibility at run time, i.e., select the
following via a dialog box:

 Template group and modified group - Enter the recipe argument;

at runtime, select the template group and specify the group to be
modified or created.

 Recipe, template group, and modified group - Enter only the

LearnRcp command. Select the recipe and its template group and
specify the group to be modified or created at runtime.

Examples

 To learn the PURGE group of the BOILER recipe and modify the
respective values of the CLEAN group (it creates the CLEAN group
if it did not exist in the recipe):

LearnRcp BOILER PURGE CLEAN

 To learn the PURGE group of the BOILER recipe and modify its
respective values:

LearnRcp BOILER PURGE

 To present a dialog box listing of all the groups in the BOILER

recipe, from which the operator can choose a particular template
group and specify a destination group, or abort.

LearnRcp BOILER

Pulse 4.12 User Guide 1554

 To present a dialog box listing of all the recipes in the project, from
which the operator can choose a particular recipe, a particular
template group, and specify a destination group, or abort.

LearnRcp

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LearnRcp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LearnRcp activity properties and attributes are described as follows.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The LearnRcp activity is executed at

runtime.

False - The LearnRcp activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1555

 Parameters

FromGroup The name of the group used as a template.

Click more... from the drop-down list to

display the Item Manager window and
browse the Hosts tree to define the
FromGroup Advised Item.

Recipe The name of the recipe.

Click more... from the drop-down list to

display the Item Manager window and
browse the Hosts tree to define the Recipe
Advised Item.

ToGroup The modified group.

Click more... from the drop-down list to

display the Item Manager window and
browse the Hosts tree to define the ToGroup
Advised Item.

The FromGroup object reference has to be

defined first before the ToGroup field is
enabled for definition.

Pulse 4.12 User Guide 1556

LoadDb
The LoadDb activity refreshes and loads or reloads the database.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LoadDb
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LoadDb activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The LoadDb activity is executed at

runtime.

False - The LoadDb activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1557

LoadRcp
The LoadRcp activity loads (downloads) a specific recipe Group, sending
the set values to their respective addresses.

The LoadRcp complementary command is LearnRcp.

The LoadRcp command skips and does not set a blank value.

As application options, use the LearnRcp command to provide flexibility

at runtime, i.e., the operator selects the following via a dialog box:

 Group - Enter the Recipe argument; the operator selects the group
at runtime.

 Recipe group - Enter only the LearnRcp command. The operator

selects the recipe and the group at runtime.

The Server has to be open when using the LoadRcp activity.

Argument

The following are the LoadRcp arguments when it is used as an action

and not used within a workflow.

LoadRcp [Recipe [fromGroup]]

 fromGroup - the name of the group used as a template

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LoadRcp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LoadRcp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.
Enter as free text; this part may be left blank
if no description is required.

Pulse 4.12 User Guide 1558

 Enabled True - The LoadRcp activity is executed at
runtime.

False - The LoadRcp activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

FromGroup The name of the group used as a template.

Click more... from the drop-down list to

display the Item Manager window and
browse the Hosts tree to define the
FromGroup Advised Item.

Recipe The name of the recipe.

Click more... from the drop-down list to

display the Item Manager window and
browse the Hosts tree to define the Recipe
Advised Item.

Pulse 4.12 User Guide 1559

LoadTrendGroup
The LoadTrendGroup activity loads the appropriate group in the given
trend. Both the group and the trend have to be created at design time.
The LoadTrendGroup activity works on an already opened display. The
last parameter represents a public or private group.

Argument

The following are the LoadTrendGroup arguments when it is used as an

action and not used within a workflow.

Display|wildcard trendName groupName 0|1

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

• trendName - Enter the Trend name.

• groupName - The group name.

• 0 - Disables loading the Trend group.

• 1 - Enables loading the Trend group.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

LoadTrendGroup activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The LoadTrendGroup activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Pulse 4.12 User Guide 1560

 Enabled True - The LoadTrendGroup activity is
executed at runtime.

False - The LoadTrendGroup activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message
window:

“Trying to execute activity

LoadTrendGroup. Continue?”

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

DisplayName Select a display name from the drop-down

list.

GroupName The Trend name

IsPrivateGroup Select whether True or False from the drop-

down list.

TrendName The Trend name

Pulse 4.12 User Guide 1561

LockWorkstation
The LockWorkstation activity locks the workstation. It pops up the Login
dialog box without a Cancel button. The workstation is locked until a user
logs in successfully.

The LockWorkstation activity is not applicable in Anonymous

Authentication mode. The Client workstation has to be open when using
the LockWorkstation activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

LockWorkstation activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The LockWorkstation activity properties and attributes are described

below.
Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The LockWorkstation activity is

executed at runtime.
False - The LockWorkstation activity is not
executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1562

LogData
The LogData activity logs the data for the selected group in the target
table.

Arguments

GroupName [TargetTableName]

• GroupName - The group name

• TargetTableName - The name of the target table

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LogData
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LogData activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The LogData activity is executed at

runtime. It participates in the execution and
validation.

False - The LogData activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message
window:

“Trying to execute activity LogData.

Continue?”

Pulse 4.12 User Guide 1563

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

GroupName

GroupName The group name

TargetTableName

TargetTableName The name of the target table

Pulse 4.12 User Guide 1564

LogDynamicData
LogDynamicData logs dynamic Data Logger Report data.

The LogDynamicData activity logs the data for the selected group in the
target table.

The LogDynamicData activity has a dictionary named ReportValues

which contains the field names and the new values to be assigned. Logic
is added in the OnDoWork function.

Arguments

LogData GroupName [TargetTableName];LogDynamicData

GroupName [TargetTableName] [%1=value %2=value]

• GroupName - The group name

• TargetTableName - The name of the target table

Action Syntax

LogDynamicData Group_A Table1 %3=|!A:89 %4=?999?

• %3 stands for the field index, which count starts at ‘1’.

To verify the dynamic report autoaction syntax

LogDynamicData Group_A Table1 %3=|!A:89 %4=?999?

1 Report group with 2 tags (group name = @groupName)

2 Add a button to the display.

3 Set autoaction
LogDynamicData @Group_A Table1 %1=|!@minutes
%2=?”999”?

Pulse 4.12 User Guide 1565

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

LogDynamicData activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The LogDynamicData activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that

appears as part of the Activity
Confirmation message window.

Enter as free text; this part may be left

blank if no description is required.

Enabled True - The LogDynamicData activity is

executed at runtime. It participates in
the execution and validation.

False - The LogDynamicData activity is

not executed and not validated at
runtime.

Confirmation

ConfirmPrompt The confirmation message that appears

on the Activity Confirmation message
window:

“Trying to execute activity

LogDynamicData. Continue?”

DoConfirm True - A confirmation message is

displayed.

False - No confirmation message is

displayed.

Pulse 4.12 User Guide 1566

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons

are displayed on the Activity
Confirmation message window.

Parameters

ReportName The name of the Report Logger group

ReportValues The values of the Report Logger group

TargetTable The name of the target table

Pulse 4.12 User Guide 1567

LoggerWindow
The LoggerWindow displays the Logger window.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

LoggerWindow activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The LoggerWindow activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The LoggerWindow activity is

executed at runtime.

False - The LoggerWindow activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1568

LogIn
The LogIn activity allows Pulse an interactive or pre-configured login.

The argument has to be specified when the user requires one of the
following:

 To present the Login dialog box for the operator to fill, the login is
recorded as the default of the next session.

For this mode, use as follows: Login (no arguments)

 Log in with the user name and password pre-configured as

command arguments; the login is not recorded as the default of the
next session.

For this mode, use as follows: Login MYNAME MYPASS

The LogIn activity is not applicable in Anonymous Authentication

mode.

The Client workstation has to be open when using the LogIn activity.

Argument

The following are the LogIn arguments when it is used as an action and
not used within a workflow.

LogIn [username password]

If nothing is provided, the login window is displayed.

Use this command for interactive, or pre-configured log-in.

NOTE In order to prevent unpredictable results, the Action Up of an

Action Button is not executed if this command is executed in
Action Down.

Specify the Argument

 To present the Login dialog box, to be filled in by the operator. The

login is recorded as the default of the next session. For this mode,
use like this: Login

 To log in with the user name and password pre-configured as

command arguments (the login is not recorded as the default of the
next session). For this mode, use like this: Login MYNAME MYPASS

Pulse 4.12 User Guide 1569

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the LogIn
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The LogIn activity properties and attributes are described as follows.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The LogIn activity is executed at

runtime.

False - The LogIn activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1570

 Login

InteractiveLogin True - This option enables interactive login.

False - This option disables interactive login.

Password Click the icon to display the Item

Manager window to browse the Hosts tree to
define the password.

UserName Click the icon to display the Item

Manager window to browse the Hosts tree to
define the user name.

Pulse 4.12 User Guide 1571

Maximize
The Maximize activity maximizes or expands the display to fill the entire
screen if the specified display name is open.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Maximize
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Maximize activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Maximize activity is executed at

runtime.

False - The Maximize activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Pulse 4.12 User Guide 1572

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc

DisplayName Select a display name from the drop-down

list.

Pulse 4.12 User Guide 1573

Minimize
The Minimize activity minimizes one or more displays that are open.

The Client workstation has to be open when using the Minimize activity.

Argument

The following are the Minimize arguments when it is used as an action

and not used within a workflow.

If a display name is not provided, the focused display is minimized.

Minimize [display|wildcard]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Minimize
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Maximize activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Minimize activity is executed at

runtime.

False - The Minimize activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1574

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc

DisplayName Click the icon to display the Item

Manager window to browse the Hosts tree to
define the display name Advised Item.

Pulse 4.12 User Guide 1575

NavigateInOperator
The NavigateInOperator activity switches the context of the Project
Navigator from Workflows to Graphics or vice-versa.

Argument

The following are the NavigateInOperator arguments when it is used as

an action and not used within a workflow.

NavigateInOperator Graphics|Workflows

• Graphics - This option displays the Graphics context on the

Project Navigator.

• Workflows - This option displays the Workflows context on

the Project Navigator.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

NavigateInOperator activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The NavigateInOperator activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The NavigateInOperator activity is

executed at runtime.

False - The NavigateInOperator activity is

not executed and not validated at runtime.

RunAtServer True - Enables running the

NavigateInOperator activity on the server.

False - Disables running the

NavigateInOperator activity on the server.

Pulse 4.12 User Guide 1576

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

NavigateInOperator

NavigationType  Graphics - This option displays the

Graphics context on the Project
Navigator.

 Workflows - This option displays the

Workflows context on the Project
Navigator.

 more... - Click more... from the drop-

down list to display the Item
Manager window and browse the
Hosts tree to define the
NavigationType Advised Item.

Pulse 4.12 User Guide 1577

ObjectContextMenu
The ObjectContextMenu activity selects the default menu to display
when a user right-clicks on a graphic object. This option only affects
objects that do not contain a Context menu defined in its Animation
Properties.

The ObjectContextMenu activity supports Expression and Bind

property.

Arguments

The following are the ObjectContextMenu arguments when it is used as

an action and not used within a workflow.

ObjectContextMenu contextMenuName [-A|-R]

• contextMenuName - Enter any free text; the text entered

is the name of the context menu.

• -R - This option allows the context menu to be replaced.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ObjectContextMenu activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The ObjectContextMenu activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ObjectContextMenu activity is

executed at runtime.

False - The ObjectContextMenu activity is

not executed and not validated at runtime.

Pulse 4.12 User Guide 1578

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

ObjectContextMenu

ContextMenuName Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘ContextMenuName’ to
an activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Pulse 4.12 User Guide 1579

 ShouldReplace Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘ShouldReplace’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Pulse 4.12 User Guide 1580

Open
The Open activity opens a display or displays in the Operator
Workstation.

To activate the Open dialog box, use the Open command without any
arguments.

To activate one or more displays, enter the name of the display or a

wildcard.

To activate one or more displays and to override the configured display

mode, enter the mode argument after the display argument: Overlap,
Popup, Replace, or ReplaceAll.

The resource key values are composed at runtime according to an index

that is given in the optional [-C|F:index] parameter.

• C - indicates the consecutive method

• F - indicates the Formula calculation method

The display's caption is: Display.Resource:C|F:index

The Client workstation has to be open when using the Open activity.

Argument

The following are the Open arguments when it is used as an action and
not used within a workflow.

Open [{display|wildcard} [mode] [x,y] [-G:resource] [-

C|F:index]]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

• mode - Specify the type of display

 Default - opens the default display

 Overlap - opens an overlapping display

 Popup - opens a pop-up display

Pulse 4.12 User Guide 1581

  Replace - opens and replaces a display with a new
one

 ReplaceAll - opens and replaces all the open displays

with a new display

• x, y = the x and y coordinates of the display

• -G = opens the resource as a group or individually

• resource - the resource name

• C - indicates the consecutive method

• F - indicates the Formula calculation method

The open activity replaces several open actions:

 OpenFirst - opens the first display in the display path

 OpenLast - opens the last display in the display path

 OpenNext - opens the next display in the display path

 OpenPrevious - opens the previous display in the display path

 OpenOld - opens the initial set of ('last') displays, presented when

the Operator Workstation is started

 OpenResource - opens the specified display with a specified

resource name. If no resource name is specified, a pop-up list of
public and private resource is displayed. If the display does not
work with resources, it opens the display with the default resource.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Open
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

Pulse 4.12 User Guide 1582

The Open activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Open activity is executed at

runtime.

False - The Open activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Display

DisplayName Select a display name from the drop-down

list.

Pulse 4.12 User Guide 1583

 Mode  Default - opens the default display

 Overlap - opens an overlapping

display

 Popup - opens a pop-up display

 Replace - opens and replaces a

display with a new one

 ReplaceAll - opens and replaces all

the open displays with a new display

 more... - Click more... to display the

Item Manager window to browse the
Hosts tree to find the Advised Item.

XPosition Click the icon to display the Item

Manager window to browse the Hosts tree to
find the X position Advised Item.

YPosition Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Y position Advised Item.

OpenType

Type  Open - This option opens a display

regularly

 OpenFirst - This option opens the

selected resource first

 OpenLast - This option opens the

selected resource last

 OpenNext - This option opens the

selected resource next

 OpenPrevious - This option opens the

previous resource

 OpenOld - This option opens an old

resource

 OpenResource - This option opens

the selected resource

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1584

 Resource

ResourceName Enter any free text; the text is the resource

name

ShouldGroup  True - This option opens the resource

as a group

 False - This option opens a resource

individually

 more... - Click more... from the drop-

down list to display the Item
Manager window and browse the
Hosts tree to define the ShouldGroup
Advised Item.

Pulse 4.12 User Guide 1585

OpenLastAlarmDisplay
The OpenLastAlarmDisplay activity opens the last alarm display or the
most current alarm display on the Operator Workstation.

The Client workstation has to be open when using the

OpenLastAlarmDisplay activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

OpenLastAlarmDisplay activity from the Pulse category. Drag the
activity to the required location in the sequence on the left.

The OpenLastAlarmDisplay activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The OpenLastAlarmDisplay activity

is executed at runtime.
False - The OpenLastAlarmDisplay activity
is not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1586

OperActionLog
The OperActionLog activity enables/disables logging events or operator
actions into the Daily Log.

The Client workstation has to be open when using the OperActionLog

activity.

Argument

The following are the OperActionLog arguments when it is used as an

action and not used within a workflow.

OperActionLog [0|1]

• 0 - This option disables logging events into the daily log

• 1 - This option enables logging events into the daily log

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

OperActionLog activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The OperActionLog activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The OperActionLog activity is

executed at runtime.

False - The OperActionLog activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1587

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

OperatorActionLog

EnableLog True - This option enables logging events

into the daily log

False - This option does not allow logging

events into the daily log

Pulse 4.12 User Guide 1588

PlaySound
The PlaySound activity plays the specified sound or controls the sound
that is currently being played on the installed Windows sound device.

The Client workstation has to be open when using the PlaySound

activity.

Argument

The following are the PlaySound arguments when it is used as an action

and not used within a workflow.

Use this command to play the specified sound or control the currently
played sound, on the currently installed Windows sound device.

PlaySound [wavfile [mode] ]

Syntax

• wavfile - Specifies the name of the sound to play. The

command searches the [sounds] section of WIN.INI for an
entry with this name and plays the associated wave form file.
If no entry by this name exists, then it assumes the name is
the name of a wave form file. If this parameter is not
provided, any currently played sound is stopped.

• mode - Specifies the mode - one of the following:

 Blank - plays synchronously (same as Async mode)

 Async - plays synchronously

 Sync - plays synchronously

 NoStop - does not stop any currently played sound

 Loop - plays repeatedly until the next PlaySound

command without arguments

Examples

 To play the Windows Default Beep once, interrupting the currently

played sound (if any):

PlaySound SystemDefault or PlaySound SystemDefault Sync

Pulse 4.12 User Guide 1589

 To play the sound in the file C:\SOUNDS\PANIC.WAV once,
interrupting the currently played sound (if any):

PlaySound C:\SOUNDS\PANIC.WAV or PlaySound

C:\SOUNDS\PANIC.WAV Sync

 To play the sound in the file C:\SOUNDS\ALLCLEAR.WAV once, only

if no other sound is currently played:

PlaySound C:\SOUNDS\ALLCLEAR.WAV NoStop

 To play the sound in the file C:\SOUNDS\PANIC.WAV repeatedly:

PlaySound C:\SOUNDS\PANIC.WAV Loop

 To stop the currently played sound (e.g., if it was started in Loop

mode):

PlaySound

Tips

 Sound Device

Use a hardware sound adapter (such as SoundBlaster) in order to

not interrupt the CPU when the sound is played.

 Synchronous versus Asynchronous Play

In the default mode, playing is asynchronous - the PlaySound

command is not supposed to keep the system busy until the sound
ends (busy being indicated by the hourglass cursor on the screen).

In Sync, playing is synchronous. In this mode, the PlaySound

command is supposed to keep the system busy until the sound
ends (busy being indicated by the hourglass cursor on the screen).

The actual result depends on your system’s behavior of the sound

adapter - some keeps the system busy until the sound ends,
whereas others release the system and play the sound on their
own. Check this issue in the documentation of the sound adapter
and/ or test the system behavior on both the default and the Sync
mode, and use the PlaySound command accordingly.

 Windows Sounds versus WAV Files

For the wavfile argument, you can specify the name of a Windows
sound or the path and name of a WAV file.

It is recommended to specify a name of a Windows sound, as the

command first looks for a Windows sound, then for a WAV file.

Pulse 4.12 User Guide 1590

 More about Windows Sounds

Windows recognizes a set of standard sounds - configured with the

Control Panel sound applet. The list includes Asterisk, Critical
Stop, Default Beep, Exclamation, Question, Windows Exit and
Windows Start. The names of the respective WAV files are stored
in the WIN.INI filed, sounds section. An example of this section is
illustrated below.

[sounds] SystemAsterisk=C:\WINDOWS\DING.WAV,Asterisk
SystemHand=C:\WINDOWS\DING.WAV,Critical Stop
SystemDefault=C:\WINDOWS\DING.WAV,Default Beep
SystemExclamation=C:\WINDOWS\TADA.WAV,Exclamation
SystemQuestion=C:\WINDOWS\DING.WAV,Question
SystemExit=C:\WINDOWS\TADA.WAV,Windows Exit
SystemStart=C:\WINDOWS\CHIMES.WAV,Windows Start

(On your system, the section might include additional sounds, installed
there by the applications you installed on your PC.)

For the wavfile argument of the PlaySound function, specify one of the
names on the left of the equal sign - e.g., SystemAsterisk,
SystemHand, SystemDefault, etc.

In addition, you may add new sounds to the system by:

 Creating the respective WAV file (using the appropriate hardware

and software such as the Sound Blaster kit).

 Creating new entries in the [sounds] section of the WIN.INI file

(using a text editor in the format shown above).

Once you created a new entry in the [sounds] section of the WIN.INI file,
you may change the WAV file associated with it with the Control Panel
applet Sound.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the PlaySound
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The PlaySound activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1591

 Description The description of the activity that appears
as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The PlaySound activity is executed

at runtime.

False - The PlaySound activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1592

 Wave

Mode  Default - This option plays the default

sound on the Windows sound device

 Async - This option plays the sound

asynchronously

 Sync - This option plays the sound

synchronously

 NoStop - This option plays the sound

and does not stop

 Loop - This option plays the sound in

a loop

 more... - Click more... from the drop-

down list to display the Item
Manager window and browse the
Hosts tree to define the Mode item.

WaveFile Click the icon to display the Item

Manager window to browse the Hosts tree to
find the wave file Advised Item.

Pulse 4.12 User Guide 1593

Print
The Print activity prints the contents of the Operator Workstation window
to the default Windows printer.

NOTE The Print activity prints appears as AfconBaseActivity on the

workflow. The Client workstation has to be open when using
the Print activity.

Argument

The following are the Print arguments when it is used as an action and
not used within a workflow.

Print [0|1]

• 1 in action is similar to ''printStudio' in activity.

• 0 in action is similar to 'printScreen' in activity. The default

action is print screen.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Print
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Print activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Print activity is executed at

runtime.

False - The Print activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1594

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Print

PrintingParameters  PrintScreen - This option captures

and prints everything displayed on the
screen onto a file

 PrintStudio - This option captures

and prints everything on the
application workspace.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to define the Print
parameters.

Pulse 4.12 User Guide 1595

PrintAllOpenDisplays
The PrintAllOpenDisplays activity, prints all of the displays which are
currently open, to the default Windows printer.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

PrintAllOpenDisplays activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The PrintAllOpenDisplays activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The PrintAllOpenDisplays activity is

executed at runtime.
False - The PrintAllOpenDisplays activity
is not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message
window:
“Trying to execute activity
PrintAllOpenDisplays Continue?”

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.
Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1596

PrintDisp
The PrintDisp activity prints the specified display to the default Windows
printer provided that the display is open.

The Client workstation has to be open when using the PrintDisp activity.

Argument

The following is the PrintDisp argument when it is used as an action and

not used within a workflow.

PrintDisp display

• display - Enter the name of the display file without the

extension, for example, “area1”.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the PrintDisp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The PrintDisp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Enabled True - The PrintDisp activity is executed at

runtime.

False - The PrintDisp activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1597

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

PrintDisp

DisplayName Select a display name from the drop-down

list.

Pulse 4.12 User Guide 1598

PrintText
The PrintText activity prints the line of text specified in the Text
argument.

It is useful to print alarms received from PfwalarmNG|pcim!alarmprint

as formatted alarm text and other print requests.

The PrintText activity supports Expression and Bind property.

The Client workstation has to be open when using the PrintText activity.

Argument

The following is the PrintText argument when it is used as an action and

not used within a workflow.

PrintText Text

• Text - Enter any free text; the text entered will be printed

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoAlarmPrint activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The PrintText activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Enabled True - The PrintText activity is executed at

runtime.

False - The PrintText activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1599

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

PrintText

TextToPrint Supports Expression and Bind property.

To bind property, double-click on the icon

to display the Bind ‘TextToPrint’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1600

Purge
The Purge activity purges or deletes files created by P-CIM for Windows
(with filenames reflecting the related dates) that are older than the
number of days specified.

The Server has to be open when using the Purge activity.

Argument

The following are the Purge arguments when it is used as an action and
not used within a workflow.

Purge {token|wildcard} [daysback] [-P|-H]

 token - the Pulse token for the particular file type:

• token - the file type

• wildcard - path, name and extension of the file

• daysback - optional; the number of days that passed from

the present day pertaining as to the date of the file to be
purged

• -P - optional; prompt flag, this option displays a prompt

before files are purged

• -H - optional; hide flag, hides the purge progress indication

Use this command to purge (delete) files created by Pulse for Windows,
which filenames reflect the date they apply to, that are older than the
number of days specified.

NOTE The present date (today) is counted as one day for the
“number of days to retain”.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Purge
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

Pulse 4.12 User Guide 1601

The Purge activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - the Purge activity is executed at

runtime

False - the Purge activity is not executed

and not validated at runtime

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Purge

DaysBack Specify the number of days that passed from

the present day pertaining as to the date of
the file to be purged.

Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1602

 HideProgressIndica True - Enables hiding the Purge progress
tion indication.

False - The Purge progress indication is

visible.

PromptForConfirm True - This option displays a prompt before

ation files are purged.

False - This option does not display a prompt

before files. are purged

PurgeToken  HistoricaltrendData - This option

purges Historical Trend Data files

 Dailylog - This option purges daily log

files.

 Wildcard - This option purges all files.

Wildcard Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1603

ReadRcp
The ReadRcp activity reads recipe values from and set values to special
dummy variables of the Operator Workstation.

The Client workstation has to be open when using the ReadRcp activity.

Argument

The following are the ReadRcp arguments when it is used as an action

and not used within a workflow.

ReadRcp [Recipe [fromGroup]]

• Recipe - the name of the recipe

• fromGroup - the name of the group to be read

Command DDE Address

• Server ID: PFWALARMNG

• Topic ID: Pulse

• Item – following is a table listing the various items (Operator

Workstation dummy variables) supported by the ReadRcp
command

Item Read Write Notes

Rcp.Name Returns the Use to edit

name of the recipe name.
current loaded
recipe

Rcp.Desc Returns the Use to edit

recipe recipe
description description.

Rcp.Total# Returns the Read only

total number of
addresses of
each recipe
group

Rcp.Grp.Name Returns current Use to edit

group name group's name

Pulse 4.12 User Guide 1604

Item Read Write Notes

Rcp.Grp.Comment Returns current Use to edit

group comment group's
(description) comment

Rcp.Grp.IoWait Returns current Use to modify

group IO Wait group's IO Wait

Rcp.Grp.TimeOut Returns current Use to modify

group Timeout group's timeout

Rcp.Grp.OnSuccess Returns current Use to modify

group On group's On
Success actions Success actions

Rcp.Grp.OnFail Returns current Use to modify

group On Fail group's On Fail
actions actions

Rcp.Grp.OnTimeOut Returns current Use to modify

group On Time group's On
Out actions Time Out
actions

Rcp.Grp.ID Returns current Use to modify

group ID group's ID

Rcp.Grp.IDDest Returns current Use to modify

group ID group's ID
destination DDE destination DDE
address address

Rcp.Grp.StatusDest Returns current Use to modify

group group's
destination DDE destination DDE
address status address status

Rcp.Grp.#.Addr Returns the Read only

address of each
item # stands for the
serial number of
the item (enter
1 for the first
item, 2 for the
second, etc.).

Pulse 4.12 User Guide 1605

Item Read Write Notes

Rcp.Grp.#.Source Returns current Use to modify # stands for the

group item group's item serial number of
source value source value the item (enter
1 for the first
item, 2 for the
second, etc.).

Rcp.Grp.#.Note Returns current Use to modify # stands for

group item note group's item the serial
text note. number of the
item (enter 1
for the first
item, 2 for the
second, etc.).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the ReadRcp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The ReadRcp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ReadRcp activity is executed at

runtime.

False - The ReadRcp activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1606

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

FromGroup more... - Click the icon to display the

Item Manager window to browse the Hosts
tree to find the Advised Item.

Recipe more... - Click the icon to display the

Item Manager window to browse the Hosts
tree to find the Advised Item.

Pulse 4.12 User Guide 1607

ReloadActions
The ReloadActions activity reloads the AutoActions script from the
Operator Workstation file or from one or more displays that are currently
open on the Operator Workstation.

When an AutoActions script is reloaded, it is also disabled.

The ReloadActions activity supports Bind property in its argument(s).

The Client workstation has to be open when using the ReloadActions

activity.

Argument

The following are the ReloadActions arguments when it is used as an

action and not used within a workflow.

ReloadActions [display|wildcard]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

If a display name is not provided, the action operates on the workstation

auto actions.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ReloadActions activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ReloadActions activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1608

 Enabled True - The ReloadActions activity is
executed at runtime.

False - The ReloadActions activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Misc

DisplayName Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1609

RepData
The RepData activity acquires report data.

The RepData command with an -S switch is used for acquiring infrequent

report data operations or for changing command arguments. The report
template and the command arguments are unloaded from memory after
the command is executed.

To unload a template and its command arguments, the RepDataStop

command can be used.

NOTE This command also supports OLEDB Report.

The Server has to be open when using the RepData activity.

Argument

The following are the RepData arguments when it is used as an action

and not used within a workflow.

RepData {txt|dbf|odbc} inrep {outrep|odbc-table} [-P] [-S]

Syntax

 For TXT reporting: RepData txt [outfile] [-P] [-S]tmplt

• tmplt - the name of the report template file; enter the name
only, without a path and without an extension.

• outfile - optional, the name of the output file; enter the

name only with or without a path, without an extension;
default path: of the PcimRepOut project subject - REPORT
OUTPUT
default name: the same as of the tmplt (template file),
extension is .TXT

• -P - optional, applicable to TXT type; prints the “snapshot”

report acquired by this instance of the RepData command to
the default Windows printer

• -S- optional, single shot; do not keep the template and

command arguments in the memory

 For DBF reporting: RepData dbf tmplt [outfile] [-S]

• tmplt - the name of the report template file; enter the name
only without a path, without an extension

Pulse 4.12 User Guide 1610

 • outfile - optional, the name of output file; enter the name
only with or without a path, without an extension;
default path: of PcimRepOut project subject - REPORT
OUTPUT, default name: the same as of tmplt (template file),
extension .DBF

• -S - optional, single shot; do not keep template and

command arguments in the memory

NOTE This command forces the Datasheet Manager to update all the
clients that have links to the DBF file in question.

 For ODBC (Open Database Connectivity) reporting:

RepData odbc tmplt [outfile] [-S]

• tmplt - the name of the report template file; enter the name
only without a path without an extension

• odbc-table - the name of the output table or file according

to the nature of the DSN referenced in the report data
template

• -S - optional, single shot, do not keep the template and

command arguments in the memory

Use this command to acquire the report data. Use with the -S switch for
infrequent report data acquisition operations, or when the command
arguments change. The report template and the command arguments are
unloaded from the memory after the command is executed. To unload a
template and its command arguments, you can also use the
RepDataStop command.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the RepData
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

Pulse 4.12 User Guide 1611

The RepData activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The RepData activity is executed at

runtime.

False - The RepData activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1612

 Output

Output Click the icon to display the Bind ‘Output’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target property
of type 'System.Object' from an
activity.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

PrintEnable

PrintEnable True - This option enables printing the report

data.

False - This option disables printing the

report data.

SingleShotEnable

SingleShotEnable True - This option enables the single shot

feature

False - This option disables the single shot

feature

Template

Template Click the icon to display the Bind

‘Template’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target property
of type 'System.Object' from an
activity.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1613

 Type

Type Click the icon to display the Bind ‘Type’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target property
of type 'System.Object' from an
activity.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1614

RepDataStop
The RepDataStop activity unloads a report template from memory. The
main purpose of the RepDataStop command is to test and debug
applications after a template is corrected. It replaces the old template
with the new one.

The Server has to be open when using the RepDataStop activity.

Argument

The following are the RepDataStop arguments when it is used as an

action and not used within a workflow.

RepDataStop {txt|dbf|odbc} inrep

• txt|dbf|odbc - type of report - enter txt or dbf or odbc

• tmplt - name of report template file - enter name only,

without a path, without an extension

Use this command to unload a report template from memory. The main
purpose of this command is during application testing and debugging.
After correcting a template, it replaces the old template with the new one.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

RepDataStop activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The RepDataStop activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1615

 Enabled True - The RepDataStop activity is
executed at runtime.

False - The RepDataStop activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Template

Template Click the icon to display the Bind

‘Template’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1616

 Type

Type Click the icon to display the Bind ‘Type’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1617

RepGen
The RepGen activity generates the Supreme Report locally by activating
the .exe file from the P-CIM path. The RepGen activity supports all its
arguments, especially when displaying the report after the generation is
completed.

The Client workstation has to be open when using the RepGen activity.

NOTE The RepGen activity runs on a Standalone station only using a

RemoteExe cute utility that activates the ODS .exe file.

Argument

The following are the RepGen arguments when it is used as an action and
not used within a workflow.

RepGen [Report Name][Output]

• Report Name - optional; the Supreme Report name

• Output - optional; the type of output

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the RepGen
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The RepGen activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1618

 Enabled True - The RepGen activity is executed at
runtime.

False - The RepGen activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Output

Output Click the icon to display the Bind

‘Output’ to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1619

 RepName

RepName Click the icon to display the Bind

‘RepName’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1620

ReportTrend
The ReportTrend activity reports the values of a historical trend in
tabular format. It sends the report to the default printer or to an ASCII
file. The report format is the same with that presented on the screen with
a Report button of a Historical Trend.

The Client workstation has to be open when using the ReportTrend

activity.

Argument

The following are the ReportTrend arguments when it is used as an

action and not used within a workflow.

ReportTrend display symbolID [output [-O]] [-T”title-Text”]

[{-P|-L}]

• display - the name of the display that contains the trend. It

must be open when the command is executed.

• symbolID - the name of the trend object

• filename - optional, path, name and extension of the file to

send the report to instead of to the printer

• -O - optional, overwrite flag, whether to overwrite the file if it

already exists (the flag is the letter O, not the numeral zero).

The default path for the report file is the same as for the UPD files of
displays.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ReportTrend activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ReportTrend activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1621

 Description The description of the activity that appears
as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ReportTrend activity is executed

at runtime.

False - The ReportTrend activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

DisplayName

DisplayName Select a display name from the drop-down

list.

IsLandscape

IsLandscape True - This option displays the Trend report

in landscape view

False - This option displays the Trend report

in portrait view

Pulse 4.12 User Guide 1622

 Output

Output Click the icon to display the Bind

‘Output’ to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

SymbolID

SymbolID Enter any free text; the text is the symbol

identifier

Title

Title Click the icon to display the Bind ‘Title’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1623

RepPrint
The ReportPrint activity produces and prints a report from the data in
the DBF file using a Crystal Reports non-compiled template. The file
extension .rpt.

When consulting with ODS, there is no interface available that regenerates

report for printing purposes as in the Crystal Report. The Supreme Report
printing method is as follows:

1 Set the properties of the outgoing report to the printer on the

Supreme Editor.

2 Set ON EVENT according to the P-CIM item on the Supreme Editor.

3 Create the action that triggers the event on P-CIM.

The ReportPrint activity works on Standalone server stations only. The

server has to be open when using the RepPrint activity.

NOTE The report is reproduced on the server, delivered to the client,

and printed on the client side.

Argument

The following is the RepPrint argument when it is used as an action and

not used within a workflow.

RepPrint report

• report - reports the Crystal Reports non-compiled template

file name (no extension - RPT assumed)

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

AutoAlarmPrint activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ReportPrint activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1624

 Description The description of the activity that appears
as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The RepPrint activity is executed at

runtime.

False - The RepPrint activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

RepName

RepName Click the icon to display the Bind

‘RepName’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1625

RepRead
The RepRead activity reads data from the dbf file or from databases as
defined in the report. The RepRead activity sets the values to advised
items according to the report definitions.

The Server has to be open when using the RepRead activity.

Argument

The following are the RepRead arguments when it is used as an action

and not used within a workflow.

RepRead {txt|dbf|odbc} inrep

• txt|dbf|odbc - text/dbf/open database connectivity (odbc)

file to read the data from

• inrep - input report

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the RepRead
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The RepRead activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The RepRead activity is executed at

runtime.

False - The RepRead activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

Pulse 4.12 User Guide 1626

 DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Template

Template Click the icon to display the Bind

‘Template’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Type

Type Click the icon to display the Bind ‘Type’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1627

RepReindex
The RepReindex activity creates or updates the index file (with an MDX
extension) for the DBF file specified as the output file (the default of which
has the same name as the tmplt file) according to the index specification
of the template (tmplt).

The Server has to be open when using the RepReindex activity.

Argument

The following are the RepReindex arguments when it is used as an action

and not used within a workflow.

RepReindex inrep [dbf-name]

• inrep - (tmplt) The name of the report data template file, no

path or extension is needed (the template created with the
Report Data Editor)

• dbf name - (outfile) optional, the DBF file created during the
regular data collection. The path is optional (default is per
PcimRepOut). The default name is that of tmplt.

The index (MDX) file is created/updated on the same path as the

implied/specified path of the DBF file (the default is per PcimRepOut),
and is named as the name of the DBF file, but with an MDX extension.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the RepReindex
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The RepReindex activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1628

 Enabled True - The RepReindex activity is executed
at runtime.

False - The RepReindex activity is not

executed and not validated at runtime.

Command

Command The name of the command. Enter as free

text.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Output

Output Click the icon to display the Bind

‘Output’ to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1629

 Template

Template Click the icon to display the Bind

‘Template’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1630

RepShow
The RepShow activity produces and displays a report from the data in
the on screen DBF file using a Crystal Report template that is not
compiled. The RepShow file extension is .rpt.

The report is produced from other report engines as well.

The “SupremeReport” action browses the Reports web portal.

NOTE The report is reproduced on the server delivered to the client

and is displayed on the client-side screen.

Argument

The following are the RepShow arguments when it is used as an action

and not used within a workflow.

RepShow report [Maximized]

• report - Crystal Reports non-compiled template file name

(no extension, RPT assumed)

• Maximized - optional, displays in maximized window view

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the RepShow
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The RepShow activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1631

 Enabled True - The RepShow activity is executed at
runtime.

False - The RepShow activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

IsMaximized

IsMaximized True - This option displays the report from

the data in the on screen DBF file in full
screen.

False - This option displays the report from

the data in the on screen DBF file in a
minimized or smaller than the full screen.
RepName

RepName Click the icon to display the Bind

‘RepName’ to an activity’s property
window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1632

Restore
The Restore activity restores one or more displays that are currently
open on the Operator Workstation, to their default size(s).

The Restore activity is similar to the Restore Operator Workstation

command in the Windows menu.

The Restore activity supports Bind property in its argument(s).

The Client workstation has to be open when using the Restore activity.

Argument

The following are the Restore arguments when it is used as an action and
not used within a workflow.

Restore [display|wildcard]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Restore
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Restore activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1633

 Enabled True - The Restore activity is executed at
runtime.

False - The Restore activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Misc

DisplayName Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1634

RevertToSaved
The RevertToSaved activity closes and then reloads or refreshes one or
more displays that are currently open on the Operator Workstation, to its
originally configured mode or in a specified mode.

The RevertToSaved activity is similar to the Revert to Saved command

in the File menu.

The Client workstation has to be open when using the RevertToSaved

activity.

The RevertToSaved activity supports Bind property in its argument(s).

Argument

The following are the RevertToSaved arguments when it is used as an

action and not used within a workflow.

RevertToSaved [{display|wildcard} [mode]]

• display - Enter the name of the display file without the

extension, for example, “area1”.

• wildcard - Enter a DOS wildcard specification, where “*”

stands for zero or more characters, and “?” for precisely one
character.

• mode - displays one of the following mode:

 Default - this option reloads the display to its default

mode

 Overlap - this option reloads the display with an

overlapping one

 Popup - this option reloads the display into a pop-up

mode

 Replace - this option reloads the display and replaces

the old one

 ReplaceAll - this option reloads all the displays and

replaces all of them with new displays.

If a display name is not provided, the action operates on the focused

display.

Pulse 4.12 User Guide 1635

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

RevertToSaved activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The RevertToSaved activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as a free text; this part may be left

blank if no description is required.

Enabled True - The RevertToSaved activity is

executed at runtime.

False - The RevertToSaved activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1636

 RevertToSaved

DisplayMode Supports Bind property in its argument(s).

To bind property, double-click on the icon

to display the Bind ‘DisplayMode’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

DisplayName Supports Bind property in its argument(s).

To bind property, double-click on the icon to

display the Bind ‘DisplayName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Pulse 4.12 User Guide 1637

Run
The Run activity runs a Windows program with optional argument(s).

The Server and the Client workstation have to be open when using the
Run activity.

Argument

The following are the Run arguments when it is used as an action and not
used within a workflow.

Run [path]program [args] [/server|/client]

• path - optional; the path of the program to run

• program - the name of the program to run

• args - optional; arguments

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Run activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Run activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Run activity is executed at

runtime.

False - The Run activity is not executed and

not validated at runtime.

Pulse 4.12 User Guide 1638

 RunAtServer True - Enables running the Run activity on
the server.

False - Disables running the Run activity on

the server.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Run

PathToProgram Enter as free text the path to the program to

run.

ProgramArgs Click the icon to display the String

Collection Editor window and enter the
string in the collection (one per line).

Pulse 4.12 User Guide 1639

RunSchedule
The RunSchedule activity executes the required schedule. If no schedule
filename is provided, a dialog box is displayed to enable the selection of a
scheduled file.

The RunSchedule activity supports Expression and Bind property.

Argument

The following are the RunSchedule arguments when it is used as an

action and not used within a workflow.

RunSchedule [fileName]

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

RunSchedule activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The RunSchedule activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The RunSchedule activity is

executed at runtime.

False - The RunSchedule activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1640

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

RunSchedule

FileName Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘FileName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Pulse 4.12 User Guide 1641

SaveDb
The SaveDb activity saves the database.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the SaveDb
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The SaveDb activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text, this part may be left blank

if no description is required.

Enabled True - The SaveDb activity is executed at

runtime.

False - The SaveDb activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1642

SavePersonalization
The SavePersonalization activity saves the user’s personalization
settings.

The Client workstation has to be open when using the

SavePersonalization activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SavePersonalization activity from the Pulse category. Drag the activity
to the required location in the sequence on the left.

The SavePersonalization activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The SavePersonalization activity is

executed at runtime.
False - The SavePersonalization activity is
not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1643

SaveRcp
The SaveRcp activity writes and saves the values set in the ReadRcp
command into the recipe file.

The Client workstation has to be open when using the SaveRcp activity.

Argument

The following is the SaveRcp argument when it is used as an action and

not used within a workflow.

SaveRcp [toGroup]

• toGroup - the destination where the SaveRcp command

writes and saves the values

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the SaveRcp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The SaveRcp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The SaveRcp activity is executed at

runtime.

False - The SaveRcp activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1644

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

ToGroup Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1645

SchedActions
The SchedActions activity schedules an actions script. It is activated
when one workstation is registered to the activated scheduler actions.

The Client workstation has to be open when using the SchedActions

activity.

Argument

The following are the SchedActions arguments when it is used as an

action and not used within a workflow.

SchedActions {0|1}

• 1 - this option enables the scheduled actions

• 0 - this option disables the scheduled actions

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SchedActions activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The SchedActions activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter a free text; this part may be left blank

if no description is required.

Enabled True - The SchedActions activity is

executed at runtime.

False - The SchedActions activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1646

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

SchedActions

EnableSchedAction True - This option enables the scheduled

s actions

False - This option disables the scheduled

actions

Pulse 4.12 User Guide 1647

ScheduleManager
The ScheduleManager activity opens a new client instance of the
Schedule Manager tool. It can be loaded with a specified scheduler file
or item.

 D Day view

 WW Work week view

 W Week view

 M Month view

 T Timeline view

The ScheduleManager activity supports Expression and Bind property.

The Client workstation has to be open when using the ScheduleManager

activity.

Argument

The following are the ScheduleManager arguments when it is used as an

action and not used within a workflow.

ScheduleManager [fileName|item] [-D|-WW|-W|-M|-T]

• fileName|item - the filename or item to open as a new

client instance of the Schedule Manager tool

• -D - this option opens a new client instance of the Schedule

Manager in a Day view

• -WW - this option opens a new client instance of the

Schedule Manager in a work week view

• -W - this option opens a new client instance of the Schedule

Manager in a week view

• -M - this option opens a new client instance of the Schedule

Manager in a Day view

• -T - this option opens a new client instance of the Schedule

Manager in a Timeline view

Pulse 4.12 User Guide 1648

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ScheduleManager activity from the Pulse category. Drag the activity to
the required location in the sequence on the left.

The ScheduleManager activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ScheduleManager activity is

executed at runtime.

False - The ScheduleManager activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1649

 ScheduleManager

FileName Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘FileName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

Click the icon to display the Item

Manager window to define the expression.

View  Day - This option opens a new client

instance of the Schedule Manager in
a Day view

 Workweek - This option opens a new

client instance of the Schedule
Manager in a work week view

 Week - This option opens a new client

instance of the Schedule Manager in
a week view

 Month - This option opens a new

client instance of the Schedule
Manager in a Day view

 Timeline - This option opens a new

client instance of the Schedule
Manager in a Timeline view

Pulse 4.12 User Guide 1650

ScheduleTo
The ScheduleTo activity schedules a schedule file to a specific item.

Argument

The following are the ScheduleTo arguments when it is used as an action

and not used within a workflow.

ScheduleTo item [fileName]

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the ScheduleTo
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The ScheduleTo activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ScheduleTo activity is executed

at runtime.

False - The ScheduleTor activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1651

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

ScheduleTo

AdvisedItem The advised item to schedule.

FileName The name of the file to schedule.

Pulse 4.12 User Guide 1652

SendKeys
The SendKeys activity sends instructions through a series of keys to
another application that is active. To the other application, it recognizes
the keys as if they were entered from the keyboard. This capability may
be used to enter data into the application as well as give commands to the
application.

The Server and the Client workstation have to be open when using the
SendKeys activity.

Argument

The following are the SendKeys arguments when it is used as an action

and not used within a workflow.

SendKeys [PathProgram|”title-bar”] Keys [/server|/client]

NOTE Before using SendKeys commands, set the focus to the target
application by using the ShowTask command. Use both
commands in the same action: ShowTask immediately
followed by SendKeys.

The SendKeys command considers the remainder of the

action specification as its argument. Therefore, it must be the
last command specified in an action.

Specify the Argument “Keys”

Each key is represented by one or more characters, such as A for the

character “A”, or {ENTER} for the Enter key. To specify a character on the
keyboard, use that character.

To specify more than one key, concatenate the codes for each character.
For example, to specify the dollar sign key ($) followed by ab, use the
code $ab.

To specify modifying keys, for:

 Shift - use + (plus sign)

 Ctrl - use ^ (caret)

 Alt - use % (percent sign)

To specify that Shift, Ctrl, or Alt be held down while another key is
pressed, precede the key with a “+”, “^”, or “%” respectively. For
example, to hold down Shift while pressing E followed by C use +(EC).

Pulse 4.12 User Guide 1653

To specify one of the special characters (+ ^ %) without its special
meaning, enter the character inside brackets. For example, to specify a
plus sign, enter {+}.

Parentheses are also special characters used, as in the example above, to

group characters. To literally specify parenthesis, enter the parenthesis
inside curly brackets: {(} and {)}.

To repeat a single key, use the syntax {key number}, where key is any
SendKeys key, followed by a single space, and number is the number of
times the key should be repeated. Examples: {PGDN 5} to press the
Page Down key five times, {S 2} to press the S key twice.

Example

To send to a program the command to open the file “REPORT” (File, Open,
REPORT, Enter
-keys ALT F O REPORT ENTER):

SendKeys %(FO)REPORT{ENTER}

or

SendKeys %FOREPORT{ENTER}

Pulse 4.12 User Guide 1654

Special Key Names

Key SendKeys Code

BACKSPACE {BACKSPACE} or {BS}
BREAK {BREAK}
CAPSLOCK {CAPSLOCK}
CLEAR {CLEAR}
DELETE {DELETE} or {DEL}
DOWN {DOWN}
END {END}
ENTER {ENTER} or ~ (tilde)
ESCAPE {ESCAPE} or {ESC}
HOME {HOME}
INSERT {INSERT}
LEFT {LEFT}
NUMLOCK {NUMLOCK}
PAGE DOWN {PGDN}
PAGE UP {PGUP}
PRINT SCREEN {PRTSC}
RIGHT {RIGHT}
SPACE BAR {SPACE}
TAB {TAB}
UP {UP}
F1 to F16 {F1} to {F16}

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the SendKeys
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

Pulse 4.12 User Guide 1655

The SendKeys activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The SendKeys activity is executed at

runtime.

False - The SendKeys activity is not

executed and not validated at runtime.

RunAtServer True - Enables running the SendKeys

activity on the server.

False - Disables running the SendKeys

activity on the server.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1656

 Misc

IdentifierType  ByProgramPath - This option enables

the SendKeys activity to send
instructions to another program type
through the program’s path.

 ByWindowTitle - This option enables

the SendKeys activity to send
instructions to another program type
via its Window title.

KeyStrokes Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

TaskName Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1657

ServerManager
The ServerManager activity opens a new client instance of the Server
Manager tool.

The Client workstation has to be open when using the ServerManager

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ServerManager activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ServerManager activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The ServerManager activity is

executed at runtime.
False - The ServerManager activity is not
executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1658

Set
The Set activity sets the value of the first DDE data item specified to the
value of the second DDE data item or the specified value.

The default value is 1 if the second parameter is not specified.

The Server and the Client workstation have to be open when using the
Set activity.

Argument

The following are the Set arguments when it is used as an action and not
used within a workflow.

Set DDE {value|DDE} [/server|/client]

• DDE - the DDE address of the variable that receives the

result of the comparison (the result is 1 if the comparison
succeeds, or 0 if not).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Set activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Set activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text, this part may be left blank
if no description is required.

Enabled True - The Set activity is executed at

runtime.
False - The Set activity is not executed and
not validated at runtime.

RunAtServer True - Enables running the Set activity on

the server.
False - Disables running the Set activity on
the server.

Pulse 4.12 User Guide 1659

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Parameters

AdvisedItem Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Value Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1660

SetLocalTime
The SetLocalTime activity sets the time and/or date of the computer.

The command has two modes: Usual and BCD.

The Client workstation has to be open when using the SetLocalTime

activity.

Argument

The following are the SetLocalTime arguments when it is used as an

action and not used within a workflow.

SetLocalTime
{BCD[ms|hm]####|[Y#][M#][D#][W#][h#][m#][s#]}

• Usual - Use to set any combination of date or time

components (Year, Month, Day of Week, Hours, Minutes,
Second) as individual numbers

• BCD - Use to set Minutes & Seconds or Hours & Minutes as

one combined BCD number in the format BCDms#### and
resp. or BCDhm####. The number is first converted from
decimal to BCD then to binary, then split into 2, two-digit
numbers - that are used for the respective time components
to be set

• ms|hm - minutes and seconds or hours and minutes as one

combined BCD number in the format BCDms#### and resp.
or BCDhm####

• Y# - year

• M# - month

• D# - day

• W# - week

• h# - hours

• m# - minutes

• s# - seconds

Pulse 4.12 User Guide 1661

Example 1

SetLocalTime Y2011M12D1W1h15m16s20

where:

Y1997 Year 1997

M1 Month 1

D16 Day 16

W5 Day of Week 5 (Thursday)

h15 Hour 3 PM

m16 Minute 16

s20 Second 20

Example 2

SetLocalTime D17W6m20s20

where:

D17 Day 17

W6 Day of Week 6 (Friday)

m20 Minute 20

s20 Second 20

Example 3

SetLocalTime BCDms4135

where:

BCDms4135 Minutes 10, Seconds 27 4135 dec. = 1027 BCD

Example 4

SetLocalTime BCDhm4135

where:

BCDhm4135 Hours 10, Minutes 27 4135 dec. = 1027 BCD

Pulse 4.12 User Guide 1662

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SetLocalTime activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The SetLocalTime activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter a free text; this part may be left blank

if no description is required.

Enabled True - The SetLocalTime activity is

executed at runtime.

False - The SetLocalTime activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Time

DateTime Click the drop-down list to display and set

the computer’s current date
(month/day/year) settings. Select the
required date from the calendar as
necessary.

Pulse 4.12 User Guide 1663

SetProperty
SetProperty is an Action Composer parameter of which the user can
use to define a specific property for an action or when an action is
performed to an object in the display.

Argument

The following are the SetProperty arguments.

SetProperty (PropertyName) (Value)

• PropertyName - the name of the property to set.

• Value - the value of the property to define

Properties and Attributes

SetProperty can be set as an Action Command or as part of a

Workflow.

 To set a property using the Action Command in the Action

Selector window, select SetProperty from the drop-down list.

The function's syntax is SetProperty (PropertyName) (Value),

where 'PropertyName' and 'Value' are the properties to define.

Pulse 4.12 User Guide 1664

Another way of defining the Action Command for SetProperty

1 Click the button next to the Action Command field to open the
Item Manager window.

2 In the Links tree, select Actions > Action Composer.

3 In the Action Composer list, select SetProperty.

4 In the Insert Action Parameters table, go to SetProperty and

define PropertyName and Value.

5 Click Apply.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1665

 Enabled True - The SetProperty activity is executed
at runtime.

False - The SetProperty activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

SetProperty

PropertyName Click the icon to display the Select

control property window to define the
property.

Value Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

To use SetProperty within a Workflow

1 Select the Workflow option in the Action Selector window and

create a new workflow.

2 Select SetProperty from the Pulse list and drag it to the workflow
area.

3 Click on SetProperty and go to its properties area.

4 Click on the PropertyName field.

The Select Control Property window is displayed.

Pulse 4.12 User Guide 1666

5 Select the display from the Select Display list, select the object
from the Select Control list, and select the property to define from
the Properties list.

6 Check that the Properties Path is correct and click OK.

7 In the Pulse Workflow Editor window, enter a value for the

Property selected in the Value field and save the settings.

8 Save the workflow.

Pulse 4.12 User Guide 1667

ShowLayer
The ShowLayer activity shows or hides a given layer of objects. Hidden
objects are not activated.

0 is optional and it means hide.

The Client workstation has to be open when using the ShowLayer

activity.

Argument

The following are the ShowLayer arguments when it is used as an action

and not used within a workflow.

ShowLayer LayerNumber [0|1]

• LayerNumber - the number of the layer to show/hide

• 0 - optional, this option enables hides the layer at runtime

• 1 - optional, this option makes the layer visible at runtime

• Properties and Attributes - the layer’s properties and

attributes

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ShowLayer activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The ShowLayer activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1668

 Enabled True - The ShowLayer activity is executed at
runtime.

False - The ShowLayer activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

ShowLayer

LayerNumber Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

LayerVisible  True - This option makes the layer

visible at runtime

 False - This option makes the layer

invisible at runtime

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised Item.

Pulse 4.12 User Guide 1669

ShowTask
The ShowTask activity shows or hides a running Windows task or
program. The ShowTask activity can be used as follows:

 To run an application (only if the application is not already

running).

To run another instance of an application that supports multiple

instances, use the Run command.

 To control a running application or program

In conjunction with SendKeys and ShowTask, it sets the focus to

an application so it can receive keystrokes from the SendKeys
command.

The Server and the Client workstation have to be open when using the
ShowTask activity.

Argument

The following are the ShowTask arguments when it is used as an action

and not used within a workflow.

ShowTask {PathProgram|”title-bar”} [showcmd]

[/server|/client]

Example

ShowTask {pathprogram|”Title”} [showcmd]

-or-

ShowTask pathprogram [arguments]

NOTE In order to prevent unpredictable results, the Action Up of an

Action Button is not executed in Action Down.

 {pathprogram|"Title"} - identifies the task by one of the

following:

• The full path specification, e.g.,

“C:\WINDOWS\NOTEPAD.EXE”

• The title - as shown in the title bar of the program or in the

Windows Task List (when you press CTRL+ESC) - enclosed in
a pair of double quotes.

Pulse 4.12 User Guide 1670

By specifying the title you can:

 Show only an already running program (specifying the path and file
name, launches the program if it is not running at that time).

 Differentiate among several instances of the same program running

simultaneously, each with a different title (different open files).

[showcmd]

Set the effect via the optional showcmd argument:

• Hide - Hides the window and passes activation to another

window.

• Normal - Default, activates and displays a window. If the

window was minimized or maximized by the operator, the
command restores it to its original size and position.

• ShowMinimized - Activates, minimizes the window, and

displays its icon.

• Maximized - Activates, maximizes, and displays the window.

• ShowNoActivate - Displays the window in its most recent

size and position. The window that is currently active remains
active (in focus).

• Show - Activates the window and displays it in its currents

size and position.

• Minimized - Minimizes the window and activates the top-

level window in the task- manager's list.

• ShowMinNoActive - Displays the window as an icon. The

window that is currently active remains active.

• ShowNA - Displays the window in its current state. The

window that is currently active remains active (in focus).

• Restore - Same as Normal.

[arguments]

The command line arguments for the program in question. They are
functional only if the program did not run before the command executed
(i.e., the program is launched by the command).

Pulse 4.12 User Guide 1671

Application Tips

Some programs can run multiple instances (i.e., copies of themselves,

e.g., AFCON INI File Editor, Microsoft Notepad and Excel), whereas others
do not (e.g., AFCON Operator Workstation), so your choice of using the
Run or ShowTask command depends on what you want to achieve as
well as on the instance capability of the program in question:

 If an instance of a multi-instance capable program is already

running, Run launches another instance, whereas ShowTask does
not.

 ShowTask can affect an already running program, whereas Run

cannot (only launches).

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the ShowTask
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The ShowTask activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ShowTask activity is executed at

runtime.

False - The ShowTask activity is not

executed and not validated at runtime.

RunAtServer True - Enables running the ShowTask

activity on the server.

False - Disables running the ShowTask

activity on the server.

Pulse 4.12 User Guide 1672

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

ShowTask

IdentifierType  ByProgramPath - This option selects

the task identifier type by its program
path

 ByWindowTile - this option selects

the task identifier type by its Windows
title

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

ShowOptions  Hide - This option hides a running

Windows task or program

 Normal - This option shows the

Windows task or program in normal
mode

 Default - This option shows the

default running Windows task or
program

 ShowMinimized - This option shows

a running Windows task or program in
minimized view

Pulse 4.12 User Guide 1673

  Maximized - This option shows a
running Windows task or program in
full screen

 ShowNoActivate - This option shows

a Windows task or program that is not
active

 Show - This option shows a running

Windows task or program

 Minimized - This option shows a

running Windows task or program in
its minimized view

 ShowMinNoActive - This option

shows a Windows task or program that
is not active in its minimized view

 ShowNA - This option shows a

Windows task or program

 Restore - This option restores a

display of a running Windows task or
program

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

TaskArguments Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

TaskName Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1674

Skin
The Skin activity switches the Operator workstation skin into another
skin. This argument is optional.

The Client workstation has to be open when using the Skin activity.

Argument

The following is the Skin argument when it is used as an action and not
used within a workflow.

Skin [Skinname]

The default skin is ‘Pulse’.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Skin activity
from the Pulse category. Drag the activity to the required location in the
sequence on the left.

The Skin activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The Skin activity is executed at

runtime.
False - The Skin activity is not executed and
not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Pulse 4.12 User Guide 1675

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Skin

SkinName Select one of the following skin type from the

drop-down list:

 Pulse

 Caramel

 Money Twins

 The Asphalt World

 iMaginary

 Black

 Blue

 Lilian

 Coffee

 Liquid Sky

 London Liquid Sky

 Glass Oceans

 Stardust

 Office 2007 Blue

 Office 2007 Black

 Office 2007 Silver

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1676

SupremeReport
The SupremeReport activity invokes the Supreme Reports program. If
there are no arguments given then browse the Masterhost reports web
portal, otherwise browse the link in the argument. The SupremeReport
activity supports arguments for report index and filters.

Supporting specific report generation requires resolving the index out of

the given report name (new infra service).

The SupremeReport activity supports Expression and Bind property.

The Client workstation has to be open when using the SupremeReport

activity.

Argument

The following are the SupremeReport arguments when it is used as an

action and not used within a workflow.

SupremeReport [Web portal URL] [repID…]

• Web portal URL - optional; the URL of the Supreme Report

web portal page

• repID - report index and filter identifiers

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SupremeReport activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The SupremeReport activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1677

 Enabled True - The SupremeReport activity is
executed at runtime.

False - The SupremeReport activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

SupremeReport

URL Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘URL’ to an activity’s
property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Pulse 4.12 User Guide 1678

SwitchToDevelopment
The SwitchToDevelopment activity switches from Operator mode to
Developer mode.

The Client workstation has to be open when using the

SwitchToDevelopment activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SwitchToDevelopment activity from the Pulse category. Drag the
activity to the required location in the sequence on the left.

The SwitchToDevelopment activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.
Enter as free text; this part may be left blank
if no description is required.

Enabled True - The SwitchToDevelopment activity

is executed at runtime.
False - The SwitchToDevelopment activity
is not executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1679

ToolBar
The ToolBar activity invokes the Operator Workstation toolbar.

The ToolBar activity supports Expression and Bind property.

The Client workstation has to be open when using the ToolBar activity.

Argument

The following is the ToolBar argument when it is used as an action and

not used within a workflow.

ToolBar [toolbar-name]

 To show the toolbar (if hidden) and populate it with a particular tool
set, write Toolbar name

 To hide the toolbar, write Toolbar

Executing this command with a valid tool set name:

 Shows the Operator Workstation toolbar (if it was previously

hidden)

 Shows this tool set in the Operator Workstation toolbar

 Sets this tool set as the current Operator Workstation toolbar (for
the next session)

 Sets this tool set as the default tool set of Toolbar Editor (in
TOOLBAR.INI)

Executing this command with an invalid tool set name has no effect.

Executing this command without an argument:

 Hides the Operator Workstation toolbar (if it was previously visible)

 Clears the current Operator Workstation toolbar setting (for the

next session)

Examples

 Show toolbar with tool set “PURGE”:

Toolbar PURGE

 Hide toolbar:

Toolbar

Pulse 4.12 User Guide 1680

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the ToolBar
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The ToolBar activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ToolBar activity is executed at

runtime.

False - The ToolBar activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on the

Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1681

 ToolBar

ToolbarName Supports Expressions and Bind property.

To bind property, double-click on the icon

to display the Bind ‘ToolbarName’ to an
activity’s property window.

 Select the Bind to an existing

member tab to define the selected
property of type 'System.String' that
can be assigned to the target property
of type 'System.String'.

 Select the Bind to a new member tab

to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.String'.

For Expression, click the icon to display

the Item Manager window to define the
expression.

Pulse 4.12 User Guide 1682

UserManager
The UserManager activity invokes a new client instance of the User
Manager tool.

The Client workstation has to be open when using the UserManager

activity.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

UserManager activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The UserManager activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The UserManager activity is

executed at runtime.

False - The UserManager activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Pulse 4.12 User Guide 1683

WinCmd
The WinCmd activity executes a Windows DOS command in the WinCmd
window. It replaces XDOS for client purposes.

It is implemented by the WinCMD /C Windows command.

It does not support P-CIM folder tokens. The activities on the client side
are not aware of any server folders.

The Client workstation has to be open when using the WinCmd activity.

Argument

The following is the WinCmd argument when it is used as an action and

not used within a workflow.

WinCmd Command arguments

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the WinCmd
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The WinCmd activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as a free text, this part may be left

blank if no description is required.

Enabled True - The WinCmd activity is executed at

runtime.

False - The WinCmd activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1684

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

WinCmd

DosCommand Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1685

WindowsLayout
The WindowsLayout activity arranges the Windows layouts that are
open on the screen according to the given parameter.

The Client workstation has to be open when using the WindowsLayout

activity.

Argument

The following are the WindowsLayout arguments when it is used as an

action and not used within a workflow.

WindowsLayout Cascade|TileVertical|TileHorizontal

• Cascade - This option displays the open Windows in a

cascade layout.

• TileVertical - This option displays the open Windows in a

vertical tiles layout.

• TileHorizontal - This option displays the open Windows in a

horizontal tiles layout.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

WindowsLayout activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The WindowsLayout activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1686

 Enabled True - The WindowsLayout activity is
executed at runtime.

False - The WindowsLayout activity is not

executed and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Windows

LayoutType  Cascade - This option displays the

open Windows in a cascade layout.

 TileVertical - This option displays the

open Windows in a vertical tiles layout.

 TileHorizontal - This option displays

the open Windows in a horizontal tiles
layout.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1687

WinExit
The WinExit activity exits Windows and restarts Windows or the
computer (optional).

The Server and the Client workstation have to be open when using the
WinExit activity.

Argument

The following are the WinExit arguments when it is used as an action and
not used within a workflow.

WinExit [ReBoot|ReStart] [/server|/client]

• ReBoot - This option automatically reboots Windows after it

shuts down

• ReStart - This option automatically restarts Windows after it

shuts down

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the WinExit
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The WinExit activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The WinExit activity is executed at

runtime.

False - The WinExit activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1688

 RunAtServer True - Enables running the WinExit activity
on the server.

False - Disables running the WinExit activity

on the server.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

WinExit

Force True - Enables Windows force shut down.

False - This option enables regular Windows

exit.

more... - Click the icon to display the

Item Manager window to browse the Hosts
tree to find the Advised Item.

Pulse 4.12 User Guide 1689

 RestartOptions Select one of the following Windows exit
option from the drop-down list:

 LogOff - This option logs off the user

on exit.

 Shutdown - This option shuts down

Windows on exit.

 Reboot - This option automatically

reboots Windows after it shuts down.

 PowerOff - This option switches the

computer’s power off instead of
shutting down.

 Hibernate - This option hibernates

Windows instead of shutting it down.

 Suspend - This option just stops

Windows for a period of time instead of
shutting it down.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1690

WinHelp
The WinHelp activity displays Help from a Windows Help file. The
WinHelp command runs the standard Windows Help application
(Winhelp.exe) and displays the Help associated with the specified
keyword.

The Client workstation has to be open when using the WinHelp activity.

Argument

The following are the WinHelp arguments when it is used as an action

and not used within a workflow.

WinHelp [path]helpfile [keyword]

• path - optional; the path of the Help file

• helpfile - displays Help from a Windows Help file

• keyword - optional; displays the Help associated with the

specified keyword

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the WinHelp
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The WinHelp activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The WinHelp activity is executed at

runtime.

False - The WinHelp activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1691

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

WinHelp

HelpFile Browse for the Help file through the Open

dialog box.

Keyword Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1692

WorkstationWindowOptions
The WorkstationWindowOptions activity modifies the look and feel of
the Operator Workstation Windows file. It allows the user to change all its
Window’s personalization options.

The Workflow activity name for the WorkstationWindowOptions

activity is WorkstationWindowProperties.

This activity is consists out of the following actions:

 FrameStyle - Changes the “Windows” appearance and associated

functionality of the Operator Workstation frame. It replicates the six
settings of the Frame style of the Operator Workstation Style.

When executed, FrameStyle causes the Operator Workstation

window to “jump” to the screen foreground.

Argument

FrameStyle {0|1|2|3|4|5}

Each style determines the appearance of the Operator Workstation

window, and the availability of window size and/or position control as
indicated below.

Code Style Position Size Control

Control

0 None

1 Single Border

2 Double border

3 Single border and title Y

4 Size control only Y

5 Size control and title Y Y

Example

To enable Size control and title, enter: FrameStyle 5

Pulse 4.12 User Guide 1693

Tips

The Operator Workstation window affected area (left for displays) is

affected also by the Windows settings:

• Size control border width is set in Windows Control Panel,

Desktop, Sizing Grid, Border Width.

• Sizing step is set in Windows Control Panel, Desktop, Sizing

Grid, and Granularity.

 MaxButton - Enables/disables the presentation of the Maximize or

Restore button (arrow) on the Operator Workstation title bar
(effective if, at that time, the Operator Workstation frame style
includes a title). It replicates setting the Maximize Button of the
Operator Workstation Style.

Argument

MaxButton [0|1]

 0 - Disables the presentation of the maximize or

restore button (arrow) on the Operator Workstation
title bar

 1 - Enables the presentation of the maximize or

restore button (arrow) on the Operator Workstation
title bar

 Menubar - Shows/hides the Operator Workstation menu bar

(ribbon only). It affects the Quick Access Bar too.

Argument

Menubar [0|1]

 0 - Hides the Operator Workstation menu bar

 1 - Shows the Operator Workstation menu bar

Pulse 4.12 User Guide 1694

 MinButton - Enables/Disables the presentation of the minimize
button (arrow) on the Operator Workstation title bar (effective if, at
that time, the Operator Workstation frame style includes a title). It
replicates setting the Minimize button of the Operator Workstation
Style.

Argument

MinButton [0|1]

 0 - Disables the presentation of the minimize button

on the Operator Workstation title bar

 1 - Enables the presentation of the minimize button on

the Operator Workstation title bar

 AlwaysOnTop - Turns On and Off the AlwaysOnTop mode of

Operator Workstation

Argument

AlwaysOnTop [0/1]

 0 - Turns Off the AlwaysOnTop mode of Operator

Workstation

 1 - Turns On the AlwaysOnTop mode of Operator

Workstation

 StatusBar - Shows/hides the Operator Workstation status bar

Argument

StatusBar [0|1]

 0 - Hides the Operator Workstation status bar

 1 - Shows the Operator Workstation status bar

Pulse 4.12 User Guide 1695

 SysMenu - Shows/hides the system control box (on the top left
corner) of the title bar and thus, enabling/disabling access to the
system menu (e.g., by clicking, or pressing the ALT + SPACEBAR).

The command is effective only if the Operator Workstation frame

style includes a title. It replicates setting the System menu of the
Operator Workstation Style.

Argument

SysMenu [0|1]

 0 - Hides the system control box (on the top left

corner) of the title bar

 1 - Shows the system control box (on the top left

corner) of the title bar

 ProjectNavigator - Shows/hides the project navigator

Argument

ProjectNavigator [0|1]

 0 - Hides the project navigator

 1 - Shows the project navigator

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

WorkstationWindowOptions activity from the Pulse category. Drag the
activity to the required location in the sequence on the left.

The WorkstationWindowOptions activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter a free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1696

 Enabled True - The WorkstationWindowOptions
activity is executed at runtime.

False - The WorkstationWindowOptions

activity is not executed and not validated at
runtime.

Appearance

FrameStyle Select one of the following for the

Workstation Windows frame style from the
drop-down list:

 FixedSingle - This option displays a

single fixed frame window.

 Fixed3D - This option displays a 3D

fixed frame window.

 FixedDialog - This option displays a

dialog box with a fixed frame.

 Sizable (default) - This option displays

a window with a frame that can be
resized.

 FixedToolWindows - This option

displays a fixed tool Windows border
style.

 SizableToolWindow - This option

displays a resizable tool Windows
border style.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Pulse 4.12 User Guide 1697

 Simple True - Only an OK button is displayed to
confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

Workstation Window Style

AlwaysOnTop  Default - This option displays the

Workstation window always on top as
a default.

 True - This option displays the

Workstation window always on top.

 False - This option does not display

the Workstation window to be always
on top.

MaximizeBox  Default - This option displays the

Workstation window as a maximized
box as a default.

 True - This option displays the

Workstation window as a maximized
box.

 False - This option does not display

the Workstation window as a
maximized box.

MenuBar  Default - This option displays the

menu bar on the Workstation window
as a default.

 True - This option displays the menu

bar on the Workstation window.

 False - This option does not display

the menu bar on the Workstation
window.

Pulse 4.12 User Guide 1698

 MinimizeBox  Default - This option displays the
Workstation window as a minimized
box as a default.

 True - This option displays the

Workstation window as a minimized
box.

 False - This option does not display

the Workstation window as a
minimized box.

ProjectNavigator  Default - This option displays the

project navigator on the Workstation
window as a default.

 True - This option displays the project

navigator on the Workstation window.

 False - This option does not display

the project navigator on the
Workstation window.

StatusBar  Default - This option displays the

status bar on the Workstation window
as a default.

 True - This option displays the status

bar on the Workstation window.

 False - This option does not display

the status bar on the Workstation
window.

SystemMenu  Default - This option displays the

system menu on the Workstation
window as a default.

 True - This option displays the system

menu on the Workstation window.

 False - This option does not display

the system menu on the Workstation
window.

Pulse 4.12 User Guide 1699

Xdos
The Xdos activity executes a DOS command. The syntax is specific to the
DOS command in question.

The Server has to be open when using the Xdos activity. The Xdos
command runs on the Server only.

Argument

The following is the Xdos argument when it is used as an action and not
used within a workflow.

Xdos doscommand

Syntax

DOScommand plus one of the following: COPY, DELETE (or DEL), RENAME
(or REN), MOVE, REPLACE

XDOS COPY source destination [-H] [-U]

Copies one or more files

• source - the source file name, use DOS convention

• destination - the destination directory name, use DOS

convention

• -H - optional, hide flag, the progress status is not shown

• -U - optional, update flag, overwrites the file only if the

source is more recent than the destination

XDOS DELETE (or DEL) source [-H]

Deletes one or more files

• source - the source file name, use DOS convention

• -H - optional, hide flag, the progress status is not shown

XDOS RENAME (or REN) source destination [-H]

Renames one or more files

• source - the source file name, use DOS convention

• destination - the destination file name, use DOS convention

• -H - optional, hide flag, the progress status is not shown

Pulse 4.12 User Guide 1700

 XDOS MOVE source destination [-H]

Moves one or more files

• source - the source file name, use DOS convention

• destination - the destination file name, use DOS convention

• -H - optional, hide flag, the progress status is not shown

XDOS REPLACE source destination [-H] [-U] [-A]

Replaces one or more files

• source - the source file name, use DOS convention

• destination - the destination file name, use DOS convention

• -H - optional, hide flag, the progress status is not shown

• -U - optional, update flag, overwrites the file only if the

source is more recent than the destination

• -A - optional, add flag, only adds files, i.e., that did not exist
at the destination

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Xdos
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Xdos activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Xdos activity is executed at

runtime.

False - The Xdos activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1701

 Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is
displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.
False - Yes and No selection buttons are
displayed on the Activity Confirmation
message window.

Xdos

DosCommand Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

Pulse 4.12 User Guide 1702

Zoom
The Zoom activity zooms or enlarges a portion of the image on the
screen.

The Client workstation has to be open when using the Zoom activity.

This Zoom activity replaces the following actions:

 ZoomIn - Applies Zoom In on the currently open display. If no

display is open then nothing is done

 ZoomOut - Applies Zoom Out on the currently open display. If no

display is open then nothing is done

 ZoomByPercent - Zooms the currently open display according to

the provided parameter

Argument

Zoom Percent

 Percent - the percent to zoom the current display

 ZoomNormal - Shows the currently open display with 100% zoom

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Zoom
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Zoom activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Pulse 4.12 User Guide 1703

 Enabled True - The Zoom activity is executed at
runtime.

False - The Zoom activity is not executed

and not validated at runtime.

Confirmation

ConfirmPrompt The confirmation message that appears on

the Activity Confirmation message window.

DoConfirm True - A confirmation message is displayed.

False - No confirmation message is

displayed.

Simple True - Only an OK button is displayed to

confirm the message on the Activity
Confirmation message window.

False - Yes and No selection buttons are

displayed on the Activity Confirmation
message window.

ZoomByPercent

ZoomByPercent Click the icon to display the Item

Manager window to browse the Hosts tree to
find the Advised Item.

ZoomType

Type  ZoomIn - This option zooms in a

portion of the image on the screen.

 ZoomOut - This option zooms out a

portion of the image on the screen.

 ZoomNormal - This option leaves the

image size as is.

 ZoomByPercent - This option zooms

by percent a portion of the image on
the screen.

 more... - Click the icon to display

the Item Manager window to browse
the Hosts tree to find the Advised
Item.

Pulse 4.12 User Guide 1704

General Activities
A general activity is a single general operation that is Microsoft based and
declared and executed within a workflow.

The Microsoft-based general activities are as follows:

 ConditionedActivityGroup

 Delay

 IfElse

 IfElseBranch

 Parallel

 Policy

 Sequence

 Suspend

 SynchronizationScope

 Terminate

 While

Pulse 4.12 User Guide 1705

ConditionedActivityGroup
The ConditionedActivityGroup activity contains several child activities
that are executed if the condition is met. The rule condition of this activity
is constructed as was described in the Handling condition in Pulse
paragraph. Actually, this is an “If” activity without an “else” activity.

Using conditions in workflows

You can use conditions to control the behavior of your workflow. The
runtime engine evaluates a condition and then acts based on the result of
that evaluation.

There are two ways to represent conditions in your workflow:

 You can express conditions in code by writing a handler that sets

the Result property for your condition.

 You can also express conditions as a rule condition, which is a

System.CodeDom expression in your rule file.

Conditional activities

Several activities that are provided with the Windows Workflow

Foundation use conditions:

 The first IfElseBranchActivity, contained within an IfElseActivity

activity, which has a condition that evaluates to true is executed.

• IfElseBranchActivity represents a branch of an

IfElseActivity. This class cannot be inherited.

• IfElseActivity Conditionally runs one of two or more

activities of type IfElseBranchActivity. This class cannot be
inherited.

 The WhileActivity activity continuously executes any activities

contained within it, as long as its condition evaluates to true. The
condition is reevaluated at the completion of each loop.

 The ConditionedActivityGroup continuously executes any

activities within it until its condition evaluates to true. Each
individual activity within the ConditionedActivityGroup has a
When condition that is set using the WhenConditionProperty. Each
activity executes only when the When condition evaluates to true.

• WhenConditionProperty represents the

DependencyProperty that targets the
WhenConditionProperty property.

Pulse 4.12 User Guide 1706

 • DependencyProperty is a special kind of property that can
be defined or attached to a DependencyObject. There are
three kinds of dependency properties: instance properties,
meta properties, and attached properties. This class cannot
be inherited.

 The ReplicatorActivity completes its execution when its

UntilCondition property evaluates to true.

• ReplicatorActivity runs multiple instances of a child activity

• UntilCondition gets or sets a completion condition that

indicates when the ReplicatorActivity should finish.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

ConditionedActivityGroup activity from the Pulse category. Drag the
activity to the required location in the sequence on the left. Drop an
activity or activities within the ConditionedActivityGroup activity, see
example below.

The ConditionedActivityGroup activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Pulse 4.12 User Guide 1707

 Base Class Specify the Base class of the activity.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The ConditionedActivityGroup

activity is executed at runtime.

False - The ConditionedActivityGroup

activity is not executed and not validated at
runtime.

Conditions

DynamicUpdateCo Specify the Until condition for the activity. If

ndition for the Until condition is not specified, the
example: activity will execute until no more children
UntilCondition are executing.

 None - without condition

 Code Condition

 Declarative Rule Condition - If this

condition is selected, set the following
parameters:

• Condition Name - Click the

icon to display the Select
Condition window and specify
the name of the Rule
Expression condition name.
Select a rule condition to be
assigned to the activity’s
condition. It is possible to add,
edit, delete, or rename existing
conditions.

• Expression - Click the icon

to specify the expression to be
associated with the Rule
Expression condition name.

Pulse 4.12 User Guide 1708

Delay
The Delay activity delays the execution of the workflow for a specific time
limit.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Delay
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Delay activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Delay activity is executed at

runtime.

False - The Delay activity is not executed

and not validated at runtime.

Delay

TimeOutDuration Click the icon to display the Bind

‘TimeOutDuration’ to an activity’s
property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1709

IfElse
The IfElse activity is similar to the ConditionedActivityGroup but only
has two branches. A condition has to be declared on its left branch and
activities are executed if the condition is met. It is not necessary to
declare a condition on its right branch.

The IfElse activity executes one of the branches according to the

following rules:

 If the Condition of the Left-hand branch evaluates as True, the

chain of activities under this branch are executed.

 If not, (i.e., the condition of the Left-hand branch evaluates as

False), the chain of activities under the Right-hand branch are
executed.

The IfElse activity is like an "else" branch. If a condition is declared on

the right branch, the branch becomes an "else if" branch.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the IfElse
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The IfElse activity properties and attributes are described below

Activity

(Name) The identifier of the activity. It has to be unique

in the workflow.

Description The description of the activity that appears as

part of the Activity Confirmation message
window.

Enter as free text; this part may be left blank if

no description is required.

Enabled True - The IfElse activity is executed at runtime.

False - The IfElse activity is not executed and

not validated at runtime.

Pulse 4.12 User Guide 1710

IfElseBranch
The branch of the IfElse activity contains the chain of activities that are
executed and the condition that determines if the branch is to be executed
or not.

NOTE You need not specify any condition under the Right-hand
branch.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

IfElseBranch activity from the Pulse category. Drag the activity to the
required location in the sequence on the left.

The IfElseBranch properties and attributes are described below

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The IfElseBranch activity is executed

at runtime.

False - The IfElseBranch activity is not

executed and not validated at runtime.

Conditions

Condition  None - without condition

 Code Condition

 Declarative Rule Condition - if this

condition is selected, define the
following parameters:

• Condition Name - Click the

icon to display the Select
Condition window and specify
the name of the Rule
Expression condition name.

Pulse 4.12 User Guide 1711

 Select a rule condition to be
assigned to the activity’s
condition. It is possible to add,
edit, delete, or rename existing
conditions.

• Expression - Click the icon

to specify the expression to be
associated with the Rule
Expression condition name.

Pulse 4.12 User Guide 1712

Parallel
The Parallel activity creates a path for two parallel chains of activities.
The Parallel activity splits the workflow into two branches that are
executed simultaneously.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Parallel
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Parallel activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Parallel activity is executed at

runtime.

False - The Parallel activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1713

Policy
The Policy activity defines a set of rules. Each rule is an "If-Else-Then"
statement. The actions that can be set in the "Then" and "Else" fields are
as follows:

 Setting a field or property on a workflow

 Performing a Halt or an Update statement (Halt action causes the

rule set execution to stop immediately and the Update action
causes any rules in the rule set, that use the field on which the
update was defined, to reevaluate).

An example of the Update statement: Update(this.Parameter1).

This leads to a reevaluation of all the rules in the set using the
Parameter1 field.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Policy
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Policy activity properties and attributes are described below

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Policy activity is executed at

runtime.

False - The Policy activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1714

 On the Developer workstation, clicking the policyActivity#
(where # is the number of the policyActivity) workflow box
displays the Rule Set Editor dialog box. Configure the rule set and
add/remove rules from the list. Set conditions and actions for each
rule.

The following parameters are added for policy configuration:

Misc

RuleSetReference Specify the rule set name.

Click the icon to display the Select Rule

Set window. Select a rule set to be assigned
to the policyActivity. Add, edit, delete, or
rename an existing rule set.

 RuleSet Definition - Click the icon

to display the Rule Set Editor dialog
box. Configure the rule set and
add/remove rules from the list. Set
conditions and actions for each rule.

Pulse 4.12 User Guide 1715

Sequence
The Sequence activity executes child activities one at a time. An activity
is only executed after the previous activity is completed.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Sequence
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Sequence activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Sequence activity is executed at

runtime.

False - The Sequence activity is not

executed and not validated at runtime.

Pulse 4.12 User Guide 1716

Suspend
The Suspend activity suspends the execution of the workflow to enable
intervention in the event of some error conditions requiring special
attention.

The SuspendActivity activity temporarily stops the execution of the

current workflow. Typically, the SuspendActivity activity is used to
reflect an error condition that requires attention by an administrator.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Suspend
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Suspend activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Suspend activity is executed at

runtime.

False - The Suspend activity is not executed

and not validated at runtime.

Error Click the icon to display the Bind ‘Error’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1717

SynchronizationScope
The SynchronizationScopeActivity activity executes contained activities
sequentially in a synchronized domain. Concurrently executing
SynchronizationScopeActivity activities that are configured to use the
same synchronization handle(s) provide their child activities with
synchronized and mutually exclusive access to shared variables.

The SynchronizationScope activity properties and attributes are

described below.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the

SynchronizationScopeActivity activity from the Pulse category. Drag
the activity to the required location in the sequence on the left.

The SynchronizationScopeActivity activity properties and attributes are

described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The SynchronizationScope activity

is executed at runtime.

False - The SynchronizationScope activity

is not executed and not validated at runtime.

Misc

SynchronizationHa Specify the synchronization handles to be

ndles acquired before executing the activity.

Synchronization handles have to be a list of

identifiers separated by commas consisting of
existing or new identifiers.

Pulse 4.12 User Guide 1718

Terminate
The Terminate activity immediately terminates the execution of the
current workflow.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the Terminate
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The Terminate activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Terminate activity is executed at

runtime.

False - The Terminate activity is not

executed and not validated at runtime.

Error Click the icon to display the Bind ‘Error’

to an activity’s property window.

 Select the Bind to an existing

member tab to select a target
property of type 'System.Object' from
an activity.

 Select the Bind to a new member

tab to provide the name of the new
member to be created. The member
can be a field or a property of type
'System.Object'.

Pulse 4.12 User Guide 1719

While
The While activity defines a loop that is executed over and over again
until a condition is met. The condition is constructed in a certain way
described in the Handling condition in the P-CIM paragraph.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the While
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The While activity properties and attributes are described below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The While activity is executed at

runtime.

False - The While activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1720

 Conditions

ConfirmPrompt Select the condition that keeps the while in

execution as long as it is true:

 None - without condition

 Code Condition -

 Declarative Rule Condition - If this

condition is selected, define the
following parameters:

• Condition Name - Click the

icon to display the Select
Condition window and specify
the name of the Rule
Expression condition name.
Select a rule condition to be
assigned to the activity’s
condition. It is possible to add,
edit, delete, or rename existing
conditions.

• Expression - Click the icon

to specify the expression to be
associated with the Rule
Expression condition name.

Pulse 4.12 User Guide 1721

Custom Activity
A custom activity is a user-defined activity with .NET 3.0 workflow
activities for sequential workflows. To create custom activities, good
knowledge of .NET Framework and .NET Workflow foundation is required.

The activities are deployed as an external dll containing user-defined

activities. The user introduces the DLLs to the project data via the
ActivityManager module, the activity DLLs can be uploaded into the
project data. Only custom DLLs can be edited/deleted. As all project data
components, the DLLs are managed with build numbers, etc. The
Workflows editor adds the DLLs to the activities toolbox list in the editor.

User defined activities are public Project data. If possible, it should be

cached and loaded while the Workstation is starting. Custom or user-
defined activities are created as methods in assemblies, and the DLLs
proliferate to the clients using a specialized service.

Properties and Attributes

On the Pulse Workflow Editor window’s right pane, select the custom
activity from the Pulse category. Drag the activity to the required location
in the sequence on the left.

The CustomActivity activity properties and attributes are described

below.

Activity

(Name) The identifier of the activity. It has to be

unique in the workflow.

Description The description of the activity that appears

as part of the Activity Confirmation
message window.

Enter as free text; this part may be left blank

if no description is required.

Enabled True - The Custom activity is executed at

runtime.

False - The Custom activity is not executed

and not validated at runtime.

Pulse 4.12 User Guide 1722

 Conditions

Condition  None - without condition

 Code Condition -

 Declarative Rule Condition -

• Condition Name - Click the

icon to display the Select
Condition window and specify
the name of the Rule
Expression condition name.
Select a rule condition to be
assigned to the activity’s
condition. It is possible to add,
edit, delete, or rename existing
conditions.

• Expression - Click the icon

to specify the expression to be
associated with the Rule
Expression condition name.

NOTE A custom activity does not always

have a rule condition. A rule
condition is necessary depending
on the custom activity that the
user creates.

Pulse 4.12 User Guide 1723

IfLevel and IfConfirm Actions
IfLevel and IfConfirm are actions that were replaced by the
workflowAuthorizationLevel in the workflows and by the Confirmation
parameters in every activity but are still used as actions.

IfLevel
The IfLevel action is implemented as a property of every activity. Its
execution authorization is checked against the value entered on the
property.

Use the IfLevel action to precede a command that has to be available

only if the present operator has a certain minimum authorization level or
password level. If the minimum authorization level condition is not met,
the Operator Workstation displays a message box to that effect and the
command preceded by the IfLevel is not executed.

In workflows, the IfLevel is implemented in each Activity as

AuthorizationLevel property. The Client workstation has to be open
when using the IfLevel action.

IfLevel is checked by the conventional mechanism. After approval, the

Operator Workstation decides whether to run the command on the server
or the client side.

Argument

The following are the IfLevel action arguments:

IfLevel passlevel command

• passlevel - enter the minimum password authorization level.

For example, enter 12 if you want the command to be

available only to an operator with password level 12 or
higher (between 12 and 0, inclusive)

• command - enter the actual command, using its own

syntax.

Pulse 4.12 User Guide 1724

Example

The following command sequence configured in an Action Button.

A graphical object that when pressed and released (by mouse-clicking or

keyboard strokes) launches a command/s (actions):

Login;IfLevel 2 Set DBSRThe P-CIM Database

Server!PCIM!VALVE89 1;Login ANY ANY

operates as follows when the operator “presses” the Action Button:

1 The Operator Workstation displays the Login dialog box.

2 The operator logs in.

3 If the password level is 2 or less, the Operator Workstation

executes “Set DBSR!PCIM!VALVE89 1”, else it presents a
message box.

4 The Operator Workstation executes “Login ANY ANY”.

IfConfirm
The IfConfirm action is implemented as a Boolean property for every
activity. If the IfConfirm action is true, the workflow engine raises a
message box with a confirmation prompt if supplied or a current activity
described by its name and description asking for permission to execute.

Use the IfConfirm action to precede a command that is to be executed

upon operator confirmation.

The IfConfirm command can be applied on one command only.

In workflows, the IfConfirm is implemented in each activity as

ConfirmPrompt and DoConfirm properties.

The Client workstation has to be open when using the IfConfirm action.

A pop-up confirmation message appears in the client side. After the user
confirms, the Operator Workstation decides whether to run the command
on the server or the client side.

Pulse 4.12 User Guide 1725

Argument

The following are the IfConfirm action arguments:

IfConfirm [“prompt”] [!]command

 [“prompt”] - optional; you can specify a prompt, i.e., message

box text, to be displayed in the confirmation message box. If you
do not specify a prompt and leave the double quotes (“”), the
default confirmation message "Are you sure?" is displayed. When
omitting this argument, the confirmation text is taken from the
prompt text of the currently picked action button, or, if this one is
empty as well, the default confirmation prompt is used.

 [!] - optional; when specifying this argument as the first character

of the command to be executed upon confirmation, the message
box style is OK and !. When omitted, the message box style is YES
/ NO and ?.

When using this command argument, you can use the IfConfirm
command to display a message to be confirmed by the OK prompt.

For example: IfConfirm “Temp. is exceeding normal”.

 command - the command to be executed upon confirmation.

To enable confirming of more than one command, use an AutoAction

script in coordination with the DoAction command.

Pulse 4.12 User Guide 1726

Blinking Colors
In the Blinking Colors Manager, define pairs of blinking colors and their
respective blinking intervals. These pairs are applied with the Blink mode
of the Animation Visibility property, see Animation Properties - Visibility.

In a blinking condition, an object is filled with two alternating colors, the

Primary color, and the Alternate color. The Object Fill color of a graphic
object is the Primary Color of a blinking pair, see Setting Object Fill
Properties.

If an object is defined to blink when it receives an “On” or “Off” command,

and its Primary color is matched with an Alternate color in the Blinking
Colors Manager, then that specific combination takes effect in the object
during runtime.

If the Primary color of the object is not configured in the Blinking Colors
Manager, the Alternate color is the Primary color’s default inverse.

The Primary color of each pair configured in the Blinking Colors Manager
must be different from the Primary color of any other pair, and also from
its own Alternate color.

Defining Blinking Colors

To define Blinking Colors pairs

1 In the Developer Workstation’s Manage ribbon, click the Blinking

Colors icon.

The Blinking Colors Manager dialog box is displayed.

Pulse 4.12 User Guide 1727

2 In the Blink Interval list, choose the time in milliseconds to
display each color during blinking.

3 Click in the Primary Color column and choose a color from one of
the palettes. This color has to correspond with the color configured
in the Graphic Object’s Color > Fill properties.

4 Click in the Alternate Color column and choose a color from one of
the palettes.

To set “Invert” as the alternate color, click the check mark button.

5 Click the “+” button to add the pair to the list

6 Click OK to save the Blinking Colors configuration and exit the

dialog box.

To change color(s) in a pair

1 In the Developer Workstation’s Manage ribbon, click the Blinking

Colors icon.

The Blinking Colors Manager dialog box is displayed.

2 Click in the column of the color that you want to change and choose
a different color from one of the palettes.

3 Click OK to save the Blinking Colors configuration and exit the

dialog box.

To delete a color pair

1 In the Developer Workstation’s Manage ribbon, click the Blinking

Colors icon.

The Blinking Colors Manager dialog box is displayed.

2 Click in the row of the color that you want to delete.

3 Click the “-” button.

The color pair disappears from the list.

4 Click OK to save the Blinking Colors configuration and exit the

dialog box.

Pulse 4.12 User Guide 1728

To navigate in the Blinking Colors Manager

1 Click the right arrow button to move to the next entry in the list.

2 Click the left arrow button to move to the previous entry in the list.

3 Click the right double-arrow button to move to the next page of the
list, if more entries exist than are displayed.

4 Click the left double-arrow button to move to the previous page of

the list, if more entries exist than are displayed.

5 Click the right double-arrow+line button to move to the last page of

the list, if more entries exist than are displayed.

6 Click the left double-arrow+line button to move to the first page of

the list, if more entries exist than are displayed.

Pulse 4.12 User Guide 1729

Toolbars and Context Menus
Creating Toolbars and Context Menus
The Toolbars and Context Menus Manager enables you to build
customized toolbars and context menus (menus that open when you
right-click the mouse) that you can then assign as an animation property
for graphic objects. For example, you can set up an object with a context
menu commands vary depending if an alarm condition occurs or returns
to normal.

To build toolbars and context menus

1 In the Developer Workstation’s Manage ribbon, click the Toolbars

and Context Menus icon.

The Toolbars and Context Menus Manager dialog box is displayed.

2 Select to create a Toolbar or Context Menu from the Type drop-

down list.

3 In the Name column, enter a free-text name for the toolbar or

menu.

4 To populate the toolbar or menu with commands, click .

The Pulse Context Menu Settings or Pulse Toolbar Settings dialog

box is displayed.

Pulse 4.12 User Guide 1730

5 Click the “+” button below the table to add a new entry to the
menu or toolbar.

6 Define the toolbar and menu commands and their appearances and
data items or actions.

For more details on the Context Menu properties, see Pulse Context
Menu Settings or see Pulse Toolbar Settings to set the Pulse
Toolbar.

7 Click OK to continue.

Duplicating Toolbars and Context Menus

You can duplicate or create multiple copies of Toolbars and Context
Menus from the Toolbars and Context Menus Manager window.

 In the Toolbars and Context Menus Manager window, right-click

on a Toolbar or Context Menu entry on the table and select the
Duplicate option from the pop-up menu.

The toolbar or context menu together with its data is duplicated and
displayed on the Toolbars and Context Menus Manager window.

Pulse 4.12 User Guide 1731

Pulse Context Menu Settings

Click the button on the rightmost part of the Context Menu name on
the Name column to display the Pulse Context Menu Settings dialog
box.

The Pulse Context Menu Settings dialog box has the following tabs
where you can define Context Menu Settings:

 Buttons

 Appearance

Pulse 4.12 User Guide 1732

Buttons
In the Buttons tab, you can add and remove elements on the Context
Menu, define their functions, and change their order.

Buttons table

Type Displays the type of Context Menu you selected on

the Static pane

Image Select the image that was defined in the Image field
on the Static pane; the image appears as the
button’s icon image.

Caption The Context Menu you defined on the Text field on

the Static pane

Static

Enable Select the checkbox to display and activate this

command (or display a separator) in the menu.

Type  Button - A command that carries out an item

command, action, or workflow.

 Label – The text that appears on the menu in

order to, for example, label an adjacent
element or identify a group of buttons.

 Separator - A line that separates controls or

groups of controls in the menu.

 Text Box - A box requiring text input by the

operator.

Pulse 4.12 User Guide 1733

  Progress Bar - An element displaying the
percentage of a process that was already
completed.

 Drop Down Menu – A drop-down command

menu list

Style Select the way the command is presented in the

menu.

 Image - command is displayed as a graphic

or icon.

 Image and Text - command is displayed with

both an icon and text string.

 Text - command is displayed as a text string

only.

 None

Text Type the command’s text string that will appear on

the menu.

Action Workflow To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to execute

a workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard

syntax.

-or-

 Open the Action Selector … to assemble

and/or choose the command or workflow.

NOTE After you enter a workflow, it appears in

the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

Width The width of the textbox. This parameter is only

available if when the TextBox type is selected.

Pulse 4.12 User Guide 1734

Image  Click the “+” button to add an image as an
icon for the command.

 Click the down arrow button to display icons

which have already been selected previously.

 Click the “-” button to remove an image from

the Image list box.

Tooltip Type a tooltip that appears when the user’s mouse

pointer hovers over the button.

Key Available only when Button or DropDownMenu is

selected as the Context Menu type.

Key specifies the shortcut keyboard combination (or

select it in the Select Accelerator Key dialog box),
which carries out the button’s command when
pressed.

Use the Select Accelerator Key dialog box to

associate a shortcut keyboard combination with a
button in a Pulse Context Menu object.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut. First,

choose a key from the list (i.e., None, A-Z, F1-F24,
PageUp, PageDown, End, Home, 0-9, Numpad0-
NumPad9, Escape, Space). Optionally, you can add
one, two, or all of the Shift/Ctrl/Alt keys to the
shortcut.

Visibility The command is visible only to users whose security

Security Lock level equals or is higher than the level specified here.

Usability The command may be used only by users whose

Security Lock security level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 1735

Dynamic

Item 1/Item 2 Specify the item name (or select it in the Item
Manager …) which affects this context menu
element.

A table displays the dynamic parameters for

Item1/Item2:

 Value

 Enable checkbox

 Action Workflow

 Image

 Text

 Tooltip

 Key

 Security Lock

Add Adds a context menu element

Click the Add button in a button’s Enable column

opens up a table for setting up a dynamic button,
where you can define the behavior of the button in
two states (if just Item 1 is defined) or four states (if
both Item 1 and Item 2 are defined).

Remove Removes the selected menu element

Pulse 4.12 User Guide 1736

Appearance
The Context Menu’s appearance background, foreground, and text
properties are defined in the Appearance tab.

BackColor Select the menu’s background color from the drop-

down list.

Background Browse and select from the available background

Image images.

Background Select a background image layout from the drop-down

Image Layout list: None, Tile, Center, Stretch, or Zoom.

Font Select a font for the menu from the list of fonts.

ForeColor Select a foreground color from the drop-down list.

Text Direction Select the direction of the menu’s text: Horizontal,

Vertical90, Vertical270.

Right to Left Select No for the text to start from the left or select
Yes for the text to start from the right.

Grip Style Select Visible to show the grip on the menu and
Hidden to hide it.

Pulse 4.12 User Guide 1737

Pulse Toolbar Settings
In the Pulse Toolbar Settings dialog box, define the appearances,
behavior of the toolbar controls, and general parameters.

General
Toolbar placement and size property elements are defined in the General
tab.

Dock Choose the location of the toolbar in relation to the

display’s work area. Possible location selections are
None, Top, Bottom, Left, Right, and Fill.

Toolbar Size

Auto Size Select this option to allow the toolbar to resize itself
automatically to fit its contents. If this option is
selected, it specifies that the control automatically
resizes itself to fit its contents and the Auto Size
Width and Height parameters are unavailable.

Width, Height If Auto Size is not selected, define the size of the
toolbar in pixels.

Image Size

Width, Height Define the size in pixels of the images (icons) on the
toolbar.

Pulse 4.12 User Guide 1738

Buttons
In the Buttons tab, you can also add and remove elements on the
toolbar, define their functions, and change their order in the toolbar.

Buttons table

Type Displays the type of Toolbar you selected on the

Static pane

Image Select the image that was defined in the Image field
on the Static pane; the image appears as the
toolbar’s icon image.

Caption The Toolbar you defined on the Text field on the

Static pane

Static

Enable Select the checkbox to display and activate this

command (or display a separator) in the toolbar.

Type  Button - A command that carries out an item

command, action, or workflow.

 Label – The text that appears on the toolbar

in order to, for example, label an adjacent
element or identify a group of buttons.

 Separator - A line that separates controls or

groups of controls in the toolbar.

 Text Box - A box requiring text input by the

operator.

Pulse 4.12 User Guide 1739

  Progress Bar - An element displaying the
percentage of a process that was already
completed.

 Drop Down Menu – A drop-down command

menu list

Style Select the way the command is presented in the

menu.

 Image - Command is displayed as a graphic

or icon.

 Image and Text - Command is displayed

with both an icon and text string.

 Text - Command is displayed as a text string

only.

 None

Text Type the command’s text string that will appear on

the toolbar.

Action Workflow To define the object’s data item, enter an action

command or workflow.

 You can type it manually.

When manually typing a command to execute

a workflow, add a workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action, use standard

syntax.
-or-
Open the Action Selector … to assemble
and/or choose the command or workflow.

NOTE After you enter a workflow, it appears in

the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

Width The width of the textbox. This parameter is only

available if when the TextBox type is selected.

Pulse 4.12 User Guide 1740

Image  Click the “+” button to add an image as an
icon for the command.

 Click the down arrow button to display icons

which have already been selected at a
previous time.

 Click the “-” button to remove an image from

the Image list- box.

Tooltip Type a tooltip that appears when the user’s mouse

pointer hovers over the toolbar.

Key Available only when Button or DropDownMenu is

selected as the Toolbar type.

Key specifies the shortcut keyboard combination (or

select it in the Select Accelerator Key dialog box),
which carries out the button’s command when
pressed.

Use the Select Accelerator Key dialog box to

associate a shortcut keyboard combination with a
button in a Pulse Toolbar object.

Shift/Ctrl/Alt Select the key(s) which comprise the shortcut. First,

choose a key from the list (i.e., None, A-Z, F1-F24,
PageUp, PageDown, End, Home, 0-9, Numpad0-
NumPad9, Escape, Space). Optionally, you can add
one, two, or all of the Shift/Ctrl/Alt keys to the
shortcut.

Visibility The command is visible only to users whose security

Security Lock level equals or is higher than the level specified here.

Usability The command may be used only by users whose

Security Lock security level equals or is higher than the level
specified here.

Pulse 4.12 User Guide 1741

Dynamic

Item 1/Item 2 Specify the item name (or select it in the Item
Manager …) which affects this toolbar element.

A table displays the dynamic parameters for

Item1/Item2:

 Value

 Enable checkbox

 Action Workflow

 Image

 Text

 Tooltip

 Key

 Security Lock

Add Adds a toolbar element

Click the Add button in a button’s Enable column

opens up a table for setting up a dynamic button,
where you can define the behavior of the button in
two states (if just Item 1 is defined) or four states (if
both Item 1 and Item 2 are defined).

Remove Removes the selected toolbar element

Pulse 4.12 User Guide 1742

Appearance
The toolbar’s appearance background, foreground, and text properties are
defined in the Appearance tab.

BackColor Select the toolbar’s background color from the drop-

down list.

Background Browse and select from the available background

Image images.

Background Select a background image from the drop-down list:

Image Layout None, Tile, Center, Stretch, or Zoom.

Font Select a font for the toolbar from the list of fonts.

ForeColor Select a foreground color from the drop-down list.

Text Direction Select the direction of the toolbar’s text: Horizontal,

Vertical90, Vertical270.

Right to Left Select No for the text to start from the left or select
Yes for the text to start from the right.

Grip Style Select Visible to show the grip on the toolbar and
Hidden to hide it.

Pulse 4.12 User Guide 1743

Defining Server AutoActions
The Server AutoActions Manager enables you to set up AutoActions
that will run only on the Pulse Server. These AutoActions will not be
executable by operators on a Client workstation. They will start at the
occurrence of a defined trigger and are not dependent on a scheduled
time.

Examples of AutoActions that may be configured to run on the Pulse

Server are recipe actions (LoadRcp, LearnRcp, and CompRcp), acquisition
of report data, closing of programs, e- mail sending, and many more.

To define Server AutoActions

1 In the Developer Workstation’s Manage ribbon, click the Server

AutoActions icon.

The Server AutoActions Manager dialog box is displayed.

Pulse 4.12 User Guide 1744

2 Configure the AutoActions for the Server side.

Automation

Select which automated tasks the operator workstation will perform.

Enable Check to run AutoActions

AutoActions

DataLogger Check to run the Data Logger workflow

Workflow

AutoAlarm Check to run AutoAlarm workflows

Workflow

Basic Scripts Check to run basic scripts actions

Actions

AutoAlarm Print Check to activate AutoAlarm prints

On Startup Select the action or workflow to execute on

operator workstation start up.

On Shutdown Select the action or workflow to run when the

operator workstation shuts down.

Active Click the checkbox option to select the

corresponding AutoAction to activate.

Name Type the AutoAction's name.

Mode Select the AutoAction's activation mode. Select one

of the following options:

 Greater than - AutoAction triggered when

the value is greater than defined.

 Less than - AutoAction triggered when the

value is less than defined.

 Change from 0 to 1 - AutoAction triggered

on value change from 0 to 1.

 Change from 1 to 0 - AutoAction triggered

on value change from 1 to 0.

 Any change - AutoActions triggered on any

value change.

 Change to 0 - AutoAction triggered on

value change to 0.

Pulse 4.12 User Guide 1745

  Change to non-zero - AutoAction triggered
on value change to non-zero.

 In range - AutoAction triggered when the

value is in the defined range.

 Equal - AutoAction triggered when the value

is equal to the one defined.

 Not empty text string - AutoAction

triggered when a text string contains
characters.

 Empty text string - AutoAction triggered

when a text string is received empty.

 Contains string - AutoAction triggered

when text contains sub strings.

Trigger Select how the AutoActions will be triggered. Type

in the item's path or browse to select an item from
the Item Manager.

Start Value Type in the item's start value used as reference to

the selected mode.

End Value Type in the item's end mode (if applicable).

Pulse 4.12 User Guide 1746

Action Select the action or workflow to execute when the
AutoAction is triggered.

To define the object’s data item, enter an action

command or workflow.

• You can type it manually.

When manually typing a command to

execute a workflow, add a workflow
prefix (WF).

For example, WF:Alert_in_B4.

When manually typing an action, use

standard syntax.

-or-

• Open the Action Selector to

assemble and/or choose the
command or workflow.

NOTE After you enter a workflow, it appears

in the relevant edit box in the following
syntax:

[WorkflowName] [arguments]

Filter row Define the filter row to filter AutoAction

information.

Skip First Trigger Select this option to cause Pulse to ignore the very
Data first trigger data, therefore not executing the first
autoaction in the action workflow.

3 After defining the AutoActions, click OK to save them and close the
dialog box.

Pulse 4.12 User Guide 1747

Duplicating AutoActions on the Server
The Add Multiple Rows option in the Server AutoActions Manager
can duplicate multiple copies of automatic actions/workflows to run on the
server.

To Duplicate AutoActions to Run on the Server

1 Click the Server AutoActions icon on the Manage ribbon.

The Server AutoActions Manager window is displayed.

2 Right-click anywhere on the Server AutoActions Manager

window and select Add Multiple Rows.

The Duplicate Trigger AutoAction dialog box is displayed.

Pulse 4.12 User Guide 1748

3 Enter the number of AutoAction row copies to add on the Quantity
field.

4 Provide the Name Formula (i.e., AutoAction[2+1]).

5 Provide the Trigger Formula (i.e.,

Trigger:|PCIM!AutoAction1.almack
Action:Set|![AutoAction1] [4+1]).

6 Click OK.

The above example duplicates the following automatic

actions/workflows to run on the server (up to 1000 AutoActions):

Trigger:|![BlockName].almack Action: [Set |![direct item] 1

Deleting an AutoAction
The Delete Row option on the pop-up menu allows the user to delete an
AutoAction row.

To Delete AutoActions

1 Click the Server AutoActions icon on the Manage ribbon.

The Server AutoActions Manager window is displayed.

2 Right-click anywhere on the Server AutoActions Manager

window and select Delete Row.

The selected AutoAction is deleted.

Pulse 4.12 User Guide 1749

Exporting TSV Files through the Server
AutoActions Manager
Exporting to TSV AutoActions TSV files can be performed through the
Server AutoActions Manager window.

To Export TSV Files via the Server AutoActions Manager

1 Click the Server AutoActions icon on the Manage ribbon.

The Server AutoActions Manager window is displayed.

2 Right-click on a row or rows and select Export All Rows to TSV on

the pop- up menu.

-or-

Select the automatic actions/workflows from the list and click the
Export to TSV option on the toolbar to export the selected
AutoActions TSV files.

3 Save the file as an Auto Actions TSV file type.

Importing TSV Files through the Server

AutoActions Manager
Importing from TSV AutoActions TSV files can be performed through the
Server AutoActions Manager window.

To import TSV files via the Server AutoActions Manager

1 Click the Server AutoActions icon on the Manage ribbon.

The Server AutoActions Manager window is displayed.

2 Right-click anywhere on the window and select Import All Rows

from TSV on the pop-up menu.

-or-

Click the Import from TSV option on the toolbar to import

AutoActions TSV files.

3 Save the file as an Auto Actions TSV file type.

Pulse 4.12 User Guide 1750

Defining the Project Configuration
In the Project Configuration Manager, you can configure your projects
settings from the client workstation. The Configuration Manager contains a
list of common properties that you may modify. To modify a property
value, you expand the property tree and click the property name, which
presents you with the necessary means, and if applicable, choices for
changing the value.

To open the Project Configuration Manager

 In the Developer Workstation’s Manage ribbon, click the Project

Configuration icon.

The Project Configuration Manager is displayed.

To edit project configuration properties

1 In the Developer Workstation’s Manage ribbon, click the Project

Configuration icon.

The Project Configuration Manager is displayed.

2 On the left pane, choose the property from the tree, expanding
branches as necessary.

Click the property name to display its value, its description, and
additional configuration data (metadata) in the right pane.

Pulse 4.12 User Guide 1751

3 On the right pane’s upper section, edit the value as you require.

To cancel the latest change before saving it, click the Undo Last
icon.

4 On the toolbar, click the Save icon to save the change(s).

In some instances, you may have to restart the Pulse server or the
workstation after changing a configuration property. In such a case,
select the appropriate Restart icon in the Project Configuration
Manager toolbar.

Pulse 4.12 User Guide 1752

Workstation Tools
This section contains the following topics:

 The DataScope Module

 The Item Explorer

 The Alarm Explorer

 The Server Manager

 The Schedule Manager

 User Manager

 Shift Manager

 Pulse Logger Window

 The Supreme Report

Pulse 4.12 User Guide 1753

The DataScope Module
During project development and runtime, use the Data Scope module as a
diagnostic tool to test the validity of item values, action commands,
connectivity and alarm conditions. As you build your project, you can
enter strings that you want to check. After you enter your string, the Data
Scope shows the current value of the item (you can force another value
manually), the current value’s validity status (Good, Bad, LastGoodValue,
Unknown, NotMonitored, Future), the timestamp of the value, and the
access rights (Read only, Read/ Write, Write Only, Unknown) - all
automatically updated according to data changes.

Additionally, the Data Scope can also be used while installing and
integrating the project in the workplace. In the communications layer, use
the Data Scope to check that communication between the Pulse Server
and the PLC is occurring normally.

The Data Scope is available in both the Developer Workstation and the
Operator Workstation. You may open several instances (windows) of the
Data Scope, each referencing a different server and topic combination,
and can save the list of data items monitored in each window (to
conveniently monitor the same items from session to session).

Data Scope supports the use of aliases while entering strings.

Data Scope assumes the security level of the most recent login to the
Operator Workstation.

NOTE Before starting Data Scope, make sure that it is connected to

the Pulse Server (DBSR) and that the Pulse application is
running.

Pulse 4.12 User Guide 1754

The Data Scope columns have the following functions:

Name Enter the item, command, or event string that you

want to check.

Item
The Item column is displayed when the
Show Items icon is clicked and is not displayed
when the Hide Items icon is clicked.

The Item column translates the alias.

Value After entering the name, a default value appears in

this column. To force a different value, type it
manually.

Status Notifies if the name and value are valid and

received by the Pulse Server: Good, Bad,
LastGoodValue, Unknown, NotMonitored,
Future.

AccessRights Displays the read/write attribute of the command

or string:

Read only, Read/Write, Write only, Unknown.

TimeStamp Date and time of the Data Scope entry.

To check a string or command using the Data Scope

1 From the Developer Workstation’s Tools ribbon, click the Data

Scope icon.

The Data Scope window is displayed.

2 In the Name column, type an item, command, or event string that

you want to check (or assemble it in the Item Manager ).

3 Click the Show Items icon to display an additional column

called Item.

The Item column translates the alias.

4 In the Value column, a default (current) value appears. To test a

different value, type it manually.

A notification about the Name’s and Value’s validity or status

appears immediately in the Status column. Additionally,
AccessRights and TimeStamp information for the entry appears.

Pulse 4.12 User Guide 1755

This section contains the following topics:

 Working with the DataScope

 Enabling Synchronous Write Update to a DataScope Entry

Working with the DataScope

This section describes the general actions that you perform in the Data
Scope. Data Scope checks are composed from a combination of these
actions:

Add an item to the Data Scope. Clicking this button

opens the Item Manager, in which you can
assemble the item, command, or action string.

Remove the selected entry’s information from the

Data Scope. No confirmation is requested.

Add all items from a Data Scope group to the

current Data Scope sequence. Clicking this button
opens the Add Item(s) From Group dialog box,
from which you select the Group.

Run all items from a Data Scope group. This group

replaces all the entries in the current Data Scope
sequence. Clicking this button opens the Open
Group dialog box, from which you select the
Group.

Save all the items in the current Data Scope

together in the current Data Scope group.

Save all the items in the current Data Scope

together in a new Data Scope group.

Pulse 4.12 User Guide 1756

 Delete a Data Scope group from the project.
Clicking this button displays a warning that you are
about to delete the entire current group. Click Yes
to confirm.

Enables the selected item to update its Read value

at a synchronous (constant) rate.

Enables the selected item to update its Write value

at a synchronous (constant) rate.

Clear all entries in the current Data Scope.

Keep the Data Scope on top of all other open

windows at all times.

Enabling Synchronous Write Update to a DataScope

Entry

Clicking the Synchronous Write button enables you to update the

selected item’s Write value at a synchronous (constant) rate.

To enable a synchronous Write update of an entry

1 In the Data Scope module, click the entry that you want to update.

2 Click the Synchronous Write button.

The New Item Value dialog box is displayed.

3 Enter the value to which the entry updates regularly and click OK.

Pulse 4.12 User Guide 1757

The Item Explorer
The Item Explorer allows you to monitor the status of the Pulse Host’s
items, such as functions and arguments. In the Item Explorer, the data is
accessed through the Host tree with various functions represented by
branches in the tree, and presented in tables for each function group.

In the Item Explorer, you turn on Monitoring in the toolbar,

browse through the tree to a specific function, and then view the current
status of the arguments and commands.
To open the Item Explorer

 From the Tools ribbon, click the Item Explorer icon.

The Item Explorer window is displayed.

The following information is displayed in the Item Explorer:

Name Full name, including the Pulse host and function of
the command.
Value Configured value for the command.
Status Returns the validity of the command and its
connection to the Pulse Server (Good, Bad,
LastGoodValue, Unknown, NotMonitored, Future)
Time Stamp The exact time and date that the check occurred.
Access Rights Access rights for the command (Read only,
Read/Write, Write Only, and Unknown).

Pulse 4.12 User Guide 1758

Item Explorer Tasks
In the Item Explorer, you can do the following:

 Explore Items

 Add to Explored Items

 Monitor the status of functions and arguments

 Save a set of functions and arguments as a Data Scope group

You may initiate the above functions from the toolbar near the top of the
Item Explorer window.

Display the items of the selected tree branch.

Clicking the Recursive button displays all items in
Explore the selected branch, including those in subfolders.
Items/Recursivel
y

Add the items of the selected tree branch to the

currently displayed Item Explorer table. Clicking the
Add
Recursive button adds all items in the selected
to Explored
branch, including those in subfolders.
Items/
Recursively These commands let you display items from
multiple branches together in the same table.

Check the status of the items listed in the Item

Explorer window. The status check functions
similarly to the Data Scope.

Select all items that are currently displayed in the

Item Explorer table.

Clear all items from the Item Explorer table.

NOTE This command only removes the items from the view - it does
not delete them from the project.

Save the listed items as a Data Scope Group, which

you can open up in the Data Scope to check when
required.

Pulse 4.12 User Guide 1759

The Alarm Explorer
The Alarm Explorer is a tool you can use to organize, monitor,
acknowledge, and analyze alarms and events on a plant-wide scope. It
supports the logical organization of your alarm and event points in their
hierarchic order (configured in a plant-wide manner with Database
Explorer).

The Alarm Explorer lets you view the following:

 Current Alarm situation

 A Log detailing a log history

 System messages

 Suspended alarms

The Alarm Explorer supports a tree structure of branches (zones). Two

trees, named "Functional" and "Location", graphically depict the physical
and the functional structure of the factory or place being monitored. You
can attach any alarm or event to a branch of either or both trees, to
graphically indicate the physical and functional impact of the specific
alarm or event.

In the Current view, you can monitor all the alarms and events currently
present in the system. The two panes of this window display the following
information:

 Tree View (left pane) - view the Functional or Location pattern of

alarms and events in your plant.

 List View (right pane) - view all the alarms and events of a
particular branch (and their details), and acknowledge and erase
alarms.

In the Log view, you can monitor all the alarm and event changes of state
that occurred in the system since it has been operated, unless configured
differently in the Project Configuration Manager’s Alarm parameters
(instructing Pulse to collect alarm data in an external log file).

The two panes of this window display the following information:

 Tree View (left pane) - view the Functional or Location pattern of

alarms and events in your plant.

 List View (right pane) - view all the alarm and event changes of
state of a particular branch (and their details).

Pulse 4.12 User Guide 1760

This section contains the following topics:

 Monitoring Alarms

 Acknowledging Alarms

 Managing Operator Authorization

 Archiving Alarms and Event Data

 Analyzing Alarms

 Filtering Alarms

 Alarm Filters for Log and System Messages

 Alarm Explorer Tasks

 Defining Popup on Alarm

 Purging Alarms at Pulse Server Startup

 Alarm Explorer Counters

 Alarm Explorer Filter Builder

 Alarm Explorer 'last selected filter' Runtime Option

 Alarm Explorer “Suspend Block/Branch Alarms

Pulse 4.12 User Guide 1761

To toggle between the Alarm Explorer views

1 In the Alarm Explorer toolbar, click one of the buttons as shown

in the illustration below:

Monitoring Alarms
Use the Alarm Explorer to monitor your alarms and events graphically in
various ways:

 Monitoring Alarms in Two Time Aspects

• In Current mode, view the status of each alarm and event at

the present time. The started, acknowledged, and cleared
time stamps of each one are shown in one line.

• In Log mode, view how alarms and events evolved over time.
Each change of state (started, acknowledged, cleared) is
shown in a separate line.

 Monitoring Alarms in their Hierarchic Order

You can display the hierarchy tree and/or the alarm and event
contents of a particular branch (zone) (similar to Windows Explorer
"All Folders" bar and "folder contents")

In the hierarchy tree you can do the following:

• See which branch (zone) has alarms.

• Choose which hierarchy tree, and which of its branches you

want to monitor.

• Monitor a branch exclusively (only alarms and events

assigned to that particular branch) or inclusively (including
alarms and events in all nested sub-branches),

Pulse 4.12 User Guide 1762

 Monitoring Alarms in Other Aspects

Choose which information fields you want to see in the list, and in
which horizontal order and column width.

Choose which alarms and events you want to see, according to both
their configured and their real-time properties. Configured
properties include: node, tag, type, priority, category, etc. Real-
time properties include: started, acknowledged, cleared, date &
time of the former, etc.

Managing Operator Authorization

You can allocate different authorization levels to various Advanced Alarm
Handler commands - to enforce your security and accountability scheme.

Archiving Alarms and Event Data

You can define the amount of alarm log data you want to keep on line
(how many days old) and have data older than that automatically
removed and archived in a separate, off-line file - to be stored away
and/or to be used to produce reports.

Analyzing Alarms
Use the Alarm Explorer as an open interface to process summary reports
out of your alarm and event history - to obtain meaningful information out
of this data:

The data of the entire plant is stored in dBASE IV files (including

associated index files), and the files are fully documented.

 You can use Pulse itself (versions bundled with Supreme Reports)
to produce reports automatically or manually.

 You can also use any other reporting software to produce off-line
and/or off-site reports.

Pulse 4.12 User Guide 1763

Filtering Alarms
You can use the following default alarm filters to hide alarms on the
current view of the Alarm Explorer.

 Show All

 Hide Cleared Alarms

 Hide Acknowledged Alarms

 Hide Cleared or Acknowledged Alarms

 Hide Cleared and Acknowledged Alarms

To find the filter options

1 Click the Tools ribbon and select the Alarm Explorer.

The Alarm Explorer window is displayed.

2 Click on the Filters icon.

A pop-up menu displays all the default filters.

NOTE When filtering ‘Value’ on the Alarm Explorer, the filter returns
incorrect results since the filter handles the values as strings
and filters them lexicographically.

Since values are textual, the filter compares texts and not numbers. You
can also create new alarm filters, see Filters for more details.

Pulse 4.12 User Guide 1764

Alarm Filters for Log and System Messages
The Alarm Explorer’s Log and System Messages views support two
default filters:

 Show All - displays all the logs

 Last 30 Days - displays all the logs of the last 30 days

Alarm Explorer Tasks

The Alarm Explorer toolbar, located at the top of the Alarm Explorer,
provides shortcuts to the various Alarm Explorer tasks, and is visible when
the Show Toolbar option is selected in the Pulse Alarm Explorer Settings
dialog box.

NOTE The toolbar illustrated below and all icons described below
appear in the Current Alarm View. Most, but not all, of these
alarms are also available from The Alarm Log and the System
Messages List.

Displays the Current Alarm View

Current
The selected branch is indicated on the left pane
when the user selects an alarm from the right pane
of the Alarm Explorer or the Alarm Explorer
instrument.

Displays the Alarm Log

Log

Pulse 4.12 User Guide 1765

 Displays the System Messages List
System
Messages

Suspends a block's alarms for a periodic duration

Suspend until the block is released from suspension.
View

Toggles between Functional and Location trees

Toggle Tree

Displays the Tree and Alarms only in the table

Tree and
Alarm

Displays Alarms only in the table

Alarms Only

Displays Trees only in the table

Tree Only

Displays Alarms and Zones (branches) in the table

Acknowledges the selected alarm

Acknowledge

Indicates Alarmed Branch, which is a branch with

Indicate active alarms. The indication is a either a “+”
Alarm which you can click to expand or a “-” which you
can click to collapse.

Views all alarms in a branch including all of its sub-

All Alarms in branches. When not selected, the list contains only
Branch alarms assigned to the selected branch.

Suspends the selected block; only available when

Suspend the

Unsuspends the suspended blocks that are

Unsuspend selected

Erases all alarms in the selected branch

Erase

Refreshes the list of alarms and event messages

Refresh List

Selects all alarms and event messages that are in

Select All the table

Pulse 4.12 User Guide 1766

 Deselects (removes highlight from) the selected
Clear alarms and event messages
Selection

Switches on/off the indication beep

Beep On When enabled; a new alarm triggers a beeping
Alarm sound.

Opens the Pulse Alarm Explorer Settings dialog

Settings box, in which you customize the appearance,
functionality, and alarm data fields displayed on
the Alarm Explorer.

Selects an existing filter for viewing Alarm Explorer

Filters alarms and event messages or creates a new filter

Saves the customized layout of the Alarm Explorer

Save as as its default layout
Default Settings

Displays the Preview window of the System,

Print Current or Log Alarms Report

The Alarm Explorer pop-up menu provides shortcuts to the following

Alarm Explorer tasks:

 Acknowledge - acknowledges alarm(s)

 Erase - deletes an alarm

 Copy Text to Clipboard - copies the selected cell(s) to the

clipboard

Right-click on any cell(s) on the Alarm Explorer window to access the

Alarm Explorer pop-up menu.

Pulse 4.12 User Guide 1767

Acknowledging Alarms
You can acknowledge alarms one at a time or several at the same time.
The Alarm Explorer records when they were acknowledged and by whom.

To acknowledge alarms

1 In the Alarm Explorer, select the alarm(s).

2 From the Alarm Explorer toolbar, click the Acknowledge icon.

3 Click Yes to confirm acknowledgement of the alarm(s).

4 In the Alarm Comment dialog box, type a free text description

string about the alarm(s) which will appear in the Alarm Explorer.

5 Click OK.

In the Alarm Explorer, the acknowledged alarm(s) are displayed in

the color defined in the Pulse Alarm Explorer Settings dialog box,
see Colors. The alarm entries include information about the
acknowledgment.

NOTE It is possible to acknowledge an alarm or alarms through the

Acknowledge alarm option on the pop-up menu when right-
clicking on the Alarm Explorer or Alarm Explorer instrument.

Pulse 4.12 User Guide 1768

Defining Popup on Alarm
The Alarm Explorer can now be configured to pop-up on the runtime
screen when an alarm is generated.

To set Popup on Alarm:

1 Select the Manage ribbon on the Developer Workstation and click

the Project Configuration icon.

The Pulse Project Configuration window is displayed.

2 On the Pulse Project Configuration Manager window, go to the

Property Name list and click General > Workstation >
Operating Mode - Popup Alarm Explorer on Alarm.

3 Go to the upper right pane, click the checkbox to enable the Run
Workstation on server side upon Pulse startup option.

4 Save the settings.

5 Restart the workstation for the settings to take effect.

Pulse 4.12 User Guide 1769

Popup on Alarm can also be configured and tested by using the
PFWALARMNG|PCIM!NotifyNewAlarm syntax in the Developer
Workstation Data Scope.

Popup on Alarm is set from the Developer Workstation but activated

through the workstation.

Purging Alarms at Pulse Server Startup

You can set up Pulse to remove (purge) all current alarms when the Pulse
server starts up. If the Purge Alarms on Startup option is enabled, any
current alarms that were still listed in the Alarm Explorer when Pulse last
shut down will not appear after Pulse starts down.

This option is defined in the Project Configuration Manager,

see Defining the Project Configuration.

To enable purging alarms at Pulse Server startup

1 In the Developer Workstation’s Manage ribbon, click the Project

Configuration icon.

The Project Configuration Manager is displayed.

2 In the left pane, expand the General > Alarm Publisher branches
and select Purging Alarms.

3 In the right pane’s upper section, select the Purge All Alarms on
Pulse Startup option.

4 In the Project Configuration Manager toolbar, click the Save

icon to save the change.

Pulse 4.12 User Guide 1770

Alarm Explorer Counters
Server ID: PFWALARMNG

Topic ID: Pulse

Alarms or Totalblocks

These are Read Only items. The value of the applied DDE address is the
quantity of existing alarms or blocks of the designated type within the
specified location.

Access
Type Syntax Description Rights

Ack PFWALARMNG|PCIM!Ack( Acknowledged Read

tree/ branch path) alarms only

Act PFWALARMNG|PCIM!Act( Active alarms only Read

tree/ branch path)

ActAck PFWALARMNG|PCIM! Active and Read

ActAck(tree/ branch path) acknowledged
alarms

Pulse 4.12 User Guide 1771

 Access
Type Syntax Description Rights

ActNAck PFWALARMNG|PCIM!ActN Active and NOT Read

Ack(tree/branch path) acknowledged
alarms

All PFWALARMNG|PCIM!All( All the alarms and Read

tree/ branch path) events that are
currently displayed
in the branch/ tree

Event PFWALARMNG|PCIM! Events only Read

Event(tree/ branch path)

NActAck PFWALARMNG|PCIM!NAct NOT active and Read

Ack(tree /branch path) acknowledged
alarms

NActNAck PFWALARMNG|PCIM!NAct NOT active and Read

NAck (tree/branch path) NOT acknowledged
alarms

TotalBlocks PFWALARMNG|PCIM!Total Database blocks Read

Blocks(tree/branch path) that are enabled
with Advanced
Alarm Handler
properties

LastAlarm PFWALARMNG|PCIM!LastA Last alarm Read

larm(tree/branch path)

AckBranch PFWALARMNG|PCIM!AckB Acknowledge Write

ranch(tree/branch path) Branch

EraseBranch PFWALARMNG|PCIM!Eras Erases the branch Write

eBranch(tree/branch or tree
path)

CURR!Alarms PFWALARMNG|CURR!Alar Returns the last Read

ms(tree/ branch path) alarms

LOG!Alarms PFWALARMNG|LOG!Alarm Displays a log of Read

s(tree/ branch path) the last alarms

The syntax of each counter type is followed by the path of the branch or
tree. The path is within the parenthesis.

Example

PFWALARMNG|LOG!Alarms(Functional/Floor1)

Pulse 4.12 User Guide 1772

Alarm Explorer Filter Builder
Pulse has SQL functions that enable the user to retrieve and filter more
‘day and time’ related information from the database.

The following are Alarm Explorer Filter Builder SQL functions:

Function Description

GETDATE() Returns the current date and time

DATEPART() Returns a single part of a date/time

DATEADD() Adds or subtracts a specified time interval from a

date

DATEDIFF() Returns the time between two dates

CONVERT() Displays date/time data in different formats

GETDATE() Returns the current date and time

DATEPART() Returns a single part of a date/time

DATEADD() Adds or subtracts a specified time interval from a

date

DATEDIFF() Returns the time between two dates

CONVERT() Displays date/time data in different formats

Example

To create an alarm filter to show alarms generated in the last 30

days

"[Start Time] > DATEADD(‘day’, -30, GETDATE())"

Pulse 4.12 User Guide 1773

Alarm Explorer 'last selected filter' Runtime
Option
The Alarm Explorer supports the 'last selected filter' runtime option.

At runtime, the 'last selected filter' option in the Alarm Explorer is set
according to the Alarm Explorer’s Current, Log, or System Messages in the
Alarm Explorer windows.

The Filters list toolbar option shows the current filter for the current
Window type.

Alarm Explorer “Suspend Block/Branch Alarms

The Suspend Branch/Block Alarms feature is used to suspend a block's
alarms for a periodic duration until the block is released from suspension.

The branch/block alarms are suspended usually when maintenance for the
application is performed.

Branch alarms can be suspended from the following:

 From the Alarm Explorer Suspend View, Tree and Alarm’s view,
Tree Only view

 Supported commands

Block alarms can be suspended from the following:

 From the Alarm Explorer Suspend View, Alarms Only view, Tree and
Alarm’s view, Tree Only view

 Supported commands

Using Suspend/Unsuspend in the Alarm Explorer

All blocks with suspended and unsuspended alarms are shown in the
Alarm Explorer Suspend view. The Suspend view displays the Block Name,
Block Description, Suspended Start Time, Suspended End Time,
Suspended By and a comment.

The suspend action can be performed on a Block or a Branch. When

performing Suspend on a block or branch that currently has no activated
alarm; all block alarms related to the branch will have their alarm
suspended.

Pulse 4.12 User Guide 1774

To suspend alarms

1 Suspend can be performed from the Functional/Location tree by

right-clicking on the Branch/Block alarm name and selecting
Suspend from the pop-up menu.

or alarms can be suspended or unsuspended by clicking the

Suspend or Unsuspend icons respectively.

2 After selecting the Suspend command either from the clicking the
Suspend icon on the menu or from the pop-up menu; the
Suspend Block dialog box is displayed.

Pulse 4.12 User Guide 1775

3 Define the alarm suspend duration in days in the Suspend for
(Days) field.

or

Define the alarm suspend duration in hours and minutes in the

Time (HH:mm) field.

or

4 Click to select the Forever option if you prefer the suspend action
to apply indefinitely.

5 Write a comment in the Comment field if required.

Alarm Publisher Suspend Items

The Alarm Publisher supports the following Suspend items:

 PFWALARMNG|PCIM!SUSPENDEDBLOCK

Displays the last suspended block name

 PFWALARMNG|PCIM!SUSPENDEDBRANCH

Displays the last suspended branch name

 PFWALARMNG|PCIM!UNSUSPENDEDBLOCK

Displays the last unsuspended block name

 PFWALARMNG|PCIM!UNSUSPENDEDBRANCH

Displays the last unsuspended branch name

Pulse 4.12 User Guide 1776

 PFWALARMNG|PCIM!SUSPD(branchID, criteria)

This item is used to list suspended block alarms belonging to the

branch and all of its sub-branches

Example:

PFWALARMNG|SUSPD!Alarms(Functional)

View the suspended block alarms of the branch from the Value
column in the Data Scope.

 PFWALARMNG|PCIM!SUSPENDBRANCH([Branch Name])

is a branch command/item supported by the Alarm Publisher. It

suspends all the blocks’ alarms included in the branch.

• SuspendBranch([Duration in Minutes] / Forever=-1/

Unsuspend=0)

Example:

PFWALARMNG|PCIM!SUSPENDBRANCH(Functional)

Pulse 4.12 User Guide 1777

 PFWALARMNG|PCIM![Node Number]:[Block Name]).
suspendblock

is a block command/item supported by the Alarm Publisher. It

suspends all the alarms of a block.

• SuspendBlock([Duration in Minutes]/Forever=-1/
Unsuspend=0)

Example:

PFWALARMNG|PCIM!0:A1.SUSPENDBLOCK

Suspended Alarms Logged in System Messages View

Suspended Alarms are logged and can be viewed from the Alarm
Explorer’s System Messages view.

Pulse 4.12 User Guide 1778

The Supreme Report
Use the Supreme Report Studio to quickly and easy design graphically rich
reports in PDF or Excel format. E-mail, print or view the reports from
anywhere in the world by surfing to the Supreme Report Web portal.

The Supreme Report program is an integral member of the Pulse system,

allowing for a seamless integration with your Pulse project and data
retrieval directly from the project’s database.

For more information about designing and generating reports using the
Supreme Reports program, click any of the links below refer to the
Supreme Report Help, which is accessible from the Pulse Online Help.

Supreme Report License

The Supreme Report requires 1 Runtime license for each workstation.

Starting Supreme Report

To start Supreme Report Studio

1 In the AFCON Pulse Program Group’s Development folder, double-

click the Supreme Report Studio icon.

2 In the Open Project dialog box, choose to start a new project or to

open an existing project.

3 Click New, or locate the existing project and click Open,

respectively.

Pulse 4.12 User Guide 1779

To start Supreme Report at Runtime

 In the AFCON Pulse Program Group’s Runtime folder, double-click

the Supreme Report Runtime icon.

The Supreme Report Runtime Engine is displayed.

To open the Supreme Report Web Portal

 In the Developer Workstation’s Tools ribbon, click the Supreme

Report icon and click Supreme Report.

The Supreme Report Web Portal is displayed in a window in the

Workstation.

Pulse 4.12 User Guide 1780

Generating a Printed Report
The Supreme Report Studio application does not contain a command to
print a report based on a triggering Pulse action. To define a trigger for
printing a full multi-page report, set the Report Settings.

To Generate a Printed Report

1 Open the selected report’s Report Settings.

2 In the Report File Format tab, select Printer.

If necessary, click Browse to select the specific printer.

3 In the Generate Report on Event tab, select Enable Generate

on Event.

4 Define the Pulse Data Source and Item Name which will trigger
the report printing.

5 Click OK.

Pulse 4.12 User Guide 1781

The Server Manager
The Server Manager is a client application that allows you to start, stop,
and change the startup type of the Pulse services.

To access the Server Manager

1 In the workstation’s Tools ribbon, click the Server Manager icon.

The Pulse Services dialog box is displayed.

2 Select a service and perform any of the required tasks

NOTE Only Pulse administrators (Security level = 0) are allowed to

perform the Start, Restart, and Stop service actions or change
the service startup type.

Status Options

Start Turn the service on. Click Start All to turn all
services on at the same time.

Pulse 4.12 User Guide 1782

 Restart Initiate the service from its startup, even if it’s
currently on.

Click Restart All to initiate all services at the

same time.

Stop Turn the service off. Click Stop All to turn all
services off at the same time.

Startup Type

Automatic The service will start during Windows startup

without need for further user action.

Manual The service can only start by user action (for

example, selecting the service in the Service
manager and clicking the Start link).

Disable The service is turned off, and will not start

unless its Startup type is changed to Automatic
or Manual.

Pulse 4.12 User Guide 1783

The Schedule Manager
The Schedule Manager allows you to schedule actions to start or occur at
specific times on specific days, and if necessary, as recurring actions.

In the Schedule Manager, you can define an action to run on the Pulse
server, the Pulse client workstation, or to use PLC schedules.

This section contains the following topics:

 Defining a Schedule

 Defining a Recurring Task

 Adding a Special Day to a Schedule

 Adding an Items Assignment to a Schedule

 Associating a Dynamic Graphic Object with a Schedule

 Changing a Schedule Manager’s View

Pulse 4.12 User Guide 1784

Defining a Schedule
You can arrange actions to take place within a schedule, and then activate
schedules as required.

To add a schedule using the Schedule Manager

1 In the Workstation Tools ribbon, click the Schedule Manager

icon.

The Schedule Manager is displayed.

2 Click New from the Schedule Manager menu and then select one
of the following in the sub-menu:

Start/Stop A start/stop sequence is a digital action or

Schedule event sequence (value = 1 for “on” or 0 for
“off”) that will occur at a specific time.

Tasks Schedule A task is an action that runs at a scheduled

time, has no defined end time, and can run on
the server or the client.

PLC Start/Stop For systems where the controller or PLC define

Schedule the times of dynamic actions, you can set a
schedule to download (send) to the controller
or upload (get) a schedule file from the
controller and edit it as required in the
Schedule Manager.

NOTE The PLC Start/Stop Scheduling is supported by some, but

not all drivers. For drivers not supporting it, this feature is not
applicable.

A new schedule name appears in the Schedule Manager.

Pulse 4.12 User Guide 1785

To define a task in the schedule

1 In the Schedule Manager, open the Tasks tab and select the
relevant schedule name to open its calendar.

2 In the calendar, right-click on the time slot in which you want to

schedule the action or event and select New Task from the drop-
down menu.

The Task dialog box is displayed.

3 Define the scheduled task as follows:

Name Type a free text name or description of the

task.

Start Time Choose the date and time for the task to start.

Action Specify the action or workflow that Pulse will

execute at the specified time.

To define the object’s data item, enter an

action command or workflow.

• You can type it manually.

When manually typing a command

to execute a workflow, add a
workflow prefix (WF).

For example, WF:Alert_in_B4

When manually typing an action,

use standard syntax.

-or-

Pulse 4.12 User Guide 1786

 • Open the Action Selector to
assemble and/or choose the
command or workflow (.

NOTE After you enter a workflow, it

appears in the relevant edit box in
the following syntax:

[WorkflowName] [arguments]

Run in Client Select this option to execute the action on a

Side client workstation.

Recurrence Click this button to set recurrence parameters

if you want the action to occur again at
regularly scheduled times. For more details
about setting a recurring task, see Defining a
Recurring Task.

4 Click OK.

The task is now in the object’s schedule.

To define a start/stop sequence in the schedule

1 In the Schedule Manager, open the Start/Stop tab and select

the relevant schedule name to open its calendar.

2 In the calendar, double-click the time slot in which you want to

schedule the sequence.

The New Start/Stop dialog box is displayed.

Pulse 4.12 User Guide 1787

3 Define the scheduled sequence as follows:

Name Type a free text name or description of the

sequence.

Start Time Choose the date and time for the sequence to
start.

End Time Choose the date and time for the sequence to
end.

On/Off On - Select whether the associated item’s

“1=On” value will occur at the Start Time or
the End Time.

Off - The “0=Off” value will occur at the

opposite time.

Dynamic Item Select this option to associate this activity with

varying items.

Selecting this option disables the Item

parameter.

Item Specify the item name (or select it in the Item

Manager) that Pulse will execute at the
specified time. This parameter is only available
if Dynamic Item is not selected.

Recurrence Click this button to set recurrence parameters

if you want the action to occur again at
regularly scheduled times. For more details
about setting a recurring task,
see Defining a Recurring Task.

4 Click OK.

The start/stop is now in the object’s schedule.

Pulse 4.12 User Guide 1788

To define a PLC start/stop sequence in the schedule

NOTE The PLC Start/Stop Scheduling is supported by some, but

not all drivers. For drivers not supporting it, this feature is not
applicable.

1 In the Schedule Manager, click the PLC Start/Stop tab and

select the relevant schedule name to open its calendar.

2 In the calendar, double-click the time slot in which you want to

schedule the sequence.

The New PLC Start/Stop dialog box is displayed.

3 Define the scheduled sequence as follows:

Name Type a free text name or description of the

sequence.

Start Time Choose the date and time for the sequence to
start.

End Time Choose the date and time for the sequence to
end.

On/Off On - Select whether the associated item’s

“1=On” value will occur at the Start Time or
the End Time.

Off - The “0=Off” value will occur at the

opposite time.

Pulse 4.12 User Guide 1789

 Dynamic Item PLC Scheduling supports the execution of
dynamic items only.

A static item cannot be set for a PLC

Start/Stop schedule.

Item Specify the item name (or select it in the Item

Manager) that Pulse will execute at the
specified time. This parameter is only available
if Dynamic Item is not selected.

Recurrence Click this button to set recurrence parameters

if you want the action to occur again at
regularly scheduled times. For more details
about setting a recurring task, see Defining a
Recurring Task. Only Weekly and Special Days
recurrence is supported by the PLC Scheduling.

4 Click OK.

The start/stop item is now in the schedule.

Pulse 4.12 User Guide 1790

Defining a Recurring Task
You can schedule a task to run repeatedly at regularly scheduled times, or
to run automatically on Special Days such as holidays.

1 Perform the “To define a task in the schedule” procedure described

above.

2 Click Recurrence.

The Task Recurrence dialog box is displayed.

3 Define Recurrence parameters as follows:

Recurrence Pattern

Daily Set action to occur at the same time every

day, every weekday, or at a constant number
of days (for example, every 3 days).

Weekly Set action to occur once a week, or at a

constant number of weeks (for example, every
3 weeks) on the same day of the week, at the
same time.

Pulse 4.12 User Guide 1791

 Monthly Set action to occur once a month, or at a
constant number of months (for example,
every 3 months) on the same date of the
month, at the same time.

Yearly Set action to occur once a year on the same

date, at the same time.

Special Days Set action to occur on the days defined as

Special Days, see Adding a Special Day to a
Schedule

Every __ days Set action to occur on the specified number of

days.

Every weekday Set action to occur every day of the week.

Range of Recurrence

Start Set the date for the first time the action takes
place.

No End Date The action or event will recur at the specified

interval indefinitely.

End after Choose the number of times that the action or

event recurs, after which it does not occur
anymore.

End by Choose the last possible date for the event to

recur, after which it does not occur anymore.

4 Click OK to insert the recurring action into the schedule.

NOTE To remove a recurring event from the schedule, click Remove

Recurrence.

Pulse 4.12 User Guide 1792

Adding a Special Day to a Schedule
Special Days are holidays or days that are designated as not routine. The
Scheduler Manager allows you to add these Special Days to the calendar
so that you can schedule recurring tasks to run automatically on those
days, see Defining a Recurring Task.

To add Special Days to the schedule

1 In the Workstation Tools ribbon, click Schedule Manager.

The Schedule Manager is displayed.

2 In the Schedule Manager toolbar, click Tools and then Special

Days.

The Special Days dialog box is displayed.

3 In the Special Days dialog box, select a group in the table on the
left. If necessary, click the “+” button below the table to add a
group.

4 Select a date in the calendar and click the “+” button below the
calendar to attach it to the group. Repeat this step to add as many
dates as required.

Pulse 4.12 User Guide 1793

5 Click Apply to make the change but keep the Special Days dialog
box open, or OK to make the change and close the dialog box.

A message appears stating that Pulse will save all edited but
unsaved rules, and that it will delete any tasks that were scheduled
in Special Day groups that were removed.

6 To continue to apply your changes, click Yes.

The Special Days will appear in red on the Schedule Manager’s

calendar.

Adding an Items Assignment to a Schedule

You can assign items which will get or change their values at the times
defined in an associated schedule. An item may be attached to only one
schedule. However, multiple items may be attached to the same schedule.

Items assignment may be attached to:

 Pulse-based schedule

 PLC-based schedule

To assign an item to a Pulse-based schedule

1 In the Workstation Tools ribbon, click Schedule Manager.

The Schedule Manager is displayed.

2 In the Schedule Manager toolbar, click Tools, point to Items

Assignment, and click Pulse.

The Items Assignment dialog box is displayed.

Pulse 4.12 User Guide 1794

3 Click the “+” button to add an item entry.

The Append Item dialog box is displayed, in which you write or

assemble the item action.

4 Specify the item and its schedule as follows:

Start/Stop Choose the schedule to which to attach the

item.

Item Type an item or command (or assemble it in

the Item Manager ).

5 Click OK to add the new assignment to the Items Assignment

list.

6 To delete an entry from the Items Assignment window, select it

and then press the “-” button.

To navigate through the list, press the various arrow buttons below
the list.

Pulse 4.12 User Guide 1795

To assign an item to a PLC-based schedule

1 In the Workstation Tools ribbon, click Schedule Manager.

The Schedule Manager is displayed.

2 In the Schedule Manager toolbar, click Tools, point to Items

Assignment, and click PLC.

The Items Assignment dialog box is displayed.

3 Click the “+” button to add an item entry.

The Append Item dialog box is displayed, in which you write or

assemble the item action.

Pulse 4.12 User Guide 1796

4 Specify the item and its schedule as follows:

Start/Stop Choose the schedule to which to attach the item.

Item Type an item or command (or assemble it in the

Item Manager ). The item be in written in the
format:

[|Server][!Topic]:[Port]:[PLC]:[address]

For example, |!1:1:40001

Download to PLC Click to send the selected Pulse Schedule file for
the described items to the controller or PLC.

Upload from PLC Click to get the Schedule file from the controller
or PLC, and from it, update the data in the
selected Pulse Schedule file.

5 Click OK to add the new assignment to the Items Assignment

list.

6 To delete an entry from the Items Assignment dialog box, select

it and then press the “-” button.

To navigate through the list, press the various arrow buttons below
the list.

To download to PLC

1 In the Items Assignment window, click the Download to PLC

button.

The Schedule Manager window displays the downloaded item and

its status.

2 Click OK to continue.

Pulse 4.12 User Guide 1797

To upload to PLC

1 In the Items Assignment window, click the Upload from PLC

button.

The Schedule Manager window displays the quantity of the items

uploaded from the PLC.

2 Click OK to continue.

Pulse 4.12 User Guide 1798

Associating a Dynamic Graphic Object with a
Schedule
In the Operator Workstation, you can attach a dynamic Graphic Object to
one of the defined schedules. The object’s item will change its value at the
times defined in the associated schedule.

An item may be attached to only one schedule. However, multiple items

may be attached to the same schedule.

If your PLC supports scheduled actions, you can download and upload the
object’s associated schedule to and from, respectively, the PLC.

To associate a dynamic Graphic with a schedule

 In the Operator Workstation, right-click the Graphic object, point to

Schedule To in the menu, and choose the schedule to associate
with the object.

To download an object’s associated schedule file to the PLC

 In the Operator Workstation, right-click the Graphic object, and

choose Download Schedule. Pulse sends the object’s associated
schedule file to update the PLC.

To upload a schedule file from the PLC in order to update the

object’s schedule data

 In the Operator Workstation, right-click the Graphic object, and

choose Upload Schedule. Pulse gets the Schedule file from the
PLC, and from it, updates the data in the object’s associated Pulse
Schedule file.

Pulse 4.12 User Guide 1799

Changing a Schedule Manager’s View
The user can switch to one of Schedule Manager’s five different available
views:

 Day View

 Workweek View

 Week View

 Month View

 Timeline View

To change a Schedule Manager’s View

1 Click the Tools ribbon and click Schedule Manager.

The Schedule Manager window is displayed.

2 Right-click on the right pane of the Schedule Manager and click

Change View To from the pop-up menu.

3 Select one of the available views to change to a specific view.

Pulse 4.12 User Guide 1800

Scheduling via Expression Solver Functions
The following are Expression Solver Functions that can be used with
Scheduling:

GetScheduleList Returns the list of schedule file names with a

CRLF/Enter separator

Syntax: GetScheduleList()

Examples of schedule files names with

CRLF/Enter separator:

• Schedule_File1

• Schedule_File2

• Schedule_File3

GetScheduleName Returns the schedule rule name for the

specified advised item.

Syntax:
GetScheduleName(advisedItemStr)

Pulse 4.12 User Guide 1801

User Manager
Defining Users and their Security Levels
A User is any person who is authorized to access any feature or function
of Pulse. In the User Manager, you create and define user accounts for all
users that need to access the Pulse system. Only users who have account
entries in the User Manager are allowed to log in.

A user account consists of an assigned level (0-99) and a set of

permissions (Developer, Operator, Monitor, Monitor and Control, Account
Enabled).

To define Users

1 In the Pulse application’s Tools ribbon, click User Manager.

2 Click the Add User icon.

The Add New User dialog box is displayed.

Pulse 4.12 User Guide 1802

3 Define User properties as follows:

Enable account Select this option to activate this account.

User must Select this option for the user to change the
change password at the next login.
password at next
login

Account name Type the user name.

Full name Type the full name of the account owner.

Password Type the password.

Confirm Type the password again.

password

E-mail address Type the account owner’s e-mail address.

Pulse 4.12 User Guide 1803

 Skin Choose a skin for this user.

Application Choose the language of projects (controls,

language indicators, messages) for this user.

System language Choose the language of the Pulse interface

(menus, dialog boxes, messages) for this user.

Authorizations

Security key Assign the security key for this user (Use Level0,
User Level99).

Expiration Date Provide the expiration date for the authorization.

Developer Select this option to give the user Developer

permissions.

Operator Select this option to give the user Operator

permissions. If this option is enabled, select
either the Monitor or Monitor and Control
level.

Monitor Select this option to give the user permission to

view activity only.

The option is only active if Operator is selected.

Monitor and Select this option to give the user permission to

Control view activity and perform limited interactivity
during runtime.

The option is only active if Operator is selected.

Event Select this option to give the user permission to

Management use the Event Management feature.

The option is only active if Operator is selected.

4 Click OK.

Pulse 4.12 User Guide 1804

Removing Users from the System
To remove users from the system:

1 In the Pulse application’s Tools ribbon, click User Manager.

2 Select the user entry that you want to delete.

3 Click the Delete User icon.

A confirmation request is displayed.

4 Click Yes to continue the deletion.

Shift Manager
The Shift Manager is a Pulse scheduling solution that allows you to
assign users to groups, manage, and track shifts. It enables you to define
the working hours for a user or multiple users via the Shift Manager
Editor. You can assign a user to multiple shifts or allowed full access. If
you do not assign a user to any shift, then the user cannot access the
Shift manager at all unless specified otherwise.

The user can log into Pulse according to the user's shift.

The user may not be allowed to access Pulse when not on shift depending
on the Shift Manager/User Manager settings.

Pulse 4.12 User Guide 1805

Managing Shifts
To manage shifts:

1 In the Developer Workstation, go to the Tools ribbon and click

Shift Manager.

The Shift Manager window is displayed.

2 Click the Settings button.

The Shift Manager Settings dialog box is displayed.

Pulse 4.12 User Guide 1806

3 Define the shift by first selecting a day from the First day of week
drop-down list.

4 Click to select the Enable Shift Manager checkbox option to

enable Shifts. If the checkbox is not enabled, the Shifts
functionality will be disabled and not applied to Pulse users.

5 In the table, enter the shift name in the Shift row, define the time
when the shift would start in the Shift Begins at row, then define
when the shift would end in the Shift Ends at row.

6 Assign a color on the Color row.

7 Create other shifts as necessary then click OK.

NOTE For the new shift settings to take effect, it is necessary to

restart the server.

The Shift Manager Settings dialog box is displayed.

8 In the Shift Manager Settings dialog box, select a user from the
Users table and drag it to a defined shift or multiple shifts as to
assign the user as many shifts as required.

9 You can add another user to one or more shifts as necessary.

10 Click Save.

11 To delete a user’s shift allocation from a specific Shift, right click on

the user's shift allocation and select Delete from the context menu.

12 Click Save.

Pulse 4.12 User Guide 1807

Copying Shift Assignments
To copy shift assignments to other periods of time (multiple
shifts)

1 In the Shift Manager Settings dialog box, click the Copy button.

The Copy Shifts assignments dialog box is displayed.

2 Define the starting week to copy from the assigned shifts available
in the From week beginning on drop-down list.

3 Define the week when to stop copying from the assigned shifts
available in the To week beginning on drop-down list.

4 Define the number of weeks to copy in the Copy to __ following

weeks field.

5 Click Copy.

The Copy Shifts result window displays the number of shift

assignments successfully copied.

Pulse 4.12 User Guide 1808

Printing Shift
Shift Schedules may also be printed by selecting the Print button.

In the Page Setup dialog box’s Format tab, print layout styles can be
chosen.

Use the Options parameters to select the required start and end date and
time as necessary.

Pulse 4.12 User Guide 1809

User Allocation for the Shift Manager
To enable User allocation for the Shift Manager, the Shift checkbox
must me checked for each required user. This is done in the User
Manager module by checking the Shift checkbox option in the Add User
dialog box.

Pulse 4.12 User Guide 1810

AutoActions for the Shift Manager
In the AutoActions tab of the Operator Personalization Settings
dialog box, the user can enable an action such as an auto logout at the
end of the shift via the On Shift End field option.

Pulse 4.12 User Guide 1811

Pulse Logger Window
The Pulse Logger window displays the current project’s system messages
on the client workstations and the server.

To define the types of messages that appear in the Logger window, you
must enable this ability in the Logger Policy window’s Destination
parameter, see Logger Policy

Defining Logging Policies.

Accessing the Pulse Logger Window

The Pulse Logger window may be accessed from either the Pulse Client
(both Developer and Operator Workstations) or the Pulse Server.

To access Logger Window from the Pulse Client

 From the Workstation’s Tools ribbon, click Logger Window.

To access Logger Window from the Pulse Server

 In the AFCON Pulse Program Group’s Tools folder, double-click the

Log Window icon.

Pulse 4.12 User Guide 1812

The following information appears in the Logger window:

Sender Time The time stamp of the system clock of the data source
Stamp (such as a connected PLC) indicating when it sent the
message.

Receiver Time The time stamp of the system clock of the Pulse Kernel
Stamp indicating when it received the message.

Message A data string describing the alarm, event, or

information.

Type All messages are of one of the following types:

Debug, Informational, Warning, Error, Critical, Audit

Trail, Application Event, Application Activity, Security
Event, Operator Message.

Category The component or module from where the message

originated.

Severity Indicates the level of severity - which users should

handle the message and its priority in relation to other
messages. The range is 0-99. The lowest numbers
indicate the highest severity and the highest numbers
indicate the lowest severity.

Workstation The name of the Client workstation or Server from

Name where the message originated.

User Name The name of the user logged into the Client
workstation or Server from where the message
originated.

Error Code The number assigned to the event, alarm, or message

which helps identify the problem, regardless of the
localized language used with your Pulse application.

Additional Data Occasionally, a type of message will include additional

important details.

Pulse 4.12 User Guide 1813

The Pulse Client Operator
Workstation
By default, Pulse starts up in runtime mode, opening the Operator
Workstation. The startup mode may be changed in the Security level
configurations.

The following figure illustrates the Operator Workstation.

For more information about personalizing the Operator Workstation for

various users, see Operator Personalization Workstation Settings.

Pulse 4.12 User Guide 1814

This section contains the following topics:

 Operator Workstation - Description

 Quick Access Toolbar (Operator Workstation)

 Opening a Display in the Operator Workstation

 The DataScope Module

 The Item Explorer

 Entering Text Input

 AutoAction

 Smart Information

 Displaying a Graphic Object’s Historical Trend

 Associating a Dynamic Graphic Object with a Schedule

 Showing and Hiding Layers

 Restricting Operator Workstation Open and Close Display

Commands

Pulse 4.12 User Guide 1815

Operator Workstation -
Description
The Operator Workstation is the Pulse Client’s runtime operational
interface. It is the environment in which operators view and interact with
objects created in the Developer Workstation, in order to monitor and
control actual real-time processes and/or equipment operation to which
the objects correspond.

Operators can interact by pressing on objects with the mouse pointer, or

by typing on the keyboard. Real-time data can be displayed in text objects
and counters, while historical trends can also be shown in graphs.

The Operator Workstation Ribbon contains only runtime programs and

tools intended to be used by the operators running the project, because
operators do not use any of the development functions that are present in
the Developer Workstation. In the Operator Workstation Personalization,
available in the Developer Workstation, the visible icons and menus are
assigned to each operator. Furthermore, in the Menu Authorization dialog
box, menu, and menu command availability are assigned to the various
security locks configured for your system.

For example, operator access to the Open, Close, and Revert to Saved
commands may be restricted. This prevents operators from opening
displays other than those that open during Operator Workstation startup.

The following tools may be available to operators during runtime,

depending on their security key and the menu authorization settings:

Data Scope Allows users to monitor and change the values and
statuses of data items from one window

Item Explorer Allows users to monitor and check changes in

expressions’ values from one window.

Alarm Explorer Allows users to view data block values and alarm/event
logs.

Supreme Report Allows users to produce graphically rich, analytical, and

secure reports from real-time data and collected
historical data.

Pulse 4.12 User Guide 1816

Historical Trend Allows users to retrieve current and historical
information from the database about a selected object,
and view this information in trend graphs covering
various time periods.

Scheduling Allows users to attach a graphic object’s actions and

behavior to a defined schedule, which may take off-
days and other pre- scheduled downtime into
consideration.

Pulse 4.12 User Guide 1817

Quick Access Toolbar (Operator
Workstation)
The Operator Workstation has its own unique Quick Access Toolbar. The
Quick Access Toolbar contains shortcuts to some of Pulse’s common
commands, enabling you to execute these commands quickly. This toolbar
is always available, regardless of the ribbon which is currently displayed in
the workstation.

Quick Access Toolbar - Operator Workstation

You may place the Quick Access Toolbar either above or below the main
interface’s ribbon.

To change the Quick Access Toolbar’s location

1 Click the down arrow at the far right end of the toolbar.

2 Click Show Quick Access Toolbar below the Ribbon.

The Quick Access Toolbar relocates accordingly.

To add a command to the Quick Access Toolbar

 In the Operator Workstation, open the relevant ribbon, right-click

the command button and then click Add to Quick Access
Toolbar.

To remove a command from the Quick Access Toolbar

 In the Quick Access Toolbar, right-click the relevant button and

then click Remove from Quick Access Toolbar.

Pulse 4.12 User Guide 1818

Quick Access Toolbar Commands
The following commands are available in the Operator Workstation Quick
Access Toolbar:

Go to the Developer Workstation

If the Operator Workstation is in Runtime mode,

click this button to enter Monitor mode (availability
depends on whether the user’s security level
permits it).

If the Operator Workstation is in Monitor mode,

click this button to enter Runtime mode.

Log in to the Operator Workstation again.

Lock the Operator Workstation so that it cannot be

edited or moved until someone unlocks it.

Open an existing display for further monitoring or

runtime operation.

Executes a workflow

Click the Tools icon to open the Data Scope. Click

the arrow to open a submenu providing access to
the following modules:

Data Scope, Item Explorer, Alarm Explorer, Event

Management Center, Server Manager, Schedule
Manager, User Manager, Event Center
Administration, Shift Manager, Logger Window

Open the Pulse Help. Click the arrow to open a

submenu providing access to the Help according to
the Table of Contents or a Search utility, as well as
the About Pulse Workstation dialog box.

Pulse 4.12 User Guide 1819

Opening a Display in the
Operator Workstation
NOTE In the Operator Workstation, users may only open saved files
(if their security levels allow).

To open a display, run the Open command from the File menu. You may
open and work on as many graphic files as you and your computer can
handle.

To open an existing display

1 From the File ribbon’s Open group, click Open.

The Open Displays dialog box is displayed, showing the Project

Directory, Project Name, and a list of all the display files associated
with your current project. In the Operator Workstation, you can
also choose an associated resource file.

2 Select a graphic display and click OK.

Pulse 4.12 User Guide 1820

The DataScope Module
During project development and runtime, use the Data Scope module as a
diagnostic tool to test the validity of item values, action commands,
connectivity and alarm conditions. As you build your project, you can
enter strings that you want to check. After you enter your string, the Data
Scope shows the current value of the item (you can force another value
manually), the current value’s validity status (Good, Bad, LastGoodValue,
Unknown, NotMonitored, Future), the timestamp of the value, and the
access rights (Read only, Read/Write, Write Only, Unknown) - all
automatically updated according to data changes.

Additionally, the Data Scope can also be used while installing and
integrating the project in the workplace. In the communications layer, use
the Data Scope to check that communication between the Pulse Server
and the PLC is occurring normally.

The Data Scope is available in both the Developer Workstation and the
Operator Workstation. You may open several instances (windows) of the
Data Scope, each referencing a different server and topic combination,
and can save the list of data items monitored in each window (to
conveniently monitor the same items from session to session).

Data Scope supports the use of aliases while entering strings.

Data Scope assumes the security level of the most recent login to the
Operator Workstation.

NOTE Before starting Data Scope, make sure that it is connected to

the Pulse Server (DBSR) and that the Pulse application is
running.

Pulse 4.12 User Guide 1821

The Data Scope columns have the following functions:

Name Enter the item, command, or event string that you

want to check.

Item The Item column is displayed when the Show

Items icon is clicked and is not displayed when
the Hide Items icon is clicked.

The Item column translates the alias.

Value After entering the name, a default value appears in

this column. To force a different value, type it
manually.

Status Notifies if the name and value are valid and

received by the Pulse Server: Good, Bad,
LastGoodValue, Unknown, NotMonitored,
Future.

AccessRights Displays the read/write attribute of the command

or string:

Read only, Read/Write, Write only, and

Unknown.

TimeStamp Date and time of the Data Scope entry.

To check a string or command using the Data Scope

1 From the Operator Workstation’s Tool ribbon, click the Data Scope
icon.

The Data Scope window is displayed.

2 In the Name column, type an item, command, or event string that

you want to check (or assemble it in the Item Manager ).

3 Click the Show Items icon to display an additional column called

Item. The Item column translates the alias.

4 In the Value column, a default value is displayed.

5 To test a different value, type it manually.

A notification about the Name’s and Value’s validity or status appears

immediately in the Status column. Additionally, AccessRights and
TimeStamp information for the entry appears.

Pulse 4.12 User Guide 1822

The Item Explorer
Working with the Item Explorer
The Item Explorer allows you to monitor the status of the Pulse Host’s
items, such as functions and arguments. In the Item Explorer, the data is
accessed through the Host tree with various functions represented by
branches in the tree, and presented in tables for each function group.

In the Item Explorer, turn on Monitoring in the toolbar, browse through

the tree to a specific function, and then view the current status of the
arguments and commands.

To open the Item Explorer

 From the Tools ribbon, click the Item Explorer icon.

The Item Explorer window is displayed.

Pulse 4.12 User Guide 1823

The following information is displayed in the Item Explorer:

Name Full name, including the Pulse host and function of

the command.

Value Configured value for the command.

Status Returns the validity of the command and its

connection to the Pulse Server (Good, Bad,
LastGoodValue, Unknown, NotMonitored, Future)

Time Stamp The exact time and date that the check occurred.

Access Rights Access rights for the command (Read only,

Read/Write, Write Only, and Unknown).

Pulse 4.12 User Guide 1824

Item Explorer Tasks
In the Item Explorer, you can do the following:

 Explore Items

 Add to Explored Items

 Monitor the status of functions and arguments

 Save a set of functions and arguments as a Data Scope group

You may initiate the above functions from the toolbar near the top of the
Item Explorer window.

Display the items of the selected tree branch.

Explore Clicking the Recursive button displays all items in
Items/ the selected branch, including those in subfolders.
Recursively

Add the items of the selected tree branch to the

Add to currently displayed Item Explorer table. Clicking the
Explored Items/ Recursive button adds all items in the selected
Recursively branch, including those in subfolders.

These commands let you display items from

multiple branches together in the same table.

Check the status of the items listed in the Item

Explorer window. The status check functions
similarly to the Data Scope.

Select all items that are currently displayed in the

Item Explorer table.

Clear all items from the Item Explorer table.

NOTE This command only removes the items from the view - it does
not delete them from the project.

Save the listed items as a Data Scope Group, which

you can open up in the Data Scope to check when
required.

Pulse 4.12 User Guide 1825

Entering Text Input
Some text objects require that the operator enters data when the mouse
passes over it, or if the operator clicks the object.

NOTE Automatic opening of the Set Value dialog box is enabled if

the Input > Immediate option is selected in the object’s
Animation Text Properties, see Animation Properties - Text.

To enter text data

1 In the Set Value dialog box, either type or choose the input value
for the selected text object.

2 Click Set.

The object now displays the new value, and any items or actions
dependent on this input also take place accordingly.

Pulse 4.12 User Guide 1826

AutoAction
An AutoAction is an action that Pulse executes when its defined trigger
action or event occurs, or if its scheduled time arrives. During runtime,
AutoActions run automatically and without operator interference.

The following types of AutoActions can be defined:

 Operator Workstation AutoActions

 Display AutoActions

 Server AutoActions (not accessible or executable from the Client

Workstation; for more information, see Defining Server
AutoActions.

Operator Workstation AutoActions

Operator Workstation AutoActions are attached to the Operator
Workstation and are triggered when the Operator Workstation is open
regardless of the display, as follows:

 Startup Action, triggered when opening the Operator Workstation.

 Shutdown Action, triggered when shutting down the Operator

Workstation.

 Idle Action, triggered when Pulse workstation has been idle for a
defined delay time.

 Idle End Action, triggered when activity resumes on the Pulse

workstation following the defined Idle period.

 Other predefined triggered events, triggered by data changes, see

AutoActions.

Pulse 4.12 User Guide 1827

Display AutoActions
Display AutoActions are attached to a specific display and are only
triggered when the display is opened during runtime, as follows:

 AutoOpen, triggered when a specific display opens.

 AutoClose, triggered when the display closes.

 Other predefined triggered events, triggered by data changes,

see AutoActions.

Pulse 4.12 User Guide 1828

Smart Information
The Smart Information dialog box displays retrieved information from
the database and direct addresses for graphic objects that refresh during
runtime and that store and display historical trend information.

In Full Mode, the Smart Information dialog box displays configuration

details from the block that is called by the object during real time, and
historical data (values read at specific time intervals). In Compact Mode,
the dialog box displays only the trend graph.

The displayed Trend graph has the same trend graph configuration that
was defined for the object, such as pens, Y- and X- axes, and toolbars.

This section contains the following topics:

 Smart Information - Analog Value or Calculation Block Object

 Smart Information - Digital Value or Boolean Block Object

 Smart Information Display Options

 Changing Smart Information Layout

 Printing Smart Information Reports

 Smart Information - Margin Percent

Pulse 4.12 User Guide 1829

Smart Information - Analog Value or
Calculation Block Object
 Right-click an object that receives data from an analog value or
calculation block and click Smart Information.

A dialog box similar to the one illustrated below is displayed.

The Smart Information dialog box displays the following information:

Block Definitions

Address Address of the item to which the block refers.

Scan Time The interval between successive processing of the

block.

Phase Time The initial time delay from the loading of the database
to the first processing of the block.

Pulse 4.12 User Guide 1830

Driver Conversion The conversion algorithm for transforming raw data to
engineering units.

Uses PLC Time If checked, the object displays the date and time of the
Stamp alarm from the PLC.

Scale

Low Scale The absolute minimum value of the block, in

engineering units (-99999.99 to +99999.98).

High Scale The absolute maximum value of the block, in

engineering units (-99999.99 to +99999.98).

Set Value

Value Current value of the object.

Value At Time that the current value was received by the object.

New Value Select a new value and click Set to change the value of
the object.

Real Time Monitors

Current Alarms Table listing the alarms generated by the object’s

referred block.

Graph display A real time trend graph or a historical trend graph

displays the data recorded by the object. The user can
open the Trend menu and choose which graph to
display.

Pulse 4.12 User Guide 1831

Smart Information - Digital Value or
Boolean Block Object
 Right-click an object that receives data from a digital value or
Boolean block and click Smart Information.

A dialog box similar to the one illustrated below is displayed.

The Smart Information dialog box displays the following information:

Block Definitions

Address Address of the item to which the alarm refers.

Scan Time The interval between successive processing of the

block.

Phase Time The initial time delay from the loading of the
database to the first processing of the block.

Uses PLC Time If checked, the object displays the date and time of
Stamp the alarm from the PLC.

Pulse 4.12 User Guide 1832

Text for On/Off

Text for On Text of up to eight characters and spaces

describing the digital 1 state (for example: ON,
OPEN, YES, etc.). This text appears in displays,
data entry, and alarm messages.

Text for Off Text of up to eight characters and spaces

describing the digital 0 state (for example: OFF,
SHUT, NO, etc.). This text appears in displays,
data entry, and alarm messages.

Set Value

Value Current value of the object.

Value At Time that the current value was received by the

object.

ON/OFF buttons Click the relevant button to change the value of

this object.

For example, if the value is at 0 (OFF), you can

click ON to change the value. If the value is at 1
(ON), you can click OFF.

Real Time Monitors

Current Alarms Table listing the alarms generated by the object’s

referred block.

Graph display A real time trend graph or a historical trend graph

displays the data recorded by the object. The user
can open the Trend menu and choose which graph
to display.

Pulse 4.12 User Guide 1833

Smart Information Display Options
Choosing a Graph Type
1 The Smart Information provides several options for viewing trend
data. Selecting any of these options changes the graph that
displays the trend in the Smart Information dialog box.

The options are:

• Hour

• 8 Hours

• 24 Hours

• Week

• Month

• Year

• Real Time Trend

• Generic

Pulse 4.12 User Guide 1834

To change the graph type

 Go to the Smart Information window and from the Trend menu,

point to Trend Mode, and then click the relevant historical time
span, or the Generic option for real- time readings.

Additional Trend graph options are:

Show Only If the selected graphic object refers to more than

Current Item one advised item, choose this command to show
information about the current item only.

Show Trend for If the selected graphic object refers to more than
All Items in advised item, choose this command to show
______ information about all the object’s advised items.

Show for All If you chose multiple historical block objects at the
Objects same time in the display, you can choose this
command to show information about all the
selected objects. In this case, the Smart
Information dialog box provides options for
switching among the selected objects’ data or
viewing them all at us (for example, in the trend
graph).

Pulse 4.12 User Guide 1835

Changing Smart Information Layout
Pulse displays the Smart Information in the following dialog box
layouts:

Switch to Full The Smart Information dialog box displays block

Mode parameters, current values, alarm conditions, and
a Trend graph.

Switch to The Smart Information dialog box displays the

Compact Mode Trend graph only.

Depending on the current mode, you can switch to the other layout mode.

To switch Smart Information layout mode

 In the Layout menu, click either Switch to Compact Mode (from

Full Mode) or Switch to Full Mode (from Compact Mode).

Printing Smart Information Reports

You can generate reports which display the Smart Information of the
currently selected data set of the graphic object or for all data sets of the
object.

After generating a report, you can do the following:

 View it

 Save it

 Print it

 Change its display layout

 Export it to a different document format

 Send it via email

Pulse 4.12 User Guide 1836

To generate a Smart Information report for the currently selected
item

1 In the Print menu, click Print - [Name of current item].

2 The report contains Smart Information for the currently selected

data item. In the Preview window, check if the report appears
satisfactory. A toolbar contains commands for modifying the
report’s appearance. In addition, you can do any of the tasks
described above.

To generate a Smart Information report for all of the object’s

items

1 In the Print menu, click Print All - ([Name of current graphic

object].

2 The report contains Smart Information for all of the data items in
the current graphic object. In the Preview window, check if the
report appears satisfactory. A toolbar contains commands for
modifying the report’s appearance. In addition, you can do any of
the tasks described above.

Pulse 4.12 User Guide 1837

Smart Information - Margin Percent
The user can add margins below and above the Smart Information Trend
Graph to change its scales; scales are calculated according to the margin.
The margins represent the original scale values below and above the
Trend Graph.

The Margin Percent parameter makes it possible for the minimum and
maximum Trend (whole area) to be calculated according to the percent of
the scale and labels, and the divisions to be calculated according to the
margin calculation. For example if '10%' is the margin value specified, the
margin is increased by 10% from the lowest scale making the scale reach
-10 (if the Low Scale value was initially set to 0) and 10% from the
highest scale making the margin reach 110% (if the High Scale value was
initially set to 100).

The Margin Percent parameter allows you to add margins to the Trend
Graph to have a wider and clearer view of the graph.

Pulse 4.12 User Guide 1838

To set the Margin Percent

1 In the Developer Workstation, go to the Pulse Project

Configuration Manager window (Manage ribbon > Project
Configuration).

The Pulse Project Configuration Manager window is displayed.

2 From the Property Name tree, click General > Workstation >
Smart Information - Trend Margin Percent.

The Smart Information - Trend Margin Percent area is displayed on

the right pane of the window.

3 Specify the percent by which you want to define the graph margin
in the Smart Information Trend Margin Percent field. The
Smart Information graph margin default value is '0'.

Pulse 4.12 User Guide 1839

Displaying a Graphic Object’s
Historical Trend
During runtime, Trend graphs are continually updated as addresses'
values change. You can scroll graphs to view previous values. The trend
historical data collection continues even when the display is not active.

The Historical Trend Graph is a dynamic graph that presents historical

data that was collected over a period of time and stored in the Database
Server. The operator can produce dynamic historical trends at any time,
from within the Operator Workstation, during the normal operational
mode, by selecting a number of objects that receive information from
blocks and displaying their historical records. Dynamic trends created by
the operator can be exported to be viewed using a spreadsheet, such as
Microsoft Excel, and saved for later retrieval.

A Real Time Trends Graph displays real-time activities whose values are
automatically updated in the Operator Workstation. As values change, the
Trend Graph continually displays the latest real-time values. Addresses in
a real-time trend can be a direct address.

To display historical trend graphs for selected graphic objects

 In the Operator Workstation, right-click an object (or select multiple

objects and right- click) that has historical data. Point to Historical
Trend and then select the time span for the graph to cover.

The options are:

• Hour

• 8 Hours

• 24 Hours

• Week

• Month

• Year

• Generic

Pulse 4.12 User Guide 1840

The Generic Option
The Generic option allows you to have the flexibility of defining, saving
and loading the Dynamic Historical Trend graph according to his own
specifications instead of just using the pre-defined Historical Trend
options.

Generic is an option where you can display the Dynamic Historical Trend
graph according to the specification of the Span Time, Time Base and
other Trend parameters.

When selecting the Generic option, Trend parameters (such as Span

Time, Time Base and other Trend parameters) are active in the Time
Settings tab of the Trend Graph Settings dialog box which you defined.
The Dynamic Historical Trend graph then displays the graph according to
your parameter settings.

After configuring the Generic Trend graph settings, you can choose to
save the Generic Trend Graph Settings as a Trend group for future use.

Pulse 4.12 User Guide 1841

Dynamic Trend Graph
Dynamic Trend Toolbar
The Dynamic Trend Graph has a toolbar with the following command
options:

 Print - The Print option allows printing the Dynamic Trend

Graph on paper as a report or as a pdf file that includes the Name,
Description, Value, the Trend graph (all the contents in the Trend
Graph window).

NOTE The toolbar also has a Print option that allows printing
the Dynamic Trend Graph on paper as a report or as a pdf file
that includes the Description, Item, Function, From, To and
Sample values.

 Set as Default Settings – The Set as Default

Settings option allows saving the current Dynamic Trend settings.

When saving the Set as Default Settings, the Dynamic Trend

settings are displayed with the user defined Trend settings set, i.e.,
Pen color(s), Toolbar button appearance and order preference, Time
Format, and other graph settings preferences.

Pulse 4.12 User Guide 1842

Dynamic Trend Table Parameters
The Dynamic Trend table parameters are as follows:

 # The number of the item

 Name The name of the item

 Description The description of the item

 EGU The EGU (Engineering Unit) parameter is

displayed on the Dynamic Trend Graph at
runtime. The EGU value is derived from the
block.

 Real Time Value The real-time value of the item

 Analyzed Value The analyzed value of the item

Pulse 4.12 User Guide 1843

Dynamically Displaying X and Y
Values on the Dynamic Trend Graph
in Crosshair Mode
When in crosshair mode in the Dynamic Historical Trend graph, you can
display the X and Y values dynamically as the mouse pointer moves
around the Trend graph.

When the crosshair moves, the value adjusts accordingly. The values are
displayed in the Trend graph’s Analyzed Value column on the table.

Click the Crosshairs icon to activate/deactivate the Crosshairs mode.

Pulse 4.12 User Guide 1844

Displaying Real Time Batch
Data for the Historical Batch
Trend Graph
The Historical Batch Trend Graph can fetch a Batch that has already ended
or a Batch that is still in progress from the Data Logger/Database Server
and display it in the Historical Batch Trend Graph.

To fetch another batch, click the Next Batch icon on the Historical Batch
Trend graph.

Pulse 4.12 User Guide 1845

Associating a Dynamic Graphic
Object with a Schedule
In the Operator Workstation, you can attach a dynamic Graphic Object to
one of the defined schedules. The object’s behavior is affected by the
settings of the associated schedule, such as Item Assignments and Special
Days. The schedule determines action times and idle times for the object.

To associate a dynamic Graphic with a schedule

1 In the Operator Workstation, right-click the Graphic object and click

Schedule To.

The Schedule To dialog box is displayed.

2 Select the schedule to associate with the object and click OK.

Pulse 4.12 User Guide 1846

Showing and Hiding Layers
From the Operator Workstation, the operator can open the Layers tree
and expose and hide layers (if permitted according to the Security policy).

To show and hide a layer

1 In the Operator Workstation, right-click and then click Layers.

The Layers dialog box is displayed.

2 To make a layer visible in the display, select (check) the layer.

To make a layer invisible in the display, deselect (uncheck) the

layer.

Pulse 4.12 User Guide 1847

Restricting Operator
Workstation Open and Close
Display Commands
The file commands Open, Close and Revert to Saved are intended for
application configuration and testing changes - they determine the
displays opened on startup. It is advised to restrict operator access to
these commands via security levels (in Advanced Authorization Mode) or
password levels (in Simple Authorization Mode). For example, you may
want to allow open and close privileges to only to users with a high
security or password level, and prevent operators with low security or
password levels from performing these operations.

The command shown in gray indicates that the operation is not authorized
in the Operator Workstation.

For instructions on restricting operator access to menu commands, see

Menu Authorization.

Pulse 4.12 User Guide 1848

Configuring Pulse Network
Pulse is compatible with networked systems that maintain the following
criteria for all stations:

 32-bit Windows platforms

• Standalone - Windows 7 Ultimate/Vista/XP/Server 2003

• Client/Server - Server - Windows 2003, Client - Windows 7

Ultimate/Vista/XP/Server 2008/Server 2003

 Support for TCP/IP protocol

 Fixed IP addresses

This section contains the following topics:

 Network Structure

 Configuring Network Nodes

 Removing Nodes from the Network

 Setting Up a Multiple Pulse Server Configuration

Pulse 4.12 User Guide 1849

Network Structure
As previously mentioned, the core Pulse programs and project data reside
on the Pulse Server and can run full-time, while the operator and
developer client stations log on and off according to their needs and work
schedules. There is no need to install entire SCADA systems on every
workstation in the network.

A Client/Server Pulse network consists of one or more PCs running Pulse

Server services, plus Pulse Client workstations.

Referencing Data from Remote

Nodes
The following types of data can be distributed over the network:

Alarm data Alarm data is distributed to and from the nodes that
are defined in the network, regardless of whether or
not the network is enabled.

Database Server Database Server data can only be distributed to and

data from a network node if that node is network-
enabled.

Additional TCP/IP Protocol Settings

Use the following information to design network properties for Alarms
Transport - and respective additional TCP/IP settings.

WINS (Windows Not used by Alarms transport; no special

Internet Naming requirements.
Service)
Resolution

DNS (Domain Not used by Alarms transport; no special

Name Server) requirements.

DHCP (Dynamic Not used - Alarms transport requires a fixed IP

Host address for each computer.
Configuration
Protocol)

Gateway When implemented (for other reasons), used by

Alarms transport.

Pulse 4.12 User Guide 1850

Configuring Network Nodes
To configure a network node

1 In the AFCON Pulse Program Group, enter the Pulse Setup folder
and double-click Network.

The Pulse Network Setup dialog box is displayed.

2 Define General Parameters as follows:

Enable Network Select this option to enable the network.

Additionally, selecting this option enables this
dialog box to accept new settings.

Port Enter the number of the logical port to which

the network is connected. This setting must be
identical for all the nodes on the network. The
default is 7.

Pulse 4.12 User Guide 1851

 Network Server Select either DBSR or PFWNET as the Pulse
Server.

Variable/Value

This table lists network parameter variables. Configure the values

of the variables by selecting the Variable name in the table and in
the Edit Local Node section’s Value box below it, type the
changed value and then click Set.

The network parameter variables are:

NodeName An alphanumeric name for this Pulse Server.

NodeNumber The number by which this Server is identified

to the network.

PortOffset A function of the TCP/IP protocol. This setting

must be identical to all the nodes within the
network. It accepts values ranging from 4000-
6000.

NOTE Use the same setting as in the

DBSR Nodes tab.

NwMasterNode The Node number of the Server computer to

which the Master SEK dongle is connected.

Add/Edit Network Node

The Network Node variable values (IPADDRxxx, ALIASPATHxxx,

HISTPATHxxx) are taken from the Add/Edit Network Node area in
the lower part of the dialog box.

Add the Node Number of IP addresses of all the workstations

connected to the network. After entering the configuration of each
workstation, click Add - the workstation, its alias, and history path
appear as variables in the Variable list above. If you modify an
existing node configuration, click Change.

Repeat this action for all workstations that you configure.

Node Number Node number of this workstation.

IP Address IP address of this workstation.

IPADDRxxx Variable for Node Number and IP Address

Pulse 4.12 User Guide 1852

 Alias Path Browse to locate the location of the Alias file
(pfwalias.txt) on the Pulse server.
(ALIASPATHxxx
variable)

Shared History Browse to locate the location of the History

Path folder on the Pulse server.

HISTPATHxxx
variable)

Alarms - Receive from

Select to receive alarms from:

All All Pulse nodes

None Alarms will not be received from nodes.

Nodes List Check the checkboxes next to the nodes from

which to receive alarms.

3 Click the DBSR Nodes tab and configure the values of the variables
in the same way as the Network Parameter variables in the
previous step. These variables relate to alarms and message data.

Pulse 4.12 User Guide 1853

NOTE Most of these variables are internal Pulse system variables. For
these variables, keep the default value and do not change it
unless advised to do so by an AFCON technician. These
variables are noted accordingly.

Pulse 4.12 User Guide 1854

4 Define DBSR Nodes parameters as follows:

ShowAliveMessa System variable. Accept the default value.

ge

ShowMaintMsg This variable enables the distribution of “*”

(maintenance oriented) messages.

 1=Enabled

 0=Disabled

Default (1) is recommended.

RefuseUnlisted This variable determines if alarms that are

generated by non-networked workstations are
to be refused or accepted by the networked
nodes.

 1=Refused

 0=Accepted

ConnectUnlisted This variable determines if alarms generated

by networked workstations are to be
distributed to non-networked workstations.
This is only relevant if the previous variable
(RefuseUnlisted) is set to accept alarms (i.e.,
set to 0).

 1=Enabled

 0=Disabled

AliveMsgTimer System variable. Accept the default value.

DGramTimer System variable. Accept the default value.

ReconnectTimer System variable. Accept the default value.

PortOffset A function of the TCP/IP protocol. This setting

must be identical to all the nodes within the
network. It accepts values ranging from
4000-6000.

NOTE Use the same setting as in the

General Parameters tab.

DGramIdentifica System variable. Accept the default value.

tion

Pulse 4.12 User Guide 1855

 NumberOfDGram System variable. Accept the default value.
s

ShowRcvWaitMs System variable. Accept the default value.

g

IPADDRxxx Indicates the node number and the IP address

of a Pulse network partner workstation.

For example, 2,130.1.70.92 indicates node

number

5 Click Save to save the configuration, and then click OK to close the
dialog box.

Pulse 4.12 User Guide 1856

Removing Nodes from the
Network
To remove nodes from the network

1 In the Pulse Network Setup General Parameters tab, select the

appropriate node’s Variable name in the Variable table.

The node’s details appear in the Add/Edit Network Node section.

2 Click Delete.

3 Click OK.

Setting Up a Multiple Pulse

Server Configuration
SCADA/HMI applications may require multiple Pulse servers. For example,
different servers may provide supervision and control over systems such
as electrical, security, raw materials supply, climate control, etc. Pulse
supports a multiple server environment in which all the systems
communicate with the main project database, and ensure that all the
servers’ real-time and historical data are available simultaneously to Pulse
clients.

A Multiple Host configuration consists of a Master Host and Other Hosts.

The Master Host is the Pulse Server to which the Pulse Client logs into,
and which must contain the enabled services, MessageBus and
SecurityService. The Client workstation logs in by browsing to the Master
Host (it does not need to browse to the other servers). The Other Hosts
are Pulse Servers which may communicate with specific PLCs or other
data sources, but share a common project database, MSMQ, and Alarm
Publisher, MessageBus, and SecurityService services with all other Hosts
in the system.

Advised items and blocks may refer to any of the servers in the
configuration. When configuring or referring to advised items and blocks,
write the server name, see Configuring Network Nodes of the server on
which the data resides or is received from, and “Server|Topic!Item” (for
example, \\SERVERNAME\DBSR|PCIM!AV1). From the Item
Manager, you can also browse the Hosts tree to assemble the item or
expression in the correct syntax, see Adding Hosts to the Item
Manager/Item Explorer.

Pulse 4.12 User Guide 1857

NOTE If the data item resides on the Master Host, you can omit the
server name and use the shortened format (for example,
|!AV1).

A Multiple Host configuration must meet the following criteria:

 All servers must share the same project database (OLEDB),

see Configuring Project Database Settings.

 All servers must share the same MSMQ folders. On each server,
configure the Storage folders for Message files, Message logger,
and Transaction logger, to the Master MSMQ location,
see Installing IIS and MSMQ Services.

 The MessageBus and SecurityService services must be enabled on

the Master Host only. On each additional server’s Services Settings,
verify that these services are configured to run on the Master Host,
see Configuring Services Settings.

 All servers must share the same Alarm Publisher service. In the
project’s Service Settings, you can define the server on which this
service runs.

 To differentiate between the various servers, each one must have a

unique node number and optionally, a descriptive name.

Pulse 4.12 User Guide 1858

 The Pulse SEK plug that allows client connection and I/O usage
must be connected to the Master Host. All other servers require
only a single Development client SEK.

 It is recommended to save all project displays, recipes, cells, etc.,

on the Master Host.

Limitations
Pulse syntax (such as \\Hostname\itemname), for reference to items
on the “Other Hosts”, and access to the Item Manager, are not supported
in the following modules:

 Supreme Report

 Report Editor

 Recipe Explorer

 OPC Gateway Editor

Configuring the Hosts

First, enter the Project Setup of the server which will function as the
Master Host and set up the Master Host configuration.

Then, enter the Project Setup of the other server(s), which will function as
Other Host(s), and set up the Other Host configuration.

Setting Up the Master Host

To set up a Master Host configuration

1 Enter the Master Host’s Project Setup. In the Project Setup

window project tree, right-click the project and click Host Network
Wizard.

-or-

Select the project and click the Host Network Wizard button from
the toolbar.

The Pulse Host Network Wizard is displayed.

Pulse 4.12 User Guide 1859

2 A Multiple Host configuration requires that one of the servers
functions as a “Master Host”. Select the Master Host type and
click Next.

Master Host This server must run the message bus and
security services.

When logging in, clients must browse to this

server’s web page. This server’s license should
enable the client workstations to log in and
perform all the necessary I/O functions.

The Master Host must:

 Be configured to run the project’s

MessageBus, SecurityService, and
AlarmsPublisher services, see
Configuring Services Settings.

 Contain the project’s primary database

(SQL Express 2008 or other user-defined
database), see Configuring Project
Database Settings.

 Include the project’s installed MSMQ

service,
see Installing IIS and MSMQ Services.

Pulse 4.12 User Guide 1860

3 In the Network Node(s) page, configure the following and then click
Next:

Enable Network Select this option to allow configuration and

operation of a configured Pulse server network.

Local Host

Node Number The number by which this Pulse Server is

identified to the network.

Node Name An alphanumeric name for this Server.

Add/Edit other Click the plus sign at the bottom of the table.
hosts
 Node Number - Type the node number
of an additional Pulse server.

 IP Address - Type the IP address of the

additional Pulse server.

Add entries for all the other servers (not

Master) in your Pulse network.

Pulse 4.12 User Guide 1861

4 In the Completing the Host Network Wizard page, review and
confirm the details for the configured Master Host and click Finish.
To return to previous pages of the Wizard to modify any
parameters, click Previous.

5 Right-click the project name and click Configure Network Setup,

or click the Configure Network Setup button in the toolbar.

6 In the Alarms - Receive From area, select None, and then click
OK.

Pulse 4.12 User Guide 1862

Setting Up the Other Host(s)
Additional servers in a multiple host configuration may run any or all of
the services that are not running on the Master Host. It is important to
configure these server nodes to refer to the services, database, and
MSMQ that are running on the Master Host.

1 Open the other server’s Project Setup, right-click the project and
click Host Network Wizard.

-or-

Select the project and click the Host Network Wizard button from
the toolbar.

The Pulse Host Network Wizard is displayed.

2 Select Other Host and click Next.

3 In the Network Node(s) page, make sure that the Enable Network
option is selected. Define the other Local Host parameters and
then click Next.

Local Host

Node Number The number by which this additional Pulse

Server is identified to the network.

Node Name An alphanumeric name for this Server.

4 In the Host Name and Database Connection page, specify the

Master Host and the shared project database which resides on the
Master Host.

Pulse 4.12 User Guide 1863

 Click to verify or set up the connection to the project database.
In the Data Link Properties dialog box, click the Provider tab
and make sure that the selected database is the same one that is
configured on the Master Host.

In the Connection tab, specify the Master Host’s name and make
sure that the configured login information and selected database
are identical to the configuration on the Master Host. Click Test
Connection to confirm whether the server connects to the
database, see Connections.

NOTE If using a specific User Name and Password for the server
login, you must select one or both of the options, Blank
Password and Allow Saving Password.

5 After returning to the wizard, click Next.

6 In the Completing the Host Network Wizard page, review and

confirm the details for the configured Other Host and click Finish.
To return to previous pages of the Wizard to modify any
parameters, click Previous.

7 To configure any more “Other Hosts”, repeat this procedure.

Pulse 4.12 User Guide 1864

To verify the correct Services configuration

It is important to verify that all of the Pulse Servers have the same
Services Settings that is that all servers connect to identical Service
addresses. Verify that the MessageBus and SecurityService services will
be enabled on the Master Host only.

1 On each server, enter the Project Setup, right-click the project

name and click Configure Services Settings.

The Service Settings dialog box is displayed.

2 Make sure that the service addresses are correct and that these
settings are identical for each server.

Adding Hosts to the Item Manager/Item

Explorer
From the Item Manager, you can access data items on the Other Hosts.
First, you have to add each new Host to the Links tree’s Host branch in
the Item Manager (and the Item Explorer). You can then browse the Hosts
tree to assemble the item or expression in the correct syntax, according
to the referred host, see Working with the Item Manager.

To add Hosts to the Item Manager/Item Explorer

1 Right-click the Hosts root branch and click Add Host.

Pulse 4.12 User Guide 1865

2 Type the host name and click OK. The host name must be identical
to the server’s Node Name defined in the Network Setup.

A branch containing all of the additional host’s items now appears in

the Item Manager.

3 Repeat steps 1 and 2 for all other hosts.

NOTE Repeat this procedure as required in the remaining Item

Manager and Item Explorers of the Developer Workstation and
the Operator Workstation.

Pulse 4.12 User Guide 1866

Deploying Several Pulse
Servers via the Ghost Software
After the deployment of the Ghost image containing the Pulse server
installation to several remote stations and changing their network settings
(i.e., computer name, etc.), the system automatically reboots at startup.

Windows restarts automatically if the Automatically restart option was

selected on the Startup and Recovery dialog box (see image below).

Since all Pulse services start automatically and their server addresses stay
as they were before the image was created, a system failure occurs.

Pulse 4.12 User Guide 1867

In this case, it is not possible to log-on remotely. Someone must
physically approach and boot each station to SafeMode (without any
services). Then Pulse server addresses should be set to match new
computer network settings and applied to all Pulse services. Reconfigure
the Pulse network settings (i.e., node numbers, IPs, etc.), if required.

There are two ways of preventing this issue:

 Configure the Pulse server address and services before creating a

Ghost image for deployment

 Configure the Pulse server address and services after deployment

Pulse Server Address Configuration

Configuring the Pulse Server Address and Services before
Deployment

1 Before creating a Ghost image for deployment, go to your desktop

and select Start > Programs > AFCON Pulse > Pulse Setup >
Project.

The Project Setup window is displayed.

2 Click the Configure Server Address icon.

The Pulse Server Address Configuration dialog box is displayed.

3 Configure the Internal and External IP addresses of the Pulse server

address to Localhost.

4 Select the Apply to all services option and click OK.

Pulse 4.12 User Guide 1868

 and/or

1 Before creating a Ghost image for deployment, go to your desktop

and select Start > Programs > AFCON Pulse > Server
Manager.

The Server Manager is loaded and the Pulse Server Manager icon
appears on the Taskbar (lower right-hand side of the window).

2 Right-click on the Pulse Server Manager icon and select Show

Services from the pop-up menu.

The Pulse Login to server dialog box is displayed.

3 Enter your User Name and Password and click Login.

The Pulse Services window is displayed.

4 Go to the Startup Type of All menu and select Manual.

Pulse 4.12 User Guide 1869

Configuring the Pulse Server Address and Services after
Deployment

1 Reconfigure the Pulse server address for each station to match the
computer's settings.

2 If required, reset the services startup type to Automatic by going

to your desktop and selecting Start > Programs > AFCON Pulse
> Server Manager.

The Server Manager is loaded and the Pulse Manager icon appears
on the Taskbar (lower right-hand side of the window).

3 Right-click on the Pulse Manager icon and select Show Services

from the pop-up menu.

The Pulse Login to server dialog box is displayed.

4 Enter your User Name and Password and click Login.

The Pulse Services window is displayed.

5 Go to the Startup Type of All menu and select Automatic.

6 If necessary, set the appropriate Pulse network settings (i.e., port

number, nodenames, IPs, and more).

Pulse 4.12 User Guide 1870

Utilities
This chapter discusses the Pulse utilities. The Pulse utilities consist of the
following:

 FTP Utility

 History Viewer

 P-CIM Email Sender

 P-CIM INI

 Pulse Security

 Audit Trail

Pulse 4.12 User Guide 1871

FTP Utility
The FTP Utility is used to transfer files between the Pulse client to the
Pulse server and vice versa.

The FTP Utility supports the FTP protocol (File Transfer Protocol). The FTP
Utility can run from the Pulse Server Tools icon group or as a task using
command line arguments.

To run the FTP Utility:

 Go to Start > Programs > AFCON Pulse > Tools > FTP Utility.

The FTP Utility dialog box is displayed.

To download/upload a file:

1 Enter the address of the site that to connect in the Ftp site to
connect to field.

2 Enter the user name in the User name field.

3 Enter the password in the Password field.

4 Click the Connect button.

5 List the directory of the site in the Local path field.

Pulse 4.12 User Guide 1872

6 Specify a file to upload in the File to upload field and click the
Upload button or specify a file to download in the File to
download field and click the Download button.

7 Follow the instructions displayed on the screen.

Using Command Line Arguments for

the FTP Utility
The FTP Utility can run as a task using command line arguments.

To run the FTP Utility

 Go to Start > Run and enter C:\AFCON\Pulse\pfwftp in the

Run dialog box.

The FTP Utility dialog box is displayed.

 Enter C:\AFCON\Pulse\PfwFTP.exe ? in the Run dialog box

The FTP Utility window is displayed listing all the arguments

available for the FTP Utility.

Pulse 4.12 User Guide 1873

The FTP Utility arguments are as follows:

 Pfwftp -u<URL> -n<USERNAME> -p<PASSWORD> -

a<ACTION>
-o<LOCAL PATH> -f<FILENAME> [-h]

NOTE An argument value must never include a “-” (minus sign). A “-

” (minus sign) is only valid before an argument.

• -u<URL> is used to specify the url (web site address) to

operate on.

• -p<PASSWORD> is used to specify the password of the

user who accesses the URL.

• -n<USERNAME> is used to specify the user name that

accesses the URL.

• -a<ACTION> is used to specify the operation on the file(s).

• The Action values are:

Up is to Upload a FILE from the LOCAL PATH to the URL.

Down is to Download a FILE from the URL to the LOCAL

PATH.

Del is to Delete a file from the URL.

• -o<LOCAL PATH> is used to specify the local path where

the file(s) to operate on is located.

• -f<FILE NAME> is used to specify the file name(s) to

operate on.

• -h is used to hide the utility window.

Example:

pfwftp -uwww.afcon-inc.com/downloads -nMyName -

pMyPass –aDown-oC:\MyLocalPath -fMyFile.txt -h

Pulse 4.12 User Guide 1874

History Viewer
The History Viewer module displays history files in list format. The History
Viewer utility allows viewing the contents of Pulse historical trend files in
detail and to convert such files to CSV format.

Viewing a history file in History Viewer can reveal important information

that is not visible elsewhere.

Converting a history file to CSV format can make the data available to
various applications, such as Microsoft Excel, for analysis and reporting.

Pulse 4.12 User Guide 1875

Features
The History Viewer utility can import a CSV file to a HIS file and export
records to a HIS file format. Importing and exporting data to and from the
database may only be done by authorized users. The authorization is
based on the Security Policy.

The History Viewer utility also enables converting HIS formatted files to
CSV formatted files.

Command Line Activation

The History Viewer utility supports command line activation. The
arguments are used for creating CSV format files for the following:

-SD Start Date

-ST Start Time (optional argument)

NOTE If omitted, the default value is set to

“00:00:00”.

-ED End Date

-ET End Time (optional argument)

NOTE If omitted, the default value is

“23:59:59”.

-F The target path and file name

NOTE If the file name in the result does not

include a full path, the file is created in
the application’s (History) current
directory.

-P Path of source history files to use for conversion

(optional argument)

NOTE When the argument -P is used, the

source path of the history files to
search must be entered. If omitted, the
module uses the Pulse Project’s History
path of the current project.

-SP Split result file to any files {name}.000.csv,

{name}.001.csv …. (optional argument).

Pulse 4.12 User Guide 1876

-C Converts the specified history file (FileName.HIS)
to a CSV file.

The following example converts the entire specified

history file into a CSV format and places the file
into the same folder.

“C:\Afcon\Pulse\HTVIEW.EXE –
C[FileName].HIS”

NOTE If history files are missing for a period, the module uses only
the existing files for the period. If no HIS file is found, the
result file is not created.

NOTE The order of switches is irrelevant. The command line letters

are not case sensitive.

Example of a command

C:\AFCON\Pulse\HTVIEW.EXE -SD2017/02/20 -ST00:00:00 -

ED2017/02/20 -ET20:00:00 -
FC:\AFCON\Pulse\[ProjectName]\History\[FileName].CSV

On failure, the application displays the following error message:

Pulse 4.12 User Guide 1877

History Viewer Interface

The History Viewer GUI (Graphical User Interface) consists of the menus
below. The menu lists the commands or options that may be selected
when using the History Viewer utility.

File

HIS File Used to select the history file to open. The default
location is set to the current project's History folder.
The history file is opened according to the View
mode definition (detailed or non-detailed).

Open DataLogger Displays the Data Link Properties dialog box where
History you can connect to a server and the database on the
server where the Data Logger history can be
retrieved.

Refresh Refreshes the current HIS file

Close Used to close the HIS file and clear the details in the
history viewer.

Pulse 4.12 User Guide 1878

Import Daily CSV Imports the daily historical CSV file to HIS format
to HIS file.

This option is available only for existing blocks in the

database.

Export HIS… Enables exporting a HIS file to a CSV file,

see Exporting HIS to CSV for more details.

Export View Exports the current displayed records and changes

the target CSV name

Select the Split CSV File option that splits the target
CSV up to 65535 in each file

Compact Daily Compacts the stored volume of historical data, which

HIS file improves the data retrieval performance, see
Compact Daily HIS File for more details.

Repair Repairs a history file, see Repair for more details

Exit Select this option to leave the History Viewer

utility.

View

View enables switching between Detailed Info and Tabular Sheet view
modes. The tabular sheet is the default view mode.

Totals Displays the total number of block(s), records, and

measurements contained in the history file and also
displays the history file’s calculated size

Pulse 4.12 User Guide 1879

Details Displays the Detailed Info mode of the current file
being viewed

Tools

Goto Block... Allows selecting a specific block

Goto Time... Allows selecting a start time of the currently

displayed period from the dialog box

Filter HIS...
Enabled only in Tabular mode. It enables defining a
period by selecting a start and end time. The user
selects the Tags to show a list of available tags from
this period.

Help

Index Displays Pulse Help

Using Help... Displays the Microsoft Windows Help’s “How to Use

Help” window

Using History Displays Pulse Help

Viewer...

About History Displays information about the History Viewer

Viewer...:

Pulse 4.12 User Guide 1880

Exporting HIS to CSV
The History Viewer utility can export a HIS file to a CSV file through the
Export HIS to CSV dialog box.

You can export a HIS file in the following export modes:

 Time Period to CSV

 Specific File to CSV

Exporting a HIS via Time Period to CSV

To export a HIS file via time period to CSV file:

1 In the History Viewer window, go to the menu and click File >
Export HIS....

The Export HIS to CSV dialog box is displayed.

2 In the Export Mode area, select the Time Period to CSV option.

Pulse 4.12 User Guide 1881

3 Provide the locations of the history files or browse for the paths
from the History files location area.

4 Specify the start and end period from the From (DD/MM/YYYY)
and To (DD/MM/ YYYY) fields and the time corresponding each
period. The date in the From and To fields requires the short date
format (DD/MM/YYYY).

5 Select the export destination as CSV or Split CSV file by checking

on the checkbox(es) from the Export destination area.

NOTE The Split CSV file option is only available when CSV is
selected.

6 Check that the Full name field is correct or browse for the path you
prefer.

7 Click Export to export the file to CSV.

You are prompted whether you wish to view the exported file.

8 Click Yes.

The CSV file is displayed.

Pulse 4.12 User Guide 1882

Pulse 4.12 User Guide 1883
Exporting a HIS via a specific file to CSV
To export a HIS file via a specific file to CSV file:

1 In the History Viewer window, go to the menu and click File >
Export HIS....

The Export HIS to CSV dialog box is displayed.

2 In the Export Mode area, select the Specific File to CSV option.

The Export HIS to CSV dialog box used for used for exporting a
specific file to CSV is displayed.

3 Provide the locations of the history files or browse for the paths
from the History files location field. The Export destination
field is automatically filled.

4 To split the CSV file, check the Split CSV file checkbox (optional).

5 Check that the Full name field is correct or browse for the path
you prefer.

6 Click Export to export the file to CSV.

You are prompted whether you wish to view the exported file.

7 Click Yes.

The CSV file is displayed.

Pulse 4.12 User Guide 1884

Compact Daily HIS File
The Compact Daily HIS File compact the stored volume of historical data,
which improves the data retrieval performance. The compaction operation
applies only to *.HIS files.

The History Viewer utility is able to compact historian records in HIS file
format for the same block.

Every HIS file is saved before compacting it under the name *_old.his.
The user may select whether to save the original file by checking the
Backup original HIS file/s checkbox (checked by default).

It is not possible to compact historical records from the current date.

The user can choose from three methods of operation:

 Records for the same block are placed next to each other. This
speeds the read operations, due to less disk access (default).

 Block records with values of which delta is smaller than the

configured step are removed from HIS.

Add –STEP to command line arguments

For example: STEP1) The STEP value (in percent) applies to all
blocks.

If block high=100 and low=0 and the operator uses only 5%, then
the compaction applies only to 5% of the block records.

Pulse 4.12 User Guide 1885

 Block records is averaged according to selected average period in
seconds.

Add –AVG to command line arguments.

The operator is able to select a range of dates for HIS files and
optional compaction methods, -STEP, -AVG

Compact Command Line Argument

• -C

• -SD Start Date

• -ED End Date

• -AVGnnnn (optional)

• -STEPpp (optional)

• -B backup file

Example

Htview –C -SD2017/02/18 -ED2017/02/19

or

Htview –C –STEP1 –AVG30 -SD2017/02/18 -ED2017/02/19

NOTE The command line letters are not case sensitive.

NOTE The operation overwrites the existing HIS files.

Repair
The repair operation is done by making a new HIS file. The new HIS file is
created from merging a good history file header and the data from the
corrupted file. It succeeds only if the corrupted file has a damage header.

The corrupted file is renamed and a .Bad extension is added to the

corrupted file. For example: (04061500.HIS > 04061500.HIS .Bad)

The new HIS file replaces the corrupted file.

Pulse 4.12 User Guide 1886

P-CIM Email Sender
Use P-CIM Email to dispatch alarms and system event messages to any
email recipient or to a group of email recipients. P-CIM Email can also be
incorporated into the runtime (Operator Workstation) display to allow a
user to manually generate and dispatch email messages.

P-CIM Email integrates with a resident MAPI mail server to enable

transmission. P-CIM Email can operate in two modes:

 Interactive

 Background

In Interactive mode, the application displays the Email Sender form at

the user’s station. The user manually configures the content of the email
message and sends it.

In Background mode, the parameters and layout of the email message

are configured as an Action command during the application development
using a command-line syntax. This Action command can then be
associated with an:

 Action Button

 AutoAction

 Alarm Class

When the Action is triggered, P-CIM Email composes and dispatches the
email message automatically.

System Requirements for Email

To use P-CIM for Windows Email your system must include:

 Any 32 Bit Windows OS

 P-CIM version 7.50 and up

 A resident MAPI mail exchange service

 Internet Mail access

NOTE Be sure that the resident mail exchange service is running

before invoking P-CIM Email.

Pulse 4.12 User Guide 1887

Using P-CIM Email in Interactive
Mode
To use P-CIM Email in Interactive mode you simply need to invoke the P-
CIM Email Sender form.

Any user who has access to the P-CIM icon group can use P-CIM Email in
Interactive mode as a stand-alone utility. To do so, click on the E-Mail
Sender icon to invoke the form.

Fill out the form as you would with any Windows email application:

1 Enter the relevant information for Address, Subject, and Message.

2 Choose the desired options for level of Importance and

Read/Delivery receipt request.

3 Enter the profile that handles your mail services into the Profile
field. If this field is left blank, the default profile is called.

4 Choose Send to send or Cancel to quit.

Runtime Usage in Interactive Mode

You can configure a P-CIM display to invoke the P-CIM Email Sender form.

To invoke the P-CIM Email Sender form

1 Create an Action button.

2 Configure the button’s Action with the following command: Email

(no arguments).

Choosing this button at runtime invokes the form and allows the
user to compose and send an email message.

Using P-CIM Email in Background

Mode
You can configure a P-CIM Button, an AutoAction, or an Alarm Class
(using Advanced Alarm Handler) to generate email messages for
automatic transmission. This is called Background mode because, in this
case, the P-CIM Email Sender form does not need to appear as all the
activity takes place in the background.

To do so, create a Button, AutoAction, or an Alarm Class and configure it

using the Email command.

Pulse 4.12 User Guide 1888

In the Action property command line, configure the email parameters
using the following syntax:

Email [{“address|groupname”} “subject-text” “body-text” [“profile- name”] [-R|-

D|-L|-H] [-#]]

Where:

Argument Description Comments

Address Address(es) of Maximum 256 characters. Multiple

recipient or group of recipients must be separated with
recipients a “;”. Recognizes individual and
group nicknames. Address is not
optional.

Subject Subject text Maximum 256 characters. Subject

is not optional but can be left
blank by inserting “”.

Body-text Text of actual Maximum 512 characters. Body-

message text is optional and can be
omitted.

Profile name Mail service profile Can be omitted, in which case the
that is to be used default profile is called.

-R Notification is sent to If the recipient deletes the

the sender when the message without reading, a
message is actually notification as such is sent to the
read sender. Optional

-D Notification is sent to Optional

the sender when the
message is delivered

-L Message labeled for If both switches are omitted, the

Low importance message is labeled Normal by
default. If both switches are
inadvertently inserted, the system
recognizes the latter.

-H Message labeled for

High importance

-# Number of retries to Range of 1-9

execute if delivery
fails

Pulse 4.12 User Guide 1889

General Examples for Email
Example 1

Email “user1@afcon-inc” “PLC failure” –L

When executed, email is sent to user1 with the Subject "PLC failure" and
no message text, labeled for Low importance. Uses default mail profile.

Example 2

Email “Shift Managers; Plant Foremen” “New Holiday Schedule” “Labor Day
night workers…” “outlook” –R –3

When executed, email is sent to all users in the Shift Managers group and
in the Plant Foremen group. The message contains the Subject “New
Holiday Schedule” and a text message that contains “Labor Day night
workers (remainder of message)”. This message is labeled for Normal
importance (by default) and for Read notification. It specifies the profile
“outlook”. It is configured for 3 retries if not successful.

Example 3

Email “[email protected]; All Users” “” “Engine room is on fire” –R –D –H –9

When executed, email is sent to [email protected] and to all users in the

All Users group. This message contains no Subject and a text message
that contains the specified text. It is labeled for Delivery and Read
notification, High importance, and 9 (maximum) retries. Uses default
profile.

AutoAction Example for Email

Suppose you wish to write an email to all plant supervisors that the trend
reports for the month are to be submitted. A possible AutoAction script
may be:

Action Name TrendReportEmail

Trigger |!@AtDate(XXXX15)

Mode Up

Action Email “Plant Foremen” “Trend Report” “Today is

?"|!&lt;&lt;$Date&gt;&gt;"?. Trend Reports are due!”
“outlook” –D –3

Pulse 4.12 User Guide 1890

Advanced Alarm Handler Example
You can assign Email as an Alarm action when configuring an Alarm Class
in Database Editor (Database > Zones… > Classes…). Consider the
following example:

In this example, when a block associated with class OffHours Alarm

triggers an alarm, email is dispatched to the Off Premises Users group
containing the readout of the alarm as the Subject. There is no message
text in this example, importance is Normal, and there are no retries.

Pulse 4.12 User Guide 1891

Sending Email Using P-CIM Alarm
Pager Notification
Alarm enabled blocks can be configured to dispatch email messages at
regular intervals that contain a summary of the alarms that were
generated over the duration of the interval.

To understand how to do this it is important to have a look “behind-the-

scenes”.

If a Database block is Alarm Enabled – i.e., the Enable option in the Alarm
Table section is checked – AND one or both of the following options are
likewise checked:

 Pager on alarm

 Pager on RTN

THEN, when an alarm occurs, an alarm message is written to the system

variable $DispatchAlarm. The alarm message is comprised of the
following fields:

Node# The node number of the P-CIM client station

originating the alarm.

Date The date of the alarm formatted using the Windows

regional setting.

Time The time of the alarm formatted using the Windows

regional setting.

Tag-Name The name of P-CIM database block.

Node# The node number of the P-CIM client station

originating the alarm.

Alarm-Type Type of alarm (HIGH, LOW, ROC etc.).

Tag-Value EGU The value of the block causing the alarm followed
by the EGU notation as specified in the block.

Tag-Description The description of the block as specified in the

database.

Each message is buffered in an ODBC database table. From this database,

the alarm data is retrieved and formatted and subsequently dispatched as
email.

Pulse 4.12 User Guide 1892

P-CIM provides a special utility for configuring recipient and message
parameters, formatting the alarm data, and for scheduling the time
intervals for dispatch: the P-CIM Email Dispatcher-Configurator.

Once the message, format, and schedules are configured and the
database block is enabled for dispatch – by enabling one or both of the
Pager options – at every Send Rate period, the P-CIM Email Dispatcher
retrieves the alarm data, formats the email message, and sends it to the
target recipient(s). No further user input is required.

Debugging Email Sender

A debug option has been added to the Email Sender, whereby a
PFWEMAIL.LOG file is created under the project’s directory. This file’s
creation is defined in the INI File Editor using the following parameter:

File: PFWEMAIL.INI Section: @QUEUEPREFERENCES Token:

lognotification=1.

If you have problems sending emails from P-CIM, create and send the
PFWEMAIL.LOG file to: [email protected] where it will be analyzed.

NOTE The PFWEMAIL.LOG file is only written to after the Email

Sender has been activated.

Pulse 4.12 User Guide 1893

P-CIM INI
P-CIM INI Settings
This help topic describes the P-CIM settings in INI files. P-CIM initialization
files contain information that defines your P-CIM environment. P-CIM
applications use the information stored in these files to configure
themselves to meet your needs and preferences. There are several P-CIM
initialization files, respectively described in the following topics.

 How to Read the INI File

 How to Change INI Settings

 Format of the INI File

 Managing INI-type Files

 PCIM.INI Sections and Tokens

How to Read the INI File

The setup settings are documented in the following format.

Name The name represents the general topic, the feature

determined by the setting and, if possible the type
of the setting (flag, character, etc.). The “[+]”
suffix indicates that this setting is configured via a
program, with which you can view and change the
setting in its functional context. When there is
none, use this document and a text editor (e.g.,
Notepad).

Description The description follows the name. When applicable,

it indicates the tool and operation with which the
setting is set in its context.

Syntax The syntax presentation format is illustrated below,

annotated.

 file.INI Name of INI file

 [section] Name of section

 token=argument Formal definition

Pulse 4.12 User Guide 1894

 argument What the argument stands for; the valid value
type and range

 Default The default is as follows: token=value

 Example An example is provided where applicable or

required to further describe the issue.

How to Change INI Settings

For convenient control of INI settings during application development, use
the INI File Editor.

For advanced applications, use the Datasheet Manager to access and

modify data in INI and INI-format files at runtime.

Read the following information for reference, and use it if you prefer to
use a text editor to edit INI and INI-format files.

Format of the INI File

The INI-type file contains several sections, each of which consists of a
group of related settings. The sections and settings are listed in the INI
file in the following format:

[section name] token_name=value

In this example, [section name] is the name of a section. The enclosing

brackets ([ ]) are required, and the left bracket must be in the leftmost
column.

The token_name=value statement defines the value of each setting. A

token_name is the name of a setting. It can consist of any combination of
letters and digits in uppercase or lowercase, and it must be followed
immediately by an equal sign (=). The value can be an integer, a string,
or a quoted string, depending on the setting.

You can include comments in initialization files. You must begin each line
of a comment with a semicolon (;).

Pulse 4.12 User Guide 1895

Changing Settings
There are two ways to change a program's settings (stored in the INI
file):

 Use the program itself to change the most frequently used settings.
This is the safest and most recommended way because there is no
need to open and edit the INI file, where it is easier to make
mistakes.

 To change the settings that you cannot change by using a program,

use one of the following utilities. After you have edited an INI file,
you must restart the program(s) that use those settings for the
settings to take effect.

• Use the P-CIM INI File Editor at is oriented toward editing

INI-type files, and provides on-line help for any standard P-
CIM INI setting.

• Use a text editor, such as Windows Notepad, to edit the INI

file directly. (Do not use a formatting editor; it can corrupt
your INI file.)

NOTE Always back up your INI file before you make changes so that
you can restore the original file in case you accidentally
damage the INI file or make changes that cause problems
when running P-CIM. It is recommended that you do not
change any settings that are not described herein, or clearly
marked “DO NOT CHANGE” Be careful when using a text editor
to edit an INI file. Incorrect changes to INI files can cause
unexpected results when you run P-CIM.

Pulse 4.12 User Guide 1896

Managing INI-type Files
The size of an INI (or INI-type) file is limited to a maximum 64 K Bytes
(65,536 Bytes). This is a Windows limitation. This limit reflects on the
following files used in association with P-CIM:

 Files with extension INI:

• PCIM.INI

• PCIMUSER.INI

• PCIMHELP.INI

• PCIMTASK.INI

• DRVRPORT.INI

• DSCOP.INI

• SELECT.INI

 Other files used as INI-type:

• PFWALIAS.TXT

• display.AUT

• recipe.RCP

• report.REP

In the present software revision, there is no indication to the user on the

size of the respective file being edited, and whether the limit has been
reached or not.

This limitation can affect your application (where the size of such a file can
increase indefinitely) in the following application topics:

 The number of Operator Workstation AutoActions stored in

PCIMUSER.INI

 The number of AutoActions of a display - stored in files type AUT

(file named after the display)

 The size of recipes - stored in file type .RCP (file named after the
recipe)

 The number of aliases - stored in PFWALIAS.TXT

Pulse 4.12 User Guide 1897

 The size of reports - stored in file type .REP (file named after the
report)

 The number of the List Box choices - stored in SELECT.INI file

(default) or in other customized INI-type files

Do the following to avoid problems:

 During application development observe (e.g., using Windows

Explorer) the size of each such file.

 Be aware that adding groups to a recipe (with the LearnRcp

command) at run time increases the size of the recipe file to a point
where it exceeds the size limit.

PCIM.INI Sections and Tokens

PCIM.INI contains factory settings. In general, they not intended to be
changed by the user.

 Section: BASICSERVER

Tokens:

• BASICOPERNO

Statement clusters - Max.(6.50)

BASIC Server

The settings SleepTime and BasicOperNO help prevent an

endless loop script from monopolizing the CPU resources and
from adversely affecting the overall system performance.
Their effect is to make the server sleep for a certain amount
of time after so many operations.

BasicOperNO defines the number of BASIC statements to be

executed from the last sleep.

SleepTime defines how much time to sleep (in milliseconds).

Example:

[BasicServer]
BasicOperNO=10
SleepTime=100

Pulse 4.12 User Guide 1898

 Syntax

PCIM.INI
[BasicServer]
BasicOperNO=number
number - number of statements

Default BasicOperNO=10

• QUERYOPEN

Debug window show - flag (6.50)

BASIC Server

Defines if BASIC server shows its debug window (if the

Restore command is available in its system menu).

Syntax

PCIM.INI
[BasicServer]
QueryOpen=flag
flag- 0 - No; 1 - Yes

Default QueryOpen=0

• REFRESHAFTERSLEEP

• SLEEPTIME

 Section: CBM32

Tokens:

• GeneralTimeout

• SMTOTimeout

• SocketEnable

• TRXMemSize

 Section: CLIENT

Tokens:

• CALLBACKSUPPORT

• DDEVERIFYPOKEDELAY

• DDEVERIFYREQUESTDELAY

Pulse 4.12 User Guide 1899

 • INSTANTPOKEEFFECT

• NOTIFYDDEBUFFER

• NOTIFYDDETIMEOUT

 Section: DBSR2LANDR

Tokens:

• LANSERVICESENABLE

• LOCALRCVACKENABLE

• LOCALRCVACKFACTOR

• LOCALRCVACKMAXLOOP

• LOCALRCVACKRECS

• LOCALSNDACKENABLE

• LOCALSNDACKRECS

• LOCALSNDEVENTENABLE

• LOCALSNDEVENTRECS

• RECEIVEALARMS

• RECEIVEEVENTS

• REMOTERCVENABLE

• REMOTERCVFACTOR

• REMOTESNDENABLE

• REMOTESNDFACTOR

• RXSIZE

• SENDALARMS

• SENDEVENTS

• TXSIZE

• TIMER

• UPGRADESWITCHESVER40

Pulse 4.12 User Guide 1900

 Section: DbsrClient

Tokens:

• DdeTimeOut

• SendInitiateTimeOut

 Section: DbsrDebug

Token:

• DbgWin_AutoOpen

 Section: DBSREXT

Tokens:

• ACTIONDEBUGENABLE

• ACTIONDEBUGFILEENABLE

• ACTIONDEBUGFILENAME

• ACTIONDEBUGLBLINES

 Section: DBUtil

Token:

• AllowOnLineUpdate

 Section: DDEITEMS

Tokens:

• FINDWHAT

• ITEM

• REPLACEWITH

• SERVER

• TOPIC

Pulse 4.12 User Guide 1901

 Section: GDISPLAY

Tokens:

• BYPASSDBSR

• GDCTLCLOSEDDEPACKET

• GDCTLDELAYDDEPACKET

• GDCTLDELAYDLGWAIT

• GDCTLFLUSHDURINGLOAD

• GDCTLFLUSHHALTLIMIT

• GDCTLMOMENTARYFLUSHHALTLIMIT

• GDCTLTIMESLICE

• GDDDETIMERMULTIPLIER

• GDFLUSHTIMESLLICE

• GDMSGTIMERMULTIPLIER

• GDTIMERINTERVAL

• LOGOFILE

• MSGQUEUSIZE

• NumObjectUpdate

• PfwTrnspStart

• STANDALONE

• USERPRIORITY

 Section: HELPMODULES

Tokens:

• BUP

• EDITRCP

• EDITRPT

• EDITUPD

Pulse 4.12 User Guide 1902

 • EXPRESS

• GDISPLAY

• HELPINI

• HTVIEW

• INIEDIT

• MSGSETUP

• OPCSRV

• PASSWORD

• PCIM_CFG

• PCIMALMH

• PCIMDE

• PCIMDSCOP

• PCIMREF

• PCIMSETUP

• PCIMTASK

• PFWALARM

• PFWNET

• PFWTLBAR

• PRJCONF

 Section: LASTDRW

Tokens:

• RECALL

• RECALL1...9

Pulse 4.12 User Guide 1903

 Section: PCIMALMH

Tokens:

• DISABLECURRENTMENUITEMS

• PCIMALMH - DISABLEDAILYLOGMENUITEMS

• PCIMALMH - DISABLESUMMARYMENUITEMS

• PCIMALMH - DISABLEZONEMENUITEMS

• PCIMALMH - SIZEOFALMHCB

 Section: PcimAtom

Tokens:

• DeleteEmptyStringTables

• Enable

• GarbageCollectFactor

• GarbageCollectMethod

• MaxAtoms

• MaxHashBuckets

• MaxStringTables

• StringTableSize

 Section: PCIMCALLBACKWINDOWS

Tokens:

• <name>

• BasicSrv

• DBSR

• OPCSrv

• pfwalarm

• PFWDrvr

• PfwNet

Pulse 4.12 User Guide 1904

 • SOCKCLI

• SOCKSRV

• TxtSrv

 Section: PCIMDBSR

Tokens:

• ACTHTMAXMES

• ACTHTRECSIZE

• ADVISEMEMFIXED

• AdviseThread.Enable

• ADVMEMBLKKB

• ADVSIZE

• CALLBACKRES

• CHKFREESPACEFACTOR

• CLIDBITEMSIZE

• CLIITEMSIZE

• DATAACKTIMEOUT

• DatabaseTxtObsolete

• DateChecking

• DBAbove1Mega

• DbgCBCliMutex

• DbgCBMutex

• DbgCBSem

• DbgMsgItemList

• DBIOWait

• DBMultiTxt

• DBSOLVERFACTOR

Pulse 4.12 User Guide 1905

 • DBSolveThread

• DDETIMEOUT

• DebugDbfCalls

• DelayDBIOAdvise

• DelayIOAdvise

• DelayIOPoke

• DosVer

• EMULATIONONNOKERNEL

• ExecDBCbxServers

• FUNCRetryIniIfUndef

• HFCMONLINE

• HistoryDestinationCode

• HTDIRENABLE

• HTFILEFACTOR

• HTIGNOREBADMS

• HTMAXMES

• HTNameDescPairs

• HTShowTagDelMsgOnFlush

• iCountry

• IODelayCBMax

• IOErrorWait

• IOld0

• IOldt0

• IOlh0

• IOTimer

• ItemGenQMax

Pulse 4.12 User Guide 1906

 • ITEMMEMBLKKB

• ITEMMEMFIXED

• ITEMSIZE

• LocalNodeShortCut

• LOWCLUSTERSLIMIT

• MAXADVMEMBLK

• MAXBIGSCAN

• MAXCBLOOP

• MaxFloatDummy

• MaxGlobalMessage

• MAXGTIMER

• MaxLongDummy

• MAXMSGQUEUESIZE

• MAXSMALLSCAN

• MaxStringDummy

• MaxToggles

• MinMBinWindows

• MSGQUEUESIZE

• NetworkOverride

• NetworkPort

• NEWHISTRETRIEVE

• OFFSCANCOMMAFTERPOKE

• OffScanIOOnBlockDelete

Pulse 4.12 User Guide 1907

 • OnIoErrorUpdateHT

History Block Error Update Flag (6.62)

There is a new switch in file pcim.ini section [PcimDBsr]:

OnIoErrorUpdateHT=0

This flag enables a function to display erroneous values when

using the HTUTIL.EXE utility. If enabled when an IO error
occurs on a block that collects historical data, the last
recorded good value is rewritten with an error notation
(FFF8) preceding the value.

This switch is a complement to the switch

HTIgnoreBadMsPCIM_PCIMDBSR_HTIGNOREBADMS. When
this switch is enabled, HTIgnoreBadMs should be disabled.

• OpenAlarmOnLine

• OptimizeFunctionPoll

• PFWDRVRREADYLOOP

• QUERYOPEN

• RAMBITSIZE

• ReAdviseItemsTimer

• ReadyDelay

• REFRESH

• RETURNONCLIENTDDE

• ReTurnOnClientDDE

• SMTOTimeout

• SMTOTimeoutReq

• StdDocNameSupp

• SWCLIENT

• SWDBGWIN

• SWEXCLUDE

• SWINI

• SWMSSG

Pulse 4.12 User Guide 1908

 • SWWMTIMER

• SYSTIMER

• TimeOutCBMutex

• TIMER

• TxtSrvCBX

• UseCBCliThreads

• USECBM

• UseCBSemSrv

• UseGMTTime

• UseInitiateWait

• UseItemInfoDlg

• UseItemListThread

• UseItemListWait

• UseParserDll

• WINFLSRVC

• WunVer

• XLTABLESUPPORT

 Section: PCIMINIFILES

Tokens:

• DRVRPORT

• PCIMINIFILES - PCIM

• PCIMINIFILES - PCIMUSER

• PCIMINIFILES - PFWALARM

• PFWALDEF

• PFWNET

• PROJECT

Pulse 4.12 User Guide 1909

 Section: PCIMINTERPROCESS

Token:

• DBSRMAINWINDOW

 Section: PCIMFILEEXT

Tokens:

• CSV

• LST

 Section: PCIMSERVERS

Tokens:

• <name>

• PCIMSERVERS - DBSR - The P-CIM Database Server

• OpcSrv

• pfwnet

 Section: PCIMTOOLS

Tokens:

• PCIMTOOLS - TOOL1...10

• PCIMTOOLS - ARG1

• PCIMTOOLS - EXE1

 Section: PCMSG

Tokens:

• MAXMSGPACKAGE

• PCMSGDELAYENABLE

 Section: PFWemail

Token:

• MailAplication

Pulse 4.12 User Guide 1910

 Section: PFWIOSERVER

Tokens:

• IOServerApp

• IOServerExeName

• IOServerTopic

 Section: PWEM

Tokens:

• DemoTimeOut

• ErrorIsEvent

• MaxIO

• MaxNodes

• NoSekTimeOut

• OldLimitTimer

• SekTimeLoop

• SekTimeOut

• SOFTKEYONLY

• StartupTimeout

• ViewerNode

• ViewerOnly

 Section: RESOURCEDATA

Tokens:

• DBOXBACKGROUNDCOLOR

• DBOXFRAMEBLACKCOLOR

• DBOXFRAMEWHITECOLOR

• MOTIFFRAMESTYLE

Pulse 4.12 User Guide 1911

 Section: RESOURCELIMIT

Tokens:

• ERRORLIMIT

• WARNINGLIMIT

 Section: SDT32

Tokens:

• MemNameBITS

• MemNameDATABASE

• MemNameDBSEGS

• MemNameDESEGS

• MemNameEDITDB

• MemNameEXTBUCKET

• MemNameSCANMEM

 Section: ShutDown

Token:

• SHUTDOWN 1 ... SHUTDOWN 2

 Section: ShutdownTimes

Tokens:

• TimeElapse

• WaitTime

• WriteToLog

 Section: SockSrv

Token:

• EnableSockSrv2DbsrMsg

Pulse 4.12 User Guide 1912

 Section: STARTUP

Tokens:

• AlmCMD

• ALMH

• DBSR

• Gdisplay

• PcimTask

• PFWOPCG.exe

• txtsrv

• ViewLogo

 Section: UPDATECONF

Tokens:

• AUTOMOVETOBACK

• BACKUP

• BMPCOMPRESSTYPE

• CLIPARTBOX

• CLIPARTBOXSTYLE

• GRAPHICOPERATIONONCELL

• HEAVYDUTYSYMBOL

• HideBlocksList

• LOGOFILE

• MINIMALFREEMEMORY

• MOVETIMEOUT

• NUMERICAUTOSID

• OPENUNTITLED

• PALETTEFILE

Pulse 4.12 User Guide 1913

 • PCIMXRES/PCIMYRES

• STATUSBAR

• SYMBOLSINTOTRANSPBMP

• TRANSPARENTALTCOLOR

• TRANSPARENTCOLOR

• UpdCompactFormat

Pulse 4.12 User Guide 1914

Pulse Security
There may be activities that are restricted and are only available to
certain operators, who have specialized knowledge and responsibilities.
Protecting project data is usually an important aspect of a company’s
activities and Pulse provides several ways to implement project and
system security.

In Pulse, mechanisms of locks/keys and access levels are used to regulate

and restrict access to various areas and tasks in the system. For example,
restrictions may apply to access to a display or to objects within a display,
where certain lock levels or access values are attached to them.

NOTE If security is not defined for a display or object, the display or

object can be accessed by all operators.

The components of Pulse Security are:

Authorization Pulse provides two Authorization Modes: the Simple

Mode and Advanced Modes. These enable the application
of access levels and lock-and-key-based security
mechanisms, respectively, that assure that your
Pulse projects are accessed and operated only by
personnel with matching security permissions.

Authentication Login to Pulse and its utility applications may be

Mode based on Pulse’s own authentication mechanism or
your network’s Windows-based user accounts.

Modules Security Modules Security restricts access to the various

modules and utilities which comprise the Pulse
Server and Client applications. Each module and
utility is associated with an access level or lock.

Audit Trail The Audit Trail utility records changes made in

various modules of the Pulse application and all
actions taken by every Pulse user, starting from the
time of user login until user logout from the
application.

I/O Write The I/O Write Security allows only users whose
Security access level or key matches or exceeds a specified
level, to write and make changes to database
blocks and other values. Unauthorized clients
cannot change I/O values.

Pulse 4.12 User Guide 1915

This section contains the following topics:

 Defining Security Policy in the Security Manager

 Simple Authorization Mode

 Advanced Authorization Mode

 Modules Security

 Audit Trail

 I/O Write Security

 Defining Users and their Security Levels

 Menu Authorization

Pulse 4.12 User Guide 1916

Defining Security Policy in the
Security Manager
In the Pulse Security Manager, define and enable all aspects of your Pulse
project’s security policy.

1 In the AFCON Pulse application group, go to the Administrative

Tools and open the Security Manager.

Pulse 4.12 User Guide 1917

2 Define Security Policy as follows:

Authorization Mode

The scope of security is affected by the Authorization Mode you

apply - Simple or Advanced.

Simple Each user is assigned an authorization level in

a range of 0 and 99 - 0 being the highest
security level and 99 represents a completely
restricted account. Each item, action, or
element that is security-enabled is also
assigned an authorization level, and only users
whose levels match or are higher, receive
access to them.

Advanced Apply a multi-dimensional lock-and-key-based

security policy which provides expanded
security to your Pulse installation.

A key is composed of a user access level and

sets of operations (modules and program
elements) and areas (zones, displays, etc.)
which the key can “enter.”

A lock is composed of feature level and sets of

operations (modules and program elements)
and areas (zones, displays, etc.) which the
lock can control access.

Access is only granted when a user’s key

matches an element’s or action’s lock.

If you select this mode, additional

configuration tabs appear in the Pulse Security
Manager dialog box. For more information,
see Advanced Authorization Mode.

Pulse 4.12 User Guide 1918

 Authentication Mode

Anonymous Users' permissions are not validated prior to

performing operations in the project. Instead
of prompting the user for login details, access
is granted through a predefined Anonymous
user with a default password. An Anonymous
user cannot customize or personalize the
workstation. The anonymous user account is
used for audit trail logging and determining
authorization.

NOTE The Audit Trail is not supported in

the Anonymous authentication
mode.

Pulse All security credentials and settings are saved

on the Pulse Server on a per-project basis.

Windows The user sends the account's full user name

and password, including the domain name, for
authentication by the Pulse Server. The
password is validated by the Active Directory,
and the username and authorization privileges
are saved in the Pulse Security database on a
per-project basis.

Windows Login The user Windows account is the logged in

Pulse user. To change the login, the user must
log off first.

Menu Authorization

Protect Operator Select this option to assign access levels or

Workstation locks to Operator Workstation commands in
the menu bar and in the system context (right-
click) menu. If this option is set, use the Pulse
Workstation to define the authorization for
each menu option, see Menu Authorization.

Pulse 4.12 User Guide 1919

 Audit Trail

The Audit Trail utility records changes made in various modules of

the Pulse application and all actions taken by every Pulse user,
starting from the time of user login until user logout from the
application. For more information, see Audit Trail.

None No action is recorded when this option is

selected.

Operator Actions Select this option to record all logged actions

(that the user specified) done by operators in
the Operator Workstation that change the
values of blocks or other items.

Operator Click this button to open the Action Log

Message Setup Messages Setup dialog box, where you can
design the structure of the Operator Action Log
messages, see Setting Up Action Log
Messages.

Operator and Select this option to record all logged actions

Developer (that the user specified) done in the Operator
Actions and Developer Workstations that affect the
data in the system.

Modules Click this button to open the Pulse Modules

Security Security dialog box, where you assign the
levels or locks to the various modules of the
Developer Workstation.

This button is only active when the Operator

and Developer Actions option is selected,
see Modules Security.

Log All Operator Select this for Force logging option all over the
Actions Pulse application even if the Log checkbox
option is not enabled for an object. It records
all actions in the workstation(s) even if the
user did not define logging in the Object
Properties window(s).

Pulse 4.12 User Guide 1920

 Intrusion Detection and Prevention

Intrusion Select this option to detect unwanted activity,

Detection such as attempts to perform an unauthorized
operation, or login with an incorrect user name
and password. Such an activity is considered
as an intrusion and is handled by the
configured security modes and policies.

This option is only available if the Pulse or

Windows Authentication Mode is selected.

Log Attempts to Record intrusion attempts in the System

System Messages log in the Alarm Explorer.
Messages

Log Attempts to Record intrusion attempts in the Audit Trail

Audit Trail Viewer

Intrusion Select this option to prevent unwanted users

Prevention from logging into the project.

This option is only available if the Pulse

Authentication Mode is selected.

Lock user after Specify the number of failed login attempts

___ failed allowed before completely blocking the user
attempts to account.
login

I/O Write Security

Select this option to activate the I/O Write Security mechanism.

The I/O Write Security prevents unauthorized clients from

modifying I/O items in the Pulse kernel. Unauthorized users may
use the I/O items in simulator actions but not in runtime.

For more information, see I/O Write Security.

Level If the I/O Write Security checkbox option is

activated when the Simple Authorization Mode
is being used, this field is available.

Specify the minimum access level required to

grant a user write privileges to any Pulse
Server functions.

Pulse 4.12 User Guide 1921

 Lock If the I/O Write Security checkbox option is
activated when the Advanced Authorization
Mode is being used, this field is available.

Specify the minimum access level required to

grant a user write privileges to any Pulse
Server functions.

Secured Click this checkbox option to transport logged

Transport data securely.

Redirect Client Check this option to redirect the recorded

log to Server logged data to the server.

Pulse 4.12 User Guide 1922

Simple Authorization Mode
In Simple Authorization Mode, each user is assigned an access level in a
range of 0 to 99, inclusive. 0 represents the highest security level with the
most privileges; 99 represents the lowest level, a completely restricted
account. Additional levels in between represent varying degrees of
privileges.

Each item, action, or element that is security-enabled is also assigned an

access level, and only users whose levels match or have a lower value,
receive access to them. For example, a user whose access level of 50 is
denied access to an element with an access level of 40. However, a user
whose access level is 40 or below gains access.

Access levels for all users are assigned in the User Manager, see Defining
Users and their Security Levels.

To set up the Simple Authorization Mode

1 In the Security Manager’s Authorization Mode area, select

Simple.

2 Enable security mechanisms as defined in Defining Security Policy

in the Security Manager.

3 From the Developer Workstation’s Tools ribbon, click the User

Manager icon.

4 In the User Manager, add your Pulse system’s users and define
their access levels and various permissions, see Defining Users and
their Security Levels.

Advanced Authorization Mode

Pulse Advanced Authorization Mode is a multi-dimensional security
system, implementing a system of locks and keys. Every function is
tagged with a lock which specifies its minimum permission requirements
for access, and every user is assigned a key, which specifies the user’s
permissions. In order to “open” a lock, the user must own a key that
matches its settings (the key may also have additional authorizations).

In the Pulse Advanced Authorization Mode, you can define locks, produce
keys, and distribute the keys to various users.

A Lock defines:

 The minimum level required for access to the function.

 The Operations which this Lock allows access.

Pulse 4.12 User Guide 1923

 The Areas (zones or devices) to which this Lock allows access.

A Key defines:

 The access level (the maximum authority) for the user.

 The Operations to which this user may access.

 In which Areas (zones or devices) this user can access.

For a full explanation of Locks and Keys, see Advanced Authorization Mode
- Locks and Advanced Authorization Mode - Keys.

To obtain access to a function, a user’s "Key" must match the "Lock" that
pertains to that function. The user is granted access to the function only if
all of the following conditions are true.

 The user's access level meets or surpasses (i.e., is numerically

equal to or less than) the access level that is defined in the
function’s Lock.

 The Operation(s) that are enabled in the function’s Lock are among
those that are enabled in this user’s Key.

 The Area(s) that are enabled in the function’s Lock are among
those that are enabled in the user’s Key.

Through this system, you can "fine-tune" the authority of each user and
restrict the access to the Operations and Areas that pertain directly to that
user.

Advanced Authorization Mode - Basic Usage

The following tasks are required to create entries in the Advanced
Authorization Mode. Each task corresponds with a tab in the Security
Manager (only when Advanced Mode has been selected):

Operations and Naming the Operations and Areas (zones) that are
Areas used in your establishment.

Locks Defining the Locks to be associated with the functions

in your establishment.

Keys Defining the Keys to be assigned to the users.

Pulse 4.12 User Guide 1924

Locks - Description
A Lock is a set of conditions that must be met in order to grant access to
a feature or function. The set of conditions consists of the following
components:

 Access level ranging from 0 to 99

 Operations to allow and restrict access

 Areas to allow and restrict access

The Locks are applied to the various functions (features, operations,

controls, commands, blocks, displays, etc.) in their respective Property
definition windows. You may define up to 255 Locks.

NOTE Locks relate only to the functions of Pulse, and not to the
users. The Keys are the bridge between the users and the
Locks. For more information about Keys, see Keys -
Description.

Keys - Description
A Key is a set of conditions that each user possesses which determine
what the key-holder (user) is authorized to do. The key consists of the
following components:

 Access level ranging from 0 to 99

 Operations which the key grants access

 Areas which the key grants access

To receive access to a function or control, a user’s Key must fit the

function’s or control’s Lock in the following ways:

 The user's access level meets or exceeds (is numerically less than
or equal to) the access level that is defined in the function’s Lock.

 All of the Operations and Areas associated with this function’s Lock
are also enabled in the user's Key.

NOTE If the user's Key contains more enabled Operations and/or

Areas than is defined in the Lock, permission to access is not
affected. However, if a Lock contains any enabled Operations
or Areas that are not enabled in the user's Key, the user is not
granted access to that function.

Pulse 4.12 User Guide 1925

Each user is issued one Key. Therefore, Keys must be designed for the
specific authority of each user. If the user's authority is unique, you must
define a unique Key for that user. Users who share an identical authority
"package" may be assigned to the same Key.

Creating Keys requires significant planning. Before you define Keys, you
must know precisely which Locks are assigned to the functions that this
user controls and which Operations and Areas are enabled for those
Locks.

You may create an unlimited number of Keys.

This section contains the following topics:

 Advanced Authorization Mode - Operations and Areas

 Advanced Authorization Mode - Locks

 Advanced Authorization Mode - Keys

 Switching Authorization Modes

Advanced Authorization Mode - Operations and

Areas
When creating entries in the Advanced Authorization Mode, you must first
list all of the Operations and Areas that are part of your enterprise.

To define Operations and Areas

1 In the Security Manager’s Authorization Mode area, select

Advanced.

2 Click the Operations tab. Until modified, the entries contain

default text (Operxx) and are numbered 1 to 32.

Pulse 4.12 User Guide 1926

3 In the Operations table, list relevant tasks, processes, stages, etc.
Click in the Description field of each entry to define or edit it. Type
a description, such as “Storage”, “Mixing”, “Loading” (up to 40
characters).

4 Click the Areas tab. Until modified, the entries contain default text
(Areaxx) and are numbered 1 to 32.

Pulse 4.12 User Guide 1927

5 In the Areas table, list relevant locations, platforms, offices, etc.
Click in the Description field of each entry to define or edit it. Type
a description, such as “Storeroom”, “Production floor”, “Loading
platform” (up to 40 characters).

6 Click Save.

Advanced Authorization Mode - Locks

The second step for creating entries in the Advanced Authorization Mode
is to define Locks. A Lock is a set of conditions that must be met in order
to grant access to a feature or function. The set of conditions consists of
the following components:

 Access level ranging from 0 to 99

 Operation permissions

 Area permissions

The Locks are applied to the various functions (features, operations,

controls, commands, blocks, displays, etc.) in their respective Property
definition windows. You may define up to 255 Locks.

To define Locks

1 In the Security Manager, click the Locks tab.

Pulse 4.12 User Guide 1928

2 In the Locks list, select a lock name from the drop-down list or
click Add to add a new lock. We suggest that the lock names
indicate a relevant role and/or security level, such as “Security”,
“Management”, “Production” (up to 40 characters).

The Add New Lock dialog box is displayed.

NOTE If you are modifying an existing lock, choose it from the Lock
list.

3 Enter a name for the new lock in the Name field and select one of
the following settings:

• Administrator

• Last selected settings

• Guest

4 Click OK to add the new lock.

5 In the Level field, enter the access level (0-99) and then click
Apply. Only users whose keys match or have a lower access level
than this, receive access to elements owning this lock. For example,
a user whose key’s access level = 50, is denied access to an
element whose lock’s access level = 40. However, a key whose
access level is 40 or below gains access.

6 In the Operations table, enable (check) all of the operations that

are not restricted by this Lock. Likewise, make sure to keep
disabled (clear) all of the Operations that are completely protected
by this Lock.

Pulse 4.12 User Guide 1929

NOTE To enable the entire list, click Select All at the bottom.

If the entire list is enabled and you wish to disable the entire
list, click Deselect All.

If the list is partially enabled and you wish to disable the entire
list, click Select All and then Deselect All.

7 In the Areas table, repeat step 4 for the areas that are not
restricted by this Lock.

8 Click Save.

Advanced Authorization Mode - Keys

The third step for creating entries in Advanced Authorization Mode is to
define Keys.

A Key is a set of conditions that each user possesses which determine

what the key-holder (user) is authorized to do. The key consists of the
following components:

 Access level ranging from 0 to 99

 Operation

 Area

To receive access to a function or control, a user’s Key must fit the

function’s or control’s Lock in the following ways:

 The user's access level meets or exceeds (is numerically less than
or equal to) the access level that is defined in the function’s Lock.

 All of the Operations and Areas associated with this function’s Lock
are also enabled in the user's Key.

Pulse 4.12 User Guide 1930

To define Keys

1 In the Security Manager, click the Keys tab.

2 Select a key from the Keys drop-down list or click Add to add a
new key.

We suggest that the key names indicate a relevant role and/or

security level, such as “Administrator”, “Production Manager”,
“Security Officer”, “Viewer Only“ (up to 40 characters).

The Add New Key dialog box is displayed.

Pulse 4.12 User Guide 1931

3 Enter a name for the new key in the Name field and select from
one of the following settings:

• Administrator

• Last selected settings

• Guest

4 Click OK to add the new key.

5 In the Level field, enter the access level (0-99) and then click
Apply. Only elements whose locks match or have a higher access
level than this, allow access to users owning this key. For example,
a user whose key’s access level = 50, is denied access to an
element whose lock’s access level = 40. However, a key whose
access level is 40 or below gains access.

6 In the Operations table, enable (check) all of the operations that

are accessible with this Key. Likewise, make sure to keep disabled
(clear) all of the operations that are not accessible by this Key.

NOTE To enable the entire list, click Select All at the bottom.

If the entire list is enabled and you wish to disable the entire
list, click Deselect All.

If the list is partially enabled and you wish to disable the entire
list, click Select All and then Deselect All.

7 In the Areas table, repeat step 4 for the areas that are associated
with this Key.

8 Click Save.

Pulse 4.12 User Guide 1932

Switching Authorization Modes
Advanced Authorization Mode is both upward and backward compatible
with the Simple Authorization Mode.

Upward Compatible
If you have been using the Simple Authorization Mode, and switch to the
Advanced Authorization Mode, the system recognizes the users and their
access levels. The system automatically creates Locks named "Feature
Group Levelxx" and Keys named "Users Levelxx" where xx is the
numeric access level that has existed until now. By default, all Operations
and Areas are enabled (unrestricted). You can now define Locks and Keys
to further restrict the authority of the users.

Backward Compatible
If you have been using Advanced Authorization Mode and switch to the
Simple Authorization Mode, the system recognizes the users and their
access levels as defined in their Keys. Users now have full access to all
functions that are within their access levels and there are no restrictions
on Operations and Areas. The Advanced Authorization settings remain
saved in the Pulse system files and are restored if you later switch back to
Advanced Authorization Mode.

Pulse 4.12 User Guide 1933

Modules Security
The Pulse Modules Security utility presents a table listing all Pulse
modules and enables you to attach a lock or access level (depending on
the current Authorization Mode) to each Pulse Server module. To define
the Modules Security, you have to enable Developer Workstation
protection.

To define modules security

1 Go to the Security Manager’s Policy tab and click the Modules

Security button in the Audit Trail area.

NOTE the Modules Security button is only active when the

Operator and Developer Actions option is selected.

The Pulse Modules Security dialog box is displayed.

Pulse 4.12 User Guide 1934

2 Select a module under the Module column and click on the
corresponding Lock / Access Level column to display the following
options from the drop-down list:

• None

• Feature Group Level0

• Feature Group Level99

3 When you have finished assigning locks to modules, click OK to

save the settings.

Pulse 4.12 User Guide 1935

Audit Trail
The Audit Trail utility records changes made in various modules of the
Pulse application and all actions taken by every Pulse user, starting from
the time of user login until user logout from the application.

Operator Actions
The Operator Actions option enables the Audit Trail log to record actions
performed by operators at runtime that change the values of blocks or
other items. If the Operator Actions option is selected, then only the
actions specified by the user are recorded.

Operator Action Log messages include information about the action

including the user, description, and the time.

For more information on setting up the Action Log Messages structure,

see Setting Up Action Log Messages.

Setting Up Action Log Messages

In the Action Log Messages Setup dialog box, design the template for
action messages sent from the Operator Workstation to a daily log when
operators activate controls (Input Text, Slider, and Buttons).

To activate the sending of action messages, the following conditions must

be present:

 Logging inputs or actions must be enabled in the graphic object’s

animation properties or instrument’s settings.

 Operator Action Logs must be activated for the Operator

Workstation (in the Operator Personalization Settings).

Every message starts with a time stamp (HH:MM:SS) followed by several

user-configured syntax fields. The fields indicate essential information
(item address parameters, display name, object name, user name, input
value, etc.) in a format specified by you.

The Action Log Messages Setup's flexibility allows it to support lexically

correct messages in various languages. A sample message is displayed at
the bottom of the window.

Pulse 4.12 User Guide 1936

To set up Action Log messages

1 In the Security Manager’s Policy tab, click the Operator

Message Setup button.

The Action Log Messages Setup dialog box is displayed.

2 In the Message Tokens area, define the structure of the message.

Set the order of the placeholder variables and the number of
characters allotted for each (or keep the default order and
allotments). The total length of all the fields cannot exceed seventy
(70) characters.

dde For Input Text and Sliders - the data item

address (Server, Topic, and Item) associated
with the activated control.

For Action Buttons - the command initiated by

the button.

Pulse 4.12 User Guide 1937

 value The DDE item’s or action’s current value
(before operator input).

oldval The DDE item’s or action’s previous value

verb The action that was carried out. See the Verb
section below for this variable’s possible strings
when the control is an Input Text, Slider, or
Button/Active X control.

newval The value entered by the operator

BY, WITH, IN User-defined words (for example, BY, WITH, IN

are prepositions) which can link the variables in
the message’s composition. See the User
Words section below for instructions on editing
this placeholder’s possible strings.

user The name of the operator that performed the

action

object The name of the control through which the

action was performed

display The name of the display in which the action

was performed

3 In the Verb area, define up to three different verbs describing

actions performed with, respectively, Input text, Slider, and Action
Button/ActiveX Control.

4 In the User Words area, define up to three different words to be

used as prepositions. By default, BY, WITH, and IN are provided.

Pulse 4.12 User Guide 1938

5 In the Button Adverb area, define adverbs qualifying the action
button verb, describing the Button Down and Button Up actions.

In an Action Button message, the adverbs stand for Value.

6 In the Sample Message area, enter the actual words to appear in

the sample message for the respective parts of the message.

7 View the resulting sample messages to confirm if the structure is

satisfactory.

Input/Slider Displays the sample message for an Input Text

or Slider control

Button/ActiveX Displays the sample message for an Action

Button or ActiveX control.

8 Click Save to save the message template.

Pulse 4.12 User Guide 1939

Operator and Developer Actions
The Operator and Developer Actions option enables the Audit Trail Log
to record all the user-specified actions done in the Operator and
Developer Workstations that affect the data in the system. These include:

 Creating, editing or deleting a display

 Creating, editing or deleting a workflow

 Creating, editing or deleting a database block or branch

 Changing configuration settings in the Configuration Editor

 Changing localized strings in the Localization Editor

 Changing AutoActions in the AutoActions editor

 Changing project data.

 Changing Security settings, especially the Audit Trail settings.

Developer Action Log messages are saved to the Audit Trail log. All
Developer Action Log messages include information about the action
including the user, description, and the time.

Pulse 4.12 User Guide 1940

Filtering the Audit Trail
Applying a filter enables the Audit Trail Viewer to display customized
information, relating to a specific module only, to a specific period, a
specific user, or a specific action.

To apply a filter to the Audit Trail Viewer

1 From the Audit Trail Viewer’s File menu, choose Filter.

The Filter dialog box is displayed.

Pulse 4.12 User Guide 1941

2 Define the Filter parameters in the Filter dialog box fields.

From DD/MM/ The earliest date and time of the displayed

YYYY entries.

To DD/MM/YYYY The latest date and time of the displayed

entries.

User Name Entries pertaining to this user name only will

appear in the Viewer.

Node Number Entries pertaining to this node only will appear

in the Viewer.

Description A free text description which must be in the

contains displayed entries.

Operation A type of action, describing what happened

during the event. Choose from one of the
following:

added, changed, closed, deleted, login,

open, saved

Pulse 4.12 User Guide 1942

 Module Names The Pulse modules in which the events
occurred. You can choose as many of the
modules that you need in your filter by
holding down <CTRL> or <Shift> while
clicking the module names.

Click Select All to choose all available

modules.

Click Clear All to deselect all the modules.

Browse Click Browse to import filtering settings (AUD

file) from another project.

Setting Up Action Log Messages

In the Action Log Messages Setup, design the template for action
messages sent from the Operator Workstation to a daily log when
operators activate controls (Input Text, Slider, and Buttons).

To activate the sending of action messages, the following conditions must

be present:

 Logging inputs or actions must be enabled in the graphic object’s

animation properties or instrument’s settings.

 Operator Action Logs must be activated for the Operator

Workstation (in the Operator Personalization Settings).

Every message starts with a time stamp (HH:MM:SS) followed by several

user-configured syntax fields. The fields indicate essential information
(item address parameters, display name, object name, user name, input
value, etc.) in a format specified by you.

Action Log Messages Setup's flexibility allows it to support lexically correct

messages in various languages. Sample messages are displayed at the
bottom of the window.

Pulse 4.12 User Guide 1943

To set up Action Log messages

1 In the Security Manager, click Message Setup.

The Action Log Messages Setup dialog box is displayed.

2 In the Message Tokens area, define the structure of the message.

Set the order of the placeholder variables and the number of
characters allotted for each (or keep the default order and
allotments). The total length of all the fields cannot exceed seventy
(70) characters.

dde For Input Text and Sliders - the data item

address (Server, Topic, and Item) associated
with the activated control.

For Action Buttons - the action or workflow

initiated by the button.

value The dde item’s or action’s current value

(before operator input).

Pulse 4.12 User Guide 1944

 oldval The dde item’s or action’s previous value.

verb The action that was carried out. See the Verb
section below for this variable’s possible
strings when the control is an Input Text,
Slider, or Button/Active X control.

newval The value entered by the operator.

BY, WITH, IN User-defined words (for example, BY, WITH,

IN are prepositions) which can link the
variables in the message’s composition. See
the User Words section below for instructions
on editing this placeholder’s possible strings.

user The name of the operator that performed the

action.

object The name of the control through which the

action was performed.

display The name of the display in which the action

was performed.

3 In the Verb area, define up to three different verbs describing

actions performed with, respectively, Input text, Slider, and Action
Button/ActiveX Control.

4 In the User Words area, define up to three different words to be

used as prepositions. By default, BY, WITH, and IN are provided.

5 In the Button Adverb area, define adverbs qualifying the action

button verb, describing the Button Down and Button Up actions.

In an Action Button message, the adverbs stand for Value.

Pulse 4.12 User Guide 1945

6 In the Sample Message area, enter the actual words to appear in
the sample message for the respective parts of the message.

7 View the resulting sample messages to confirm if the structure is

satisfactory.

Input/Slider Displays the sample message for an Input Text or

Slider control

Button/ActiveX Displays the sample message for an Action

Button or ActiveX control

8 Click Save to save the message template.

Pulse 4.12 User Guide 1946

I/O Write Security
The I/O Write Security prevents unauthorized clients from modifying I/O
items in the Pulse kernel. Unauthorized users may use the I/O items in
simulator actions but not in runtime.

To enable the I/O Write Security mechanism

1 In the Security Manager’s Policy tab, click the I/O Write Security
checkbox option to select it.

2 Depending on the Authorization Mode, set the Pulse Server’s

minimum access setting.

Level If the I/O Write Security checkbox option

is activated when the Simple Authorization
Mode is being used, this field is available.

Specify the minimum access level required to

grant a user read/write access to I/O items in
the Pulse kernel.

Lock If the I/O Write Security checkbox option

is activated when the Advanced
Authorization Mode is being used, this field
is available.

Choose the minimum level lock required to

grant a user read/ write access to I/O items
in the Pulse kernel.

Pulse 4.12 User Guide 1947

Menu Authorization
The Pulse Menu Authorization utility enables you to assign access levels to
Operator Workstation commands and functions. To define the Menu
Authorization, you have to enable Operator Workstation protection in the
Security Manager, see Defining Security Policy in the Security Manager.

To define menu authorization

1 In the Workstation display area (it is not mandatory that a display

be open at this time), right-click and click Menu Authorization.

The Operator Workstation Menu Authorization dialog box is

displayed.

2 Select a Menu Option - expand the relevant Menu Option tree until
you can select it.

3 In the Security Lock column, choose the menu’s access level.

4 Repeat steps 2 and 3 as many times as necessary to change all

menus requiring a security setting.

5 When you have finished assigning access levels to the menus, click
OK to save the settings.

Pulse 4.12 User Guide 1948

Integrated SQL Server
Pulse has Integrated SQL Server security from Pulse version 3.5 to
support in-depth secured database operation. The Pulse 4.12 server
supports SQL authentication mode in Windows.

There are two types of Microsoft SQL Server security authentication:

 SQL Server authentication which authenticates the user to the

database using a database user name and password.

 Windows authentication which is also referred to as "Windows

Integrated Security" or a "Trusted Connection" because it relies on
the user being authenticated, or "trusted," by the operating system.

Windows authentication employs Windows user security and

account mechanisms. By allowing the Microsoft SQL Server to share
the user name and password used for Windows, users with a valid
Windows account can log into Microsoft SQL Server without
supplying a user name and password. In addition to a single login
within a Windows domain, Windows authentication provides a more
secure mechanism for logging into the Microsoft SQL Server.
Standard Windows security mechanisms also provide the added
advantages of auditing, password aging, minimum password length,
and account lockout after multiple invalid login requests.

The recommended authentication mode is Windows authentication.

User Account
A domain user account is allowed to access a remote computer. The user
account is able to access SQL as well.

Pulse 4.12 User Guide 1949

Software
The new configuration allows:

 Pulse access to a remote SQL Server

 Pulse access to remote project files (Redundancy)

 Pulse services to run as a 'User' and not as a 'System' account

 Easy configuration of a Pulse services account

 Pulse to avoid storing user account information in the registry

Remote SQL with 'Windows

Integrated Security' Configuration
 Some Pulse services run under a User account and other services
run under a System account

 All Pulse kernel programs are spawned by the P-CIM Server service
only

 All Pulse kernel programs are spawned as 'Interactive with Desktop'

 Callback adaptor runs in the system account and can gain access to
a remote SQL via WCF to the Database service. The Database
service runs under a User account.

 Kernel programs can perform login since they can execute with a
User via a P-CIM server

 Project configuration can be set for Pulse services to use a User

account

 Allows changing the User account in hidden/quiet mode. Pulse has

to be restarted

 Coexists with Redundancy configuration

Pulse 4.12 User Guide 1950

Architecture and Modules
The following is a list of Pulse services, in running mode, with a required
account in a remote SQL Windows Integrated Security configuration.

Service Name Account

P-CIM Alarm Publisher User

P-CIM Data Sheet Publisher User

P-CIM Event Management Publisher User

P-CIM Server User

Pulse Data Logger Publisher User

P-CIM Callback Adaptor Publisher System

P-CIM OPC Gateway System

P-CIM DDE Adaptor Publisher System

P-CIM Management Service System

P-CIM OPC Adaptor Publisher System

P-CIM Scheduler System

P-CIM Simulator Publisher System

The modules affected are listed below:

 PfwVer32.dll

• Spawns programs as 'Interactive with Desktop'

• Detects Remote SQL configuration

• Detects 'Windows Integrated Security' SQL configuration

• Modifies Pulse Service's account settings

• Performs a log-in only for System accounts

 DBSR.exe Performs a log-in only for System accounts

 StartUp.exe Performs a log-in only for System accounts

Pulse 4.12 User Guide 1951

 Callback adaptor

• Accesses the remote SQL using the new 'P-CIM Server

Service' interface

• Performs DBSR recovery using the new 'P-CIM Server

Service' interface

 P-CIM Server Service

• Spawns kernel programs as 'Interactive with Desktop'

• Exposes the new interface for SQL access

 Project Setup

• Informs a user if and when a User account is required

• Modifies the Pulse Service's account settings

• Enables hidden/quiet modification of Pulse service's account

settings

OPC Gateway Considerations

The Pulse OPC Gateway can gain access to a remote SQL in order to
expose kernel block- names to any OPC client. But since the OPC Gateway
service is running as a System account, the user must supply valid user
account information.

The following lists 2 possible configurations when running the OPC

Gateway:

Pulse 4.12 User Guide 1952

Configuring the Pulse SQL Windows
Integrated Security
The SQL Windows Integrated Security is configured in the Project Setup.

To configure the Pulse SQL Windows integrated security:

1 In the Project Setup window, go to the menu and click File >
Configure Database settings…

or, go to the toolbar and click the Configure Database settings…

icon.

The Database Configuration window is displayed.

2 In the Connections tab, click the Select Provider button.

The Data Link Properties window is displayed.

3 Go to the Connection tab and select an SQL database with

Windows NT Integrated Security, see image below.

4 Click OK.

The Database Configuration window is displayed.

The Project Setup identifies the Windows NT Integrated Security.

Pulse 4.12 User Guide 1953

5 Provide a valid Domain user account to access the remote SQL with
‘integrator security’.

6 Click OK.

NOTE This account must be defined in the SQL Server as well.

7 After configuring the User account, Pulse services that will run
under this account are changed to log on as users. Pulse Services
should be as illustrated in the following image.

Pulse 4.12 User Guide 1954

8 The defined User is also saved in the registry, as it enables
impersonating the OPC Getaway to or any Kernel module that runs
as a System.

Pulse 4.12 User Guide 1955

Pulse Disaster Recovery Control
(DRC)
The Pulse Disaster Recovery Control (DRC) Station (a feature, system
component), is a system level backup and restore capability. This
capability gives the Pulse system an integrated, simplified backup and
restore as well as disaster recovery operation (continuity). This feature is
beyond the Hot Redundancy capability already available for Pulse servers.
DRC adds another Pulse server station with a server and a client in one
computer. This solution is designed to assure operation of critical systems
at all times. The feature is simple to configure, runs transparently from
normal operation and does not require any additional hardware
(redundant switches, redundant networks, redundant storage), additional
outside applications, or virtualization platforms. It is an economic solution
alleviating a critical system availability challenge when disaster strikes.

Backup and restore operations can be performed externally from standard

Pulse system operation. Users can perform these operations on a file,
directory, or disk level. Many commercial products backup and restore a
running system, even mission critical systems. Yet, the Pulse system as a
controller for large installations needs to offer more resilience. The Pulse
DRC feature uses internal files and operation states to assure fast and
reliable backup and restore. Each project's files are transferred to the DRC
Station at a set period of time, usually set in minutes. DRC Station
monitors the main server operation and takes over when failure is
detected. Since the DRC solution is an integrated into the Pulse system,
operation restore is seamless and takes over from the last known state.

The Pulse DRC solution is not intended to replace a redundant fail-over,

high availability (HA) secondary server. A separate, redundant server
solution is also offered in the Pulse system. In the case of the redundant
HA solution, only a failing server or network communication to the server
(i.e., failure of a network switch) is handled by a second Pulse server. In
the case of Pulse DRC, the Pulse server, Pulse client and network
operation can be recovered.

The new Pulse DRC server feature is designed to assure system operation
when both Pulse servers (primary and redundant) fail (in case of a
redundant system configuration). In case of catastrophic power failure,
facility failure or network connection failure, the Pulse DRC server can still
keep a system operational (monitor and control SCADA controllers). These
failures are usually referred to as disaster condition, which affect a
geographic or functional area in a system. Usually a site wide failure due
to physical event (flood, fire, power failure, attack, etc.) is considered a
disaster condition. Failures of large network sections due to equipment or
external factors are also considered disaster condition.

Pulse 4.12 User Guide 1956

High Level Overview
Pulse DRC solution is an additional server and client node (i.e., separate
hardware). The DRC station contains a copy of the project running on the
primary (active) Pulse server. It connects to the primary system and
keeps a snapshot of the system, database and operating state, through
FTP file transfers. When a disaster state occurs, system operation stops
on the primary server. Operation of the system: communication on the
Controller TCP Network and communication on the Pulse client LAN is
transferred to the Pulse Server running on the Pulse DRC station.

The Pulse DRC station includes both one Pulse server instance and one
Pulse client instance in one computer. Each primary Pulse server runs a
DRC Agent which synchronizes operation with the Pulse DRC server.
During normal operation (none disaster state) a DRC Agent synchronize
data and state with the Pulse DRC Server. During DRC configuration,
synchronization parameters such as file locations, synchronization time
period (how often a state is backed up, in seconds or minutes), length of
time a backup set is stored (number of days), as well as other parameters
are configured. DRC agents start operation at a system startup.

The Pulse DRC feature is designed to keep a site operating when a large
system failure occurs. It is designed to give operators a way to bring up
the failing system while the controllers are still being monitored by the
Pulse server. Pulse DRC also gives operators full client operation in order
to monitor and control system operations. This capability is vital in
mission critical deployments where there is absolute need to keep
controllers running nonstop. The DRC is also crucial in deployments where
control capability is mission critical, where a Pulse monitor or control
failure can cause catastrophic results.

Pulse 4.12 User Guide 1957

System Diagram
The existing Pulse client-server system configuration (topology) stays the
same (see figure below.) The addition of Pulse DRC station component (a
node), simply connects to the existing system to a new server. Notice the
DRC Agent (box representing processes) added in the Main server
instance. The processes related to DRC feature are shown in the boxes
next to each Pulse Server. DRC Agent runs on each machine. FTP Server
and FTP Download processes are used to transfer blocks of data from each
machine to the DRC Station. DRC Agents are key components to
transferring data and state from normal operation to DRC operation
(disaster state) and back once the main (primary) Pulse server is
operational again. This simplified diagram applies to standard
configurations with multiple clients and server instances. This
configuration works with a single main Pulse server as well as with
redundant fail over HA server topology.

Pulse 4.12 User Guide 1958

Pulse Server Configuration
Preparing for DRC Configuration using the
Wizard
1 Create a project configuration file with a minimal set of folders set
(category).

2 Include the database without the log tables or history files.

This DRC configuration file will not be backed up.

3 Create a new project using the AFCON Project Setup utility by

clicking on Start > All Programs > AFCON Pulse > Pulse Setup
> Project.

The Project Setup window is displayed.

4 Install the Windows FTP feature on the primary Pulse server.

Notice how the FTP server needs to be installed even if IIS is

installed. This process is described in detail on the Microsoft
knowledge base. Search for "setting up ftp server".

Pulse 4.12 User Guide 1959

Pulse DRC Configuration Wizard
 Start the Pulse DRC Configuration Wizard by clicking on Start >
All Programs > AFCON Pulse > Tools > DRC Settings Wizard.

The Pulse DRC Configuration Wizard dialog box is displayed.

The Pulse DRC Configuration Wizard is used for DRC Server and
DRC Station configuration as well as to remove DRC configuration
parameters.

 To configure DRC Server parameters, select the DRC Server option

and click Next.

The DRC wizard will configure files for the Primary Pulse Server.
This is the server running Pulse at normal operation (not disaster
condition.)

 To configure DRC Station parameters, select the DRC Station

option Next.

The DRC wizard will configure files for the DRC Pulse Station. This is
the server running Pulse at a disaster condition operation.

Pulse 4.12 User Guide 1960

 To delete the DRC configuration completely, select the Remove
DRC Configuration option and click Next.

The DRC wizard will delete configuration files for the DRC Pulse
Station and all the Pulse servers.

Configuring the DRC Server

To configure the DRC server

1 In the Pulse DRC Configuration Wizard dialog box, select the

DRC Server option and click Next.

The Configure DRC Server dialog box is displayed.

DRC Server parameters:

Create/Select DRC Backup Settings

Settings Name Select a backup settings script name; this will

load the local path from the settings, and the
virtual directory name from the project name
of the script (“DRC”+ProjectName).

Pulse 4.12 User Guide 1961

 Click the Create Settings button to execute
the backup and restore wizard in a DRC
mode that will check the Save Backup
settings checkbox and will have a default
script name (“DRC”+ProjectName).

Click the Refresh button to reload script

names.

Backup Interval The agent will execute an automated backup

on every n minutes.

FTP Settings

The parameters for the DRC Station to FTP into the Pulse Server

Local Path The backup file will be stored in this path,

and the wizard will create an FTP virtual
directory to this path. By default this data will
be extracted from the selected backup
settings definitions.

Server Name The FTP server name, by default is the

machine name

Virtual Folder The FTP virtual directory name that the

Name wizard will create.

Anonymous User A security level flag, check if you do not need

a FTP password protection.

User Name If not anonymous, local machine user name

Password If not anonymous, local machine password

2 Click the Create Settings button or select a settings name from

the Settings Name field.

The Pulse Project Backup or Restore Wizard - Welcome to the Pulse

Backup or Restore Wizard window is displayed.

3 Select Backup Pulse Project and click Next.

The Backup a Pulse Project window is displayed.

4 Select a project and click Next.

The Select the Backup file path window is displayed.

Pulse 4.12 User Guide 1962

5 Define the full path of the backup location, the backup file name,
the volume size for the backup media (DVD, external disk, etc.),
and select the Password Protected option in order to restrict
access to the backup file. Click Next.

The Custom Backup Settings window is displayed.

6 If you do not want to back up all the components, you can back up
only those components that you consider essential to preserve.
Select components you want and deselect components that you do
not require accordingly and click Next to continue.

NOTE When Data Logger History Enabled is selected for the

project’s Historical Data Collection, the History Database
checkbox is disabled (grayed out) in the Pulse Project
Backup or Restore Wizard components dialog box. The
entire database should be backed up using SQL command and
the Pulse Datasheet Tags Manager, or the SQL Server
Management Studio. For more information,
see Data Logger History Database Backup for Pulse 4.12Data
Logger History Database Backup for Pulse 4..

The Ready to Backup window is displayed.

7 Check that the backup configuration settings are correct. To save

this configuration for reuse, select Save Backup Settings and
specify a Name and Description for the “backup settings” file.
Then, click Backup.

The Backup Progress window is displayed.

8 After the backup process is complete, click Next.

The Finish Project backup or Restore window is displayed.

9 Click Finish.

10 In the Pulse DRC Configuration Wizard - Configure DRC Server

window, click on the Settings Name field and select a setting.

Pulse 4.12 User Guide 1963

 The parameter fields are automatically filled.

Pulse 4.12 User Guide 1964

11 Click Next.

The Configure History rules window is displayed.

12 Manage history files to be included:

Override History If checked - deselects the history category

Category from the selected backup settings script, and
add individual Include Files rules of history
files in Last n days.

Backup history Before each automated backup, the agent

files of _ _ evaluates the history files in Last n days.
[number] last These are saved into the directory based on
days the parameters in the backup configuration
script.

Pulse 4.12 User Guide 1965

13 Click Next to complete the DRC Configuration Wizard settings.

The Completing the DRC Configuration Wizard window is displayed.

14 Complete the DRC Configuration process and start the DRC

operation:

• A summary shows the DRC Type, the FTP URL and the local
backup path locations. Verify all the parameters and go back
if they need correction.

• Clicking the Export DRC Configuration creates a DRC

configuration for DRC stations. Use the configuration file by
copying it to the local machine:
C:\Afcon\Pulse\ProjectName\Utilities\.

15 Click the Finish button to complete the DRC configuration process.

a Check if the FTP Feature is installed.

b Create the FTP Virtual directory.
c Configure the DRC Agent to run at Pulse startup.
d Stop DRC Agent if running.
e Run the DRC Agent.

Pulse 4.12 User Guide 1966

Data Logger History Database Backup for Pulse 4.12
When Data Logger History Enabled is selected for the project’s
Historical Data Collection, the History Database checkbox is disabled
(grayed out) in the Pulse Project Backup or Restore Wizard
components dialog box. The entire database should be backed up using
SQL command and the Pulse Datasheet Tags Manager, or the SQL Server
Management Studio.

Workaround

NOTE Backup the Pulse project first, then backup the database.

After backing up the database, restore the Pulse Project.

Restore the database before starting the Pulse Server.

Do the following to back-up your Database using the SQL

command and the Pulse Datasheet Tags manager

1 Select or create a new folder named Pulse.BAK on the disk (same

disk where Pulse is installed).

2 Right-click the folder and select Properties from the context menu.

3 Select the Security tab and set the security permission of the
ANONYMOUS LOGON user to Full Control.

NOTE If the user ANONYMOUS LOGON is not in the Group or user

names list then add the user.

4 Open the Pulse Datasheet Tags Manager and add an OLEDB

tag.

5 Define the Connection String for your History database and click
Next.

6 Open the Query Builder and type the following in the SQL tab:

BACKUP DATABASE [DatabaseName]TO DISK =

‘C:\AFCON\Pulse.BAK\[BackupDatabaseName].bak’ WITH
NOFORMAT, NOINIT, NAME = N’[DatabaseName] - Full Database
Backup’, SKIP, NOREWIND, NOUNLOAD, STATS = 10

7 After typing the above, select the Data tab to execute the
command.

The database will be backed up to your folder.

Pulse 4.12 User Guide 1967

Do the following to restore your Database using SQL command
and the Pulse Datasheet Tags Manager

1 Open the Pulse Datasheet Tags Manager and add an OLEDB

tag.

2 Define the Connection String for the Master SQL database and
click Next.

3 Open the Query Builder and type the following in the SQL tab
where the new database name is different from the backup
database name.

NOTE Make sure that your MSSQL DATA path is correct,

e.g.,[c:\Program Files (x86)\Microsoft SQL
Server\MSSQL10.PULSESQLEXPRESS\MSSQL\DATA]

RESTORE DATABASE [TargetDatabaseName]

FROM DISK = N'C:\AFCON\

Pulse.BAK\[BackupDatabaseName].bak' WITH FILE = 1,

MOVE N'[OriginalDatabaseName]' TO
N'C:\MSsqlDataPath\TargetDatabaseName.mdf',

MOVE N'OriginalDatabaseName_log' TO
N'C:\MSsqlDataPath\TargetDatabaseName.LDF',

NOUNLOAD, REPLACE, STATS = 10

4 After typing the above, select the Data tab to execute the
command.

The database will be restored to your target database

Pulse 4.12 User Guide 1968

Configuring the DRC Station
To configure the DRC station

1 In the Pulse DRC Configuration Wizard dialog box, select the

DRC Station option and click Next.

The Configure DRC Station dialog box is displayed.

DRC Station parameters:

FTP Settings

Server Name The DRC Server name, the station will

download from this ftp server name the
backup file.

Virtual Folder The virtual directory name you entered in the

Name DRC server wizard, by default it is
(“DRC”+ProjectName)

Pulse 4.12 User Guide 1969

 Anonymous User The security level you selected on the DRC
server side wizard. Add a User and Password
if needed.

User Name The ftp user name you selected on the DRC
server side wizard.

Password The ftp password you selected on the DRC

server side wizard

Local Path The backup file will be downloaded from the

ftp server into this location

Project Name Read only- the current project

Password Password for backup file, if needed

Protected

Restore Interval Specify the delay interval, in minutes, when

the restoration process of the DRC Station
will start.

Enter Password Supply the project's password, if needed

Modify database Check and modify the connection string.

connection
string

Oracle Database Administrator Login

User Name For Oracle database, supply the administrator

User Name

Password Enter the Administrator Password.

2 Configure the DRC Station Wizard.

The Completing the DRC Station Configuration Wizard window is

displayed after the configuration is complete.

Pulse 4.12 User Guide 1970

3 After the DRC Configuration process, start the DRC operation. The
following are displayed:

• A summary of the DRC Type, the FTP URL and the local
backup path location is shown. Verify all parameters and go
back if they need correction.

4 Click the Finish button to complete the DRC configuration process:

• Save the wizard settings.

• Create the local download directory if required.

• Configure the DRC agent in the Windows startup.

• Stop the existing DRC agent process if it is running.

• Run the DRC agent.

The DRC Agent startup status message is displayed.

Pulse 4.12 User Guide 1971

DRC Agent running status box

 Shows the DRC Agent status. First message on backup status (next
one in 1 minute).

 When backup starts and ftp is in progress; the DRC Agent status
informs the operator.

Workstation Network Disconnection dialog box

DRC Station to DRC Agent network reconnect:

 Starting DRC Station button performs the following:

• Is visible if the DRC agent is running on this machine and the

correct project name has the same name.

When activating the DRC station:

• Local station server starts.

• Local station workstation starts.

• The disconnected workstation closes.

 Show Services: Displays the Windows Task Manager in the

Processes tab.

 Close Workstation: Closes the workstation.

Pulse 4.12 User Guide 1972

Report-a-Problem
The Pulse Project Report a Problem wizard tool enables the user to report
a problem. The wizard collects the Pulse project files and packages it.

To use the Report a Problem wizard:

1 On your desktop, go to Start > AFCON Pulse > Tools and select
Report a Problem.

The Pulse Project Report a Problem Wizard - Welcome to the Pulse

Project Report a Problem Wizard window is displayed.

2 Click Next to run the wizard.

Pulse 4.12 User Guide 1973

 The Pulse Project Log Files Packaging window is displayed.

3 Select the required project to package from the project list and click
Next.

The Select the Path for Report Package window is displayed.

Pulse 4.12 User Guide 1974

4 Enter the full path of the directory where to save the report
package, provide a file name for the report, describe the problem
clearly, and click Next.

The Custom Package Configuration window is displayed.

5 Select the project components to be included by checking on the

corresponding checkbox of the component. It is recommended that
you choose all the components available.

6 Click Next to continue.

The Ready to package window is displayed.

Pulse 4.12 User Guide 1975

7 Review the configuration information setting then click Pack.

The Package Progress window is displayed showing the progress of

the files being packed.

Pulse 4.12 User Guide 1976

8 After the package processing is complete and the system
information report is loaded to a file, the file is ready to be sent to
the Pulse Support team.

The Finish Project Report a Problem Wizard window is displayed.

9 Click Pack Another Package to run the Report A Problem

Wizard again.

Pulse 4.12 User Guide 1977

History Migration
The Pulse History Migration Wizard enables you to migrate History files
created in earlier versions of P-CIM to the current Pulse version.

History files that were migrated to a later version of Pulse are not
accessible to earlier versions of P-CIM.

To migrate History files

1 On your desktop, go to Start > All Programs > AFCON Pulse >
Tools and select History Migration Wizard.

The Pulse History Migration Wizard - Welcome to the Pulse History

Migration Wizard window is displayed.

Pulse 4.12 User Guide 1978

2 Click Next to run the wizard.

The Configure History Migration Settings window is displayed.

3 Specify the following History Migration settings:

• Project Name - The name of the Pulse project with the

history files to migrate

• History files location - The path where the history files are
located.

• History Date Range - The range of the dates and times of

the history files to be converted by the History Migration
Wizard.

• History Date Destination - Select a History Date

Destination:

 DataLogger

 OpenH

Pulse 4.12 User Guide 1979

4 Click Next to continue.

The History Migration Ready window is displayed.

A summary of the history files are displayed in this window.

Pulse 4.12 User Guide 1980

5 Click the Migrate button to continue the migration process.

The History Migration Progress window is displayed.

The History Migration Progress shows the migration progress of

files.

Pulse 4.12 User Guide 1981

6 After the History Migration process is complete, click Next to
continue.

The Completing the History Migration Wizard window is displayed.

7 Click Finish to complete the History Migration process.

Unity Application Generator

(UAG) Migration Wizard
The Unity Application Generator (UAG) Migration Wizard is a Pulse tool
used to back up projects by saving a copy of the project in its current
version.

Pulse 4.12 User Guide 1982

Basic Server
BASICSRV adds logic capabilities to Pulse. Using the integrated system,
you can implement logic and functionality well beyond the original Pulse
package capabilities. The BASIC script language provided supports most
of the functions of standard BASIC, and is enhanced with extensions that
are specific to Industrial Control applications.

NOTE The Basic Server is not displayed unless the Interactive

Services Detection is enabled or the script is executed through
the Windows run command.

If a user has to run basic script to see the Trace mode, the
user has to use the Interactive Services Detection.

To access Interactive Services Detection:

1 Go to Start > Settings > Control Panel > System and Security
> Admin Tools and select Interactive Services Detection.

2 Enable the Interactive Services Detection option and set its

status to Started.

Operating the Server

Use the BASIC server to:

 Run one or more scripts from Pulse or from the command line

 Evaluate and return an immediate expression result to Pulse

Pulse 4.12 User Guide 1983

Running Script from Pulse or from
the Command Line
BASICSRV supports multiple instances (run more than once) and can be
run as a regular program with script name and optional arguments given
as command line parameters. BASIC server runs in this mode one or more
scripts in the background.

To run a script from Pulse, use the Run button command like this:

Run BASICSRV [path]script-name[.ext] operation [arg1 [arg2 [|!]

]]

To run a script from the command line, use a command like this:

BASICSRV [path]script-name[.ext] operation [arg1 [arg2 [|!] ] ]

where:

 Run The Run button command

 BASICSRV Application name

 Path Path of the script file - if not in default location

(path of the Pulse token PcimUtil)

 script-name Name of script file

 ext Extension of script file - if not the default (LGC)

 operation Operation keyword:

• RUN To run script

• TRACE To run script with open debug window (override

QueryOpen)

• STOP To stop script - see Stopping a Script

 arg1, arg2, etc. Optional, list of arguments - see Using Script

Arguments below

Pulse 4.12 User Guide 1984

Using Script Arguments
Use argx script arguments to substitute at run time script assignments.
The main purpose is to reuse the same script with a different set of
external (Pulse) variables and/or constants.

Each argx specified in the BASICSRV command substitutes the right side
contents of the respective script assignment - in the order of assignment
lines specified in the script.

To specify an argument that contains spaces and/or punctuation marks,

enclose it in single or double quotes (like this "can't do" or this 'a
"banana"').

To skip an argument, specify just |! (i.e., a blank DDE reference).

NOTE This substitution mechanism operates on line-by-line basis in

the script - to use this feature, do not specify at the beginning
of the script more than one assignment per script line!

Script Example

LET VAR1 = |!ABC

LET VAR2 = |!XYZ

LET PRESET = 100

VAR1 = VAR2 * PRESET * 2

END

Script Running Command Examples

 BASICSRV script RUN

Runs the script using original script assignments

 BASICSRV script RUN |!1:1:40010

Runs the script but now VAR1 references |!1:1:40010 (VAR2 still
references |!XYZ)

 BASICSRV script RUN |! |!1:1:40010

Runs the script with VAR1 referencing the original address (|!ABC)
but VAR2 reference changed to |!1:1:40010 (the blank DDE
reference |! right after RUN skips the first script assignment, so it
remains unchanged).

Pulse 4.12 User Guide 1985

 BASICSRV script RUN |!1:1:40010 |!1:1:40444

Runs the script with VAR1 reference changed to |!1:1:40010 and

VAR2 reference – to |!1:1:40444.

 BASICSRV script RUN |!1:1:40010 |!1:1:40444 200

Runs the script with VAR1 reference changed to |!1:1:40010, VAR2

- to |!1:1:40444, and PRESET - to 200.

Stopping a Script
BASICSRV supports the STOP command line argument that stops the
specified running script – in case there is more than one script with the
same name running, this command stops the first one the server finds.
General usage is as follows:

BASICSRV [path]script-name[.ext] STOP [-H]

where:

 BASICSRV Application name

 path Path to script file - if not in default location

(path of Pulse token PcimUtil)

 script-name Name of script file

 ext Extension of script file - if not the default (LGC)

 STOP To stop script

 -H Optional, without confirmation prompt (via

message box)

Pulse 4.12 User Guide 1986

Returning Immediate Expression
Result to Pulse
BASIC server calculates in this mode an expression and returns the result.
The syntax follows the DDE reference format (server|topic!item), where
the expression to be calculated is specified as the item part:

BASICSRV|PCIM!expression[type]

where:

 expression Valid BASIC expression, can contain BASIC

functions and operators, and DDE variables (of
other Pulse servers). If the expression contains
spaces, enclose the expression in parentheses ()

 type Result data type - using type-suffix listed in

Names and Data Types

To specify a DDE variable in the expression, use this syntax:

DDE[type](server|topic!item)

where:

 DDE Keyword that designates a DDE-format

reference

 type DDE data type - using type-suffix listed in

Names and Data Types

 server ServerComputer or system which makes its

resources or data available to the inquiring
clients for example Pulse server in a server-
client Pulse network which grants the clients
access to the real time and historical data name

 topic Topic name

 item Item name

Pulse 4.12 User Guide 1987

Examples

See the following examples for expression usage:

 Set |!AV1 BASICSRV|PCIM!(SIN(DDE(|!AV2)) + 10)%

Returns result as integer

 Set |!AV1 BASICSRV|PCIM!(SIN(DDE(|!AV2)) + 10)

Returns result as single precision (default type)

 Set |!AV1 BASICSRV|PCIM!SIN(DDE(|!AV2))%

Returns result as integer

 Set |!$ds2 BASICSRV|PCIM!MID$(DDE$(|!$DS1),1,1)$

Process DDE variable as string, return result as string

 Set |!$DS1 BASICSRV|PCIM!(MID$('The Power of P-

CIM',14,5))$

Process DDE variable as string, return result as string.

Controlling CPU Load

The external parameters SleepTime and BasicOperNO help prevent an
endless loop script from monopolizing the CPU resources and from
adversely affecting the overall system performance. Their effect is to
make the server sleep for a certain amount of time after so many
operations. The parameters are located in the file PCIM.INI in section
[BasicServer]. Setting BasicOperNO defines the number of BASIC
statements to be executed from the last sleep, and SleepTime - how much
time to sleep (in milliseconds).

Example

[BasicServer]

BasicOperNO=10

SleepTime=100

Pulse 4.12 User Guide 1988

Creating BASIC Scripts
Script Syntax
The Pulse BASIC script has the following rules:

 A line cannot start with a number (no line numbers).

 A line may consist of one or more statements separated by a colon

‘:’.

 A label must be specified in a separate line, and trailed with a colon

‘:’.

 BASIC variables, functions and statements are case insensitive

(Sin() = sin() = SIN()).

 A string constant is specified enclosed in double quotation marks

("string"); if it contains a double quotation mark, insert two (enter
"the ""A"" letter" for the string the "A" letter).

 BASIC must not encounter at runtime a RETURN statement

without first executing a GOSUB statement.

Place all subroutines together at script end, precede label of first

subroutine with statement END.

 Script may reference external variables (e.g., DDE items of Pulse

servers DBSR. The Pulse Database Server, TXTSRV, etc.) - by
assigning each to a BASIC variable. Place all such assignments at
the beginning of the script, each on a separate line, see also
Running Script from Pulse or from the Command Line (Using Script
Arguments) on how to substitute them when running a script.

 Script may contain Pulse Aliases - that are translated during the
first processing phase - see Alias Support.

 A line can be flagged as break point (see Debugging BASIC Scripts)

with an asterisk (*) as first character.

Pulse 4.12 User Guide 1989

Names and Data Types
You can give names to BASIC variables, labels, and custom functions.
Those names can consist of up to 40 characters and must begin with a
letter. Valid characters are A-Z, 0-9, and period ‘.’. A custom function
name must start with 'FN'. A name cannot be identical with a reserved
BASIC name (of a function or statement).

BASICSRV supports the data types listed below. The data type of a
variable must be identified by placing the respective suffix at the end of
its name.

Type Description Suffix Range

Integer Two-byte integer % -32768 to 32767

Single Four-byte floating point ! -3.37E-38 to

(default) number 3.37E+38

Double Eight-byte floating point # -1.67E-308 to

number 1.67E+308

String String of characters $ Max 255 characters

(bytes)

A variable without suffix is assumed to be Single precision data type.

BASICSRV supports arrays of all the above types. The maximum array
size is 32767 elements.

Pulse 4.12 User Guide 1990

Exchanging Data with Pulse
BASICSRV is a 32bit application that uses the Pulse fast DDE protocol
(callback) to communicate with other Pulse callback servers such as Data
Base ServerComputer or system which makes its resources or data
available to the inquiring clients for example Pulse server in a server-
client Pulse network which grants the clients access to the real time and
historical data and Datasheet Manager.

Access by Reference - Read and Write

Pulse variables can be accessed in BASIC script by reference using a
simple pre- assignment statement once, such as:

AV1 = DBSR|PCIM!AV1 or AV1 = |!AV1

From this point in the script, referencing the BASIC variable AV1 returns
the value that Pulse database variable DBSR|PCIM!AV1 had when the
LET statement was executed. A subsequent REFRESH statement, or a
LET statement with the same contents, refreshes BASIC variable AV1
with the current value of Pulse database variable DBSR|PCIM!AV1.

Likewise, writing to the BASIC variable AV1 in the script, writes to the
same Pulse database variable. For example, the BASIC assignment
statement LET AV1 = 100 will actually set DBSR|PCIM!AV1 to this
value.

Access by Value - Read Only

Pulse variables can be read in BASIC script by value using an assignment
statement and the function DDE() - only the value of the Pulse data item
is passed to the BASIC variable.

Example

TOTALVOLUME = DDE(|!VOLUME1)+DDE(|!VOLUME2)

It is highly recommended to use the pre-assignment method in order to

get a clear and understandable script when dynamic arguments (DDE
addresses) are used.

Debugging BASIC Scripts

Use the BASIC Server debug window to monitor the execution and
debugging of your scripts.

Pulse 4.12 User Guide 1991

Preparing for Debugging
When running, BASIC Server stays in minimized mode. Right-clicking on
its icon displays the System Menu illustrated below.

 Trace places the BASIC server in Trace mode - to debug your script
using the Breakpoint and Step buttons

 About… displays the BASIC server About dialog box.

Enabling the Debug Window

To make the debug window available for one "shot", run the script in
TRACE mode, see Running Script from Pulse or from the Command Line.

To make the debug window available continuously, preset the INI setting
QueryOpen to support the opening of BASIC Server debug window (i.e.,
make the Restore command available in its system menu). The setting is
located in the file PCIM.INI in section [BasicServer], like this:

[BasicServer]

QueryOpen=1

BasicOperNO=10

SleepTime=100

Pulse 4.12 User Guide 1992

Using the Debug Window
BASIC Server debug window displays (from the top down):

 Table All basic variables in the script with columns for:

name (Basic Variable), external reference - if
any (Address) and current value (Value)

 Basic Name of currently running script

 Basic Line Last executed BASIC line

 Breakpoint Shown in Trace mode - toggles breakpoint on

current line

 Step Shown in Trace mode - Steps to next line

Single Stepping a Script

When BASIC runs script in Trace mode, it executes one line at a time. To
proceed to the next line, click the Step button.

Pulse 4.12 User Guide 1993

Using Breakpoints
You can use breakpoints in two ways:

 For frequent debugging, insert breakpoints in the script itself -

insert an asterisk (*) as first character in the line in question. Script
will run normally if you do not open the BASIC server window; if
you do, scripts will eventually stop at first breakpoint encountered,
at which point you can proceed with your debugging.

 For casual debugging, run BASIC script in Trace mode (use TRACE
mode in command line, or turn Trace mode on from BASIC server
widow control menu). Breakpoint and Step buttons are shown in
BASIC window all the time - use the Breakpoint button to insert
breakpoints ‘on-the-fly’.

Debugging a Breakpointed Script

To debug a script that contains breakpoints

1 Run the script.

2 Open the BASIC server windows in normal (not Trace) mode -

script runs until it encounters first breakpoint, at which point it
stops, enters Trace mode, and the Breakpoint and Step buttons are
revealed.

3 Proceed as appropriate:

• Single step with the Step button

• To cancel breakpoint, click the Breakpoint button.

• To proceed to next breakpoint, choose Trace from the control

menu.

Pulse 4.12 User Guide 1994

Debugging a Plain Script
To debug a script that does not contain breakpoints:

1 Run the script with TRACE flag in the command line

-or-

Turn Trace mode on from BASIC server widow control menu.

2 Open BASIC server widow - the Breakpoint and Step buttons are
shown.

3 Step through the script with the Step button until you reach the
line you want to break at.

4 Click the Breakpoint button.

5 Disable Trace mode from BASIC server widow control menu - script
runs until it encounters first breakpoint, at which point it stops,
enters Trace mode, and the Breakpoint and Step buttons are
revealed.

6 Proceed as appropriate:

• Single step with the Step button

• To cancel breakpoint, click the Breakpoint button.

• To proceed to next breakpoint, choose Trace from the control

menu.

Pulse 4.12 User Guide 1995

BASIC Runtime Error Codes

# Condition

1 Internal Error

2 Out of memory

3 No label

4 RETURN without GOSUB

5 Label not found

6 Incomplete statement

7 Value is out of range

8 Syntax error

9 ON without GOTO or GOSUB

10 Argument count mismatch

11 WHILE without WEND

14 Type mismatch

16 Out of DATA

17 Overflow

18 NEXT without FOR

19 Undefined function

20 Division by zero

21 Variable cannot be re-dimensioned

22 OPTION BASE must be called prior to DIM

23 Unknown statement

24 WEND without WHILE

25 Variable required

26 Subprogram without RETURN

27 DOACTION failed (Operator Workstation not running?)

28 Address error

29 FOR without NEXT

Pulse 4.12 User Guide 1996

BASIC Functions Reference
A function returns a value that can be assigned directly to a variable, or
can be used in an expression together with other functions and variables.

Functions Summary

Function Returns

ABS absolute value of a number

ASC ASCII code of first character in string expression

ATN arctangent (in radians) of numeric expression

CHR$ character corresponding to specified ASCII code

CINT integer value (rounded) of numeric expression

COS cosine of angle specified in radians

CSNG single-precision value of numeric expression

DATE$ string of computer's current system date in format MM-

dd-yyyy

DDE value of external DDE variable

ERL last error line number

ERR last error code

EXP e raised to a specified power (e =base of natural

logarithms)

HEX$ string of hexadecimal representation of numeric

expression

INSTR position of first occurrence of string in another string

INT truncation of numeric expression (largest integer less

than or equal to)

LEFT$ so many leftmost characters of string

LEN string length (number of characters in string)

LOG natural logarithm of numeric expression

MID$ part of string (substring)

MSECTIMER number of elapsed milliseconds since midnight

OCT$ string of octal representation of numeric expression

Pulse 4.12 User Guide 1997

Function Returns

RIGHT$ so many rightmost characters of string

RND single-precision random number between 0 and 1

SGN sign of numeric expression as 1, 0 or -1

SIN sine of angle specified in radians

SPACE$ string with so many spaces

SQR square root of numeric expression

STR$ string representation of numeric expression

STRING$ string of a character repeated so many times

TAN tangent of angle specified in radians

TIME$ string of computer's current system time in the form

hh:mm:ss

TIMER number of elapsed seconds since midnight

VAL number from its string representation

Pulse 4.12 User Guide 1998

BASIC Statements Reference
A statement does one of the following:

 Sets a global BASIC feature

 Controls (changes) program flow

 Performs an action

To insert more than one statement in a single BASIC line, separate

statements with a colon ':'.

Statements Summary
Statements marked with an asterisk (*) are special for using BASIC in the
Pulse environment.

Statement * Purpose

DATA Specify values to be read by subsequent READ

statements

DEF Define function

DIM Declare array variable

DOACTION * Pass an action to Operator Workstation

ERASE Free array and variables storage space

ERROR Simulate occurrence of a BASIC error

FOR .. TO .. STEP Repeat block of statements a number of times

GOSUB Branch to subroutine (and return)

GOTO Branch to label

IF .. THEN .. ELSE Execute a statement or another depending on

condition

IF .. THEN .. ELSE Execute a block of statements or another

.. ENDIF depending on condition

LET * Assign value of expression to / associate

external variable with a BASIC variable

Pulse 4.12 User Guide 1999

Statement * Purpose

MID$ Replace part of string

ON .. GOTO Jump per value to one of several locations

ON .. GOSUB Branch per value to one of several locations

and return

ON ERROR GOSUB Branch if error occurs to location and return

OPTION BASE Set first array index as 0 or 1

RANDOMIZE Initialize random-number generator

READ Assign values from DATA statements to

variables

REFRESH * Refresh values of DDE variables

REM Insert remark in script

RESTORE Reset READ position to first DATA statement

SLEEP * Force Server to sleep for an amount of time

SWAP Exchange values of two variables

WHILE .. WEND Execute statements block as long as condition

is true

Pulse 4.12 User Guide 2000

BASIC Operators Reference

Type Name Symbol

Arithmetic Exponentiation ^

/M¥S -

/MeS *

/)ØS /

Modulo MOD

Integer division \

Addition +

Subtraction -

Relational Equal =

Greater than >

Greater than or equal >=

Less than <

Less than or equal <=

Not equal <>

Logical Negation NOT

And AND

Inclusive Or OR

Exclusive Or XOR

Equivalence EQV

Implication IMP

String Concatenation +

Pulse 4.12 User Guide 2001