You must make changes in Tealeaf before you can send event data to Exchange automatically. Completing the planning phase will make such preparations easier.
To get your Tealeaf installation ready to automatically send event data to Exchange, you must complete the following preparations.
- Confirm that you have satisfied all integration requirements.
- Configure the event bus for use with Exchange.
- Enable events for sharing through Exchange.
Configuring the event bus for use with Exchange
To automatically send event data to Exchange as it is captured, you must configure the Tealeaf event bus to process the data and send it to Exchange.
Make sure that the event bus is enabled.
If you have upgraded from an environment earlier than Tealeaf version 10.0, you must upgrade the event bus configuration file.
To enable Tealeaf to send captured event data to Exchange, you must add the Exchange session agent to the Event bus pipeline.
You perform this configuration on every server that sends event data to Exchange.
- Enable the event bus, if you have not already enabled it.
- Go to System > TMS > WorldView and open the Canister configuration in the Canister configuration.
- On the Services perform tab, click Enable Event Bus.
- Clear the Include Response option.
- Save the configuration.
- On the server where you have the Portal installed, go to System > TMS > WorldView and open the Event bus configuration in the Canister configuration.
- Edit the event bus configuration to open the Pipeline editor.
- In the Pipeline editor, drag the Exchange session agent into the Event bus pipeline. Place the Exchange agent after the Decouple agent and before the Null agent.
- Save the configuration.
Upgrading the event bus configuration file for use with Exchange
If you have upgraded your installation from a version previous to Tealeaf version 10.0, you must update the TeaLeafEventBus.cfg
file to include information about Exchange.
To support sending event data to Exchange, the event bus configuration file must contain information about Exchange. Starting with version 10.0, TeaLeafEventBus.cfg
contains the required Exchange information. Previous versions of the file do not.
Because the Tealeaf upgrader does not overwrite existing configuration files, you must manually add the Exchange information to the current TeaLeafEventBus.cfg
(as created and modified in your 9.0.2 environment) to now include the Exchange agent configuration in your new Tealeaf version 10.0 environment. You need to perform this task every server that sends event data to Exchange.
- In the Configuration Files folder in your Tealeaf CX installation, open
TeaLeafEventBus.cfg
in a text editor. - Copy the Exchange section of the file.
- Open the current
TeaLeafEventBus.cfg
file. This is the file that you carried forward from your 9.0.2 installation. Paste the Exchange section into this file. - Save the file.
Now, when you open the Event bus editor, you will see the Exchange agent as an option to add to a pipeline.
Enabling events for sharing through Exchange
Sending Tealeaf event data to Exchange requires a change in the configuration of the Tealeaf event. You must indicate in the configuration that the event can send data to Exchange.
- In the Event manager, edit the event that you want to use to send event data to Exchange.
- Open More options.
- Select Send to EventBus/UBX.
- Save the event configuration.
Troubleshooting event sharing through Exchange
Sometimes things do not go as expected. In case you run into problems, you can check the log files. By default, logging is turned off. To track Tealeaf to Exchange activity, you must enable logging for the integration.
When you successfully configure Exchange in the event bus, log files can be saved in the Logs folder, if logging is enabled.
To enable logging, you must update the TealeafEventBus.cfg
file.
- In the Configuration Files folder in your Tealeaf CX installation, open
TeaLeafEventBus.cfg
in a text editor. - Edit the Log Mode parameter. By default, the value is
0
. To enable logging, change the value to1
. - Save the file.
Log files are available in the Logs folder in the format SA_UBX_<date>
.