Beruflich Dokumente
Kultur Dokumente
User Guide
Release 10SP4HFR4
Document Revision 1.0
Contents
Introduction ................................................................................................. 8
Introduction to the Desktop-Analytics Product Suite .......................................... 9
Activity Desktop-Analytics .......................................................................... 10
Event Desktop-Analytics ............................................................................ 10
Process Desktop-Analytics ......................................................................... 10
Process Discovery Desktop-Analytics ........................................................... 11
Naming Conventions .................................................................................... 11
Notations Used ......................................................................................... 12
Trademarks / Copyright Information ........................................................... 12
Overview .................................................................................................... 12
Synopsis of Operation ............................................................................... 12
Activities in the Database ......................................................................... 13
Desktop-Analytics Server Settings ................................................................. 13
Database ................................................................................................. 14
DSN Entry ............................................................................................. 14
User ..................................................................................................... 14
Password............................................................................................... 14
Upgrade .................................................................................................. 14
Services .................................................................................................. 14
Job Processor Service (default state: Running)........................................... 14
Server Side Trigger Service (default state: Stopped) .................................. 14
Configuration .............................................................................................. 15
Licensing Tab ........................................................................................... 16
Configuration Profiles ................................................................................ 16
Custom Profile .......................................................................................... 18
Configuration Assignments ......................................................................... 19
Configuration Storage ............................................................................... 20
Upgrade Deployment ................................................................................... 20
Desktop-Analytics Client MSI Installer ......................................................... 21
Desktop-Analytics Client: DCUApp ................................................................. 21
Installed Files ........................................................................................... 21
Typical Operation ...................................................................................... 23
Desktop-Analytics Web Interface ................................................................... 23
Web Reporting Overview ........................................................................... 24
User Permissions .................................................................................... 24
User Roles ............................................................................................. 24
Team Leader Role .................................................................................. 25
User Role Table ...................................................................................... 25
Administrative Reporting ......................................................................... 26
Application Groups ................................................................................. 26
Getting Started......................................................................................... 26
NT Authentication ..................................................................................... 26
Home Page .............................................................................................. 27
System status ........................................................................................ 28
Current User Activity .............................................................................. 28
Reports ................................................................................................... 29
Reports Home Page ................................................................................ 29
Activity, Event and Process Reporting ....................................................... 29
Save Report Feature ............................................................................... 32
Set Application Chart Colors .................................................................... 32
Export to Excel or PDF ............................................................................ 33
Activity Reporting ................................................................................... 33
Live Information Report .......................................................................... 37
Activity Chart Reports ............................................................................. 38
Application Duration by Application ........................................................... 39
Activity Timeline Reports ......................................................................... 40
Showing Multiple Data Streams on a Time Line Report ................................ 43
Activity Event Reporting .......................................................................... 45
Process Reporting................................................................................... 45
143
148
148
148
149
149
151
151
151
151
152
153
154
154
155
155
155
155
156
156
156
157
157
157
158
162
162
164
164
165
165
166
166
166
166
166
167
167
167
167
168
168
168
170
171
171
172
172
172
173
173
173
173
175
175
176
177
177
178
178
178
181
182
182
182
182
184
184
184
185
185
186
188
188
188
190
191
196
196
201
207
207
207
208
208
209
209
209
209
209
209
210
210
211
216
218
220
221
224
224
225
228
229
229
230
232
235
235
237
239
241
242
242
243
Release Notes
Introduction
Summary listed here encompasses all new key features compared to 10.0.3 HF2
Edit Screen Edit all aspects of a captured screen on the web administration
interface without the need to run DPA Validator again, mainly used where a screen
has been captured and items have not been highlighted correctly or window title
has been incorrectly specified
Migrate Screen Migrate triggers from one screen to another, mainly used for cases
when an application has changed and require the same triggers to be recreated
Standalone Triggers Firing triggers can be tested during the Discovery phase,
without the need of installing a Desktop-Analytics server.
Message Pop Additional functionality now allows changing colour and message
type.
Highlight and Guidance Used for troubleshooting. Controls can be highlighted and
message near control displayed, to remind end users their input is required.
Trigger Feedback Used for troubleshooting. Prompt message appearing before
firing triggers; provide information on the trigger it is about to fire.
Remote Tracing Client tracing can now be activated/deactivated remotely via
Server configurations and traces can be collected directly from the DesktopAnalytics server.
Client versioning information Client files report precise version information for all
executable and supporting files within the DPA client folder. Combined with the
search feature, this enables identification of incorrectly patched or old product
versions
Search enabled administration In previous releases it could take some time to
locate the required trigger or screen. The search facility quickly finds triggers,
screens, applications or windows titles of defined screens or triggers.
Document Open and close Triggers Window open and close triggers have been
refined to cope with many more instances of window and application name
combinations than in prior releases.
No Longer Idle trigger Notification of when a computer goes Idle has always been
in the product. However, it is now also possible to be notified when a machine has
been idle and has now come out of idle state. The trigger fires precisely at the
point of time when a key press or mouse click has brought the machine out of idle
state.
Release Notes
Trigger On Tables Triggers can now be set up pass back a matching row of data
from within a table, available for standard HTML & SAP tables.
Autocapture The Autocapture feature is a Remotely Triggered DPA Validator, where
supported applications can be captured by firing triggers. It can be used during
both discovery and troubleshooting phases.
Enhanced screen library export Previous versions would export a screen library file
containing all triggers and processes defined on a site. The screen export function
has been enhanced to also export all screen bitmap and data information into a
single zip archive.
System State A system state export is available. This will export current state of
the server, including the software & database version, client versions, licensing
details, computer and user details, and screen library into a zip archive for review
by support engineers.
Server Health Messages are available on the front page of the web reporting to
show at a glance whether any misconfiguration of the server has occurred. System
health messages include license details, active trigger / process versions, number
of client machines on the current versions, and will warn where disk space is low or
database is unavailable. The client facing data services can also be paused or
resumed from the server health screen
Unicode support All unicode / wide character sets are now supported. Multi-bye
characters such as those found in Korean, Chinese, or Japanese can be reported
upon, triggered upon , and correctly displayed in any report.
Organizational Teams Users can be grouped into hierarchical teams, allowing
reporting to reflect an organisational structure. The Usergroup feature of previous
versions is retained for triggering and backwards compatibility.
V10 N+N recorder support Multiple V10 recorders can be configured for N+N
recording environments
NOTE
Some of the features and components described in this
document may not be available on every customer site as they are dependent on
the license type purchased.
Release Notes
Activity Desktop-Analytics
Provides detailed information on how your most expensive assets - your technology
and your employees - interact with each other. This is the first step in identifying
how you can best accomplish your business process improvement initiatives.
Event Desktop-Analytics
Analyzes events occurring in software applications (text entered into specific fields,
values returned by the application) and uses these occurrences to trigger other
actions such as notify a supervisor of a critical event, remind an employee to upsell on a product order or enforce compliance related actions. Event DesktopAnalytics can also be used to take information from one application and populate
the specified fields in other applications.
Process Desktop-Analytics
Can recognize an entire business process that may span several software
applications and multiple complex steps, allowing a complete analysis of each
individual step and the process as a whole. Parameters used within the processes
are also available allowing organizations to maximize both the efficiency and the
effectiveness of their operations. Process Desktop-Analytics can also track a
transaction through multiple departments, e.g., a transaction may start in order
placement and move through procurement and finance before finally being passed
to the shipping department. Analyzing how these transactions move through the
organization helps identify system bottlenecks and best practices within each work
group.
10
Release Notes
Naming Conventions
This document uses the following terminology to describe the Desktop-Analytics
suite of software products.
Machine
A server, desktop or laptop computer that has Desktop-Analytics software installed.
Client Machine
A machine that has the Desktop-Analytics client software running.
Server Machine
A machine on which a Desktop-Analytics server component is installed.
Activity Data
The data collected on each client machine that contains information on how the
machine is being used. This data is placed into a small log file for transport to the
central activity database.
Database
A database that contains all Desktop-Analytics data in a concise and optimized
manner.
Administrator
The user of the system who is responsible for
user/computer/licensing/trigger/group maintenance.
Desktop-Analytics Log
The data collection engine installed on client machines. It is sometimes referred to
as DCUApp.
Web Reporting
Internet browser based reporting and administration facility.
Desktop-Analytics Data Upload Service
The program installed on the server machine, responsible for placing the collected
data into the Desktop-Analytics database.
Live Update Service
11
Release Notes
The Live Update service is used by Web Reporting to display each users/computers
current application, activity and window text.
Notations Used
Where necessary, this manual uses the following notation:
c:\winnt\system
Denotes filenames or system directories or folders.
FileExit
Denotes Menus and sub menu items.
Overview
Synopsis of Operation
Desktop-Analytics clients periodically send log files to a temporary directory,
specified during the installation process. These log files are used by the DesktopAnalytics data service to create the Activity Database (pcmon).
12
Release Notes
The system operates using standard network file systems and no new network
protocols need to be installed on the system.
Web Reporting generates both graphical charts and detailed log reports from the
information stored in the database.
Joe Smith was writing a budget proposal on Monday morning. Half way through
the proposal, he checks an email address book for a contact name. He then
finishes the proposal and sends it to the printer.
These activities would be stored as follows:
Date
Time
Duration
User
Computer
Applica
tion
Ms
Word
4th Jan
08
09:13:0
0
4:20
JS002
Joe-Laptop
4th Jan
08
09:17:2
0
0:05
JS002
Joe-Laptop
Ms
Outlook
4th Jan
08
4th Jan
08
09:17:2
5
09:18:1
0
0:45
JS002
Joe-Laptop
5:20
JS002
Joe-Laptop
Ms
Outlook
Ms
Word
4th Jan
08
09:23:3
0
10
JS002
Joe-Laptop
System
Window Text
BudgetProposal1
.doc Microsoft
Word
Inbox
Microsoft
Outlook
Address Book
BudgetProposal1
.doc Microsoft
Word
Print
Although the data is stored in the database in this manner, it does not necessarily
have to be displayed as a simple text report (text reports although detailed, can
become very large and difficult to derive information from). Using Web Reporting,
the administrator can generate graphical reports, charting trends or summaries of
user and application usage for an overall picture of how the company workforce is
performing. (See section below on generating reports).
13
Release Notes
Please also note, from 10.0.3 onwards much of the configuration that used to be
set in Server Settings is now performed in the Configuration area of the web site.
Database
DSN Entry
The DSN name is PCMON. This is the ODBC connection used by the Data Upload
service to upload data into the database.
User
The user name with appropriate privileges for accessing the database.
Password
Password for accessing the database.
For information on setting up the PCMON DSN, please refer to
Desktop-Analytics Installation.pdf.
Upgrade
The automatic upgrade facility allows the system manager to roll out a new copy of
the Desktop-Analytics log client without having to physically approach each
machine. Refer to the Upgrade Deployment section for details on how to use the
upgrade facility.
Services
Job Processor Service (default state: Running)
The Job Processor Service, among other things is responsible for the timing of the
upload service. This service can is set to run each of its jobs every 5 minutes.
14
Release Notes
Configuration
Configuration of most of the client is now done via the Configuration area of the
web site. The Configuration area broadly mimics the previous configuration system
present in the Server Settings executable, which was only accessible on the server
machine. The Configuration area of the web UI is now available as a standard part
of the Administration web site (http://SERVER/FocusAdmin)
The key difference to the old Server Settings utility is that as well as a default
configuration that is set at install time, custom configurations can be added as well.
Any user or computer can be added to one of these custom configurations. If they
are not specified, then the default configuration is adopted.
The configuration is applied in the following precedence:
Default configuration options are applied.
Any additional computer configuration options over rule the default options.
Any additional user specific configuration options over rule the computer options.
A custom configuration need not have every single option specified in all areas of
the configuration. It could be only a single change. For example, it could be used
to specify a longer transfer interval for only a single individual user. Alternatively, it
could be used to over-rule every configuration setting for a number of users or
computers.
15
Release Notes
Licensing Tab
Desktop-Analytics will not function without a valid license key. The licensing tab
can be accessed from the Administration website. It shows the company name to
which the product is licensed and provides details such as expiry date and number
of remaining licenses. Module can be assigned to users or computers.
Configuration Profiles
The Default Configuration is automatically assigned to all users/computers so its
settings will apply to all unless custom profiles are created. In most deployments
only the default configuration will be needed. The items in the Default
Configuration can be viewed by clicking on DEFAULT on the left hand pane. Its
corresponding items will be displayed on the right hand pane. The values in a
DEFAULT configuration cannot be removed only modified and the DEFAULT profile
itself cannot be removed from the system as it contains critical items that are
required for the client functionality.
Items may be edited by highlighting the item and selecting the pencil icon to its
left.
NOTE
The ConfigurationServer entry must be a valid Desktop-Analytics server
name and must be in the format http://SERVER:PORT/services
16
Release Notes
Click on the Default profile in the left-hand pane and highlight Tray Group as
above. Now, click on the pencil icon to the left of UseTray and change its value to
Y. Repeat for UseTrayViewLog.
17
Release Notes
Custom Profile
Click on New Profile, enter a name
and click Insert.
The name of the profile may be
changed by clicking on the pencil
symbol to its left. It may be deleted
by clicking on the trash icon.
Certain configuration options must be
set. Click on the name of the profile.
An Add Configuration Item button
will now appear in the right-side
pane. This area is used to insert
custom configuration items. The
insert screen has a pull-down of the
items that can be added to a custom
profile and a space to enter the value corresponding to that key. Only one item of
each key type can be added to each profile. Items can be removed from a custom
profile by way of the trash icon and edited by selecting the pencil icon.
NOTE
Deletion of a custom profile will mean that
all users and computers that have been assigned
that profile will now revert back to the DEFAULT
profile and lose the relationship with the deleted
profile.
18
Release Notes
Configuration Assignments
Custom profiles are assigned to users or computers from within the Configuration
Assignments tab.
The find pull down list can be used to select a filter to find users or computers.
The search entry box located at the right side of the find pull down list can be used
to search for one item or multiple items separated by one of the following (":" ","
"~" ";"). The search box also accepts a wildcard character "%", which can be
used to return items that match a partial string and the wildcard. For example,
'%st' will return all items ending in 'st' regardless of the characters that preceded
the 'st'. Likewise, 'Chr%' will return all entries that start with 'Chr' and have any
number of remaining characters, whereas '%er%' will return all entries that contain
'er' anywhere in the entry name.
Entering Adm%
returns all computers
starting with Adm.
The administrator can also choose how to find the entries for the computers or
users by way of a dropdown choice list. The choices are (when searching for
computers):
Computers
Search for the entered criteria in the list of computers.
Computer Assigned Group Search for computers that are in groups that match
the entered search criteria.
Computer Assigned Profile Search and return computers that have been assigned
a configuration profile which matches the search criteria.
Unassigned Computers
Ignores the search criteria box and returns all
computers not currently assigned a custom profile.
The list and functionality is the same for computers with the list being Users, User
Assigned Group, User Assigned Profile and Unassigned Users.
The search results are displayed in a grid list which is paged at 15 entries per page.
The grid lists the name and Assigned Profile. Administrators can select rows to
perform operations on if wanting to assign to a subset of the returned list. The
area under the grid list holds the List of Profiles, which can be assigned (all custom
profiles will list here), the type of action that can be performed and an "Apply
19
Release Notes
Action" button. To assign a profile, the administrator can choose a profile from the
list and then choose an action from the Actions list and click the "Apply Action"
button to execute the choice.
The available actions are as follows:
To Selected Applies the selected configuration to only the items in the list that
the administrator has highlighted.
To All Pages Applies the selected profile to all the items in the grid list which were
returned from the search.
To Unassigned Applies the selected profile to all entries in the returned list that do
not already have an Assigned Profile.
Remove Assigned
Profile from Selected removes the currently assigned profile from the selected
items in the grid of returned items which in effect reverts the user/computer back
to the DEFAULT configuration.
Configuration Storage
The Default and Computer configuration sent to the client is stored in memory and
(on non-Citrix installs) is also stored within the PcMonConfig.ini file located in the
client directory. The user configuration is stored in the
HKEY_CURRENT_USER\Software\Iontas\Verint\UserConfiguration registry entry as
well as being loaded in memory.
Upgrade Deployment
Deploying an upgrade is a simple process and requires the following steps.
On the server running the Desktop-Analytics Data Upload service create an
Upgrade sub-directory underneath the shared Desktop-Analytics directory. This
new directory must be visible to all client machines e.g.
\\SERVERNAME\Public$\Upgrade.
Add the new versions of the files to be upgraded into this directory. Contact
Support if you do not have these files.
Run the Desktop-Analytics Server Settings utility from the start menu.
Click upgrade.
Type the full local path to the upgrade directory e.g. C:\Verint\public\Upgrade
Click Set Upgrade to activate the upgrade.
Click Start in order to start the upgrade service.
The client machines will begin to upgrade within a few minutes. The upgrade
should be kept in place until you are sure all client machines have had a chance to
upgrade.
20
Release Notes
NOTE
A restart of the client machine is not required in order to complete the
upgrade unless you are upgrading Hkproc.dll or MenuHk2.dll.
Removing the upgrade:
Click Stop in order to stop the upgrade service.
Click Clear Upgrade to de-activate the upgrade.
Description
Trigger utility
Support library
Support library
DCUApp API
Local copy of tracked data
Main logging client
Masking Dll
Auto-upgrade program
Temporary store
Support library
GSoap dll
Support library
Support library
Trigger utility
Trigger utility
Support library
Protection utility
Pop-up utility
Used for email triggers
Support library
Configuration
Support library (MSI Only)
Trigger cache
Tracing DLL
Process DLL
Process cache
Support library
21
Release Notes
Support library
Protection utility
Support library
Support library
22
Release Notes
Typical Operation
Computers that have the Desktop-Analytics client software
installed can display a Windows Tray Icon that lets the user
know that Desktop-Analytics client is installed and working
correctly. Display of the tray icon is optional. Refer to the
section on Server Settings for details on turning the tray icon on
or off.
If the tray icon is enabled, the following features are available by right-clicking on
the icon:
About
Displays an about box showing product summary information.
Set Activity
Users can enter the activity they are currently working on, or select one from a
drop-down list.
Start Logging
Allows the user to restart logging of the machine if logging has been suspended.
Stop Logging
Allows the user to disable logging of the machine if required.
View Log
Allows a user to view the log of the current windows session in a web browser
window.
Add Comment
Allows the user to enter a comment into the log. Users can use this option to
highlight a problem they are having during their workday. This comment will be
shown in any log report generated.
Close
Allows the user to shutdown the logging client until the next log in.
NOTE
These features can be enabled or disabled using the Tray Icon settings in
the configuration section of the web site.
23
Release Notes
User Permissions
User permissions are separated into different reporting roles. There are four
reporting roles. Applying each role has an accumulative effect on the user to which
they are applied.
User Roles
The web site now contains four user roles that can be applied against each user.
The roles are cumulative in effect.
The purpose of the enhanced user roles is to ensure only specified users can access
detailed log reports about other user activity.
By default, users will be given the standard report user role when they are added
to the system. If a user needs access to the log reports they must be assigned the
Advanced Reporting role by an administrator. The administrator must enter the
user role password to assign the advanced reporting role.
The separation of the administrator role from the reporting roles ensures that the
administrators only have access to the data specified by their reporting role. A
team leader will also only have access to the data specified by their reporting role.
A user can have any combination of roles but if the user has advanced reporting
role assigned then they will have access to all standard reporting role features.
User roles are assigned in the Users section of the Administration site. Edit the
required user.
Administrator
An Administrator has Access to Administration and licensing pages on web site
Standard Reporting
Standard reporting gives a user access to summary reporting without any sensitive
data (window titles or trigger values).
Application Activity Percentages
All bar chart reports (except websites) and without drill down to pc log and
keyword filter
Timeline Report without keyword filter or drilldown to pc or trigger log reports
Process and step log report
Weekly process AHT Report
Daily process AHT Report
24
Release Notes
Advanced Reporting
Advanced Reporting gives the full range of reporting features including keyword
filtering on each report. To add a user into the Advanced Reporting role the
administrator must enter the correct role management password.
Roles
Outcome
No role defined
Standard Reporting (default role level)
Standard
User
Standard Reporting
Advanced Reporting
Admin user
Administrator
Standard Reporting
Team Leader
Advanced
Admin user
Administrator
Advanced Reporting
Team Leader
Team Lead
Reporting
Standard Reporting
Team Leader
Management
Reporting
Advanced Reporting
Team Leader
No reporting access
Can run non-keyword
reports on own data
(Data, Triggers and
Processes)
Can run any report on
their own data, including
log reports
Can run non-keyword
reports (Data, Triggers
and Processes) on own
data and members of
their Team(s)
Can use web
administration.
Can run any report on
their own data, including
log reports and members
of their Team(s).
Can use web
administration.
Can run non-keyword
reports (Data, Triggers
and Processes) on own
data and members of
their Team(s).
Can run any report on
their own data, including
25
Release Notes
Administrative Reporting
In 4.1, for both security and practical reasons, an administrator no longer has the
ability to automatically review every user and every logged data that they create.
Administrators can configure triggers, groups, screens, and so on, but do not
explicitly have the right to view reports.
This can cause problems where an administrator is setting up triggers for a group
of users, and that administrator needs to check database to determine whether or
not triggers are firing. To do this, you need to do the following:
1) create a new team "All Trigger Users"
2) assign your administrator as a team leader of this "All Trigger Users" team
3) Add the users you need to report on to into this team
4) alternatively, set the "parent team" of existing teams to this "All Trigger Users"
team
The administrator can now review the trigger timeline report to confirm whether
triggers are firing
If you wish to give the administrator Full reporting access, then they can also run
trigger log reports on these users for greater visibility of trigger passbacks etc.
Application Groups
Application Groups are groups of similar type applications. For example, you could
have an Application Group called Games. All game applications could be assigned
to this group. Instead of running a report on each game application, you can
report on all games. Application Groups are set up in Desktop-Analytics Web
Administration.
Getting Started
To access Web Reporting, open Internet Explorer and enter the URL the DesktopAnalytics administrator has provided. It is usually of the form:
http://IIS_Server_Name/FocusAdmin
NT Authentication
When a user visits the Web Reporting web site, NT Authentication is used to
establish the users permission level. This means a user with Administrator
permissions will be able to view data and generate reports on all users within the
Desktop-Analytics database. A user with no permissions will be unable to access
Web UI.
26
Release Notes
NOTE
New Users have to be set as at least a standard report user before they can
access Web UI
Home Page
The Web Reporting home page should look similar to:
27
Release Notes
System status
The new System Status section shows license
information and other information
that is useful in determining the health of the
system. There are plans to expand the
information displayed here in future releases.
Licensed to
This is the name of the company to which the instance of Desktop-Analytics is
licensed.
Licensed for
The number of user/computer license modules purchased and the remaining free
licenses available.
28
Release Notes
Reports
There are 3 reporting options Activity Reporting, Event Reporting and Process
Reporting available on the Reports link on the Web Reporting home page.
By convention all reports are displaying older data at first followed by newer data.
Report Category
Each category can be selected using the radio button appearing on the lower left
hand corner of each image.
Report Type
The Type can be chosen from the Report Type pull down list.
29
Release Notes
Date Range
A number of pre-defined date ranges such as This week, Last week, Today,.. are
available for selection from the Date Range pull down list. An exact date range can
be defined by Enter Specific Date .
Click here to
enter a specific
date range.
TIP
30
Release Notes
Click on icon to
the left of a
filter to
remove.
The newly added item now appears under a Selected Filter Criteria section.
31
Release Notes
A link to
the saved
report on
the home
page.
Click on
the pin on
the
bottomleft of
each
chart
report,
enter a
name and
it will be
saved to
your
home
page.
Click here
to assign
a fixed
color to
an
applicatio
n.
32
Release Notes
Activity Reporting
The following reports are available if the site is licensed for Activity Focus.
Navigate
through
the pages
of the
report.
Search for
text
within the
report.
Export to
Excel or
PDF
33
Release Notes
The columns in the percentage active time in applications report are explained as
follows:
Item on report
Active duration
Total Percentage
Lotus Notes
Other Applications
Explanation
The total hours and minutes of non idle time
The percentage of time spent in active duration
The percentage of active time spent in each application
The percentage of active time spent in applications not
shown
Average score for the team included in the report (if any)
Team Average
Thus:
Adding up all applications across the top, will result in the total Percentage
reported, from example above: 90.3% = 20.8 + 0.7 + 9.7 + 23.4 + 9.7 + 2.8 +
3.5 + 19.7
The actual time logged in (including idle) can be calculated as Active Duration /
Total Percentage, from example above, 12hh 48mm / 0.903 = 14hh 10mm
34
Release Notes
Each Website report can cover up to 6 weeks in duration. The number of distinct
users using an application is displayed for each of the 6 weeks. The total weekly
duration of usage is listed beside the number of distinct users. Clicking on the
duration link will produce a bar chart that shows which computers have run the
application.
35
Release Notes
36
Release Notes
Filter by
A number of filters are available to reduce the number of items being displayed at
any one time. A filter is applied by either typing into one of the 5 text boxes above
the user list, or by making a selection from one of the drop-down lists. It is also
possible to filter by keyword. Filtering by keyword will display a list of all users
whose window text contains the keyword.
The following are some examples of filtering.
Filter by User Group
Click on the Select user group drop-down list and select a user group. Click Go
and the list of users will be filtered to only display users who are members of the
group selected.
Filter by Keyword
Enter the required keyword into the Keyword text box and click Go. The list of
users will be filtered to only display users whose current window text includes the
keyword entered.
Combining Filters
The live information list can be filtered by more than one filter at a time. Taking
the previous examples would allow filtering by user group and keyword.
Replace WinText
From 10 SP4 Hf1 onwards a feature to replace sensitive data from window title has
been introduced.
To activate this feature, edit the web.config located in the services folder and set
the following key ReplaceLiveInfoWintext from false to true. Then edit the
LiveInfoXmlCondition file to setup replacement pattern for the window title.
In terminal services and Citrix environments, in the rare event of users login in
with the same user name, only the first connected session will display.
37
Release Notes
38
Release Notes
Select the
next 10
applications
to display.
39
Release Notes
Idle Time
Idle time is displayed in white. Desktop-Analytics records a computer as idle once
there has been no mouse or keyboard activity for a period of 5 minutes or more
(set in Configuration area). This means if a user is working in MS Word and then
goes for lunch; the period the user was at lunch will be recorded and displayed as
idle. Recording a users idle time is vital in order to get a true picture of a users
application usage.
An option in Edit Report allows you to show or hide the idle time in the Report.
Colour Coding
40
Release Notes
Each bar of a time line report is divided into 15-minute sections. Clicking on a
point on a time line bar will produce an hourly time line report for the hour selected
(see below). The colour-coding is assigned based on the application that is most
used by the user during the 15-minute segment.
Application Colors
The application with the highest duration on a time line report is assigned the
colour red. The second most used application is assigned yellow and so on. If MS
Word is the most used application in a time line report then it will be coloured red.
However, if a time line is run for another day and MS Word is not the most used
application, then it will not be coloured red.
NOTE
Colours may be assigned to an application. Refer to the Set Application
Colours section.
Drilling down
on a daily
timeline
report
produces an
hourly
timeline.
The Hourly Timeline is colour-coded in the same way as the Daily Timeline.
However, each application that was used is displayed whereas with the Daily
Timeline, only the most used application within each 15 minute period is displayed.
Drilling down on a users timeline produces a Summary Statistics pop-up, showing
details on how the user has used the selected application. For example, the
average duration for each time the user accesses the application is provided.
41
Release Notes
A PC Log Report for that user for the relevant hour is produced by clicking on the
PC Log Report link on the bottom-left of the Summary Statistics window.
42
Release Notes
A separate
legend is
displayed for
each data
stream.
43
Release Notes
Below is another example showing Activity, Process Events, Steps and Processes.
We see 4 data
streams per
user.
Time line reports are not limited to showing a single day of duration. To view a
timeline report over a longer duration, select a different time range on the edit
report page.
The timeline axis is automatically adjusted for the time period specified. When
generating a timeline, the timeline shows an approximate representation of the
data for the time period shown. This time line is approximate because it must show
the data with a level of granularity available for the period of time shown.
For example, if a process runs for an hour, stops for a minute, and runs for another
hour, and you show the timeline over a period of 2 hours, it is possible that you will
be able to see the minute gap. If, however, you run the timeline over a period of
12 hours, or a week, it is unlikely that you will be able to see the single minute gap
due to the scaling required to show the full 12 hours on the timeline.
44
Release Notes
The report is
searchable
and is
paginated.
It features pagination and is searchable, just like the Application Duration Log
Report.
Process Reporting
Process/Step Log Report
The Process Log report shows a particular step and / or process, for all steps and
processes within a particular time period. To report on a step or process, type the
45
Release Notes
matching name (or sub-string of this name) into the Process text box and generate
the report. Only processes and steps matching this criteria will be displayed.
Completed
processes
are
highlighted.
Click on a
process to
see the steps
that made up
the
completed
process.
If you wish to review all steps that have occurred within a process, both those that
are part of the process definition and also steps incidental to the definition but that
have occurred during the process, click on the highlighted process name. The
report will be redrawn only showing the items within this process.
Filtering
In addition to being able to filter by the usual items such as user and Team, it is
also possible to filter by Tag - Transaction ID, Value, Status and Process Value.
How these items are defined is dealt with in the
Process Desktop-Analytics section. These values are essentially values that have
been tagged to the Step or Process during which they fired. Refer to the example
in the section below.
46
Release Notes
users (and when) have touched the transaction. The required Tag is selected
when creating a Process/Step Log Report (or Process Timeline) and the particular
The analyst running this
report spots that the user did
not perform the Address
Verification step.
47
Release Notes
We have now established where the transaction went wrong. The knock-on effect
of the missed Step is that the order is sent from Front Office to Shipping. The user
who picks up the transaction in Shipping (Frank) is unable to dispatch due to the
address being incorrect. The order is sent to Customer Services.
The customer service representative calls the customer and resolves the address
issue. The order is sent back to shipping and successfully dispatched.
Process Desktop-Analytics has shown us in this example:
A transaction being worked through multiple departments
Who worked the transaction and when
Where it went wrong
The knock-on effect
Instead of going from Front Office to Shipping it went through customer service
and then back to shipping.
Transaction was delayed to the next day.
Customer dissatisfaction.
Potential training requirement for Front Office worker
48
Release Notes
49
Release Notes
Click on the
duration to drill
down to a log
report.
Outliers may be highlighted in the returned data by selecting the Outliers filter
before generating the report.
50
Release Notes
Process
Event
and
Step
and
Process
Timeline
By
51
Release Notes
User/Computer
The report displays two timelines for each user/computer combination. The top
line shows the Steps and the line below shows the Processes followed. The dots
along the timeline signify Process pass back events (ref. Process Desktop-Analytics
section for more details). Hovering over the dot shows the details of the pass back
event e.g. Property Value: 500000.
52
Release Notes
53
Release Notes
Above, we see users process statistics over the period of a few days. Each line
represents a user. We can clearly see how their AHT changes. The blue line,
which is marked with crosses shows the AHT for a defined team and can be
displayed for comparison purposes.
This report is generated by
selecting the Peer User Team
against which you wish to compare
the users. The users are selected
by adding them from Available
Filters. The process or step that is
to be reported on, is also added as
a filter.
54
Release Notes
Clicking on one of the dots on a line will drill you down to the daily view.
55
Release Notes
56
Release Notes
Activity based
To be used at early Discovery stage, before events have been defined, it doesnt
replace the need to create Event but help to find the most used application and
associated window title. Each users activity data is compiled and reviewed
together. The resulting high level workflow diagram shows which activity most
frequently follow on from each other across the entire user population (also on a
group basis).
Event based
Linked Triggers
Each user's trigger data is compiled and reviewed together. The resulting workflow
diagram shows which events most frequently follow on from each other across the
entire user population (also on a group basis). The results are drawn as process
workflow diagrams using Microsoft Visio (2003 or 2007).
Linked Steps
Each user's step data is compiled and reviewed together. The resulting workflow
diagram shows which steps most frequently follow on from each other across the
entire user population (also on a group basis). The results are drawn as process
workflow diagrams using Microsoft Visio (2003 or 2007).
Add Incomplete Paths
Previously (prior to 10SP4-HF1), if a user started a process, but did not complete,
it was not included to the trigger matrix to be displayed. This option now allow
displaying the paths that are not finishing at the defined end event.
The below diagram provide an example of what is seen when incomplete paths
option is enabled.
Add User List
If require and for scalability, from 10SP4-HF1 onwards, workflow can be drawn
without the user list, as this reduce the amount of data retrieve from the database,
the workflow will generate quicker.
Add Event Values
Similar to User list, this option remove the data from event values to be retrieve
from the database, hence reducing the time it takes for the workflow to be
produce.
57
Release Notes
Process based
This generates reports directly from the process data stored in the database, it
does not require the creation of Links.
Overview
The connecting line (pathway) between activities or events varies in thickness
depending on the number of times the two activities or events follow on from each
other i.e. based on the number of times the path has been taken. Using the right
58
Release Notes
mouse click menu on this line allows you to review the users that have performed
this pathway, giving statistical data on how much time was taken by each user to
perform this pathway. Users who are outside the norms for the time take to
perform this pathway are highlighted in red (if their connection time is longer than
the norm) and green (if their connection time is shorter than the norm). The basis
for this outlying calculation is the number of standard deviations away from the
average connection time.
Some events fire repeatedly. In this case, a connecting line loops back to itself
showing that this repetition has occurred.
Versions 1.0.0.9185 onwards support both 4.X and 3.X versions.
Pathway
A line connecting two events that represents the number of times any user has
performed these two events sequentially.
Start Event
An event that has been identified as being the start of a particular sequence of
events.
End Event
An event that has been identified as being the end of a particular sequence of
events.
Linked Event
A Start Event and End Event pairing.
Operation
A Process Discovery Focus workflow diagram displays
the most travelled path between two events. The
thicker lines represent a higher number of events.
The diagram on the right shows a Start Event and the
various pathways leading from it. Start Events are
displayed in green. Intermediate Events are displayed in
blue and End Events are displayed in red. Each pathway
between two events shows the number of times this
path was taken.
It is highlighted in red to signify some users who took
this path either took longer than normal or were faster
than the norm. Green arrows indicate no users were
significantly faster or slower than average.
59
Release Notes
Settings
Select Settings from the Process Discovery menu option of Microsoft Visio. This is
where the connection to the DAM sever and Links can be defined.
General
The General Tab in Settings is used to setup the connection between the
workstation running Process Discovery and the DAM server, refer to chapter 3.2.7
for more details on setting up the connection with the DAM server.
Advanced Options
Standard Deviation Multiplier
This is the number of standard deviations that the colour-coding of the connections
is based on. Refer to the Show User List section for more details.
Enable Trace
Allow saving exceptions received from .Net and Microsoft Visio into a file, useful to
gather information on usability (i.e: report on Microsoft Visio users that have
deleted an object from the drawing). The resulted trace file is saved into My
Documents\My Process Discovery\Process Discovery Trace.log, the location cannot
be changed.
60
Release Notes
Ignore Events
Events selected in Ignore Events will
not be displayed on the diagram.
Events can be easily searched using
the Filter feature, once selected from
the evens List click on the top arrow
to add the event to the ignore list.
Should you wish to remove an item
from the ignore list, simply select it
and click on the bottom arrow.
Linked Event
At least one Linked Event must be created prior to draw a workflow diagram.
Linked Events are created in the Linked Events tab available in the Settings dialog.
Add/Remove
Events buttons are
disabled until a
new Link is
created.
61
Release Notes
The Add/Remove Events buttons will remains disabled until either a new link is
created by clicking on the Add Button, or a Link is imported by clicking on the
Import button.
Click on the Add button, assign a name to the new linked event and click Save.
Now select the Start Event from the Event List on the left side of the screen. Use
the green arrows to add it as a Start Event. Do the same for the End Event.
A workflow diagram will be drawn for this linked event the next time the Show
Workflow option is selected.
Import
This feature allows you to import any Process Focus Steps which have already been
defined through the Process Focus definition area of the web interface. If Steps are
imported, then a workflow diagram can be drawn between the start event of the
step and the end event of the step. The events visited in between will be drawn.
62
Release Notes
General Tab
Selection Options
Click on the Process Discovery Focus menu option and select
Show Workflow.
Select the required data and time range.
NOTE
The start and end time range you are defining here will be used for each
day the report is run, i.e: From 5/1/2010 12:00:00AM, To 5/5/2010 01:00:00PM
means that the report will return data for an hour each of the 5 selected days.
63
Release Notes
The workflow diagram will be drawn against the Process Focus data only. Only
events which are defined as part of Process Focus Steps and Processes will be
displayed in the resulting workflow diagram.
Consolidated Activity Data
The workflow diagram will be drawn against consolidated Activity Data. Only data
based on Application and Window Title will display. Two pages will be created, Top
10 Wintext by Duration and Top 10 Wintext by Count.
NOTE
Because this report is based on Activity data from the database PC_log
table, the Selection amount (based on number of rows from the trigger_log) from
the Selection Options is not available, this report can only be run based on a Date
Range, the User Group Filter option is however available.
User Filters
The workflow diagram can be limited to data from a particular User group, User
Team or User.
64
Release Notes
Intermediate Event
shown in Blue
Some Users are
taking shortcut
paths
65
Release Notes
66
Release Notes
Here we see the list of users who took this path. The count is displayed for each
user along with their average time to complete the path between the two events.
Users highlighted in red are above the standard deviation. This means they took
longer to complete the step. Users in green made the step very quickly. The red
users are calculated adding the Group Average + Standard Deviation. Users with
an average above this total are highlighted in blue; slow users. The yellow users
are derived by subtracting the Standard Deviation from the Group Average. Users
below this figure are the fast users.
The Standard Deviation camn either be calculated on Average Duration or
completion percentage, the Multiplier defaults to 1. If it were 2 then the above
calculations are performed as follows.
Group Average + (Std Dev x 2) and Group Average (Std Dev x2)
Report on all users section:
Completion %: This represent the percentage of completion for each users, taking
Angela Jones as an example from the screen shot above, 96% means that 4 % of
Paths didnt complete (didnt end at the end event you defined as your end Link
Event).
Figures other than 100% completed can only happen when the add incomplete
path option was used to drawn the report.
67
Release Notes
68
Release Notes
The top section of this report shows statistical information for the list of users that
have followed the same path. Clicking on a user from the Statistical report all
users section will display detailed duration per user in the lower section of the
page.
Standard deviation calculation is made on the list of users and detailed durations,
this to allow quick visual comparison.
69
Release Notes
Go To Definition
From the Workflow Diagram, right-click on an event and select Go To Definition to
see the events trigger definition.
Refresh Workflow
A workflow diagram can be redrawn with different parameters while keeping the
same layout. For example, this allows you to view differences in the workflow from
one date range to the next. Workflow Diagram Example 1 above was drawn
with a 3 day date range. Below we see the same workflow drawn but for only 1
day. As you can see, the layout is the same but the number of connections
between events is much less.
From the Process Discovery menu in Visio, select Refresh Workflow.
Web Administration
To access Web Administration, open Internet Explorer and enter the URL DesktopAnalytics administrator has provided. It is usually of the form:
70
Release Notes
http://IIS_Server_Name/FocusAdmin
NOTE
The website can also be accessed using
http://IIS_Server_Name/Focus_admin or
http://IIS_Server_Name/Focus_web urls.
The Web Administration home page defaults to the System Status page and will
look like this:
The system status area shows client and version information.
The Control Web Services area allows you to temporarily shut down the client
facing web services.
Log Record Service Pausing this service will force all subsequent data to remain
on the client machines. This is useful if the server is out of disk space, or for some
New Feature:
Heading while the server
other reason the logged data needs to remain
on client machines
docketc).
objects
can be
is attented to (upgrades, database updates,
Pausing
and resuming this
collapsed
service immediately will cause it to flush expanded
its currentordisk
cache. : Useful when you
this client
allowsmachines.
for greater
want to confirm data is being received from
use of screen real estate
71
Release Notes
Configuration Service Pausing this service will stop any configuration changes
from being received by the client machines. This is useful if you are conducting a
planned change to a large number of configuration options, and you wish to stop
configuration changes until all updates are completed.
Pausing and resuming this service will force the configuration system to update
itself immediately. Useful when you need to quickly force a new configuration out
to the client machines.
Help Screen System State
The Help page shows system status
messages.
It also allows you to export the system
state to a zipped archive. This archive
can include the screen library and also
the current user, computer, and system
files as CSV data files. On Installation
and trouble shooting, this system state
should always be exported as an initial
support task.
72
Release Notes
stamping of the event will still relate to the time when the trigger fired so the data
contained in the Trigger_Log will be as accurate as before. The Trigger_Log will
just not be updated in real-time.
Trigger Criteria
Each control that is selected on a trigger can contain one of a number of criteria,
which, when met, will fire the trigger command. Standard trigger criteria are
shown below:
The Equal To and Not Equal To criteria are special
cases for the following reasons:
Use of Blank : If you require a trigger to fire when
an element is blank or not blank, then you must
always use either equal to or not equal to.
Specifying that a field contains or does not contain
<blank> will result in a trigger that does not fire.
Starts with / Ends with : you can set a trigger to
fire it it starts with ( or does not start with ) a
particular patten by using the equal to and not equal to criteria, but with the
additional code as shown below.
Starts With Trigger criteria
To configure a trigger to fire against a starts with criteria, define the trigger as
normal, and set the trigger criteria to be Equals to. Now, where you normally
type the condition value, you include the DPARX^ prefix. The bitmap below
shows how to set the criteria for the readout element of a trigger to fire when it
starts with 123 : DPARX^{[1][2][3]}.
Ends With Trigger criteria
To configure a trigger to fire against an ends with criteria, define the trigger as
normal, and set the trigger criteria to be Equals to. Now, where you normally
type the condition value, you include the DPARX{}$ prefix. The bitmap below
shows how to set the criteria for the readout element of a trigger to fire when it
ends with 321 : DPARX{[3][2][1]}$
Note how each character must be surrounded by [ ] brackets. The entire
condition must be enclosed with { } and terminated with the $ symbol to signify
the end of the line.
For more information and examples on starts with and ends with, see the
10SP4HFR4 release notes document, DPA_10SP4-HFR4-Release Notes.
73
Release Notes
Trigger Administration
Triggers and Screens are now combined into a single screen. The Triggers screen
displays all triggers grouped by the screen they are based on.
Searching for Triggers/ Screens/ Applications/ Window Titles
74
Release Notes
75
Release Notes
Screen Content triggers are attached to screens. A screen is uploaded from the
DPA Validator utility by clicking on the Add New Screen, or by importing a screen
library. Once uploaded, screens are shown on the same triggers page. You can
search for your screens using the filter at the top of the page
Selecting the expand
v chevron will display
all criteria associated
with the selected trigger
Copy to New
quickly creates a
new trigger against
this screen
76
Release Notes
77
Release Notes
78
Release Notes
Click on the Add New Screen button on the main Triggers screen.
You will be prompted to either run or save this utility. For security purposes, it is
best to save this application locally to somewhere that you have full read and write
permissions, such as your desktop.
Once downloaded, clicking on the DPA Validator file will open a small window in the
top-left corner of your screen. This is DPA Validator. This utility is used to
generate screens to which you can later attach your triggers.
Typically, you can just select capture and then select the application you wish to
base your triggers upon. The settings dialog controls how particular aspects of the
capturing and triggering system interact with the target application.
New functionality has been added to DPA Validator which makes it possible to
select table columns as a single control. In order to enable this functionality after
downloading DPA Validator, as per above instructions, click on Settings. In the pop
up window that appears select the Capture Columns option as shown in the below
image, and click OK.
79
Release Notes
Once this setting is selected, in order to capture the full column as a single control,
hold down the SHIFT key while selecting the relevant control using the left mouse
button. It is also possible to capture individual row elements. To do this simply
select the control in the normal manner.
NOTE
Another new feature to 10SP4HF4 is the use accessibility feature. For more
information on this feature see section below on internet explorer browser triggers
80
Release Notes
If you find DPAValidator is taking too long, it may be that the directory it is using for
the grabs folder is being targeted by anti-virus utilities and as such may cause a slow
down due to virus scanning activity on the trace file. If this occurs, please try disabling
the anti virus utility for the period of the validation session, or move the DPA
Validator executable to an area of disk that is free from Virus Scanning.
Click on
the pen
to edit
Locate the required screen and click its Edit Screen button. Click on an non- the
highlighted control to select it as an available trigger control.
screen.
Care must be taken if editing the Window Text or Application values. Both of these
fields must only the full or sub-string of characters from their original values. For
example, if the original Window Title is Order Form then I must not add in any
additional characters, otherwise such a screen will never be found which will result
in any triggers based on this screen not firing.
NOTE
Controls can only be added to the screen. Controls highlighted during the
original DPA Validator capture cannot be removed.
81
Release Notes
82
Release Notes
Optimising triggers
During initial definition of triggers, you may find that the same screen has been
captured two or three times in DPA Validator, each with a couple of triggers
assigned to it. Best practice is to move all your triggers onto a single captured
screen. This makes it easier to find the triggers (since they are grouped by screen
on the trigger definition page) and easier to check and manage them.
Updating a Screen
A number of triggers may be set up on a web page or application. After a period of
time, the target web page or application may get changed due to external updates
or other factors. At this point, you will need to capture the new screen. It is time
consuming to build up all triggers on the new screen based on the old triggers. To
do this in migrate screen, you capture the changed application and ensure all items
are highlighted in their correct positions. Once this has been done, and the new
screen is in your screen library, you can select the edit icon on the old, existing
screen, and select the "migrate" button. You must manually decide which elements
from the old screen are equivalent to the items on the new screen. To do this you
must have enough elements highlighted on both screens before you perform the
migrate. Once all items are selected and matched between the old and the new
screens, you can select the "move" triggers button to move all the triggers defined
on the old screen over to the new screen. Note you must make sure you match up
83
Release Notes
all controls from the source screen with all controls on the destination screen,
otherwise you will not be able to move all triggers correctly.
Click on Migrate
Screen.
84
Release Notes
Clicking on Migrate screen open a new Dialog, this is where the target screen is
selected (the screen to which the trigger will be migrated). The search feature can
be used to quickly find the target screen, this by entering criterias such as screen
or application name.
Type a Screen or
Click on the Target screen from the list of availableApplication
screen matching
your search
name and
criteria.
click on the search
(magnifying glass)
button.
85
Release Notes
Use Up/Down
arrow to re-order
the controls
Controls
highlighted in
green are already
used in triggers
Automatch controls:
This feature can be used to automatically select the controls from the source and
corresponding controls from the target screen. However it is important to note that
this feature will only function for screens that are quite similar in terms of control
position and type.
Copy All Triggers: This button make a copy of all triggers based on the source
screen and keep the original triggers.
86
Release Notes
Move All Triggers: This button make a copy of all triggers based on the source
screen and delete the original triggers.
The migrated triggers will appears with a name starting with Migration of.
87
Release Notes
Java
DPA Validator will prompt you to install Access Bridge if you attempt to capture a
Java application and it detects Access Bridge is not already installed.
Trusted Sites
Sometimes production workstations have security in place which restricts access to
Internet Explorers DOM. Access to the DOM is required by both DPA Validator and
ultimately by the Desktop-Analytics client as well.
MDI
DPA Validator will prompt to Capture the Parent window of an MDI application if it
detects a Child window has just been Captured.
Firefox
Desktop-Analytics requires an additional install in order to DPA Validator or trigger
from web pages within Firefox. The Desktop-Analytics Firefox installer is found in
\Verint\Web_Reports\WinGrab\MozillaDCUApp. DPA Validator will prompt to install
this installer if it is not detected. This must be installed both on machines where
DPA Validator.exe is used, and also on target machines where triggers are to be
fired against Firefox.
HotSpots
Warnings are displayed if DPA Validator detects that you are trying to draw
HotSpots in the following unsupported scenarios:
On a web page.
On a terminal emulator.
88
Release Notes
Tracing
If DPA Validator contains the name of the application server within its file name, it
will not generate any tracing by default. You must specify tracing using the settings
dialog in this case. If DPA Validator does not contain a server name, then it
defaults to generate tracing and HTML files where relevant.
Click on Add
New Trigger
to create a
trigger based
on that
screen.
The new trigger definition screen makes it easier than ever to define a trigger.
Parts of the screen will be familiar to users of previous releases. One notable
change is that each highlighted control is no longer listed on the trigger definition
page. The user clicks on each of the controls he/she wishes to use as part of the
trigger condition or as a passback. Only those controls are displayed.
Click on the
required
controls and
they will be
displayed above
the screen.
89
Release Notes
Trigger Commands
The Trigger Commands section is where you define applications that will fire when
trigger criteria are met. The following variables may be passed to a Trigger
Command:
%USER
%COMPUTER
%APP
%WINTEXT
%DATE
%TIME
%TRIGNAME Name of the trigger
%TRIGVAL Value of controls from which the trigger is passing data
%FORMAT details below
%TRIM details below
%PARSE details below
Copying a Trigger
Creating multiple triggers off the same screen may be speeded up significantly by
using the Copy to New Trigger feature.
Search for the existing trigger on the Triggers page
Click the Copy to new trigger button to the right of the trigger.
Enter the name of the new trigger and make whichever changes you require for the
new trigger.
Click on Save when finished.
Click on this
button to Copy a
trigger.
90
Release Notes
Deleting a Trigger
To delete a trigger, click on the Delete button on right hand side of the trigger.
Click Activate Trigger Changes to apply the changes.
The New Control Trigger button will take you to the Trigger Definition Screen
where you can create a new trigger based on the Outlook Express New Message
screen.
91
Release Notes
Now go back to the DPA Validator program and select Grab. Click on the message
window again. DPA Validator will momentarily disappear (this to avoid polluting
the screen when grabbed) and pop up a new window containing the grabbed
screen.
92
Release Notes
Selecting Controls
Click on the controls on which you are interested in basing the trigger criteria of
future triggers. Right-click on a highlighted control to de-select it.
In our example, 4 controls have been highlighted in red. This means we will be
able to attach triggers to the From, To, Cc, Bcc and Subject of an email.
If clicking on a control results in it being highlighted in blue, this means DPA
Validator does not support this type of control. It will not be possible to base a
trigger on such a control.
Another DPA Validator window is opened.
This window allows you to customize the screen library entry for this screen.
93
Release Notes
Command to execute
Select the required Trigger Command from the pull-down list. In our example,
were using a Notify Trigger Command.
Additional Parameters
The Additional Parameters field is used to enter command line arguments for the
Trigger Command that will be specific to the current trigger. In our email example,
we will enter the following:
-fTrigger@xyz.com -tjohn.smith@xyz.com -sSupport Email %USER on
%COMPUTER has emailed Support at %TIME on %DATE
The above equates to:
-fFrom Email Address -tTo Email Address -sSubject Body
94
Release Notes
NOTE
This field has a limit of 1024 characters.
95
Release Notes
Specify Criteria
The user clicks on each of the controls he/she wishes to use as part of the trigger
condition or as a passback. Only those controls are displayed.
Click on the
required
controls and
they will be
displayed
above the
screen.
Equal to
Trigger when equal to item
Not Equal to
Trigger when not equal to item
Less than
Trigger when less than item
Greater than
Trigger when greater than item
Contains
Trigger when contains item
Does not contain
Trigger when it does not contain item specified
Has Changed
Trigger when value of control has changed
On Clicked
Trigger when control is clicked
Exists At
Trigger when control exists at this location (only applies to Win32
applications more details below)
96
Release Notes
Process ID, Value, Status etc are known as Tags and will be explained in the
Process Desktop-Analytics section of this document.
We also want to pass back the value of the Subject field to our Trigger Command
executable. To do this, we simply check the PassBack value beside the Subject
control. This means the trigger will fire when an email is sent to an email address
that contains the word support. In addition, the subject of the email will be
passed back to the Trigger Command executable. In our example, were using the
Notify email program. Notify will send an email to the address defined in the Notify
Trigger Command. The email will include the support e-mails subject (Control 3s
PassBack value).
97
Release Notes
98
Release Notes
Click-type Triggers
Only one button-click, menu item or HotKey can be defined per trigger. For
example, a trigger based on File .. Open menu option being selected AND an OK
button being clicked, is not allowed. Two separate triggers may be defined
instead.
Each application/WinText combination may have only:
64 button-clicks/Hotspots/Anchors (any combination can make up the 64)
+
64 menu-clicks
+
64 hotkeys
NOTE
This limit is based on the application and WinText combination. It is not on
a per screen basis. This is important to understand since multiple screens may
have the same application and WinText combination.
HotSpots
Hotspots allow you to create a trigger based on a control that is otherwise not
supported by AppAlert. The screen is grabbed in the normal way. Controls that
are supported by AppAlert can be highlighted as normal. Controls that are not
supported (highlighted in blue) can be selected by drawing a box around them.
Holding down the Ctrl key, simply draw a box around the control in which you are
interested. Once the box is drawn it is highlighted in red, just like the other
selected controls. Upload the screen in the usual way.
99
Release Notes
than the control on which it is based. A trigger based on the hotspot below would
never fire not only because it is bigger than the control but also because the box
covers an area outside the toolbar in which Send/Receive is found.
NOTE
Only one HotSpot can be defined per trigger.
A HotSpot is treated like a button-click. Each application/WinText combination can
have:
64 button-clicks/Hotspots/Anchors (any combination can make up the 64)
+
64 menu-clicks
+
64 hotkeys
HotKey
A Hotkey trigger is used to fire a trigger when a specified key is pressed on a
defined screen. The Outlook hotspot trigger described above will fire when the
Send/Receive button is clicked. Following on from this example, we may wish to
create a hotkey trigger to fire when F5 is pressed on the keyboard (F5 is the
function key associated with most versions of Outlook). The Trigger Definition
page now contains an option to define a Hotkey. In the example below, we can
see the HotKey Pressed criteria has been selected and F5 has been entered as the
chosen key. This trigger will fire when the user hits the F5 function key.
NOTE
The Outlook examples above describe two separate triggers. It is not
possible to create a single trigger to cover both examples. The example below
would not work:
This would mean the trigger would only fire if the Send/Receive button AND the F5
key were selected. Remember the logic when defining criteria based on multiple
controls is AND and not OR.
NOTE
A button-click trigger must not be defined on the same trigger as the
HotKey.
100
Release Notes
101
Release Notes
%TRIGVAL
Placing %TRIGVAL in the trigger command instructs the trigger system to output
the entire trigger string of all trigger passback classnames and values into the
trigger command line argument.
%TRIGVAL Example:
[CalWndMain]28 February 2007[Static]Current time zone: GMT Standard Time
%FORMAT
The %FORMAT command is a way of printing only the value of particular trigger
criterion, instead of printing out the entire trigger string. Using the %FORMAT
command will output the value of the specified class name on the command line,
along with any other strings contained in the %FORMAT statement. It is designed
to be used instead of %TRIGVAL and is especially useful when combined with
%PARSE,
"%PARSE<CalWndMain>28?2007%PARSE<Static>Current?one%FORMAT My
Favorite Month is<CalWndMain>%FORMAT in<Static> gone by"
This runs the two pre-processor %PARSE statements and the outputs the result
along with the additional text specified as the trigger string:
My Favorite Month is February in time z gone by
%FORMAT and %PARSE can be used in this way to format exact command line
parameters that may be needed when integrating into another system.
%PARSE
%PARSE is a pre-processor operation that is added to a trigger command line to
parse a particular value in the trigger string. The operation can split a text value
by matching for both before and after strings, if necessary. It parses the string
102
Release Notes
and returns only the middle section that it might find, using the following
operators:
%PARSE<classname><prefix string to match><string to return, designated by
'?'><postfix string to match>
%PARSE on its own does NOT print out any output to the trigger command line. It
only modifies the trigger string obtained by the trigger. To print out the parsed
item, you need to combine it with either a %TRIGVAL command or a %FORMAT
command
For example:
"%PARSE<Static>? time%TRIGVAL"
This will first modify the static value and then print out the full trigger string:
[CalWndMain]28 February 2007[Static]Current
Note how as soon as %PARSE encounters the string time it returns the sub-string
Current. It does not need to continue looking for the rest of the remainder time
zone: GMT Standard Time
%PARSE can be applied to each value in the trigger string:
"%PARSE<CalWndMain>28?2007%PARSE<Static>Current?one%TRIGVAL"
The above will run two pre-processor operations and then print out the resulting
trigger string:
[CalWndMain] February [Static] time z
103
Release Notes
%TRIM Command
The %TRIM command is used to extract a sub-string of characters out of a
controls passback value.
%TRIM<controldispname1>offset1,size1<controldispname2>offset2,size2....<cont
roldispnameN>offsetN,sizeN %TRIGVAL
OR, if you wish to output only two control display names rather than the entire
trigger value:
%TRIM<controldispname1>offset1,size1<controldispname2>offset2,size2....<cont
roldispnameN>offsetN,sizeN %FORMAT <controldispname1> <controldispname2>
This will trim a control value by taking the sub-string starting at offset for the size
of characters.
If the offset is negative, the offset is calculated from the end of the string.
If size is -1 then the sub-string runs from the offset to the end of the string
Similar to a %PARSE command must be followed by either %FORMAT or
%TRIGVAL in order for its value to be output.
For Examples:
ControlDispName: Test
Control value abcdefghijklmnopqrstuvwxyz
%TRIM10,5
%TRIM10,-1
%TRIM-10,5
%TRIM-10,-1
PCMONTAG
A PCMONTAG trigger can be used to insert values from objects into the WinText
field. The extra data contained in the WinText can then be reported on in Web
Reporting.
PCMONTAG updates the WinText in a similar way to a Content Module. However, a
PCMONTAG is actually a little more powerful than a Content Module since it allows
you to define a condition. The WinText will only be updated if the condition is met.
Below is an example of PCMONTAG in use. It is configured in a similar way to
MsgPop.
104
Release Notes
The trigger will fire when the year is not equal to 2005. When the trigger fires we
want to insert the value of the Date object into the Date and Time Properties
WinText. The usual WinText for Date and Time Properties is either "Date/Time
Properties" (Win2k) or "Date and Time Properties" (XP/2003). When our trigger
fires, this WinText will be replaced with whatever the new date is e.g. if we change
the year to 2006, then the new WinText will be
27 SEPTEMBER 2006.
PCMONLOGONLY
When a PCMONLOGONLY trigger fires, nothing happens other than the trigger
event is written to the SXN file and then it will make its way to updating the
Trigger_Log. No third-party command is executed.
Create a Trigger Command called PCMONLOGONLY. Select "Execute on Client" and
replace the path with PCMONLOGONLY. No other parameters are required.
NOTE
Process only or DAT install does not allow logging of triggers. If you require
troubleshooting to determine whether your pc activitv or process triggers are
working, please use the trigger debug feature of the product to confirm that
triggers are correctly firing.
PCMONADDREC
This trigger command allows you to insert a record into the PC_Log table of the
DAM database. This means the record will appear alongside the Application
Analysis data rather than the AET trigger data. The PCMONTAG command also
affects the PC_Log. However, the PCMONTAG command differs in that it only
updates the WinText field of a PC_Log record whereas the PCMONADDREC
command allows you to specify the application as well. The command accepts the
following parameters:
%FORMAT <APP> <WINTEXT>
A passback value may be inserted as either parameter. This is done by simply
replacing APP or WINTEXT with the object name of the passbacks value which you
wish to enter as the application or WinText.
105
Release Notes
106
Release Notes
Description
EventType_List.EventName
Event1_List.eventName
Event2_List.eventName
Event3_List.eventName
Event4_List.eventName
Event5_List.eventName
Event_Log.Duration
Event_Log.FrameTime
Event_log.LogTime
Event_log.EndTime
Dependent Triggers
A dependent trigger is one that will only fire if the trigger on which it depends has
already fired. For example, lets say you wish to receive an email notification but
only when a user completes a sale in the CRM application that exceeds $10,000.
The email notification is configured to only fire if the high sale value trigger has
already fired for the user.
107
Release Notes
Trigger Expiry
Sometimes it is necessary to force the expiry of a trigger in order for it to be
available to fire again. To do this, enter a value in the Fire again even if no
change detected after field. The value is in seconds.
Once the trigger fires and the expiry time has elapsed, the trigger has been reset
and is now available to fire again.
NOTE
This does not mean the trigger will immediately fire again. The trigger will
fire the next time its condition is met. This may or may not be the case
immediately after the expiry time has elapsed.
Expiry Command
If a trigger has an expiry and you wish a command to ALWAYS fire once the expiry
time has elapsed, then set up an expiry command. Select the required command
from the Select a command to fire at expiry pull-down.
NOTE
The Select a command to fire at expiry option is only displayed if a trigger
expiry has been set.
A Window Close can be set to fire EITHER when the window completely closes or
each time the window loses desktop Desktop-Analytics.
108
Release Notes
NOTE
The With Window Title Containing filter is based on characters that appear
in EITHER the window title OR the URL, if the application is a web browser.
A Window Open trigger can be set to either fire every time the window gains
desktop Desktop-Analytics OR only when a new instance of the window has been
opened.
NOTE
This MUST be the applications executable name and NOT the friendly name
assigned to the application e.g. it must be IEXPLROE instead of Internet Explorer.
109
Release Notes
A PC Shutdown trigger fires when a user logs off from his/her computer. It also
fires if he/she shuts down the computer.
NOTE
A PC Shutdown trigger must be configured as a server-side trigger. A
client-side PC Shutdown trigger will not fire.
On Idle Trigger
This type of trigger will fire when a specified computer goes idle. More information
on Idle is available in the Configuration section of this document.
No Longer Idle Trigger
A No Longer Idle trigger fires when a computer comes out of idle.
NOTE
Moving the mouse will not bring a computer out of idle. There must be
keyboard or mouse-click movement.
Threshold Triggers
Triggers fire immediately when their trigger criteria are met. Threshold Triggers
may be used to fire a trigger once a users usage of an application has reached a
defined threshold. For example, a threshold trigger could be used to send an email
notification to a users supervisor once the user had exceeded his/her
daily/weekly/monthly web usage limit.
The above Threshold trigger will fire for each user when the user reaches 1 hour of
Internet Explorer usage during the period of 1 day. This example fires an email
notification to the users supervisor saying, %USER has exceeded his/her daily
web usage limit.
Threshold limits may be defined for the period of a day, week or month.
110
Release Notes
MsgPop
triggers
must be
set as
client-side
triggers.
-sTITLE
This is optional. The title will be AppAlert if omitted.
Replace TITLE with the title you wish to appear on the title bar of the message.
Setting to s%TRIGNAME means the title will be the name of the trigger.
Body Enter the text you wish to appear in the message in double quotes. Using
<tag> allows us to place the triggers PassBack values in the message body. The
tags relate to the triggers Control Name. In the example well use <Address>,
<Name>, <Title> and <Phone>. These are all Control Names in our trigger. \n
creates a new line in the message body.
To illustrate MsgPops functionality well create a trigger that fires MsgPop when a
new contact is created whose address contains Donegal.
111
Release Notes
112
Release Notes
The triggers criteria will be, when Control 8 Contains Donegal. This means the
trigger will fire when a user creates a new contact that has Donegal as part of
his/her address. Click Generate Trigger followed by Activate Trigger Changes.
When the trigger fires, the following message will be displayed on the users
desktop:
113
Release Notes
For such cases, You can cancel the capture, and review the settings of DPA
Validator. There is an option under web settings to enhance the capture of HTML
pages, Use Accessibility Capture. This setting should be enabled if at first an
ActiveX component of a web page does not get highlighted.
Note: Adobe Flex shockwave flash objects are not currently supported in DPA.
However, other Accessibility base shockwave or embedded servlet technologies
are supported with the Accessibilty Capture setting.
With the onset of Internet Explorer release 9, a number of significant changes
have been made by Microsoft to the way it renders HTML. For example, Menus,
images, or text may appear in a different position than expected or than when
rendered within internet explorer 9 compatibility mode and / or Internet explorer
versions 8 or below. ( see Microsoft kb article http://support.microsoft.com/kb/956197 ).
If you require Internet explorer 9 without compatibility mode, then you may need
to recapture and migrate screens that have been previously captured in earlier
versions of the browser. Compatibility mode should allow existing triggers to fire
correctly even if originally validated against earlier versions of the browser. Again,
as a rule of thumb, if the page looks different within Internet Explorer 9, it is most
114
Release Notes
likely that you will need to capture the screen again within the new browser
before triggers will fire against it.
In all cases where new screens are required for Internet Explorer 9, you should
group these triggers against a known list of computers that have this browser
version installed, so as to ensure that they are not also being sent to DPA clients
that have earlier browser versions.
Vendor
Integration
method
Versions
supported
Emulator
mode
restriction
?
Multisession
Notes
Attachmate
extra
Attachmate
COM
8.0
Telnet only
Yes
Does not
support
embedded
version
Attachmate
Reflections
Attachmate
COM
15
Telnet only
Yes
iSeries
IBM
COM
5.8
9542
Yes
Rumba PC to
Host
Rumba
HLLAPI
7.4
No
Yes
Rumba Web
To Host
Rumba
COM
5.3.1
No
Yes
115
Release Notes
Setting DPA Validator to include tracing may cause it to become unresponsive due
to the additional time it takes to output full accessibility features that are present
in the latest versions of the product.
If you find DPAValidator is taking too long, it may be that the directory it is using
for the grabs folder is being targeted by anti-virus utilities and as such may
cause a slow down due to virus scanning activity on the trace file. If this occurs,
please try disabling the anti virus utility for the period of the validation session, or
move the DPA Validator executable to an area of disk that is free from Virus
Scanning.
SAP Triggers
SAP Triggers can be detected only if both server side and client side SAP scripting
has been enabled on the target system. Triggering against SAP supports version 7
and above of SAPGUI. There are a number of limitations inherent within the SAP
triggering system.
Some SAP controls will be highlighted as hotspot controls on the bitmaps
created and uploaded by DPA Validator. This is expected behavior. Those controls
highlighted in this manner cannot be used for triggers other than click events.
SAPGUI Vs SAPLOGON / SAPLGPAD : SAP Scripting is only supported when
running SAP applications using SAPLOGON/SAPLGPAD. Make sure that your SAP
application suite is configured to use SAPLOGON/SAPLGPAD rather than SAPGUI.
Please note that if you create triggers based on SAPLOGON they will not
automatically work with SAPLGPAD and vice versa. Triggers must be defined
separately for both application names.
SAP Table column triggers are supported on the following types of control:
SAPGUIGridView tables, and SAPGUILabel tables. Tables comprised of text labels
do not support column scan triggers because only the visible portion of the table
is made available for triggering against.
As mentioned in the Release notes, SAP Scripting can sometimes prevent a
minimized SAP application from being restored by clicking on it. In these cases,
you must right click and select the restore option to regain the focus of the
application.
116
Release Notes
Group Administration
In this section User Groups, Application Groups and Computer can be added, edited
and deleted. The operation of each is similar. User Groups is used below to
illustrate how grouping is used.
Group Administration
Group administration for users, computers and applications allows easy addition of
people to teams, computers to rooms, applications to application groups etc.
117
Release Notes
On this screen you can add a new group or edit/delete existing ones.
118
Release Notes
Users
To manage users, the Users Tab is selected within the web administration area of
the web site.
This will present a list of users by default, showing their display name, computer
user name and assigned computer group.
119
Release Notes
After changing the row, you must select the Save changes
changes
option.
The following tasks are covered on the User Edit screen:
Renaming items
You can rename a user or computer on this screen. You should only rename
inactive users or computers.
NOTE
Care must be taken when doing this If you rename a user, this does not
affect the data coming from that logged user. Data will continue to be logged as
the old username, and you will be now taking up two licenses for the one element
in your database.
Assigning Administrators
An Administrator has full access to the web reporting and administration areas of
the product. Care should be given when assigning users as an administrator. To
assign a user as an administrator, select the Administrator check box against the
user.
120
Release Notes
A team leader cannot administer the web site, but can report on any of the users
and teams that they are associated with.
Select the team leader check box first. Then select the teams that your user should
be a Lead of from the Leads selection box. Finally, select the Tick box at the
end of the item to save the change.
Deleting Users/Computers
A User or computer is deleted by selecting them, and then selecting the
icon.
Delete
Only a single warning is shown. If you select ok, the user or computer is marked
for deletion. You cannot at present undelete an item. Deleting a user or computer
does not stop data arriving. If you delete a user or computer from the system, but
data is still available for this user / computer, then a new item will be added to the
system.
121
Release Notes
NOTE
To remove logging from a user or computer, you keep that item in the
database, but mark them as inactive
Configuration Versions
The Configuration Versions section is where we can report on for example the
Trigger or Process Version of users. This is useful in either determining a new or
changed trigger has fully propagated and also from a troubleshooting perspective
(trigger has not fired because the user does not have the trigger yet).
The Export All option is used to export the existing search output to a spreadsheet
for further analysis or to share with others.
UploadSQlite specifics
Remove Sensitive Trigger Content
The uploader will not load trigger values into the TRLValue field of the Trigger_Log
table if the UseTriggerValue option in the UploadSQLite.exe.config file is set to
True:
<!-- Flag to include Trigger value -->
<add key="UseTriggerValue" value="true"/>
XMLCondition structure
The structure of the XML condition set is as follows:
<allow list>
<application>
<windowtext>
<deny list>
122
Release Notes
<application>
<windowtext>
<replaceCondition 1>
<application>
<fields>
<split features>
<replace features>
<getmatch features>
<replaceCondition 2>
<application>
<fields>
<split features>
<replace features>
<getmatch features>
...
XmlCondition explained
In each case, sensitive data is specified by a regular expression, and typically is
set against a specific application and window title.
Regular expressions are a defacto standard method for matching text patterns
within a larger portion of text.
While we are allowing regular expressions to be used within the conditions, we do
not support training in regular expressions themselves.
NOTE
We expect only service personnel to be modifying complex regular
expressions.
Allow List
Any application/ window title combination contained within the Allow list area of
the XML condition will be added to the database despite any rules that are
included within the Deny list.
Application Expression : EG OUTLOOK or OU*OOK
Window title Expression : EG * (matches every outlook window) or
^.*Message.*$ (only matches windows containing "Message", does not
change outlook windows such as "in Box", "New Appointment", etc).
123
Release Notes
Deny List
Any application/ window title combination contained within the DENY list that is
not also matched by an item in the Allow list will *NOT* be placed in the
database. Reporting on any such item will show a complete absence of data in the
database (i.e likely to return "not enough data to display" error.
Application Expression : EG OUTLOOK or OU*OOK
Window title Expression : EG: * (matches every outlook window) or
^.*Message.*$ (only matches windows containing "Message", does not
change outlook windows such as "in Box", "New Appointment", etc).
Replace Conditions
These allow you to replace the content of the data stored in the database, rather
than remove it entirely. You can have any number of replace conditions.
Each condition is additive and obeys precedence. Thus care must be taken when
adding more than one replace condition into the XMLCondition file, since
potentially the same data can be modified against each ReplaceCondition.
Application
ReplaceConditions have an application to include or exclude. The specified
application can include wildcards. If you only need to specify included
applications, there is no need to have an <exclude> application tag.
EG: Include all applications in the replace condition:
<application>
<include>*</include>
</application>
EG: Include 3 internet browsers
<application>
<include>IEXPLORE</include>
<include>FIREFOX</include>
<include>SAFARI</include>
124
Release Notes
</application>
EG: Include all applications except 3 internet browsers:
<application>
<include>*</include>
<exclude>IEXPLORE</exclude>
<exclude>FIREFOX</exclude>
<exclude>OPERA</exclude>
</application>
There are three ReplaceCondition features available:
Split
Replace
Getmatch
NOTE
A single ReplaceCondition must have at least one of these three features
enabled.
Split
It allows removing a part of the text. This feature will be applied if the
<split>true</split> option is specified within the ReplaceCondition.
The split feature has two additional settings that can be used against the match
pattern: valuebeforematch and valueaftermatch.
valuebeforematch=true
Feature will change the value of the data by only keeping the value before
the specified pattern match.
125
Release Notes
valueaftermatch=true
Feature will change the value of the data by keeping only the value after
the specified pattern match.
If both split settings are set to true, then the split feature will keep both
sides of the value (i.e. removes only the pattern matched)
EG:
Keep all characters before a comma is found (regular expression notation
dictates that the comma is escaped and is thus represented by \,)
<split>true</split>
<splitpattern>\,</splitpattern>
<valuebeforematch>true</valuebeforematch>
<valueaftermatch>false</valueaftermatch>
Replace
It allows replacing the matched expression with a new value. This feature will be
applied if the <replace>true</replace> options is specified within the
ReplaceCondition. The new value is not an expression, and can only contain
standard text characters.
EG:
Replace all characters in the window title (or other field) with the word
"REPLACED":
<replace>true</replace>
<replacepattern>*</replacepattern>
<replacement>REPLACED</replacement>
Getmatch
It allows retaining the portion of the window title (or other field) which matches
the regular expression.
126
Release Notes
EG:
Keep a web title up to and including the fourth "/" within the address, but
remove all further text within the window title:
<getmatch>true</getmatch>
<getmatchpattern>^(http|https|ftp):\/\/([A-Za-z0-9_\.
:-]+\/){0,4}</getmatchpattern>
NOTE
A single ReplaceCondition can only have one instance of each of these
features.
Conclusion
To include 2 split conditions against the same application/window text, you must
have two ReplaceConditions.
To include 1 split and 1 replace against the same application / window text, you
can use a single ReplaceCondition with each of these features enabled.
Full Example:
The XMLCondition.XML file being shipped as part of the patch contains the
following:
No Allow list (it is commented out using <!-- and -->
No Deny list (it is commented out using <!-- and -->
Replace condition for internet applications
split condition:
keep only items up to the first "?" in the text
no replace condition
getmatch condition:
keep only the portion of the text which contains http//
followed by up to 4 additional "/" elements.
Outcomes:
remove any sensitive query or session data
127
Release Notes
remove any final pages after the first 4 directories of URL web
addresses
Window
Module
Administration
(Virtual Applications)
By default, Desktop-Analytics reports on applications based on the applications
executables. This allows us to report on, for example, CRM usage based on the
application having an executable name of CRM. Sometimes this level of detail is
not enough. Perhaps, the CRM application has many modules and knowing which
module a user is using may be of great interest. Desktop-Analytics Modules
address this requirement. It enables us to treat an applications individual modules
as separate applications.
Create a Module
To create a Module, go to the Modules
section on the Administration site.
Both Content Modules and Window
Modules are created in this section.
Select Window Modules. To illustrate
creating a Module, well use a CRM
applications Order Form screen. We
will create a Module called CRM Order
Form. This Module will result in the
CRMs Order Form usage being treated
as a separate application from other
CRM usage.
Enter an appropriate name for the Module. This will be the name displayed in
reports.
128
Release Notes
Select the application from which the Module will be derived e.g. MASTAPP. Enter
the Keyword carefully. This keyword must exist in the window title of the main
application or in the URL. In the above example, weve entered Order Form as
the keyword.
Click Insert to create the Module.
Modules are not retrospective. The module will only be treated as a separate
application from the time it was created.
Note: the correct way to rename a window module is to treat it like any other
application within the application list this is where it should be renamed.
All window modules have an appname prefix of 0ISA_ so that they can be easily
found within the application list. To rename one, simply modify the application
display name for the appropriate 0ISA_ application.
After renaming the displayname for this application, navigate back into the window
module list, and the relevant window module will be renamed.
Web site
or partial
web site
name.
129
Release Notes
Enter the web site in this field. The web site is the part of the URL between http://
and the first forward slash /. In our example, this means the web site is senanvista-61.
NOTE
The protocol (http://) must not be entered in the Web Site field. Anything
including and after the first / should be stripped and included in the Keyword field,
if required.
Content Modules
Content Modules allow us to
replace the original window title
of a screen with the values of
Type a prefix
objects contained within the
for the new
screen. This creates a much
window title.
greater level of flexibility in
data monitoring and reporting.
For example, lets say a CRM
tool has very little data
contained in its window title.
We could use a Content Module
to add the value of an object
contained within the screen to
Click on the
the window title.
object (field)
A Content Module will not
whose value you
appear as a new application
wish to include
like a Window Module (Virtual
in the Content
Application). The application on
Modules window
which the Content Module is
title.
based keeps the same name.
The Content Module adds new data to the window title. This new data is only
seen in Desktop-Analytics reports.
To create a Content Module, go to the Modules section on the Administration site.
Both Content Modules and Window Modules re created in this section. Select
Content Modules.
The following describes how to set up a Content Module. The example is based on
the previously seen CRM application.
Select a screen youve previously uploaded to the Screen Library from the Content
Modules drop-down list and click Add Module. You may also add a new screen.
130
Release Notes
The CRMs Order Form window simply has Order Form as its window title. In this
example, well change the window title to show the name of the customer that the
user is working on.
Enter a prefix for the new window title in the Window Title Prefix field. This text
will appear at the beginning of the new window title. Click on the control within
the DPA Validator image whose value you wish to include in the window title. In
this case control 1 (Aquatic Drama) has been selected. Click the Save button
when finished.
NOTE
You must go to the Triggers section and click Activate Changes for the
Content Module to become active.
From this point on whenever a user opens the Order Form section of the CRM
application, the window title will be logged by Desktop-Analytics as:
Section: Aquatic Drama
NOTE
The window title is not physically changed so the user does not see the
change when they open the application. The changed window title is only viewable
in reports.
NOTE
All object types except button-clicks may be used in a Content Module.
131
Release Notes
PC
Eve
nt
Trigger System
Run command
Process Engine
Process Trigger
System
Moves step state
onwards
Moves process
state onwards
Reports
&
storage
132
Release Notes
Process Event
An event is any triggered user interface event on the client machine. Such screen
event examples are, opening a specific window, entering a particular value into a
data entry field on the screen, clicking a specific button on a specific web page and
so on. Events are triggers. These events are fed into the process engine on the
client in addition to being used to trigger commands to run. Once a number of
events have been defined, there will be a real-time flow of events passing through
the process engine. The process engine looks at these events and will combine
them into steps and processes that the user has defined.
Please refer to the PROCEVENT section for details on defining a Pass Back Event.
Step
A step is defined as a collection of events. It must contain a start event and any
number of additional event lists, one of which can be termed the end event.
133
Release Notes
Step One :
Event 1
Event 2
Event3 and Event4
Event5 or Event6 and not Event7
Event2 or Event3
1,2,4,3,6,5,3
1,2,2,3,2,4,2,5,2,6,
2
Example invalid data flows
1,2,4,1,3,6,5,2
1,2,2,3,2,4,2,5,2,6,7,
2
Step one starts with Event1. Each subsequent event list is sequential.
Each item within each event list is not sequential.
The data flows shown are color coded to illustrate what state the
process engine is in for each event it detects.
The second valid data flow illustrates how the process can cope with
multiple events (event2) which are apparently out of sequence and still
determine a valid step.
In the first invalid data flow, the start event occurs, which resets the
step, it then eventually finds event2 and so starts to progress again.
In the second invalid data flow, the not Event7 criteria is violated and
the step is abandoned.
134
Release Notes
Start Event
A start event must be a single event because it starts the process engines
evaluation of the step. Once a start event is encountered, the process engine treats
this step as underway. If the step is underway and the exact same start event
occurs, then the step will be restarted. A start event cannot recur within the rest
of the step. The only exception to this rule is that a start event can also be the last
event in a step. The end event for a step may be either an event list, or the start
event. Placing the start event within an event list containing other events will
cause the step to fail.
There is no limit to the number of steps that can be started on a machine by the
same start event.
There is no limit to the number of steps that can be started and be in process by
the process engine.
Event List
An event list is a collection of events which are combined together within a logical
expression. The events within an event list are not sequential: that is, they can
happen in any order within the list, and once all have occurred, the event list is
deemed to be completed. Each event list must be evaluated in a strict order. If an
event is sent to the process engine which has no match within the current event
list, it is ignored. Only after all conditions within the event list have been met will
the process engine progress to evaluating the next event list. This allows for a
level of flexibility on the approach to matching real time events to the appropriate
data stream because events can be forced to be sequential if required, but there is
still flexibility included to allow non-sequential events to occur when necessary.
A Step is completed when all the criteria for the final event List are met. At this
point, the process engine resets and all step items are completed.
135
Release Notes
Process
A process is equivalent to a step, except instead of being a step consisting of one
or more events; a process consists of one or more steps. The process may contain
a start step, followed by any number of step procedures.
[process:{start step}{step list}{step list} ]
[start step:{step}]
[step list:{step}logical operator{step} ]
The Start step is equivalent in definition and operation to the start event.
The Step list is equivalent in definition and operation to the event list.
Logical Operators
The supported logical operators are, And, OR, NOT. Within an event list or a step
list, each item can be linked by a logical operator. An event list cannot contain
nested operators.
Having a not as the only item in a list will mean that this step will get evaluated
correctly any time any event other than the one in the Not clause occurs. This
therefore has little use as a single item. It is recommended to use the Not clause
to join two items within an event list rather than having a single item on its own.
136
Release Notes
Defining a Process
To define a process we firstly need
to create the triggers on which the
steps will be based. The triggers
are created like normal triggers in
the Trigger Administration area of
the web interface. Once the
triggers have been created, go to
Processes and you will see the
triggers listed as Events.
List of events
to define
steps.
137
Release Notes
Creating Steps
The steps can be created once the events have been defined.
Click New
Drag each of the
Enter the name of the step e.g Client Details.
events required
for the step to the
middle column
Create the other steps in the same way. Steps will be listed on the List Steps
screen.
138
Release Notes
Creating a Process
A process is made up of a number of steps in the same way as a step is made up of
events.
Click on the List Processes tab.
Select New and enter the name of the process e.g. New Mortgage Customer.
Drag the required steps to the middle column as illustrated below.
Drag each of the steps
required for the process
to the middle column
The process is now created. Client machines will be updated with the new process
information within minutes. The process detection will then begin on each client
machine.
Definition
Match against anything containing "ALT" anywhere in
the title"
Match against anything that STARTS with ALT "
139
Release Notes
^ALT.F
^ALT..F
^ALT.*F
140
Release Notes
141
Release Notes
Transaction Status
The Transaction status is designed to be used to tag a particular state value to a
step or process, such as closed,open or escalated. This allows reporting based on
a particular status type. To set a Transaction Status, set the required passback
field of a trigger to be:
Process Status
Step Status
Process & Step Status
In theory, one trigger can tag all three process variables, but it is not necessary to
do so.
Tag Example
Lets say the screen below is used as part of a support ticket process. We can use
Tags to track a ticket as it progresses through the organization. A unique identifier
is selected in this case Ticket ID. We now create relevant triggers which will be
used to define the Steps and Processes for the support ticket process. At least one
of these triggers must have the Ticket ID set as a Step or Process Value.
Below we can see how any control on the trigger definition screen can be set as a
Tag. In our example we would select control 1 (TicketID) to be a Step or Process
Value.
142
Release Notes
Remember, a Step Tag will be set with the final value of the control on which its
based once the step has completed. A Process Tag is set with the final value of the
control once the process has completed.
143
Release Notes
144
Release Notes
<PO_Value>
matches the Control
Name in the trigger
criteria.
145
Release Notes
have been made to screen import and export mechanism. For completeness, the
following section lists the main use cases for screen import and export.
146
Release Notes
Example Scenarios
Using the Importer during an upgrade
For example, lets say release 3.4 is installed and you wish to upgrade to 4.1. A
screen export (refer to 3.4 user guide) is performed on the server prior to the
147
Release Notes
upgrade and the BMP/CLF files contained in the Screens folder are backed up.
Once the server has been upgraded to 4.1, an import of the 3.4 exported data is
done. The triggers, screens and processes are now available to be used on the
upgraded server. Please refer to the upgrade documentation for detailed
instructions on how to upgrade a site.
148
Release Notes
Fire a trigger when > 60% of all users have been in application X for more than n
seconds
Fire a trigger when < 10% of all users are now using application X in the last n
seconds
Notification Qualifiers
When the threshold is met, the notification is sent. While the threshold is above
this sustained level, the notification can be resent if required, depending on the
notification qualifiers, Notification Interval, and MaxNotify.
Notification Interval
If the threshold is still met after this interval, fire the notification email again
Maximum Notify
If the threshold is still met after this number of intervals, then after this number of
notifications, no further notification email will be sent, until the threshold level is
dropped.
Reload Interval
The Siteinfo webservice checks for changes made to the sitertriggers.xml file every
st_rules_reload_interval_seconds.
Snap Interval
This is the option to set how often the Siteinfo webservice evaluates the current
state of the rules, to see if thresholds have been exceeded and notifications need
to be sent.
Active User Cut off
The Siteinfo webservice considers a user to be active if they have sent a live
update message within the past st_ActiveUserCutoffSeconds.
If no live update message is received by the Siteinfo webservice from a user for
this number of seconds then the user is considered inactive and not included in the
rules calculations.
The default value is 900 seconds.
149
Release Notes
Example: In the site below, the use of Internet Explorer drops from 40% to 24%
over the course of the day.
Notification Interval : 1 minute
Maxmimum Notification: 3 times
Threshold
reset
150
Release Notes
Real-time Reporting
The current state of Site Info Rules can be reviewed on the web site. Rules are
displayed in green or red, depending on whether their thresholds have been met.
151
Release Notes
Click
Add to
create a
Rule.
Click
this
button
to save
the
rule.
Rule Types:
There are two types of rules based on Usage or based on Event.
Usage
Usage evaluates how long an application has been used for a period of time, for
example:
- Fire a trigger when >60% of all users have been in application X for more than n
seconds in the last y minutes
- Fire a trigger when <60% of all users have been using something other than
application X for more than n seconds in the last y minutes
Event:
Event evaluates how many times an event occurs during a period of time, for
example:
- Fire a trigger when > 10% of all users have encountered a GPF on their system
within the last n seconds
- Fire a trigger when > 10% of all users have started up google within the last n
seconds
Application:
Enter the name of the application to be monitored.
152
Release Notes
Window Text:
Enter the Window text of the application to be monitored, leaving the window title
blank will mean that the application will be monitored for any window title it can
contain.
Threshold %:
Correspond to the percentage level above or below which the trigger will be set to
fire.
Timeout Seconds:
Is the time period in seconds during which the rule is evaluated. Once the
threshold expires the rule is reset and the trigger is set to fire again.
Rule Name:
Enter the name you want to give to the rule.
Notify:
A rule can be setup to send an email to for example a Team leader, type the email
address of the recipient in this field.
Comment:
Use this field to add comments about the rule.
153
Release Notes
Usage Example
In the below example we are setting up a rule to fire when Notepad application has
utilized for more than 40% of the number of users during a 5 minute time period.
The Rule status can be seen from Application Event Triggering Reports\Site
Triggers Monitor.
Rule Evaluation
Once a number of users starts to utilize Notepad the rule get evaluated and
become highlighted in green, the rule will be highlighted in red once the threshold
has been met, in our example once the time spend in Notepad exceed 40% of the
time that spend on other applications. The rule will reset after the set timeout time
period.
154
Release Notes
In the below example we are setting up a Site Rule to fire when button 4 in
Calculator is clicked on more that 10% of the client machines during a time period
of 2 minutes.
Example
Rule
Example
Trigger
definition.
Licensing
The application
equals to the
Trigger name.
Active
An active user/computer takes up one license unit. Data for this user/computer is
able to enter the Desktop-Analytics database.
A users/computers Status is set in Users or Computers section of the
Administration section of the web interface.
Inactive
Once a computer is set to Inactive, no further data is received for this computer,
and it does not contribute to the license totals. Triggers will no longer fire for an
inactive user/computer and application usage data will not get collected. Any data
that the computer had while it was active is still accessible from the web site.
Unlicensed
If a site has a license for 1000 computers, but has DCUApp installed on 1050
computers, the first 1000 computers that contact the database will be added. The
additional 50 computers will still be attributed a licence, they will fire triggers and
collect application usage data, a warning will appear on the Web User Interface
Home page to signal that the number of licenses has been exceeded.
155
Release Notes
Modularized Licensing
Previously, if a customer was licensed for multiple products, the same number of
licenses had to apply for each product. For example, a customer licensed for
Activity and Event had to have the same number of licenses of each. Now a
customer can have for example 500 each of Activity and Event but only 50 Process
licenses. Each module can also have a different expiry date.
The Product Licensing section of the Administration user interface is used to assign
licenses to users or computers. In the examples below, we will assume a
computer-based license has been deployed. However, the very same applies to
users, if a user-based license is installed.
Assigning Licenses
Use the Find pull-down list to display computers that are or are not licensed for a
particular product within the Desktop-Analytics suite. For example, lets say I want
to display all computers that do not have a Process license. I simply select the
Process Desktop-Analytics Not Licensed For option. All relevant computers will
be displayed. I can then add a Process license to one of the computers by simply
ticking the appropriate checkbox.
NOTE
If the license limit has already been reached for a particular product, then a
license must be removed from an existing computer before another computer can
be given a licence for that product. Alternatively, additional licenses may be
purchased for that product and assigned to the system.
156
Release Notes
If you attempt assign a license whose limit has been reached, then you will see an
error message similar to the one below.
Temporary Licenses
Modularized licensing also allows us to assign a temporary license on top of an
existing permanent license. For example, lets say the site is currently licensed for
500 licenses of Event and Activity. A temporary pilot license may be applied lets
say for Process Desktop-Analytics. The Temporary Licenses section is used to
assign these temporary licenses to the required computers/users. Once the
temporary license expires, the permanent license continues as normal.
The Assign Licenses to Temporary Licensed Users/Computers button is used as a
quick way to assign the modules in the selected temporary license to
users/computers that have these modules assigned in an older license, i.e. one
that is about to expire.
157
Release Notes
The standalone trigger test application allows for capture of a screen, definition of a
test trigger and ability to test the trigger without the need for an installation
procedure or the need for the server portion of the Verint product.
Components.
The packaged standalone trigger test application consist of 3 main portions which
will be outlined below, it is small and compact and easily portable between client
machines.
DPA Validator
This existing tool is used to capture the screen(s) of interest in exactly the same
manner as a user would when using the tool in a full product install without the
need to upload the files to the server.
LocalTriggerTest This new application allows the user to load the screen(s)
grabbed with the DPA Validator tool and select controls of interest to build a test
trigger. The user can then choose to run a test from this application to fire the
trigger.
Client folder This folder comprises of a configured set of client files for running
with a standalone license. These files are used to run the test trigger and produce
the result.
LocalTriggerTest
This application is designed to make it easy to detect initial problems with
triggering on discovery tasks at the customer site. Diagram 1. on a further page
outlines the different areas of the screen visually. They are listed below with a
description of the main functionality contained. Diagram 2. depicts the screen in
Running Test mode which is also described below.
Diagram1. Areas
Screen Preview Area This area contains the visual representation of a selected
screen showing the available controls highlighted from the DPA Validator session.
Each of the highlighted controls represents a clickable area which is used to add a
control to the Test Trigger Definition area.
Open Screen Location This action allows the user to select a different directory to
read the captured screens from
Available Screens at Location This area lists the current working directory and
contains a list of the available screens in that location. Selecting an item in the list
will present that screen to the user in the Screen Preview Area.
App Information area - This area contains information about the currently selected
screen.
App Name represents the executable name belonging to the selected screen.
App Version represents the version f the application belonging to the selected
screen.
App Wintext / Url - represents the Window title of the screen or the url if a web
application
No. Selected Controls represents the number of controls highlighted in the DPA
Validator session and thus available to use to define the trigger.
158
Release Notes
No. Detected Controls represents the total number of controls that were detected
during the DPA Validator session on that screen.
Test Trigger Definition Area This area contains 2 main parts, the intermediary
area and the control list.
The intermediary area - is where control information appears when you select a
control by clicking on it in the screen preview area or when editing a control from
the control list. The area allows you to select a Condition on the control and specify
a value to correspond with the condition if appropriate. Some conditions do not
require a value element and once they are selected the item will automatically be
added to the control list e.g. On Clicked , Passback Value Only or Has
Changed, others will require a value element and will require you to select the
add/update button e.g. Not Equal To, Less than or Contains if you have
selected a value for one of these conditions but forget to click to add/update, the
item will be added automatically should you select another control or click the Save
and Test Trigger action.
The Control List area - is where the added controls that make up a trigger are
displayed. Clicking on a control row will bring it back to the intermediary area for
editing; selecting a row and clicking remove will remove the item from the trigger.
Each Trigger should have at least one control that has a condition other than
Passback Value Only and should not contain more than one On Clicked event as
in standard operation a user can only click on one button at a time.
Test Action Buttons These actions comprise of the methods used to
add/update/remove controls and then to start executing tests, end tests and close
the application.
Add this action adds a control in the intermediary area to the control list.
Update this action will update an entry in the control list when editing a control in
the intermediary area.
Remove this action removes the currently selected item from the control list.
Save And Test Trigger this action saves the defined trigger and starts the test
client the current application minimizes and a small dialog is presented to the user
to help with the test by way of information.
Stop test this action when used will stop the running test client.
Exit - this will close the app and stop the test client before exit.
159
Release Notes
160
Release Notes
Diagram 2. Areas.
App Wintext / Url This area show the information about the screen where the
test trigger is expected to fire. This application and Wintext or url if on a web
application should be brought into Desktop-Analytics to test the defined trigger.
List of Conditions This area shows the conditions that need to be met before the
trigger will fire, this is a list of actions essentially to complete to fulfill the test.
End Test Action This action closes the current test session and returns the user to
the main application screen.
List of Passbacks This area shows the controls that will be returned when the
conditions of the trigger are met.
161
Release Notes
SnapShot Procedure.
Extract the LocaltriggerTest.zip maintaining the directory structure.
Open the standalone trigger test folder which should have 2 programs and 1 folder
called client
Use the DPA Validator executable to capture the screen(s) of Interest.
Open the LocalTriggerTest executable
Select the screen of interest from the list of available screens.
Select controls on the Screen displayed in the Screen preview pane and Add
conditions to the relevant controls
Once happy all relevant controls have been added click the save and test trigger
action
Bring the relevant app into the foreground and complete the actions required to
fulfill the trigger conditions
Once the test trigger has fired a visual prompt will appear to confirm it was
successful.
Close the prompt and click the End Test action to return to the Main screen.
Detailed Procedure.
(based on items 1-10 above in snapshot procedure)
Extract the LocalTriggerTest.zip ensuring to maintain the directory structure as the
location of the client folder is relevant to the correct operation of the testing phase.
TriggerTest.exe and DPA Validator.exe must be placed in the folder above the
client, i.e: c:\Verint\DPA.
Open the Standalone trigger Test folder which should contain the DPA
Validator.exe, LocalTriggerTest.exe and a Folder named Client.
Use the DPA Validator Tool to capture the relevant Screen(s) of interest ensuring
that normal DPA Validator guidelines are observed, e.g. ensure you highlight the
controls on interest, shorten / remove any wintext/urls that may have a
changeable or unique element which would prevent the test trigger from firing next
time you visit the screen, e.g. a Window text of Test Case Open for 0:1:34where
the time element is continually changing.
Open the LocalTriggerTest tool the App should by default present the list of screens
just captured on the right hand side, nothing will be displayed in the screen
preview area.
The list of screens available is displayed on the right hand side if you select a
screen it will load the visual representation of that screen to the screen preview
area. This area is a scrollable area and each of the rectangles that are
superimposed on the controls are active areas, in that a click on one of those
selects the control under that position and enters its information in the
intermediary area.
Each control should have a Condition attached e.g. Passback Value Only, On
Clicked, Has Changed etc. Certain conditions like the ones mentioned formerly
162
Release Notes
require no Value element as they are based on an action e.g. a click, a value
changing and as a result will be automatically added to the control list when such a
condition is selected. Conditions that are value based e.g. Equal To, Does not
Contain, Greater Than etc require a value element and should be added with the
add button (update when in edit).
Once you have added all controls of interest and ensured that they have the
correct conditions you can save and test the trigger. Before saving and testing a
trigger must have at least one condition of a type other than Passback Value Only
pass backs have no conditional element attached to cause/allow the trigger to fire
they are only controls whose value will also be returned when the conditions for the
trigger are met.
Each trigger should contain no more than 1 On Clicked condition as in a standard
app a user can only click on 1 control at a time. Once the Save and Test Trigger
action is clicked a prompt will display the app and window title of the target screen
to perform the test on, this app and window title should be brought to the
foreground in order to test the trigger. The main window of the local trigger test
app minimizes at this point being replaced by a smaller Helper screen to assist in
the trigger test.
The helper screen contains a reminder of the app and window title that should be
brought into Desktop-Analytics to test the trigger. It also contains information on
what conditions must be met for the trigger to fire, and the details of the controls
that will be used as passbacks on the trigger.
The relevant application should be brought into Desktop-Analytics and actions
taken to ensure that the list of conditions are met thus firing the test trigger.
Conditions that have already been met will appear in a green outline to indicate
they are ready items in a red outline are not met and steps must be taken to
make the item be recognized in green as the trigger will not fire until such point as
all conditions are met.
Once all conditions have been met the test trigger will fire displaying a visual
prompt see diagram 3. below. The prompt is an indication that the test was
successful. The prompt outlines the app the test was performed on the relevant
values of the conditional controls and passback controls at the point of the trigger
firing.
163
Release Notes
Click OK on the prompt and the test is completed, you can continue to re-fire the
trigger if possible to do so.
NOTE
Once a trigger fires at least 1 condition that caused the trigger to fire must
go to a false state before the trigger can be fired again.
Once the testing is complete please click on the end Test action on the helper
dialog to end the test client and return to the LocalTriggerTest main screen where
you can edit the trigger for re-testing define a different trigger on the same app or
choose to test a trigger on a different application essentially repeating the required
steps from points 5-10.
Message Pop
Whats new
Message pop allows you to prompt the user for information. With the latest
version, you have more control over the look and style of the alert given to the
user. Previous versions looked similar to a normal windows message box, causing
many users to dismiss it before reading it. In the new message pop, you can:
Change the title
Add a heading
Give it a background style
Change the back ground colour
Change the icon
Change the number of buttons displayed
Change the text on the prompting button
Alter how and when the user can dismiss
the dialog
This document details all the possible
parameters that can be added to message
pop.
164
Release Notes
Parameters
A number of new commandline parameters are available in messagepop. In general
terms, these all take the form of a / followed by a particular parameter, followed
immediately by an option.
NOTE
No space should be used between the parameter and the option.
The parameters possible are /t /m /I /c /s /h /k /b /o /a /r and are detailed below
/tTITLE CAPTION (String)
Must be Enclosed in Quotes e.g. /tIontas New MsgPop
Default is App Alert
/mMESSAGE TEXT (String)
Must be enclosed in Quotes e.g. /mDo this
\n will put in a line break \t will put in a tab
e.g. /m First Line\nSecondLine\n\tThird Line tabbed in
/iICON (number)
Must be a Number e.g. /i1 or /i5
See Icon Options Below
/cBACKGROUND COLOUR (number)
Must be a Number e.g. /c1 or /c7
See Colour Options below
/sBACKGROUND STYLE (number)
Must be a Number e.g. /s1 or /s3
See Style Options Below
/hHEADER TEXT (STRING)
Must be Enclosed in Quotes e.g. /tImportant Outage Information
165
Release Notes
Options Explained
In general, an option must be immediately proceeded by the qualifying argument.
Adding a space (e.g. /i 12 instead of /i12 should be avoided)
Button Options
Example: /b1
1: MB_OKCANCEL;
2: MB_ABORTRETRYIGNORE;
3: MB_YESNOCANCEL;
4: MB_YESNO;
5: MB_RETRYCANCEL;
default: MB_OK;
Icon Options
Example: /i10
1: Forbid
2: Red X
166
Release Notes
3: Question Mark
4: edit
5: gear
6: save
7: barchart
8: stop
9: Green Tick
10: Warning
11: Default: info
Colour Options
Example: /c4 /k4
1: Blue
2: Green
3: Red
4: White
5: Purple
6: Yellow
7: Orange
Default: System Grey
Style Options
Example /s 2
1: Fade from specified colour
to grey and back to colour
2: Outline border in specified
colour inside in grey
167
Release Notes
Auto Options
1: FORCE All BUTTONS DISABLED
FOR 3 Seconds (keeps the msgpop
from being closed as no button
can be clicked for 3 seconds)
2: AUTO CLICK Default Button
AFTER 5 seconds (Auto close
MsgPop on 5 seconds if not
closed by clicking a button)
default: NO TIMEOUT (Normal
stays until clicked)
Guided Highlighting
The highlighting system is designed as a guide for a user to fire the trigger. For
example, some triggers may have a number of conditions set up against them.
Only when all conditions have been met will that trigger fire.
If the trigger system detects that a condition is false, it will :
Highlight the detected item as false .
Cease higlighting any other controls until this condition is met.
Once the detected false condition is changed to true, the highlighting system will
turn this control to a true highlight. It may then highlight the next false condition.
This should allow for guiding the user through the appropriate prompts and
guidance items that are required to fire the trigger.
Buttons are always evaluated as "true" if they can be found on the interface.
NOTE
Any false element that causes the red highlighting to occur will stop the
highlighting system. This may cause "true" highlighted elements to not be shown
or highlighted at all, until the false condition is changed.
168
Release Notes
169
Release Notes
To make a control highlighted, simply select the highlight check box that is
available from the trigger definition page.
In the above sample, the Spouse/Partner field will remain highlighted in red until
the value Administrator appears in it and will then change to be highlighted in
green.
Once the condition based on the highlighted control become true, the control gets
highlighted in green.
NOTE
Any machines or Users assign to the Trigger Tracing configuration option,
170
Release Notes
will have the TriggerHighlight option turned on by default, meaning that all controls
in triggers will automatically get highlighted independently from the highlight check
box status in the trigger definitions.
Guided Prompting
The message prompt available in the product can provide guidance for users in the
form of tutorial type prompts. These are created by using the Message prompt
utility with the new controllable co ordinates for displaying it. For example, a user
might need to be reminded that a particular element of a form must be updated. A
trigger can be set up to display the message prompt of your choice next to the
relevant form element. To do this, you add the following to the end of the Message
prompt Trigger command arguments:
/r%RECT <Element>
In the trigger example below, a prompt will be displayed near the field containing
the Middle Name, this to remind the end user that a value is required in that field.
The resulted trigger looks like below. This messagepop is moved to a position
close to the specified. Only a single element can be specified in this way per
trigger.
Trigger Feedback
Desktop and Process Analytics Release Notes
2011 Verint Systems Inc. All Rights Reserved Worldwide.
171
Release Notes
Trigger Feedback can be used to quickly assess if a trigger fire, this feature is also
available to Process only license sites and is not only restricted to client side
triggers, (server side triggers are also supported). PCMONTAG commands will be
ignored as per design, see limitation section for more details.
General Operation:
The Trigger Debugger option can be activated on a particular user or computer,
this is done via a Configuration key located in the Tracing Group Area.
Once the key assigned with a value of Y, a prompt will occurs after firing any
triggers.
Answering OK to the prompt will execute the trigger command.
Answering CANCEL to the prompt will stop the execution of the trigger command,
reply with Cancel if your intention is to assess the trigger validity (will the trigger
as I defined it fire?) without the need of executing the command.
172
Release Notes
Operation:
Once the TriggerDebug key is assigned with the Value set to Y, all the time a
trigger fire on the particular client machine a prompt message similar to the one
represented below will appear. No changes are required to the trigger definition;
the only requirement is to make sure the key is adequately assigned.
In the sample below, a trigger is defined on Calculator Button 1 clicked, the prompt
happens just after clicking on the button:
This message is a proof that the trigger is firing as expected. Click OK if you
require the trigger to execute the command or Cancel if not.
Limitations:
PC-Shutdown are not supported, having
the trigger debug option turned ON will
prevent this type of triggers from firing,
other system event triggers such as PC
Start-UP and IDLE are supported.
PCMONTAG trigger command is ignored,
this due to the nature of this type of
command that fire at each snap.
Remote Tracing
Overview
Remote tracing allows a client machine to print tracing for particular areas of the
product without the need to restart the client program. Tracing is printed out to a
temporary file. Once the temporary file reaches a certain size, this file is zipped up
and placed in a Traces\ directory. The zip file is password protected to obscure
sensitive information. The zip password is given to know support engineers and
cannot be changed.
173
Release Notes
Once a zip file has been created, it will be sent from the client to the nominated
web server on next transfer interval. Typicaly, the nominated web server will be
the same as the dataserver. However, it is possible to nominate any compliant web
server as a dedicated trace file destination.
Click here to
download a Trace.
Click here to delete a
Trace.
As shown above, the Administration web site contains a Tracefiles tab that will list
all received trace files. You can select a trace file archive to download (or delete) as
required. Trace file archives use the following naming convention:
COMPUTER_USER_DATETIME_EXECUTABLENAME_MODULENAME_PcMonTrace.txt
Example:
XP-IE7-2_Administrator_20091216175825384_DCUApp_DA_PcMonTrace.txt
You can search the trace files listed using a drop down filter for filename starting
with or containing a keyword.
Tracing can be turned on or off by assigning the target user or computer to a
configuration profile that has been configured for remote tracing. A Tracing
configuration profile is set up on the configuration page of the administration web
site. As with other configuration profiles, users or computers can be added. A
number of standard tracing profiles are available on installation. These can be
changed or added to as required.
Default Tracing
profiles.
Desktop and Process Analytics Release Notes
2011 Verint Systems Inc. All Rights Reserved Worldwide.
174
Release Notes
Traces
Transfer
Interval
Configuration
interval
Max File
size
Trigger
Tracing
Ctrltrg.dll
Web Triggers
Button Clicks
1 minute
2 minutes
32Mb
Trigger
Feedback
Visual Triggers*
Web Triggers
Win32 Triggers
1 minute
2 minutes
None *
DCUapp
Tracing
DCUApp.exe
1 minute
2 minutes
32Mb
Process
Tracing
ProcMon.dll
Ctrltrg.dll
1 minute
2 minutes
32Mb
Network
Tracing
GSoap Network
Layer
1 minute
2 minutes
32Mb
Guidance
Tracing
PopData.exe
Ctrltrg.dll
1 minute
2 minutes
32Mb
Trigger Feedback uses visual highlighting onscreen to show that triggers have fired,
and does not output any trace files.
The default tracing groups have a lower than normal transfer interval and
configuration interval to allow traces to be received from the client machines
quickly. In addition, they also have the tray icon and the close option visible by
default. This allows the users greater control over the client while in tracing mode,
to enable stopping and updating of the client if necessary.
NOTE
Adding many machines to a tracing profile will significantly impact both
server and client performance. It is recommended to only nominate one or
two users or computers for a tracing profile
Typical Operation
If instructed to turn tracing on by a support engineer, a suitable candidate machine
or user is selected. This user or computer is then placed within one of the tracing
configuration profiles, as required. Within the transfer interval as dictated by the
previous configuration profile (typically: 15 minutes) the tracing system will
become enabled for that user or computer. At this point, tracing will start on the
user's machine. Within 1-2 minutes, a trace file archive should be ready for review
for this user via the trace files tab on the administration site.
A tray icon should also appear on the user's machine, allowing them to view the
current log of the machine, and also allowing them to close (stop) logging entirely.
This removes the need for the DCUStop.exe utility to be present on the client
machine.
175
Release Notes
Once tracing is no longer required, the user / computer is removed from the
tracing profile. Within 1-2 minutes, that user's session will revert back to the
normal profile, and tracing will be removed.
On shutdown of the client, it is possible that a trace file may be left behind on the
client machine in an unzipped state. This can occur if the system becomes
unresponsive at shutdown or if the system is shut down unexpectedly. In this case,
on next log in or the next time the client starts up (which ever is sooner) , the
trace file will be zipped up and transported off the client to the default dataserver.
NOTE
Although there is a limit to the number of files and the size of the files
stored on the local client machine, there is no limit set on the server to the
number of trace archives that will be held. For this reason, it is
recommended to remove the client machine from the tracing profile as soon as
tracing is no longer needed.
Tracing Options
All tracing options can be edited after installation. The default profiles are there as
a guide for typical tracing operations.
The full list of tracing options are as follows:
Name
TriggerHighlight
TriggerDebug
Value Range
Description
Y/N
Y/N
TraceFileMaxNum 2-100
TraceFileMaxSize 1024-32999999
176
Release Notes
TraceFileServer
TraceDCUApp
0-5
TraceCtrlTrg
0-5
TraceIEHooks
0-5
TracePopData
0-5
TraceHKGsoap
0-5
TraceDCUProt
0-5
TraceDCUStart
0-5
TraceCITRIXSERV 0 - 5
TraceProcMon
0-5
TraceHKProc
0-5
The trace level is typically of range 0-5. Unless specified by support engineers, a
tracing level of 5 is recommended.
Autocapture
Introduction
The Autocapture feature is a Remotely Triggered DPA Validator, where supported
applications can be captured by firing triggers. It can be used during both
discovery and troubleshooting phases.
Autocapture will be deployed on each client machines as an additional client file.
Most DPA Validator functionality is present in Autocapture, however with
Autocapture, the normal DPA Validator settings can be set from a trigger
command. This enables it to be run on the client machine with very little required
interaction from the person operating the client computer.
The use of this feature can also be considered where accessing the end-user
desktop, to run a DPA Validator session, is not possible. Accessing the server will
still be required in order to define the autocapture trigger.
Other cases where a re-visit of the desktop client would be required and where
177
Release Notes
Autocapture command
PCMONAUTOCAPTURE application_options trace_options prompt expiry silent
The order of the additional parameters is irrelevant.
Application Option
Format:
/oOptionstring
Optionstring can contain one or more of the following values
M
D
J
H
S
U
There MUST NOT be a space character between the /o and the first option
character
and/or between the different option characters.
Examples:
/oM
/oH
Use MDI
TerminalEmulator
Trace Option
178
Release Notes
This sets the trace level for DPA Validator traces (which are zipped up with the clf &
bmp files) and Switches on HTLM tracing.
An entry for AutoCapture has been added to the RTTInfo.xml file which is
independent from this tracing option!
The entry in the RTTInfo file will enable tracing of the startup code in AutoCapture
and also tracing from where the zip file is created. This trace file will be handled as
any other trace file on the system.
Format:
/tOptionstring
Prompt Option
This option brings up a message box containing a prompt message, the application
name and the window text of the window that triggered the capture. An OK and
Cancel buttons are displayed.
If the OK button is clicked the screen capture is performed.
Pressing the Cancel button will abort the screen capture.
Format: /pPrompMessage
PromptMessage can contain newline (\n) and tab (\t) characters.
The string CANNOT contain double quote characters.
If the backslash character (\) is used it must be escaped with a backslash (\\)
If the string contains space characters it MUST be enclosed in double quotes.
There MUST NOT be a space character between the /p and the start of the
message string or the starting double quote.
If there is no valid prompt string the prompt option is ignored!
Example:
/p"Proceeding with\nAutocapture"
This will output the following message if the application is CALC and the window
text is Calculator.
179
Release Notes
Expiry Option
This option will stop the screen capture being performed if not sufficient time has
elapsed since the last screen capture on the same application (with the same
window handle, once the application closes, the window handle will changes next
time it is re-opened, therefore it cannot be expected that the timeout will be
relevant for cases when the application closes and is re-opened). If the capture is
on a new application window then the expiry is ignored. This option is only used by
CtrlTrg and is ignored in AutoCapture.exe.
NOTE
There MUST NOT be a space character between the /e and the first digit of
the number.
/e option:
Format:
/eNumberOfSeconds
Example:
/e60
This will stop a capture from being performed until 60 seconds have
passed since the last capture on the same window that has the same window
handle (each time the application closes a new window handle is attributed to the
application).
NOTE
It is the main application window that is used for this check.
Different tabs, child windows etc are NOT used in this check!
/E option:
Format:
/eNumberOfSeconds
Example:
/E60
This will stop a capture from being performed until 60 seconds have
passed since the last capture on the same window that has the same window title
and application name (this can be used for cases where the requirement is not to
recapture if the same application with the same window title is closed and reopened).
NOTE
It is the main application window that is used for this check.
Different tabs, child windows etc are NOT used in this check!
Silent Option
This option will not show any error messages produced.
AutoCapture will quit silently but will zip up the trace file if the tracing option was
set.
180
Release Notes
Format: /s
The command is setup to display a prompt message. Upon opening Calculator, the
below message will appear:
Clicking Cancel will close the message and the screen will not be captured.
Clicking OK will proceed with the screen capture, the below message will display
during the capture to prevent the end-user from interfering with the process.
181
Release Notes
The grabs issued from the screen capture are compressed and initially stored on
the client machine, the default location being C:\Verint\DPA\Client\Screens. The
format of the compressed zip file is as follow:
Wingrab20100312023734CALC_1.zip
Translated it become: WinGrab YEAR MONTH DAY HOUR MINUTE SECONDS
APPLICATION_N.zip.
Where N is the number of times Autocapture came across the same application.
At the next Transfer Interval, the client will send all the zip files that have been
gathered in the screens folder and upload them to the server to the Incoming
folder, the default location being C:\Verint\Data\Incoming.
A Cancel button will appear after a timeout of 5 seconds, this to allow the end-user
to Cancel the capture.
Uploading screens to create triggers:
No prompt like in Wingrab, i.e: access Bridge. It should but doesnt work
Limitations
Auto capture will NOT attempt to add a URL to trusted sites if it fails to get access
to a web page. A warning message is displayed instead.
AutoCapture will NOT attempt to install AccesBridge if it detects that
AccesBridge is not installed. A warning message is displayed instead.
Certain warning messages are NOT displayed by AutoCapture.
These include all warning messages about unsupported applications.
As there is a small delay between the when an event like a button click happens
and AutoCapture receiving a command triggered by this event it is best NOT to
base triggers for AutoCapture on events that result in a change to the current
application as it might not capture what was intended or fail altogether (having a
capture command on clicking the close button of an application for example).
Auto capture will wait up to 10 seconds for a web page to go to state interactive or
complete so a trigger could be used on the event that changes a web page.
Messages
Similar to DPA Validator, Autocapture will display warning message when it come
across known applications for which it knows particular steps are required.
Tracing
182
Release Notes
Unlike DPA Validator, the initial trace that is produced before any screen is
capture is activated if tracing is turned on in the Rttinfo.xml for the Autocapture
module.
183
Release Notes
Guidance Script
Introduction
Datapop is a method of sending stored data between applications. It can be used
to automate user interaction between applications, start up new applications, and
send stored data, keystrokes, or mouse events to any window on screen.
This feature is available from the Guidance Script tab in the Administration section
of the Web User interface. It allows DataPop scripts to be created in an automated
way but leaving the option to manually tweak the script if required.
Terminology
Trigger Event
A click, key stroke, change of value, or other windows event that can be used to
fire a trigger which will initiate a datapop script /? Sequence.
Target Screen
Any screen that may require a click, select, or data value to be placed into it
Source Screen
Any screen that contains data which can be stored to be used in a Paste into
some further Target screen
Execution Screen
Any screen that is used as the point at which the datapop script should be started.
Execution Control
A windows interface object to which a trigger event can be attached
Data Control
Any piece of data inside a windows interface object that can be copied from a
Source screen or pasted into on a target screen (
NOTE
This could be the same windows object as the execution control)
PopData Event
A windows event (key press, button click, mouse click, or paste command) that is
generated by popdata
Copy Command
A popdatastore trigger that will copy one or more control variables on a source
screen.
184
Release Notes
Action Command
A PopData command that will send a user action to a specific data control
Datapop script
A series of commands that are interpreted by datapop, which amount to controlling
and pasting data into a screen (or sequence of screens). Historically, these items
have been within a Popdatascript.pds file located on the client machine.
Only Guidances
triggers are display.
185
Release Notes
186
Release Notes
1.1.1.1.2
187
Release Notes
You can enter a confirmation prompt if the user is required to confirm the script
execution before the script runs. The confirmation prompt is optional.
188
Release Notes
Click to select
the source
screen.
The Guidance script wizard presents all screens that currently have triggers on
them with the trigger command of PCMONSTOREDATA .
If no source screens are available you can exit the script wizard and create the
required copy triggers.
189
Release Notes
Select the
variables to be
included in the
script.
Once a source screen is selected, you can select controls on this screen that can be
used as variables in the guidance script.
The control types that can be used to copy data are , in general, any control that
will passback a value on a normal trigger. The control types that can be used to
paste data into are any control that you would, under normal circumstances, be
able to type into or select with a mouse. You cannot copy elements such as radio
boxes, buttons, or check boxes, as the values of these only contain checked /
unchecked, true / false or clicked.
Once all the source variables for this screen have been selected, additional source
screens can be selected, or you can proceed to the Create Script Variables step by
selecting Next.
190
Release Notes
You can add to, combine, modify or format your source variables. For example, one
source variable might be a first name, and another might be a last name. You
could create a new source variable, which combines these two, to generate a full
name for pasting into a single data control.
Existing source variables are shown as a readonly list any formatting or change
to them will create a new variable with the amended contents of the source
variable within it.
The following script variable types are available:
191
1.1.1.1.3
Release Notes
192
Release Notes
1.1.1.1.4
193
Release Notes
FORMAT [list]<opt1>,<opt2>,<opt3>
USERSELECT [selected] <list> <PROMPT> <TITLE>
[selected] is the new variable that will contain the item picked from the <list> by
the user.
Example script equivalent:
Taking the example as shown in previous screenshot, the pick list in the script will
look like below:
FORMAT [New]a,b,c
USERSELCT [abc]<New> Select from abc list List abc
1.1.1.1.5
Lookup variables
194
Release Notes
Use a value from a file instead of the current variable. For example: lookup a
postal address from a postal code.
To add a lookup variable, select lookup value as variable type, add the name of
the variable the lookup should apply to, in the above example we want to replace
values from the Site variable by values from a stored in a lookup text file, so that a
site of BT48 could be replaced by Derry District.
NOTE
The lookup file must be placed in the client folder where DataPop can
read from. It is no required to add the full path to the Lookup from file location,
only the file name is required.
In script actions, select the name of the variable that uses the lookup file, in this
case District, data placed in there will come from the substitution lookup file, i.e a
value of BT48 will be placed as a value of Derry.
A typical lookup file looks like this:
NOTE
Use Tab as delimiter.
BT47
BT48
BT49
1.1.1.1.6
Letterkenny
Derry
Belfast
195
Release Notes
Derry
Belfast
196
Release Notes
The script author specifies the type of application, whether a new or existing
instance of the application should be used, whether the user should be prompted to
confirm the target screen script actions and how long the script should wait for the
screen to become available. Default options are displayed dependent on the
screen selected in the previous step.
1.1.1.1.7
1.1.1.1.8
Use Existing
Opening an existing application will instruct the guidance system to find a
corresponding window on the desktop, and use it for the target screen. If the
window is in the background obscured by other windows, it may be brought to the
front as part of the open action. If the window is minimized, it may remain
minimized but will still be sent the datascript actions.
An existing target screen is found by its window title. It is not found by its web
address, even if it is a web browser.
197
Release Notes
198
Release Notes
USEHWND
Connects to a window using the window handle passed to popdata
with the /h parameter, commandline is ignored (only useful if connecting to the
window in focus as the trigger fires).
NOTE
This option should only be used to paste data in the application currently in
the foreground, it is useful is more than one application with same window text are
open, without this option PopData will paste in the first application with same
window text that was found, this last one is not automatically the one we are
interested in, this option must be used to guarantee that the data get placed into
the variation of the same screen that is in foreground window.
OPENIFNOTFOUND Opens a new application with the given command line ifthe
application is not open already. commandline is application + (optional)parameters
Can only be used as a second command after an initial USEEXISTING open
command (i.e. in order to get OPENIFNOTFOUND working, you actually need two
OPENAPP commands, one after the other)
Example script equivalent:
Taking a Win32 application name as ButtonTest.exe with window title of Trigger
Stress Test as an example, here is how it will look in the script:
OPENAPP WIN32 USEEXISTING BUTTONTEST.exe Trigger Stress Test
1.1.1.1.12 Confirm Prompt Parameter and format
The end user can be prompted before script execution if necessary, for example a
Ready to execute? message can be setup to appear on screen, cancelling the
message will stop the execution of the script.
Format: OPENAPP apptype openflag CONFIRM commandline CONFIRMMSG
confirmmsg
Confirm:
CONFIRM (optional)
ConfirmMsg:
CONFIRMMSG (optional)
Displays confirmmsg if CONFIRM is also specified on
the command confirmmsg can include newline (\n) and tab (\t)
Example script equivalent:
Taking a Win32 application name as ButtonTest.exe with window title of Trigger
Stress Test as an example, where a confirmation message of Ready to execute?
has been setup, here is how it will look in the script:
CONFIRM ready to execute?
OPENAPP WIN32 USEEXISTING BUTTONTEST.exe Trigger Stress Test
199
Release Notes
200
Release Notes
Select
Script
Actions.
201
Release Notes
202
Release Notes
Screen actions are not sent to a control on the screen, but you may need to send a
click to a control to ensure it has focus before performing the screen action.
If you have a included source screen or script variables in the script, the
conditional execution option is available. By enabling this option you can add
conditional if blocks to the script so that different parts of your script can be
executed depending on different values of your variables.
1.1.1.1.17 Screen Script Actions Send Single Key Press Parameter and Format
Send key presses to the application, can be use to direct the cursor to a field where
data can be later paste, this if pasting data in that particular application is not
supported. For example a number of Tab key string can be send to FireFox until the
cursor reach the appropriate field in which data will placed.
Select key down if required (i.e: CTRL+) and then select keyboard key from the
available pull down lists.
203
Release Notes
To do this, select Send Single Key Press from the Screen Scripts Actions pull
down list and then click Add Screen Action. The Send Single key press actions
will be added to the action list where further selection of key press can be defined.
Format:
SENDKEY ctrlflag+altflag+shiftflag+keyname
ctrlflag (optional) CTRL+
altflag (optional) ALT+
shiftflag (optional) SHIFT+
The order of these flags is arbitrary
Example script equivalent:
Taking the above as an example:
SENDKEY 1
SENDKEY CTRL+ C
SENDKEY ALT+ TAB
1.1.1.1.18 Screen Script Actions Wait (ms) Parameter and Format
Use this option to add timeout in your script. For example add a timeout after
sending a mouse click and before pasting data into a control, this to guarantee that
the application had time to place the cursor in appropriate control prior to push
data.
Enter a waiting time, the value is in ms, so 1 second will read 1000.
To do this, select Wait (ms) from the Screen Scripts Actions pull down list and
then click Add Screen Action. The Wait (ms) action will be added to the action
list where the timeout value can be defined.
Format:
WAITFOR waitflag waitinfo
waitflag (reqired)
WINDOW Waits for a window which contains given window text to
appear as the foreground window.
waitinfo is part of required window text
URL Waits for a Internet_Explorer_Server window which has a given URL
appear as the foreground window.
waitinfo is part of required URL
TIMEOUT
204
Release Notes
NOTE
Currently only If and EndIf commands are available from the Web User
Interface.
205
Release Notes
Format (If):
Must be first command in a conditional block
IF <TestVariableName> condition conditionvariable
<TestVariableName> This will look in the valuelist for a Name/Value pair that
matches the TestVariableName and will use the associated value.
=
!=
>
<
Equal to
Not Equal to
Greater than than
Lesser than
conditionvariable
"string value" hard coded string value
numericValue hard coded numerical value
<VariableName>
This will look in the valuelist for a Name/Value pair that
matches the VariableName and will use the associated value.
Format (Else If):
Must follow an IF or an ELSE IF command
ELSE IF <TestVariableName> condition conditionvariable
<TestVariableName> This will look in the valuelist for a Name/Value pair that
matches the TestVariableName and will use the associated value.
=
Equal to
!=
Not Equal to
>
Greater than than
(only valid for numerical condition variables)
<
Lesser than
(only valid for numerical condition variables)
conditionvariable
"string value" hard coded string value
numericValue hard coded numerical value
<VariableName> This will look in the valuelist for a Name/Value pair that matches
the VariableName and will use the associated value.
Format (Else):
Must follow an IF or an ELSE IF command
No additional parameters allowed with this command
Format (ENDIF):
Closes a conditional block
No additional parameters allowed with this command
Format (END):
END Ends the current script
Example script equivalent:
Taking the above as an example:
IF <Site> > 5
POPDATA {22|11|0|0|TBEdit|TBEdit|||}<abc>
206
Release Notes
Review Script
This section display the script as it will appears on the client machines, although
not recommended, the script can be manually modified from the Review script
section.
Addendum
Citrix Installs
DPA Client will install on Citrix Metaframe and XEN releases from Citrix metaframe
version. A number of Citrix specific items are discussed in this section. For more
information on installation and configuration within citrix, please refer to the
Installation Guide Document, DPA_10SP4-HF4 Installation Guide.
Client footprint
The citrix client install differs slightly in that it uses SVRDCU.exe ( server Data
collection Unit ) rather than DCUApp for DPA data collection. In a single client
install, DCUApp is responsible for all configuration and data transfer off the client
machine. In a citrix environment, since any number of data collection units may
be in operation, it is inconvienient to use this method. Instead, each Server Data
Collection Unit will only generate off line data (SVN data) and read locally from
the PCMONConfig.ini file to receive its configuration. A second application,
CitrixServ.exe is installed to be responsible for all transfer from the citrix server to
the DPA application server. This server is installed on the citrix machine as an NT
Service.
207
Release Notes
Computer Name
Under citrix, the user is reported as the logged in user within the citrix machine (
typically, the same user as is logged into the standard DPA client machine).
However, to distinguish this users session from a user who is physically logged
into the citrix machine, the computer name for the citrix user is reported
differently. If it is preferred, the citrix computer name can be further distinguished
between a Published application session, and a published desktop session. The
standard citrix installer will add a citrix command line argument to the current
version run registry on the citrix machine so that any user who logs in via
published applications will log with the computer name of
CITRIXDT_ComputerName (where ComputerName is the machine name of the
citrix server machine). Any citrix published application session within a citrix
environment that is not called with this /c command line argument will report the
computer name of CITRIXPA_Computername.
208
Release Notes
Tracing system
Although the SVRDCU executable responds as normal to remote tracing
configurations, the citrixServ NT Service does not. If tracing is required against
this service, an RTTINFO.xml file needs to be placed on the citrix machine and the
citrixServ.exe service should be restarted in order to initiate tracing. Removal of
tracing requires removal/renaming of the XML file, and restarting of the service.
The rttinfo.xml trace file is located in the program files\Verint\DPA folder on the
application server. Ensure that the XML portion for AppName CITRIXSERV is set
for TRACEALL at level 5 to enable citrixServ tracing.
Shutdown procedure
Citrix implementation uses a number of helper applications slightly differently to
optimize the multi-user nature of the citrix platform. The Hkproc32ExelS.exe
executable which manages 64 bit and 32 bit button clicks within the 64 bit
environment is an example. This executable normally closes down on a single user
DCUApp. Within Citrix, it remains open and running for any new SVRDCU
connection. To completely shutdown DPA under citrix, you must ensure that all
instances of SVRDCU, Hkproc32ExelS, and CitrixServ are terminated
Protection mechanism
Citrix installation does not require a protection mechanism to keep it running
since it always runs while the desktop or application is served to the metaframe
client. Thus the normal svrstr.exe helper process that runs on normal clients does
not run within Citrix.
PopData file
Default filename: popdatascript.pds
Script Commands
209
Release Notes
Comments
All lines beginning with // are comments which are ignored by PopData
Example:
//
Calculator test script 1
Script Identifier
SCRIPT scriptname
scriptname (required)
Reverenced in popdata by the /s command argument
is the script section which will be executed by popdata Comparison is case sensitive
Example:
SCRIPT CalcTest1
Control Information
This holds the information to access a particular control in an application.
This information can be extracted from a CLF file using the ClfConvert utility.
Format: {index|pos|servid|type|name|dispname|frame|servUrl|buttonId}
ind
(integer)
pos
(string)
servid (integer)
Index of control
Position string
Embedded Server Object Index (Not implemented yet)
type
(integer)
name (string)
disp
(string)
frame (string)
servUrl (string)
(not implemented yet)
buttonId (string)
Control type
Control name
Control display name (only used for confirm dialog)
URL (or part of) of frame that contains control
URL (or part of) of Server Object of embedded Server
Text of button (only used for type 4
CtrlTrig Commands
Format: PCMONSTOREDATA CLEAR %TRIGVAL
stores/updates name/value pairs in datastore in ctrltrg
CLEAR (optional)
cleares all values in the datastore before adding new values
%TRIGVAL (required)
HAS TO BE AT THE END OF THE LINE!
Format: PCMONPOPDATASTORE CLEAR /sScript /dDirectory /h%WINDOWHANDLE
%TRIGVAL
stores/updates name/value pairs in datastore and sends datastore to popdata
CLEAR (optional)
clears all values in the datastore after popdata command is
run.
210
Release Notes
Keynames
This is the list of keynames and associated keycodes that PopData acceps:
Keynames
This is the list of keynames and associated keycodes
that PopData acceps:
1
2
3
4
5
6
8
9
12
13
13
16
17
17
18
19
20
20
21
23
24
25
"LEFT MOUSE"
"RIGHT MOUSE"
"CANCEL"
"MID MOUSE"
"X1 MOUSE"
"X2 MOUSE"
"BACKSPACE"
"TAB"
"CLEAR"
"RETURN"
"ENTER"
"SHIFT"
"CONTROL"
"CTRL"
"ALT"
"PAUSE"
"CAPS"
"CAPSLOCK"
"IME KANA/HANGUL"
"IME JUNJA"
"IME FINAL"
"IME HANJA/KANJI"
211
Release Notes
"ESC"
"IME CONVERT"
"IME NONCONVERT"
"IME ACCEPT"
"IME MODE"
"SPACEBAR"
"SPACE"
"PRIOR"
"PAGE UP"
"NEXT"
"PAGE DOWN"
"END"
"HOME"
"LEFT"
"LEFT ARROW"
"UP"
"UP ARROW"
"RIGHT"
"RIGHT ARROW"
"DOWN"
"DOWN ARROW"
"SELECT"
"PRINT"
"EXECUTE"
"PRINT SCREEN"
"INS"
"DEL"
"HELP"
"0"
"1"
"2"
"3"
"4"
"5"
"6"
"7"
"8"
"9"
"A"
"B"
"C"
"D"
"E"
"F"
"G"
"H"
"I"
"J"
"K"
212
Release Notes
"L"
"M"
"N"
"O"
"P"
"Q"
"R"
"S"
"T"
"U"
"V"
"W"
"X"
"Y"
"Z"
"LEFT WINDOWS"
"RIGHT WINDOWS"
"WIN CONTEXT"
"APPLICATION"
"SLEEP"
"NUMPAD 0"
"NUMPAD 1"
"NUMPAD 2"
"NUMPAD 3"
"NUMPAD 4"
"NUMPAD 5"
"NUMPAD 6"
"NUMPAD 7"
"NUMPAD 8"
"NUMPAD 9"
"NUMPAD *"
"NUMPAD +"
"SEPERATOR"
"NUMPAD -"
"NUMPAD ."
"NUMPAD /"
"F1"
"F2"
"F3"
"F4"
"F5"
"F6"
"F7"
"F8"
"F9"
"F10"
"F11"
"F12"
"F13"
213
Release Notes
"F14"
"F15"
"F16"
"F17"
"F18"
"F19"
"F20"
"F21"
"F22"
"F23"
"F24"
"F27"
"F28"
"F29"
"F30"
"F31"
"NUM LOCK"
"SCROLL LOCK"
"F32"
"F33"
"F34"
"F35"
"F36"
"F37"
"F38"
"F39"
"F40"
"F41"
"F42"
"F43"
"F44"
"F45"
"LEFT SHIFT"
"RIGHT SHIFT"
"LEFT CONTROL"
"RIGHT CONTROL"
"LEFT MENU"
"RIGHT MENU"
"BROWSER BACK"
"BROWSER FORWARD"
"BROWSER REFRESH"
"BROWSER STOP"
"F46"
"BROWSER SEARCH"
"R1"
"BROWSER FAVORITES"
"R2"
"BROWSER HOME"
"R3"
214
Release Notes
"VOLUME MUTE"
"R4"
"VOLUME DOWN"
"R5"
"VOLUME UP"
"R6"
"NEXT TRACK"
"R7"
"PREV TRAK"
"STOP MEDIA"
"PLAY/PAUSE MEDIA"
"M1"
"START MAIL"
"M2"
"SELECT MEDIA"
"M3"
"START APPLICATION 1"
"M4"
"START APPLICATION 2"
"M5"
"OEM_1"
";"
"PLUS"
"+"
"COMMA"
","
"MINUS"
"-"
"PERIOD"
"DOT"
"."
"OEM_2"
"/"
"OEM_3"
"APOS"
"~"
"["
"]"
"'"
"OEM_4"
"OEM_5"
"OEM_6"
"OEM_7"
"OEM_102"
"L1"
"L2"
"L3"
"L4"
"L5"
215
Release Notes
"L6"
"L7"
"L8"
"L9"
"L10"
"APP"
"F25"
"F26"
"ATTN"
"CRSEL"
"EXSEL"
"EOF"
"PLAY"
"ZOOM"
"PA1"
"CLEAR"
216
Release Notes
217
Release Notes
0.1
15
IdleInterval
300
TriggerUpdateInterval
ConfigUpdateInterval
15
CitrixMinWinCount
MaxBlockTransfer
10
MaxBlockTransferCitrix
1000
VncAuthorisation
TriggerCtrlPrefix
RemoteDir
MaximumWinTextMatch
WorkDir
FileDirectory
ProductVersion
ProductInformation
DisableMonitor
UseMDI
'Filled
Script'
ON UI
'Filled
Script'
ON UI
N
in By Install
NOT SHOWN
in By Install
NOT SHOWN
218
Release Notes
UseVnc
UseLiveUpdate
UseLogData
UseChatMonitor
UseTriggers
UseProcesses
UseNetworkMonitor
UseTray
UseTrayViewLog
UseTrayComment
UseTrayStartStop
Y
N
Y
Y
N
N
N
N
N
UseTrayClose
UseActivityManager
N
N
SimpleMode
Y/N
DefaultActivities
UserActivities
ConfigurationServer
http://_WEBSERVER
NAME_/services
DataServer
http://_WEBSERVER
NAME_/services
BackupServer
http://_WEBSERVER
NAME_/services
TriggerServer
_WEBSERVERNAMEN
OPORT_
UpgradeServer
_WEBSERVERNAMEN
OPORT_
219
Release Notes
ForceV10Server:
Y or N (Y for Yes N for No). if Yes, calls will ignore the ILA
registry entries for server name and use the value entered in V10Server only.
220
Release Notes
V10SwitchID:
ID of Version 10 CTI Link API Switch. Must be added by
administrator. Cannot be obtained automatically.
UseScreenIP:
LocalTrigTimeout:
A numerical value which represents the timeout for the calls
to the Ultra Recorder. Stating a positive number i.e. 5 represents a 5 second
timeout and entering a negative number i.e. -200 represents 200 milliseconds
timeout.
V10GetExtTimeout: Time in minutes that the extension is assumed to be valid.
After this timeout period, the next call to CTI Link / Version 10 CTI Link will
attempt to obtain a new extension prior to any other call. Typically this value will
be set to 240 minutes on the assumption that an agent will stay in the same
extension for at least 4 hours before logging in an a new position. Setting this
value to a lower value will increase the number of calls made to the CTI Link /
Version 10 CTI Link server.
V10Port:
Port for Version 10 CTI Link API Web Service (V10Server Soap
communication).
AgentIdentificationILA
Set to Y if ILA Mode is Agent Identification. Set to N
if ILA Mode is any other option. If set to Y all GetDeviceByNTLogin calls will send
the NTUserName as the login parameter. If set to N all calls to
GetDeviceByNTLogin will use DOMAIN\NTUserName as the login parameter.
Custom Data
The Custom Data tab is where the administrator will import the Custom Data Field
Names from the Impact 360 QM version 10. The Custom Data Field names will
be available from the trigger definition page so the passback value in a trigger can
be associated with the Custom Data Field. The Custom Data page has a grid
221
Release Notes
control displaying the currently loaded Custom Data and a choice to "Load from a
Webservice" or "Upload from an .XML File".
Pre-requisite Configuration on QM10 Server
Custom Data fields that will be used with AET must be configured on the QM 10
Hub Server, from the Portal Toolbox: Custom Data and Caption Editor. In most
cases the Custom Data fields is initially created on the CTI Link server, and then
edited via the Portal Toolbox. In any case the fields must be defined and
configured in both CTI Link and the Portal. Refer to the QM 10 documentation for
information on configuring CTI Link and Custom Data Fields.
NOTE
Please note these requirements for QM 10 CTI Link and Custom Data
configuration that are specific to integration with the AET Module.
This is a High Level description of the set up of custom data fields with the AET
specific aspects noted. Refer to QM10 documentation for complete detail of each
area.
A switch is added to CTI Link to accept the API calls the AET client module
makes. The default name of switch should not be changed.
The Client Disconnect sent to IntelliLink setting must not be set CTI Link server
The switch is normally the 2nd entry in CTI Link. It must be active.
Configuration of custom data in CTI Link
When custom data fields are configured on the CTI Link server they can only be
configured as CTI
Configuration of the custom data in the Portal Tool Box
When the same custom data fields are edited in the Portal Tool box the data
source must be changed to API. The CTI, ScreenAnalysis or IntelliScreen setting
should not be checked
Custom Data configured on QM at Caption Editor or in the xml file should not start
with the word Custom Data. Custom Data fields in QM 10 that are configured
with Custom Data are assumed to be unused default fields and are not imported
into the AET module for use in triggers.
222
Release Notes
The AET module references PD identifier, not the caption, when sending a tag to
the QM 10 Recorder. If the custom data caption/PD relationships are changed in
the QM 10 caption editor then they should also be updated by repeating the steps
below to ensure that the AET module is in synch with the QM 10 Server.
Changes to Custom Data fields in QM 10 will require the restart of key services on
the QM 10 server to take effect. Be sure to plan for this brief downtime when
working with Custom Data fields in QM 10.
Custom Data Limitation
Custom data field sizes are limited as follows:
The control name has to be the identifier of the Verint Custom Data field.
These identifiers are assumed to be PD1 to PD75, although any prefix is allowed,
so long as it is followed by a number from 1 to 75.
The values for these identifiers are truncated using the following schema:
CD / PD identifier designation
PD1
PD2 - PD16
PD17 - PD23
PD24 - PD25
PD26
PD27 - PD41
PD42 - PD48
PD49 - PD50
PD51
PD52 - PD66
PD67 - PD73
PD74 - PD75
Size Reserved
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
All values are treated as strings internally. Any value found to contain more than
the reserved number of bytes will be truncated at the appropriate reserved
boundary.
Values for names that do not appear in this schema are currently sent to the DDR
API as they are.
Optional further refinement not implemented at present:
223
Release Notes
Check for numeric data for PD24, PD25, PD49, PD50, PD74, PD75
Numeric field must contain no more than 16 characters, but otherwise are treated
as strings internally. Any character over the 16 character limit in these fields are
truncated in same way as all other fields.
This Web Server should be the same location where the items were configured via
Caption Editor described in 1.1.1 above from which the custom data definitions
can be returned. This is not a call to the CTI Link web service. The "Retrieve
Custom Data" action will contact the specified web service and return the
definitions for the custom data, loading them to the database and showing on
screen.
To Verify that the items were returned correctly / are current or most up to date
simply compare the list of items on screen on this page with the items defined in
Caption Editor.
This option is the preferred option as it ensures that the AET module has the same
definition that the QM 10 Server is expecting to receive on Tag requests.
224
Release Notes
Selecting to upload from an .XML file requires a file in the format shown below,
which contains the definition of the custom data field names and the
corresponding display name defined for the field. A user should browse to the file
location and then select the "Retrieve Custom Data" action to retrieve the
information
Below we can see the format of the XML file.
<CustomDataValues>
<Fields>
<CDField>
<Name>PD1</Name>
<Display>Display Name 1</Display>
</CDField>
.
<CDField>
<Name>PD.N</Name>
<Display>Display Name.N </Display>
</CDField>
.
<CDField>
<Name>PD75</Name>
<Display>Display name 75</Display>
</CDField>
</Fields>
</CustomDataValues>
Profile Hierarchies
Configurations have a hierarchy where DEFUALT is the base configuration. Any
item defined on a computer configuration overrides the corresponding item in the
default configuration and a user configuration will override both computer and
default configuration sets.
Where a profile has been created and assigned to a user and a separate profile
has been created and assigned to a computer the DCUApp program will receive 3
profile sets, the DEFAULT set, the set assigned to the currently logged on user
and the set belonging to the current computer that the user is logged on to. In
this case all three sets are combined to produce the actual set of configurations
and the hierarchy is as follows:
225
Release Notes
NOTE
When the QM 10 Desktop Version 10 CTI Link Agent is installed, it will
update the registry of Version 10 CTI Link server at
HKEY_LOCAL_MACHINE\SOFTWARE\Verint\ILA, then the V10Server
configuration option is completely overridden by the list of Version 10 CTI Link
servers (See 1.6.1 below), unless the ForceV10Server config option is set to Y. In
the case where the ILA server items are being used and not the V10Server value,
All V10Server items, Default, Computer, and User, are all ignored. This is only
the case with the V10Server option, and does not affect any of the other
configuration keys.
Example showing configuration precedence
Compute User :
Key
Default r: PC22 Fred
10.20.3
0.40*
V10SwitchID
2
UseScreenIP
N
LocalTrigTrace
5
V10ExtTimeout
0
V10Port
8001
AgentIdentificationILA Y
ForceV10Server
N
V10Server
Actual :
Jim on
PC22
Actual:
Fred on
PC22
Actual:
Fred on
other PC
10.20.30.
50*
4
Y
0
0
4001
Y
N
10.20.30.
50*
4
N
0
0
4001
Y
N
226
Release Notes
* as noted above, the V10erver key will only be used if there is no Version 10 CTI
Link server list located in the registry of the machine or the ForceV10Server
option is valued to Y. Despite this, the Default configuration must always contain
a fall back Version 10 CTI Link server name. This is to ensure that there will
always be a potential V10 server address, even if the multiple lists are removed
from the registry at some point.
227
Release Notes
Where a site requires a number of Version 10 CTI Link servers, User can use
Version 10 CTI Link Server IP Update tool to add more Version 10 CTI Link
servers. This will update the HKEY_LOCAL_MACHINE\SOFTWARE\Verint\ILA
registry as seen in the image below.
228
Release Notes
If this QM10 Desktop Version 10 CTI Link Agent has been installed and updated to
use multiple Version 10 CTI Link servers and its registry has been updated as
mentioned above, then AET will adopt the InfoLink IP items as a list of appropriate
servers to use instead of using the V10Server configuration key. The InfoLink Port
is ignored by AET.AET will on initialization attempt to obtain the extension to
associate with the Version 10 CTI Link server from each server within the list of
registry items. This will be done any time an extension is required by the AET
triggering system. The first server that provides an appropriate extension
response will then be adopted until a new initialization is forced (either through
log on, extension timeout, or explicit getExtension call)
Configuration Storage
The Default and Computer configuration sent to the client is stored in memory and
(on non-Citrix installs) is also stored within the PcMonConfig.ini file located in the
client directory. The user configuration is stored in the
HKEY_CURRENT_USER\Software\Iontas\UserConfiguration registry entry as well as
being loaded in memory.
229
Release Notes
Acceptable Commands
The commands for execution of QM10 recording instructions are included within the standard installation and can be viewed from the trigger
commands area of the Web UI.
The following table shows the commands used and appropriate parameters (if any) to be used with them:
Name
Command
Parameters
Notes
Recording - Version
10 - API Pause
PCMONLTAPI_DDR_Pause
%TRIGVAL
Recording - Version
10 - API Resume
PCMONLTAPI_DDR_Resume
%TRIGVAL
Recording - Version
10 - API Get
Extension
PCMONLTAPI_DDR_GetExtension
Recording - Version
10 - API Store Tag
Data
PCMONLTAPI_DDR_StoreTagData
%TRIGVAL
Recording - Version
10 - API Tag Data
PCMONLTAPI_DDR_TagData
%TRIGVAL
230
2011 Verint Systems Inc. All Rights Reserved Worldwide.
Release Notes
Recording - Version
10 - API TAG Data
by SID
PCMONLTAPI_DDR_TagData
USESID
%TRIGVAL
Recording - Version
10 UpdatePrivateData
PCMONLTAPI_DDR_UpdatePrivateData
%TRIGVAL
Recording API
Start Recording
PCMONLTAPI_DDR_StartRecording
%TRIGVAL
PCMONLTAPI_DDR_StartRecording
SENDSTOP
%TRIGVAL
Recording API
Stop Recording
PCMONLTAPI_DDR_StopRecording
%TRIGVAL
Recording - API
Start Stop
Recording
PCMONLTAPI_DDR_StopRecording
SENDSTART
%TRIGVAL
NOTE
Even if the command contains %TRIGVAL, triggers can be created without passing any parameters.
231
2011 Verint Systems Inc. All Rights Reserved Worldwide.
232
Command Description
Recording - Version 7 - Agent
Logon
Command
Parameters
-e AgentLogon
-u"%USER"
-h"%COMPUTER"
-e Connected
-e DataEvent
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
-e DataEvent
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
-e DataEvent
-e Disconnected
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
-e AgentLogoff
-u"%USER"
-h"%COMPUTER"
-e Connected
-e StartRecord
-e DataEvent
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
-e DataEvent
-e StopRecord
-e Disconnected
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
-e StopRecord
-e Disconnected
-e Connected
-e StartRecord
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
Notes
Issues the agent log on
command and passes
the username and
computer name
Issues the connected
command followed by
the data event
command and passes
the username and
computer name along
with identified data
elements
Issues the data event
command and passes
the username and
computer name along
with identified data
elements
Issues the data event
command followed by
the disconnected
command and passes
the username and
computer name along
with identified data
elements
Issues the agent log off
command and passes
the username and
computer name along
with identified data
elements
Issues the Connected
command followed by
the start recording
command followed by
the data event
command and passes
the username and
computer name along
with identified data
elements
Issues the data event
command followed by
the StopRecording
Command and the
Disconnected command
and passes the
username and computer
name along with
identified data elements
Issues the
StopRecording
command followed by
the disconnected
command followed by
the connected command
and then the
StartRecording
233
-e DataEvent
-u"%USER"
-h"%COMPUTER"
-d%TRIGVAL
No additional configuration is required for use with the QM 7.8 recorder. Triggers
will be configured to call commands that invoke the FIModule application.
V10Server: Machine name or IP Address of the CTI Link / Version 10 CTI Link
web service machine.
NOTE
The V10Server address will not be used if Version 10 CTI Link servers are
configured via the ILA registry.
This makes it possible to use only the default profile even in environments where
agents at different sites connect to different Version 10 CTI Link servers. As long
as the other settings in the configuration are common across the enterprise, a
single default profile can be used for agents connecting to different Version 10 CTI
Link servers. See Configuring for Multiple Version 10 CTI Link Servers.
ForceV10Server:
Y or N (Y for Yes N for No). if Yes, calls will ignore the ILA
registry entries for server name and use the value entered in V10Server only.
V10SwitchID:
ID of Version 10 CTI Link API Switch. Must be added by
administrator. Cannot be obtained automatically.
UseScreenIP:
234
timeout and entering a negative number i.e. -200 represents 200 milliseconds
timeout.
V10GetExtTimeout: Time in minutes that the extension is assumed to be valid.
After this timeout period, the next call to CTI Link / Version 10 CTI Link will
attempt to obtain a new extension prior to any other call. Typically this value will
be set to 240 minutes on the assumption that an agent will stay in the same
extension for at least 4 hours before logging in an a new position. Setting this
value to a lower value will increase the number of calls made to the CTI Link /
Version 10 CTI Link server.
V10Port:
Port for Version 10 CTI Link API Web Service (V10Server Soap
communication).
AgentIdentificationILA
Set to Y if ILA Mode is Agent Identification. Set to N
if ILA Mode is any other option. If set to Y all GetDeviceByNTLogin calls will send
the NTUserName as the login parameter. If set to N all calls to
GetDeviceByNTLogin will use DOMAIN\NTUserName as the login parameter.
Custom Data
The Custom Data tab is where the administrator will import the Custom Data Field
Names from the Impact 360 QM version 10. The Custom Data Field names will
be available from the trigger definition page so the passback value in a trigger can
be associated with the Custom Data Field. The Custom Data page has a grid
control displaying the currently loaded Custom Data and a choice to "Load from a
Webservice" or "Upload from an .XML File".
NOTE
Please note these requirements for QM 10 CTI Link and Custom Data
235
This is a High Level description of the set up of custom data fields with the AET
specific aspects noted. Refer to QM10 documentation for complete detail of each
area.
A switch is added to CTI Link to accept the API calls the AET client module
makes. The default name of switch should not be changed.
The Client Disconnect sent to IntelliLink setting must not be set CTI Link server
The switch is normally the 2nd entry in CTI Link. It must be active.
Configuration of custom data in CTI Link
When custom data fields are configured on the CTI Link server they can only be
configured as CTI
Configuration of the custom data in the Portal Tool Box
When the same custom data fields are edited in the Portal Tool box the data
source must be changed to API. The CTI, ScreenAnalysis or IntelliScreen setting
should not be checked
Custom Data configured on QM at Caption Editor or in the xml file should not start
with the word Custom Data. Custom Data fields in QM 10 that are configured
with Custom Data are assumed to be unused default fields and are not imported
into the AET module for use in triggers.
The AET module references PD identifier, not the caption, when sending a tag to
the QM 10 Recorder. If the custom data caption/PD relationships are changed in
the QM 10 caption editor then they should also be updated by repeating the steps
below to ensure that the AET module is in synch with the QM 10 Server.
Changes to Custom Data fields in QM 10 will require the restart of key services on
the QM 10 server to take effect. Be sure to plan for this brief downtime when
working with Custom Data fields in QM 10.
Custom Data Limitation
Custom data field sizes are limited as follows:
The control name has to be the identifier of the Verint Custom Data field.
236
These identifiers are assumed to be PD1 to PD75, although any prefix is allowed,
so long as it is followed by a number from 1 to 75.
The values for these identifiers are truncated using the following schema:
CD / PD identifier designation
PD1
PD2 - PD16
PD17 - PD23
PD24 - PD25
PD26
PD27 - PD41
PD42 - PD48
PD49 - PD50
PD51
PD52 - PD66
PD67 - PD73
PD74 - PD75
Size Reserved
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
128 bytes
64 bytes
32 bytes
16 bytes (these are numbers but no
check of content yet made)
All values are treated as strings internally. Any value found to contain more than
the reserved number of bytes will be truncated at the appropriate reserved
boundary.
Values for names that do not appear in this schema are currently sent to the DDR
API as they are.
Optional further refinement not implemented at present:
Check for numeric data for PD24, PD25, PD49, PD50, PD74, PD75
Numeric field must contain no more than 16 characters, but otherwise are treated
as strings internally. Any character over the 16 character limit in these fields are
truncated in same way as all other fields.
237
This Web Server should be the same location where the items were configured via
Caption Editor described in 1.1.1 above from which the custom data definitions
can be returned. This is not a call to the CTI Link web service. The "Retrieve
Custom Data" action will contact the specified web service and return the
definitions for the custom data, loading them to the database and showing on
screen.
To Verify that the items were returned correctly / are current or most up to date
simply compare the list of items on screen on this page with the items defined in
Caption Editor.
This option is the preferred option as it ensures that the AET module has the same
definition that the QM 10 Server is expecting to receive on Tag requests.
Upload from an .XML File
NOTE
Loading from an xml file is not the preferred method as it does not ensure
that the items defined in caption editor are in synch with the AET module,
this method is a manual step if the retrieve from web service is not an option.
Selecting to upload from an .XML file requires a file in the format shown below,
which contains the definition of the custom data field names and the
corresponding display name defined for the field. A user should browse to the file
location and then select the "Retrieve Custom Data" action to retrieve the
information
Below we can see the format of the XML file.
<CustomDataValues>
<Fields>
<CDField>
<Name>PD1</Name>
<Display>Display Name 1</Display>
</CDField>
.
<CDField>
<Name>PD.N</Name>
<Display>Display Name.N </Display>
</CDField>
.
238
<CDField>
<Name>PD75</Name>
<Display>Display name 75</Display>
</CDField>
</Fields>
</CustomDataValues>
Profile Hierarchies
Configurations have a hierarchy where DEFUALT is the base configuration. Any
item defined on a computer configuration overrides the corresponding item in the
default configuration and a user configuration will override both computer and
default configuration sets.
Where a profile has been created and assigned to a user and a separate profile
has been created and assigned to a computer the DCUApp program will receive 3
profile sets, the DEFAULT set, the set assigned to the currently logged on user
and the set belonging to the current computer that the user is logged on to. In
this case all three sets are combined to produce the actual set of configurations
and the hierarchy is as follows:
239
NOTE
When the QM 10 Desktop Version 10 CTI Link Agent is installed, it will
update the registry of Version 10 CTI Link server at
HKEY_LOCAL_MACHINE\SOFTWARE\Verint\ILA, then the V10Server configuration
option is completely overridden by the list of Version 10 CTI Link servers (See
1.6.1 below), unless the ForceV10Server config option is set to Y. In the case
where the ILA server items are being used and not the V10Server value, All
V10Server items, Default, Computer, and User, are all ignored. This is only the
case with the V10Server option, and does not affect any of the other configuration
keys.
Compute User :
Default r: PC22 Fred
Actual:
Fred on
other PC
10.20.30. 10.20.30.
50*
50*
4
4
Y
N
0
0
0
0
4001
4001
Y
Y
N
N
Actual: Fred
on PC22
* as noted above, the V10erver key will only be used if there is no Version 10 CTI
Link server list located in the registry of the machine or the ForceV10Server
option is valued to Y. Despite this, the Default configuration must always contain
a fall back Version 10 CTI Link server name. This is to ensure that there will
always be a potential V10 server address, even if the multiple lists are removed
from the registry at some point.
240
Where a site requires a number of Version 10 CTI Link servers, User can use
Version 10 CTI Link Server IP Update tool to add more Version 10 CTI Link
servers. This will update the HKEY_LOCAL_MACHINE\SOFTWARE\Verint\ILA
registry as seen in the image below.
241
If this QM10 Desktop Version 10 CTI Link Agent has been installed and updated to
use multiple Version 10 CTI Link servers and its registry has been updated as
mentioned above, then AET will adopt the InfoLink IP items as a list of appropriate
servers to use instead of using the V10Server configuration key. The InfoLink Port
is ignored by AET.AET will on initialization attempt to obtain the extension to
associate with the Version 10 CTI Link server from each server within the list of
registry items. This will be done any time an extension is required by the AET
triggering system. The first server that provides an appropriate extension response
will then be adopted until a new initialization is forced (either through log on,
extension timeout, or explicit getExtension call)
Configuration Storage
The Default and Computer configuration sent to the client is stored in memory and
(on non-Citrix installs) is also stored within the PcMonConfig.ini file located in the
client directory. The user configuration is stored in the
HKEY_CURRENT_USER\Software\Iontas\UserConfiguration registry entry as well as
being loaded in memory.
242
Acceptable Commands
The commands for execution of QM10 recording instructions are included within the standard installation and can be viewed from the trigger
commands area of the Web UI.
The commands for execution of QM10 recording instructions are included within the standard installation and can be viewed from the trigger
commands area of the Web UI.
The following table shows the commands used and appropriate parameters (if any) to be used with them:
Name
Command
Parameters
Notes
Recording - Version
10 - API Pause
PCMONLTAPI_DDR_Pause
%TRIGVAL
Recording - Version
10 - API Resume
PCMONLTAPI_DDR_Resume
%TRIGVAL
Recording - Version
10 - API Get
Extension
PCMONLTAPI_DDR_GetExtension
Recording - Version
10 - API Store Tag
Data
PCMONLTAPI_DDR_StoreTagData
%TRIGVAL
Recording - Version
10 - API Tag Data
PCMONLTAPI_DDR_TagData
%TRIGVAL
243
(RCAPI_UpdateByExtension call)
Recording - Version
10 - API TAG Data
by SID
PCMONLTAPI_DDR_TagData
USESID
%TRIGVAL
Recording - Version
10 UpdatePrivateData
PCMONLTAPI_DDR_UpdatePrivateData
%TRIGVAL
Recording API
Start Recording
PCMONLTAPI_DDR_StartRecording
%TRIGVAL
PCMONLTAPI_DDR_StartRecording
SENDSTOP
%TRIGVAL
Recording API
Stop Recording
PCMONLTAPI_DDR_StopRecording
%TRIGVAL
NOTE
Even if the command contains %TRIGVAL, triggers can be created without passing any parameters.
244
Release Notes
245
Release Notes
246