Tealeaf uses two publicly maintained standards to monitor user agents. These standards are individual files that contain all known user agents and mobile devices.
BrowsCap.csv
is the standard for fixed user agents.WURFL.csv
is the standard for mobile devices.
You can also customize your own set of user agents and apply it to your Tealeaf installation. Through UserCap.csv
, you can provide configuration information for fixed and mobile user agents. These settings can be used to add new user agents to the standards listed.
WURFL.csv
The WURFL.xml
public standard contains all the user agent information for known mobile devices. This file contains the library of user agent information for mobile devices. This file is maintained by a third-party and should be updated in your Tealeaf solution on a regular basis.
Management of mobile user agents requires the CX Mobile module, a separately licensed component of the Tealeaf CX platform. For more information, contact your Tealeaf representative.
Periodically update your local version of WURFL from the public standard.
Do not change to this standard-based file, which is overwritten whenever an update is made from the public standard. Apply new entries or update entries in the UserSupplement.csv
and UserCap.csv
files.
WURFL.XML
must be downloaded and updated in your Tealeaf system regularly.
When it is downloaded, WURFL.xml
must be converted from its source .xml
file to the .csv
format. This format is required for Tealeaf use with the WURFL2CSV.exe
utility.
Converting the WURFL file
Use the WURFL2CSV.exe
utility to convert the downloaded source .xml
for the WURFL file to the .csv
format, which is required by Tealeaf.
Converting the WURFL file with WURFL2CSV.exe
requires the CX Mobile module, a separately licensed component of the Tealeaf CX platform. For more information, contact your Tealeaf representative.
- Double-click
WURFL2CSV.exe
. - Select the downloaded
WURFL.xml
as the input file. - Provide an output file name or use the default
WURFL.csv
file name. Store the file in the location suggested by the application. - If you want to add generic versions of mobile user agents to the
.csv
version.- Generics are used as a fallback entry for partial matches. For example, if
iPhone 10
is detected in the capture stream and no exact match exists inWURFL.csv
, a generic user agent string (iPhone
) can be used instead. - By default, use of generics is enabled.
- Generics are used as a fallback entry for partial matches. For example, if
- To generate the
.csv
file, click Convert. - The file is generated and stored in the specified location.
browscap.csv
The browscap.csv
file is a publicly available standard for user agents on the web. This file is maintained by a third-party and should be updated in your Tealeaf solution on a regular basis. It contains a list of all known user agents and system information that is related to them.
The browscap.csv
file is available in various formats but only the .csv
file format is supported by Tealeaf. The browscap.csv
file is verified by Tealeaf to be in the original format.
Do not change this standard-based file, which is overwritten whenever an update is made from the public standard. Apply new entries or update entries in the UserSupplement.csv
and UserCap.csv
files.
The browscap.csv
file must be downloaded and updated in your Tealeaf system regularly.
UserCap.csv
In some cases, you might need to overwrite the user agent strings and their corresponding data that is available in the public standards. The UserCap.csv
file is used to overwrite user agent strings. For example, you might need to correct errors that your enterprise detects in the public standards with more accurate information.
Tealeaf provides the UserCap.csv
file, which can be used to override values in the public standards. By gathering the user agent string value from the source file, you can then create a new entry in the UserCap.csv
file through the UserAgentRevealer.exe
utility. During evaluation of user agent strings, the Tealeaf Reference session agent checks UserCap.csv
to see whether it contains replacement values for any detected user agents. If so, the replacement values are used instead.
Configurations in UserCap.csv
replace corresponding entries in browscap.csv
or WURFL.csv
. If you want to add values that do not appear in these files, use UserSupplement.csv
.
Be careful in creating replacement user agent strings. UserCap.csv
takes precedence over the public standards at run time. It is possible for the public standards to become updated without having those updates reflected in the user agent data that is consumed by Tealeaf. Review the contents of UserCap.csv
whenever updates are made to the public standards in use by your Tealeaf implementation.
An example version of UserCap.csv
is included during installation. You can configure entries in this file with the UserAgentRevealer.exe
utility.
UserSupplement.csv
If you need to add custom user agent strings for fixed or mobile user agents, you can add the configurations to the UserSupplement.csv
file. The UserSupplement.csv
file is used for adding new definitions that are not covered in browscap.csv
and WURFL.csv
definitions.
Using the UserSupplement.csv
file allows you to include anomalous or unreported data for purposes of reporting. For example, you can use this file to include a single value for reporting purposes without updating all configuration files.
Configurations in UserSupplement.csv
do not override any corresponding entries in browscap.csv
or WURFL.csv
, which are public standards.
An example version of UserSupplement.csv
is included during installation. You can configure entries in this file with the UserAgentRevealer.exe
utility.
Creating UserSupplement.csv
By default, a version of UserSupplement.csv
is not provided with your installation. If you need to create a version of UserSupplement.csv
, complete the following steps.
- Log in to one of the Processing Servers (Canisters) as an administrator.
- Navigate to the
<install_directory>\System
directory. - Create a copy of
usercap.csv
. - Rename the copied file:
UserSupplement.csv
. - Edit the file in Microsoft™ Excel.
- Remove all data lines in the file so that only the header remains.
- Use
UserAgentRevealer.exe
to add your entries to the file. - Save the file and store it in the same directory.
- Copy this file to all Canisters that process hits.
- Restart the Transport Service on each Canister.