2012 Milestone Systems A/S.
Trademarks
XProtect is a registered trademark of Milestone Systems A/S.
Microsoft and Windows are registered trademarks of Microsoft Corporation. App Store is a service
mark of Apple Inc. Android is a trademark of Google Inc.
All other trademarks mentioned in this document are trademarks of their respective owners.
Disclaimer
This text is intended for general information purposes only, and due care has been taken in its
preparation.
Any risk arising from the use of this information rests with the recipient, and nothing herein should be
construed as constituting any kind of warranty.
Milestone Systems A/S reserve the right to make adjustments without prior notification.
All names of people and organizations used in the examples in this text are fictitious. Any resemblance
to any actual organization or person, living or dead, is purely coincidental and unintended.
This product may make use of third party software for which specific terms and conditions may apply.
When that is the case, you can find more information in the file
3rd_party_software_terms_and_conditions.txt located in your Milestone surveillance system
installation folder.
This document is intended for system administrators. This document explains how to install and
configure XProtect Transact as an add-on to a Milestone XProtect surveillance system.
Descriptions about how to browse transaction data and video recordings together using the XProtect
Smart Client are available in the XProtect Transact User’s manual aimed at end users who solely use
XProtect Transact for browsing transaction data and video recordings.
XPT25-am-e1-
XProtect Transact is a powerful tool for tracking transactions linked with video recordings of the
transactions taking place.
XProtect Transact is an add-on to Milestone's IP video surveillance solutions XProtect Basis+,
XProtect Professional, XProtect Enterprise and XProtect Corporate. Milestone XProtect XProtect
Transact can combine your digital video monitoring with transaction data from many kinds of
transaction data sources and for many purposes. You get a 1-to-1 correspondence of images to
transactions and the transaction data is time-linked with simultaneous display of transactions and
camera recordings.
Common transaction data sources are PoS (Point of Sale) or ATM (Automated Teller Machine) which
enables you to easy investigate and prove fraud. But actually any transaction data source that you
would like to time-link with digital video monitoring can be combined through XProtect Transact. A few
examples of other transaction data sources and purposes are: number plate recognition for collection
of road taxes, access control for combined visual identification for higher security—but the only limit is
your imagination. Note, that some solutions might require additional programs and/or customizations.
The examples used in this manual show typical retail situations and transactions data from PoS (Point
of Sale) or ATM (Automated Teller Machine). For these purposes, XProtect Transact speeds up
investigations into fraud by integrating digital video surveillance images with PoS (Point of Sale) or
ATM (Automated Teller Machine) transaction data: 1-to-1 correspondence of images to transactions.
transaction data is time-linked with video images of cash registers/ATMs for simultaneous display of
transactions and camera recordings. Whether the problem is internal or external perpetrators, it is
easy to find suspicious transactions with XProtect Transact's features for searching transactions by
cash register/ATM, camera, data, time or free text.
See also
Viewing transactions (see "View transactions" on page 49)
Interaction with Sources and Surveillance Solutions (on page 7)
Interaction with sources and surveillance solutions
There are several components in the XProtect Transact communication flow. XProtect Transact
consists of a Transact Server and a Transact Database.
The XProtect Transact Server has a service that listens for transactions from sources. Five different
kinds of source exist: Serial ports, TCP clients, TCP XML, Troy boxes and an Analytics XProtect
Transact provider (more types may be available in customized XProtect Transact installations).
Sources, in turn, are connected to the actual devices on which the transaction data is generated (cash
registers, ATMs, etc.).
When the XProtect Transact Server receives transaction data from a source, it stores the data in the
XProtect Transact Database.
Video recordings are stored independently on your surveillance server, as defined through the
configuration of your XProtect surveillance solution.
Example only: The blue arrows outline video recordings from the surveillance system, while the red
arrows outline transaction data from sources.In addition to an ATM, transaction data may also come
from a cash register or any other RS-232-enabled device.
In addition to an ATM, transaction data may also come from a cash register or any other
RS-232-enabled device.
When you purchase XProtect Transact, you also purchase two types of licenses:
Software License Code (SLC): A license to use the XProtect Transact application.
Connection License Key (CLK): A license for a certain number of simultaneously opened
transaction sources.
During the installation you are asked to enter both the SLC and the CLK. The Software License Code
is printed on the Product License Sheet enclosed with the XProtect Transact software as well as on
your order confirmation. You must, however, register your SLC (see "Register SLC" on page 12) to get
the CLK.
You can add an unlimited number of transaction sources (see "Managing sources" on page 18) in
XProtect Transact. You can, however, only view the number of simultaneous transaction sources
corresponding to your CLK. At any time, you can obtain a new CLK (see "Obtaining additional
licenses" on page 12) with more simultaneously viewed transaction sources.
Install the software
Read the License Terms on the Product License Sheet (enclosed with the software DVD) before
installing XProtect Transact.
Prerequisites: If you are upgrading, read Upgrading from a previous version (see "Upgrade from a
previous version" on page 11) first. Before installing the software, register your XProtect Transact
Software License Code (SLC) (see "Register SLC" on page 12). When the license is registered, a
Connection License Key (CLK) is generated. You need the CLK during the installation. Check that you
have the latest version of Microsoft .NET Framework 3.0. You can download .NET Framework 3.0
from Microsoft's Download Center at www.microsoft.com/downloads (see
If you are installing XProtect XProtect Transact on a computer running Windows Vista, you must run
the installation as an administrator.
Install XProtect Transact on the same computer as the server for XProtect Enterprise or XProtect
Professional or XProtect Basis+ or on the same computer as the management server for XProtect
Corporate.
To install XProtect Transact, do the following:
1. Run the XProtect TransactInstaller.exe installation file (either from the DVD or internet). The
wizard starts automatically.
2. Read and accept the license agreement.
3. Enter the SLC and CLK for your XProtect Transact solution.
4. SQL Server Install/Select: Choose between using an existing SQL 2005 Server on the
network or setting up a SQL Server Express Edition on the computer itself.
Important: If you are updating from a previous version of XProtect Transact, we recommend
you install the new database application (read Updating from a Previous Version on page ).
oIf you choose to setup a SQL Express Edition, only edit the SQL services user and
System administrator password fields are required. For example, if your local security
setup requires you to use another user than the one suggested per default. If you chose to
use another user that the default, this user must already be known by the server.
oIf you use the existing SQL database, only edit available SQL servers if required. For
example, if your local security setup requires you to use another server than the one
suggested per default.
This installation may take a short while, after which you are automatically taken to the following
installation step.
5. Database Create/Select: If you are upgrading from a previous version, select whether you
want to use your existing database or create a new one. Specify a database password
manually only if your local security setup requires you to.
6. Install Server: On this installation step, the XProtect Transact server will be installed. Click
Next.
The XProtect Transact installation is complete.
You can now begin to configure your XProtect Transact (see "Getting started" on page 14) in
the XProtect Transact Administrator window.
Upgrade from a previous version
If you are updating from a previous version of XProtect Transact, note the following:
Before you install XProtect Transact 2.5, you must remove the XProtect Transact software,
XProtect Transact Plugin Installer and any XProtect Smart Client Plugins of the previous
XProtect Transact version.
XProtect Transact 2.5 uses a new database (Microsoft SQL Server 2005 Express Edition)
compared to previous versions of XProtect Transact (Microsoft SQL Server Desktop Engine).
XProtect Transact 2.5 can use the old database, but we recommend installing the new—and
better—XProtect Transact 2.5 database.
If a previous XProtect Transact database is detected on the computer during the installation, you will
be asked whether you want to install the new database Microsoft SQL Server 2005 Express Edition, or
update the old database.
If you choose to install the new database, the old database and its content are moved to a new folder
but remain on the computer and new transaction data will be stored in the new database. However,
XProtect Transact 2.5 cannot read data from the old database or make it available for browsing or
viewing.
If you have a lot of important data, update the old database. If you have less data, for example, seven
days of transaction data, export the data from the old database with the export features in the XProtect
Smart Client before you remove the previous XProtect Transact installation and install XProtect
Transact 2.5 with the new database.
Even if the old database and its content remain on the computer, if you choose to install the new
database, it is not possible for you to access the data in the old database by removing XProtect
Transact 2.5 and reinstalling XProtect Transact 2.2. If it is very important for you to access the old
database, you can contact your Milestone vendor.
For information about the export features in the XProtect Smart Client see Exporting Data and
Recordings in the XProtect Smart Client in the XProtect Transact User’s manual and the separate
documentation for the XProtect Smart Client.
Register SLC
If you do not have your SLC, contact your vendor.
1. Go to the Milestone website at www.milestonesys.com, and click the Software registration link
in the menu.
2. Log in to the Software Registration Service Center with your user name (e-mail address) and
password.
Tip: If you have not used the Software Registration Service Center before, click t he New to
the system? link, and follow the instructions for registering yourself as a user, then log into the
Software Registration Service Center by using your registered user name and password.
3. In the Software Registration Service Center, click the Add SLC link.
4. Type your SLC. Confirm that you want to add the SLC to your account, and then click OK.
5. Once your SLC has been added, click the Main menu link.
6. Click the Logout link to log out of the Software Registration Service Center.
Tip: If you plan to use online activation when you activate your licenses, make sure you use
the same user name (e-mail address) and password that you used when you registered the
SLC.
Obtaining additional licenses
If you want to view more simultaneous transaction sources than you currently have licenses for, you
must purchase additional licenses for these transaction sources. You can add and configure an
unlimited number of transaction sources in XProtect Transact, but only simultaneously view the
number of sources that are included your CLK.
To obtain additional licenses for your XProtect XProtect Transact system, contact your XProtect
XProtect Transact vendor.
Once you have obtained the required additional licenses, do the following to activate them:
1. When you have received a confirmation about the purchase of the new licenses, go to the
Milestone website, and click the Software registration link in the menu.
2. Log in to the Software Registration Service Center with your user name (e-mail address)
and password.
3. Click the link representing your XProtect Transact SLC.
4. Copy the updated CLK's 16-digit hexadecimal number displayed on the page.
5. Start the XProtect Transact Administrator, and click the General Settings tab.
6. In the Connection License Key (CLK) field, replace the current CLK by pasting the updated
CLK into the field.
7. If relevant, click the Sources tab, select an existing suspended source and click the Resume
button to be able to view data from this source. You can also add new sources. See Managing
Sources on page for more information.
8. Click Close to exit the XProtect Transact Administrator.
Once the XProtect Transact Server is installed, you should perform the configuration tasks in this
order.
Check that your XProtect Transact Server service settings are correct.
1. From the taskbar, right-click the XProtect Transact Server Service Taskbar icon. Select
Server Service Configuration....
Tip: Server Services (see "Managing server service settings" on page 15) does not have to be
running during configuration, they will be (re)started automatically when configuration setting
are saved.
2. Verify that transaction data will be stored in the XProtect Transact Database for sufficiently
long time to cover your organization’s needs.
By default, transaction data will be stored for seven days, but you can change this default
value on the XProtect Transact Administrator window’s General settings tab.
Note that when defining individual sources (see next step), you can also define individual
transaction data storage lengths for each source.
3. Add your XProtect Transact’s sources. A source is a data source, typically a serial server,
through which transaction data is fed to the XProtect Transact Server and subsequently stored
in the XProtect Transact Database.
As part of defining a source, you define a configuration for the source. A configuration handles
the transformation of received data into presentable data. This is necessary because the
initially received data typically consists of a single string of information, in which it can be
difficult to see when individual transactions begin and end. If the data originates from a printer
connection, it may furthermore contain non-printing control characters used for indicating line
breaks, etc. By using configurations, the received data can be presented to end-users in a
format matching real-life receipts. You can of course base your configurations on real
transaction data sampled from your sources.
Tip: XProtect Transact comes with a built-in configuration called Epson default. Because
Epson is a widely recognized printer manufacturer, you can often save time by basing your
configuration on a copy (see "Copy a configuration" on page 28) of the Epson default
configuration.
4. Enable browsing and viewing of transaction (see "View transactions" on page 49) data
together with video recordings using the XProtect Smart Client. Note that browsing of
transaction data in the XProtect Smart Client requires a plugin.
See also
Managing sources (on page 18)
Managing Server Service Settings (on page 15)
Creating a configuration (see "Create a configuration" on page 23)
Viewing transactions (see "View transactions" on page 49)
The name for the service communicating with the XProtect Smart
Client. By default Service. You can change the name if another
service has the same name.
Administration service name
The name for the service communicating with the XProtect Transact
Administrator. By default Admin. You can change the name if
another service has the same name.
Host
Specify the local IP address or host name of the XProtect Transact
Server Service.
Example of an IP address: 123.123.123.123
Example of a host name: OurDevice
Port
Specify the local port number on which communication between the
XProtect Transact Server service, any XProtect Transact
master/slave servers and the client applications should take place.
The default port number is 9001.
If you want to change the port number, make sure you select a port
number which is not already in use for other purposes. Click the Set
button to begin using the new port number.
Tip: To verify which ports are in use on a given computer, select
Start > All Programs > Accessories > Command Prompt. In the
command prompt window, type netstat -a and press ENTER to
display a list of all current TCP/IP network connections and listening
ports. For more information about the various parameters to use
with the netstat command, type netstat /? and press ENTER.
Protocol
Choose between http (default) and Net.Tcp. If you change from one
protocol to the other, you need to restart the XProtect Transact
Administrator, restart the surveillance system server, and restart the
relevant Smart ClientXProtect Smart Clients for the change to take
effect.
Outside host
Specify the outside IP address of the XProtect Transact Server
service so it can be accessed over the internet.
Administration
The XProtect Transact Server listens for transactions from cash registers and other sources, and
stores such transactions in the XProtect Transact Database. End-users can browse recordings and
transaction data (see "View transactions" on page 49) with the XProtect Smart Client.
Managing server service settings
In the XProtect Transact Server Service Configuration window you define general settings for the
XProtect Transact Server Service, and the ports and services used for communication between the
XProtect Transact Server Service, the XProtect Transact Administrator, any XProtect Transact
master/slave servers and the client applications.
Specify the outside port number on which communication between
the XProtect Transact Server service and the client applications
should take place so they can communicate over the internet.
Name
Description
Troy Box XProtect Transact
provider
Use when receiving transaction data from a Troy box on your
network through port 9100. Troy box is a popular name for a Troy
serial server. Provided the Troy box has been assigned an IP
address, it is able to receive serial input from a cash register, ATM
or any other RS-232 source and relay it to the XProtect Transact
Server through your network.
Serial Port XProtect Transact
provider
Use when receiving transaction data as input on the computer's
own serial port.
TCP XML XProtect Transact
provider
Use when receiving transaction data through a serial server device
and the transaction data is fed as XML packages. It is prerequisite
that the content of the XML packages includes a time stamp in the
following format: <Timestamp>date and time according the RFC
3339 standard</Timestamp>.
TCP Client XProtect Transact
provider
Use when receiving transaction through any kind of serial server
device. This option also allows you to receive data directly from a
PoS (Point of Sale) source, such as a cash register, provided the
PoS source can be configured for this purpose.
Sources and configurations
A source is a data source through which transaction data is fed to the XProtect Transact Server and
subsequently stored in the XProtect Transact Database. transaction data can originate from cash
registers, ATMs, etc. The connection between the XProtect Transact Server and the cash registers,
ATMs, etc. is in the XProtect Transact Administrator established through the definition of a source
provider.
The data initially received from sources typically consists of a single long string of information, and
includes control characters or other characters that are irrelevant and confusing when end-users want
to view the transaction data. You can transform the transaction data of this kind into a presentable,
reader-friendly form through configurations. Configurations are managed in the XProtect Transact
Administrator window's Sources tab since configurations are associated with and customized to the
different sources.
See also
Interaction with sources and surveillance solutions (on page 7)
Different source providers
There are five different kinds of source providers through which the transaction data is fed from a PoS,
ATM or others to the XProtect Transact Server:
Use when receiving alarm data in connection with the XProtect
Analytics software.
Additional kinds of sources may be available in customized
XProtect Transact installations.
When creating and editing a source (see "Managing sources" on
page 18), the different source settings vary depending on your
choice of source provider. See Managing Sources on page for
more information about how to create or edit sources.
Reader-friendly data through configurations
You can omit and substitute characters and define where individual transactions begin and end, so
end-users can view the transaction data in a format matching real-life till receipts, ATM receipts, etc. If
the data originates from a printer connection, it may for instance contain unprintable characters used
for indicating line breaks, when to cut off a till receipt, etc.
By creating a configuration, you can:
Clearly define when individual transactions begin and end.
Make sure line breaks are used as required.
Filter out unwanted characters.
Substitute characters, if required.
Tip: XProtect Transact comes with two built-in configurations called Epson default and Analytics.
The Analytics configuration is only available for sources that use the source provider TCP XML XProtect Transact provider. Epson default is available for all the other source providers. Epson is a
widely recognized printer manufacturer; thus Epson’s way of dealing with control characters is often
supported by printers of other makes as well. You can often save time by basing your configuration on
a copy (see "Copy a configuration" on page 28) of the Epson default configuration.
The built-in configuration for the TCP XML XProtect Transact provider, Analytics, contains the
necessary configuration for transaction data received as XML packages through a serial server device.
Further configuration is not needed.
Configurations are managed in the XProtect Transact Administrator window's Sources tab since
configurations are associated with and customized to the different sources.
See also
Create a configuration (on page 23)
How to omit characters (see "Export/import a configuration" on page 29)
How to use substitutions (see "Use substitutions" on page 30)
How to add line breaks (see "Add line breaks" on page 31)
How to use start and stop masks (see "Use start and stop masks" on page 31)
Through XProtect Transact's event and event group features you can get XProtect Transact to listen
for occurrences of specific words, numbers, characters etc. in the transaction data and generate
events when the specified occurrences are found. Sources are also associated to event groups in the
XProtect Transact Administrator window's Sources tab. See Managing sources (on page 18) and
Events and event groups (on page 38) for more information.
Managing sources
A source, also called a source provider, is a data source through which transaction data is fed to the
XProtect Transact Server and subsequently stored in the XProtect Transact Database.
You define and edit the source settings for the XProtect Transact Server by clicking the Sources tab
in the XProtect Transact Administrator window.
Add a new source
To add a source, do the following:
1. Either from the Start menu or the desktop shortcut, open the XProtect Transact Administrator window.
2. On the Sources tab, click Add New....
3. In the New Source window, in the Source name field,specify a name for the new source. In
the Source providers list, select the type of source. See Sources and configurations (on page
16) for more information about the available sources providers and their use.
Tip: The source name can contain spaces and special characters, such as @, $, %, æ.
4. In the Create Source window, specify properties (see "The Create/Edit Source window" on
page 19) for the source.
5. Select a standard configuration.
oIf you are defining a source that uses the source provider TCP XML XProtect Transact
provider, select the standard configuration Analytics from the list in the Configuration
section.
oFor all other source providers select the standard configuration Epson default from the list
in the Configuration section.
You can add a new configuration (see "Create a configuration" on page 23) or edit the
standard configuration (see "Edit a configuration" on page 27) later.
6. If you have defined transaction events and event groups (see "Events and event groups" on
page 38), you can associate the source with an event group in the Event Group list, to trigger
actions through generic events defined in the surveillance system.
7. When ready, click OK.
The new source will now appear in the transaction sources list on the XProtect Transact
To edit the properties and configuration of an existing source, do the following:
1. Either from the Start menu or the desktop shortcut, open the XProtect Transact Administrator window.
2. On the Sources tab, select the required source and click Edit....
3. In the Edit Source window, change the necessary (see "The Create/Edit Source window" on
page 19) settings for the selected source.
4. Click OK to save the changes.
Delete a source
To delete a source, do the following:
1. Open the XProtect Transact Administrator window.
2. On Sources tab, select the required source and click Delete....
3. Click Yes to confirm the deletion.
Suspend/resume a source
When the source is running, you can click the Suspend button to stop the source. Since you only
have Connection License Keys to view a certain number of sources simultaneously, this could be a
reason for you to stop one source so you can start another. See Licensing (on page 10) for more
information.
You can start or stop the connection from a suspended or running source selected in the transaction
sources list. On the XProtect Transact Administrator window's Sources tab you can see whether
your sources are running or suspended.
IMPORTANT: While the source is suspended, no transaction data will be fed from the source to the
XProtect Transact Server and onwards to the client applications.
When the source is suspended, the button changes to Resume. Clicking the Resume button will lift
the suspension, and data will again be fed from the source to the XProtect Transact Server and
onwards to the client applications (provided the XProtect Transact Server service is running). See
Managing server service settings (on page 15) for more information.
Refresh the status of sources
If a source is unavailable, the source in question will be displayed as Disabled on the Sources tab.
When the source is available again, click the Refresh button to refresh the displayed status of the
source in XProtect Transact Administrator window.
The Create/Edit Source window
Much of the content of the Create/Edit Source window is the same regardless of which type of source
you are creating or editing.
Read-only field displaying the name of the source as defined in the
New Source window.
Provider name
Read-only field displaying the type of the source as defined in the
New Source window.
Time to store transaction
Specify how long transaction data from the source in question
should be kept in the XProtect Transact Database.
Default:Use the XProtect Transact solution's default.
Transaction data older than the default number of days will
be deleted from the XProtect Transact Database, and will
therefore not be available for browsing in the client
applications.
Tip: The default number of days the transaction data is
stored if nothing else is specified for individual sources, is
defined in the XProtect Transact Administrator window,
on the General settings tab.
For ever: Store Transaction data for ever.
Even when Forever is selected, the ability to store
transaction data will be limited by the available disk space
on the computer running the XProtect Transact Database.
Days to store: Specify the required number of days for
which to store transaction data for the source in question.
The number of days may be higher as well as lower than
the XProtect Transact solution's default.
Transaction data older than the specified number of days will be
deleted from the XProtect Transact Database, and will therefore not
be available for browsing in the client applications. Make sure the
number of days is sufficiently high to cover your organization's
needs.
COM Port
Select the COM port (i.e. serial port) to be used for receiving data
from the source.
Bits per second
Select the bit rate (i.e. data transfer rate) with which data will be
sent on the serial connection.
The specified bit rate must match the bit rate used by device (cash
register, ATM, etc.) connected to the serial port source.
Loading...
+ 44 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.