Professional Documents
Culture Documents
14
Installation Guide for BiblioChip-based Core Services
www.bibliotheca.com
Copyrights & Trademarks
Copyright 2013 Bibliotheca, all rights reserved. Bibliotheca provides this document to customers and
prospective customers only. The content of this document is strictly confidential and may not to be
reproduced in any form or transferred by any means, in whole or in part, to any third party without the
explicit and prior written consent of Bibliotheca.
3M Standard Interchange Protocol is the copyright of the 3M Corporation 1997, 1998, 2005.
Windows is a registered trademark of the Microsoft Corporation in the United States and other countries.
Text boxes containing an orange circle and white i contain important information
pertaining to the use or configuration of the product. These may also contain tips or
recommendations from Bibliotheca or Bibliotheca customers.
Text boxes containing a red triangle and exclamation point contain either information
critical to the successful use or configuration of the product, or a warning. It is important to
read and consider the information presented in the hazard text boxes carefully.
Text boxes containing a blue square and question mark contain a definition or explanation
of a specific term or concept that may not be immediately apparent or common
knowledge to all users. The information in these text boxes should assist the readers
understanding of this documents content.
Clickable/Writeable Fields Bold Text denotes a button, tab, text field, or menu that a user can select or
otherwise interact with.
Location/Reference Italic text denotes the location of a file or folder on a computer, or a specific section
within the document or reference to a separate document
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 3 of 23
Table of Contents
1 Introduction ............................................................................................................................................................... 4
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 4 of 23
1. Introduction
smartgate manager can be configured to use the BiblioChip core or the Intellident core. This document
discusses only configuring the BiblioChip core.
This guide is a draft, and does not cover every detail of every step.
We assume that all pedestal hardware, including people counters and controller boards, has been
installed and correctly configured for each gate and the librarys local security settings. This guide is to get
smartgate manager up and running; specifically:
Reading item barcodes off of tags with security ON as they pass through the gate
Communicating the barcodes to the ILS/LMS and displaying title and status information at the
smartgate manager console (and on smartadmin, when available)
Displaying patron count information on the smartgate manager console (and on smartadmin,
when available.)
We distinguish between a pedestal and a gate. A pedestal is a single antenna, with or without a reader
attached. A master pedestal is a pedestal with a reader, for example, a Feig A pedestal. A gate is a
collection of pedestals that cover a single entrance to the library. A Feig gate usually has a single IP
address, unless it has more than one master (A) pedestal. A Tagsys gate has distinct IP addresses for each
pedestal, as each pedestal is its own master.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 5 of 23
2. System Requirements
smartgate manager runs on a library-supplied computer, often a staff station. The library IT staff should
supply the following to the installation tech:
A computer running Windows 7 or Windows XP, meeting at least the minimum requirements for the
operating system. (Both 32-bit and 64-bit architectures are supported.)
An account with local administrative permissions. (If installing the smartadmin v2+ client, will
require regedit permissions as well.)
The installation tech should have available the following software prerequisites:
Microsoft .NET frameworks 3.5 and 4.0 (may be supplied by the operating system.)
The appropriate Microsoft SQL Server Compact Runtime Environment for the architecture of the
system.
For Tagsys gates, the Tagsys Library Pedestal Configuration Tool.
For Feig gates, the latest version of OBID ISOStart.
The Microsoft SQL Server installers are available here. The Feig and Tagsys utilities should be available in the
Support folder.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 6 of 23
3. Network Setup
The network administrator must assign a range of static IPs and should make a list for you showing which IP
is going into each pedestal position.
The network administrator should make reasonable efforts to ensure that the pedestals are reachable
across the firewall typically port 10001 for Feig and ports 4001 (and 4002 for auto-discovery) are open for
TCP and UDP traffic if needed.
Typically with Feig security gates there is one master pedestal (the A pedestal) with an IP address per
group of antennas. For Tagsys security gates, each pedestal has its own IP address and is its own group.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 7 of 23
4. Pedestal Setup
The details of setting up the number of pedestals, counters, or other peripherals per Feig
master using OBID-ISOStart is not covered in this document
4.1 Temporary connection to gates to load settings and set IP and other
values for network.
Before installing smartgate manager, please install the latest version of the Tagsys Library Pedestal
Configuration Tool or the Feig OBID ISOStart application. Then attempt to reach each pedestal via a
local USB connection, or by forcing your PC or Laptop have an Ethernet adaptor that is on the same IP as
the default IP of the pedestal temporarily. Often this step is done using a laptop computer of the install
tech.
There are many non-default settings needed for making Feig pedestals work with AFI, and smartgate
manager data gathering. It is important to load these settings BEFORE setting your gate IPs or other values
(such as number of pedestals, peripherals, etc.) If you try to load these settings AFTER you set other values
you will lose your other settings (such as the gate IP address). If you try to set the values manually to make
the pedestals work with smartgate manager you may run into difficulties and those procedures are not
documented here.
The default configuration file will save you some steps if loaded first. But even after loading it you must set
the correct AFI value(s), IP addresses, and other values related to the number of pedestals and peripherals.
Some of these settings are complicated, even using the OBID tool, and are outside of the scope of this
document. The seasoned install techs have knowledge of these settings. The settings presented in this
document are primarily those required for smartgate manager operation, over and above basic gate
alarming functionality.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 8 of 23
If you used your own laptop for setting the IP and other initial values on the pedestals, please install the
appropriate gate configuration software(OBID-ISOStart or Tagsys Library Pedestal Configuration Tool) on
the computer that will be used to run smartgate manager.
Once the pedestals are all reachable from the staff station PC, you can use that station to make remaining
changes to the pedestal configuration.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 9 of 23
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 10 of 23
[Common] - This is where to define the enabled data models, using the Bibliotheca RFID naming scheme
(Data Model key in Section 9) and separating each data model with a pipe | symbol. Among the more
common data models in our libraries: DM45 is Intellident 5; DM60 is Danish; DM170 is ISO 28560 -2; DM135 is
ITG 16; DM136 is ITG 15.
EnabledDataModels = 45|60|170|135|136
Note that the number of enabled data models directly affects the reliability of decoding tags. Best
practice is to enable only the data models used in the customer library and its circulation partners.
[Logger] - Unless you are trying to diagnose low-level tag reading errors in BiblioChip itself, leave the
loglevel at 1. A log level of 4 will generate hundreds of lines of output for a single tag read. You have
been warned.
loglevel=1
In addition, you can set the maximum file size (in MB) that BiblioChip.log can grow to before being
renamed to BiblioChip.log.001, and the maximum number of overflow log files that are created before
the last is overwritten. So to permit a maximum of nine 10MB logs,
MaxFileSize=10
MaxLogFiles=9
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 11 of 23
Leaving these values unset, or 0, will allow a single BiblioChip.log file to grow without bound.
[DM#] - For each enabled data model, provide any AFI values that can be expected on a tag, separating
each value with a space. (So if the library is in a consortium where AFI values differ from member library to
member library, even with the same data model, enter all the valid AFI on and off values.) BiblioChip uses
the AFI value to help determine (with other factors) what data model the tag uses, so that it can extract
the data. Note that the AFI settings determine how to read the tag, not how to write it. For example,
consider an ITG 16 library (DM135) in which both 07 and 9E are valid ON values, and C2 and 9D are
OFF.
[DM135]
AFICI = 07 9E
AFICO = C2 9D
If the library wishes to recognize tags that use only EAS security (likely candidates are older ITG customers or
French libraries), add 00 to both the AFI check-in and check-out values.
[DM136]
AFICO = 9E 00
AFICO = 9D 00
Generally, libraries using EAS only are likely to have Tagsys gates. Feig pedestals, when configured for EAS
only, will detect every tag, whether security is ON or not. This is a limitation of the Feig pedestals.
Each instance of smartgate manager can only support a single gate architecture (e.g.,
Tagsys or Feig.) In the rare case that a library has gates from both manufacturers, they will
need separate instances of smartgate manager, each with its own SIP connection.
6.2.1 <IntegrationControllerConfiguration>
These are the recommended settings for the gates, regardless of architecture. Note that both ReadAFI
and ReadEAS are set to false. smartgate manager only attempts to decode tags whose security is ON,
based on detection by the security pedestal.
<ReadInterval>2000</ReadInterval>
<AisleCountsInterval>5000</AisleCountsInterval>
<MaximumReadDuration>3000</MaximumReadDuration>
<MaximumUpdateDuration>5000</MaximumUpdateDuration>
<ReadAFI>false</ReadAFI>
<ReadEAS>false</ReadEAS>
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 12 of 23
6.2.2 <ReaderSetupsValue>
The readers are configured in the <ReaderSetupsValue> block. Each reader is defined in its own
<ReaderSetup>. Each Id must be unique. By default, the application uses ReadPoint1, ReadPoint2, etc. for
each master pedestal. The following is an example of a 2-master-pedestal Feig deployment.
<ReaderSetup>
<RegistrationName />
<Id>ReadPoint1</Id>
<ConfigurationValue>
<BiblioChipReaderType>FeigGate</BiblioChipReaderType>
<Name>Front Gate</Name>
<Interface>TCP</Interface>
<Address>192.168.51.18</Address>
<Port>10001</Port>
<Baudrate>38400</Baudrate>
</ConfigurationValue>
</ReaderSetup>
<ReaderSetup>
<RegistrationName />
<Id>ReadPoint2</Id>
<ConfigurationValue>
<BiblioChipReaderType>FeigGate</BiblioChipReaderType>
<Name>Back Gate</Name>
<Interface>TCP</Interface>
<Address>192.168.51.20</Address>
<Port>10001</Port>
<Baudrate>38400</Baudrate>
</ConfigurationValue>
</ReaderSetup>
Below is a single Tagsys (master) pedestal configuration.
<ReaderSetup>
<RegistrationName />
<Id>ReadPoint1</Id>
<ConfigurationValue>
<BiblioChipReaderType>TagsysLSP3</BiblioChipReaderType>
<Name>Front Gate</Name>
<Interface>TCP</Interface>
<Address>192.168.51.19</Address>
<Port>4001</Port>
<Baudrate>115200</Baudrate>
</ConfigurationValue>
</ReaderSetup>
The <name> tag is a friendly name, but is not promoted to the top level of the application. The <Id> tag
value is used by Core Services to define the reader across the application.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 13 of 23
6.2.3 <ServicesSetup>
In the <ServicesSetup> block, the read points are configured for each service. smartgate manager uses
two of the core services: RFIDItemService, to detect individual items and return the barcode; and
RFIDAisleCountsService, which reads the people counter values from the gates. Every read point defined in
the <ReaderSetupsValue> block must be declared for each service in which it is used. (This is not an issue in
other Core Services applications because they only use a single reader defined by default as Reader1.)
For the 2-read-point example above, the corresponding block is below:
<ServicesSetup>
<ServiceSetup>
<RegistrationName>bibliochipRFIDItemService</RegistrationName>
<ServiceId>RFIDItemService</ServiceId>
<Configuration>
<Readers>
<string>ReadPoint1</string>
<string>ReadPoint2</string>
</Readers>
</Configuration>
</ServiceSetup>
<ServiceSetup>
<RegistrationName>bibliochipRFIDAisleCountsService</RegistrationName>
<ServiceId>RFIDAisleCountsService</ServiceId>
<Configuration>
<Readers>
<string>ReadPoint1</string>
<string>ReadPoint2</string>
</Readers>
</Configuration>
</ServiceSetup>
</ServicesSetup>
For a single read point, delete/comment out the reference to ReadPoint2.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 14 of 23
To set the direction of an individual aisle, we need to identify the specific people counter. The format is
<ReaderId>,[<board number>].[<detector number>], where <ReaderId> is the read point name
(ReadPoint1, ReadPoint2, etc.); <board number> is a value between 1 and 3, as defined by OBID as
the bus for the given controller board; and <detector number> is a value between 1and 2, for the sensors
position on the board. So given the key ReadPoint1[2][1], smartgate manager will match all detectors on
the read point (gate/pedestal) with the hardware Readpoint1; [2]_ will match the controller board on
bus 2; _[1] will match the first sensor on that board.
<SerializableAisleCountsMapping>
<Key>ReadPoint1[2][1]</Key> <!-- match only ReadPoint1, board 2,
sensor 1 -->
<Value>
<InCount>1</InCount> <!-- IN is second direction -->
<OutCount>0</OutCount> <!-- OUT is first direction -->
</Value>
</SerializableAisleCountsMapping>
The application will attempt to match against <SerializableAisleCountsMappingValue> settings in order. If
the all read points pattern appears before any specific configuration in the file, its settings will be applied
and all other patterns will be ignored.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 15 of 23
For Pedestal Type select 3-All. Then enter the number of pedestal groups. This corresponds exactly to the
number of distinct read points you defined in BiblioChip RFID Core Configuration.xml. For Tagsys gates,
each pedestal is its own group; for Feig gates, each master (A) pedestal constitutes a group.
To configure each group, select the group number in the Edit Group box using the arrows. For each group,
select a descriptive Name (such as FrontEntrance or BackDoor.)
The Control ID is the name of the read point of this gate group, and must correspond to one of the read
points defined in BiblioChip RFID Core Configuration.xml.
The Station ID is only used for legacy ITG Centralized Statistics and Reporting and should otherwise be
ignored. When used a unique number should be supplied per group.
Note that the other settings are disabled, and cannot be modified.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 16 of 23
The smartadmin ID is used to uniquely identify the gate on the smartadmin server, so that the server display
and alerts are (somewhat) descriptive. The format for smartadmin ID is:
gate group name.Counter#
where # is the aisle number in the gate group.
After making the appropriate changes for each of your read points, save the settings and exit the
application.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 17 of 23
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 18 of 23
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 19 of 23
1. smartadmin uses a registry key to find the applications files for remote administration. If this is the first
installation of smartgate manager on this computer, or the first time attempting to use smartadmin, the
key may not be present. The installer for smartgate manager does not automatically create the
registry key for the application. Check the registry (in both Wow6432Node and SOFTWARE) before
creating the key.
To a new key, add a string value InstallPath, with its data being the fully qualified path to the
executable. For example,
2. Edit smartadmin.client.config.
a. Generate a GUID for the identifier. Each 2.0 client has to have its own unique identifier. (There
are a number of on-line sites to generate GUIDs, for example here.)
b. The deviceType for smartgate manager is 2000.
c. The part number for a generic people counter is 15; the part number for the item detector is
31.
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 20 of 23
d. Since we can have multiple people counters and item detectors per smartgate manager,
weve added an instanceId field to the parts list. Starting at 0, increment the instanceId for
each part of the same type you add to the parts list.
In the configuration file below, we have 2 gate groups, each with an item detector (part 31).
The first gate group has a single people counter (part 15), the second has 3 people counters.
Note that there are no descriptions available for the parts. Each part name is taken from the
smartAdminID (for people counters) or the gate group name (for item detection) in smartgate
manager.ini.
<smartadmin.client remoteServerAvailable="true" ignoreSSL="false">
<identification identifier="aeaaa146-9d22-463e-b975-b55c4ec259e7"
customer="Bibliotheca"
location="Norcross"
device="NorcrossGates"
deviceType="2000" />
<deviceParts totalParts="6">
<parts>
<add name="Part1" serverId="31" instanceId="0" />
<add name="Part2" serverId="15" instanceId="0" />
<add name="Part3" serverId="31" instanceId="1" />
<add name="Part4" serverId="15" instanceId="1" />
<add name="Part5" serverId="15" instanceId="2" />
<add name="Part6" serverId="15" instanceId="3" />
</parts>
</deviceParts>
<proxy serverName="" port="" domain="" user="" password="" />
<timers>
<add name="workTimer" period="120" />
<add name="statisticsTimer" period="120" />
</timers>
<installer packageSource="https://www.mysmartadmin.com/software/"
updatesLocation="c:\program files\bibliotheca\updates" />
</smartadmin.client>
Version 11.0.0.14 of smartgate manager is stubbed for smartadmin client v2.1 (currently in beta) support,
and requires no modifications to the application when the smartadmin client is upgraded
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 21 of 23
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 22 of 23
www.bibliotheca.com
smartgate manager v11.0.0.11 Installation Guide, page 23 of 23
Please be ready with your librarys customer number, case number, any applicable error messages or
conditions, and the product version or serial number.
www.bibliotheca.com