The primary use of this utility is to apply patches to the event definitions installed on your system. For implementation engineers, this utility can be used for a one-time migration of event definitions between a previous installation and the current installation. The most common use case is when you want a fresh system with no pre-existing data, other than their event definitions.
TLEventManager.exe is an external utility that can be used to install or update the event definitions in use by your Tealeaf system to all active Canisters.
The command-line utility is available here:
<install_directory>\Reporting\TLEventManager.exe
Upgrading
During an upgrade, this utility is automatically called by the Database Manager.
TLEventManager.exe utility on the same set of definitions for the same version of the software is harmless.Prerequisites
- The Portal application must be made aware of each Canister in the environment. Verify that there is a reference to each Canister in the Portal Management page.
- If you are loading only the default events, no additional files are required.
- If you load or import an event XML file, TLE, or convert CSV files, these files must be placed in the
TeaLeaf\Systemdirectory on the same machine asTLEventManager.exe
Before you make changes to a system that already contains event definitions, perform a backup of the existing definitions. Through the Event Manager, you can export a version of the event definitions that can be re-imported as needed.
Loading the default event definitions
If your database installation did not run TLEventManager or you must reload the system's default event definitions, follow the steps.
- Log in to the Report Server as an administrator.
- Navigate to the following directory: <install_directory>\Reporting.
- Run the following command at the command line:
TLEventManager.exe -bootstrap
Result: If the events are successfully loaded, the following message is displayed:
Event Manager Utility completed with return code: 0 (OK)
Return codes
If you receive a non-zero return code when you load event definitions from the command line after a fresh installation, retrieve the log file for the utility from the Logs directory and contact Support.
The following table describes the return codes.
| Return Code | Description |
|---|---|
| 0 | No Errors |
| 1 | Invalid command arguments |
| 2 | Unable to connect to the Data Device |
| 3 | Data Service started with error |
| 4 | License file not valid |
| 5 | Unable to load internal event resources |
| 6 | Unable to load event definitions from the Data Service |
| 7 | Error saving events |
| 8 | Error saving reports |
| 9 | Invalid namespace |
| 10 | Unable to connect to Search Server |
| 11 | Error saving legacy event definitions |
| 12 | A required Dimension Group was not found |
| 13 | Error loading 7.2 event CSVs |
| 14 | Error importing/converting events |
| 15 | Error converting Custom Charts |
| 16 | Error converting Dashboards |
| 17 | Error converting Scorecards |
| 18 | Error converting Schedules |
| 19 | Error saving legacy dimension values |
| 20 | Error loading deleted events list from the Data Service |
| 21 | Error generating event XML |
Loading or importing events with the TLEventManager
You can use TLEventManager to import and export of Tealeaf events in XML and TLE format.
File names cannot contain spaces. Specified XML and TLE files must exist in the TeaLeaf\System directory on the local computer where TLEventManager is being executed.
In the following examples, events.xml and events.tle can be replaced with any file name.
Load the default events
TLEventManager.exe -bootstrap
Import event definitions for an Event XML
TLEventManager.exe -importxml events.xml
Import event definitions from an Event TLE
TLEventManager.exe -importtle events.tle
Running TLEventManager.exe
TLEventManager.exe launches the Tealeaf Data Service, which connects to a variety of Tealeaf systems. However, the utility only needs the Data Service to insert the event definitions into the database. Other Tealeaf components do not need to be available while the utility is running.
Order of events: TLEventManager has a fixed order of steps. Whether the following steps are run depends on the command-line arguments:
- Bootstrap events
- Converted events
- XML events
- TLE events
The XML or TLE events can override bootstrap and converted events. Each subsequent event type can potentially override the preceding in the same operation.
Arguments: The following arguments are available at the command line.
| Argument | Description |
|---|---|
-ss |
Search Server host |
-ssport |
Search Server port |
-ds |
Data Service host |
-dsport |
Data Service port |
-bootstrap |
Load base objects only |
-convert |
Convert legacy events |
-fullenumconvert |
Convert enum lists with ref value support. |
-importtle <tle> |
Import Event TLE from TeaLeaf\System |
-importxml <xml> |
Import Event XML from TeaLeaf\System |
-outfile <file> |
Writes program exit status to file |
-dimgroups <group1,group2> |
Dimension groups for conversion |
Log file
TLEventManager.exe generates and maintains a robust log file. If you encounter issues when you use the Event Manager utility, acquire the log file for the date in question before contacting Support.
The log file is located here:
<install_directory>\Logs\TLEventManager_YYYYMMDD.log
where YYYYMMDD is the date stamp for the log file. Log files are rolled every night at midnight.
Data service log messages
If the Tealeaf system is offline, errors may be generated in the Data Service log indicating that the service was unable to connect to other Tealeaf components. For example, the following error message indicates that the Data Service could not connect to Search Server.
2010-03-24T16:53:58 SsConnector.PrimeServer ERROR
TEALEAF.EXAMPLE.COM:19000 Server.Initialize returned null.
Error: Initialize error for TEALEAF:19000 - Cannot connect to
a search server! (Web Exception), AttemptCount=0 : Unable to
connect to the remote server