By default, the selected server is polled for stats every two seconds through TMS.

The Connections table shows active connections to the Transport Service through the protocol in use, and the name of the machine from which the connection originates.

• All current connections are permanently displayed and cannot be added, removed or selected.
• The slot# column contains the memory address in the Tealeaf shared memory occupied by the connection.

The Pipeline table shows the different session agents in the order in which they appear in the currently selected pipeline. In the Pipelines table, you can review each session agent in the pipeline in the order of execution.

Firewall settings only apply to Transport Service pipelines.

Additional documentation on all settings is available in the TealeafCaptureSocket.cfg file stored in the Tealeaf install directory on the server.

Complete the following steps to edit configuration settings.

1. Select the head node containing the configuration description and click Edit at the bottom of the editor, or double-click the head node.
2. Click the + next to a section to expand it.
3. Click a configuration setting, change the values as desired, and click Apply.
4. When done, click OK.

By default, a single pipeline is created for you, which monitors port 1966 using standard HTTP traffic. A set of pipeline session agents is added to the pipeline based on the installed components in your Tealeaf solution. Additional details can be managed through manual editing of the appropriate configuration file.

You can continue to build the session agents of your pipeline. In this manner, you can build your pipeline until you reach one of the terminal pipeline session agents:

1. The Canister session agent forwards the session data to a Tealeaf Short Term Canister.
2. The Archive session agent forwards the session data to a Tealeaf Archive.
3. The Null session agent discards the data (for debugging purposes).
4. You can also point the end of a pipeline to the start of another pipeline.

Complete the following steps to add a pipeline.

1. To create a new pipeline, click the topmost node in the left panel.
2. Select Add Pipeline.
3. Enter a port number and select whether to use SSL in the pipeline.

   Use port 1966 for standard HTML (non-SSL) traffic and 1967 for SSL traffic.

   An SSL pipeline and a non-SSL pipeline should not both reference the same downstream session agent, especially if it is a canister. This situation results in multiple threads.

   Note: Use of SSL can impact pipeline throughput.

4. Click Apply.
5. To edit the pipeline, select it and click Edit.
6. After the pipeline has been added and edited, you can begin adding session agents to it.
7. If your pipeline is receiving data, you can iterate on the configuration through TMS to tune performance.

Complete the following steps to add a session agent to a pipeline.

1. Select a session agent to add from either:
   • Available session agents, which includes the following options:
     • Custom - Custom native (C++) session agent
     • Managed - C# or VB.NET session agent hosted by session agentCLR
     • RulesEngine - TCL script hosted by session agentRulesEngine
   • Saved session agents list
2. Drag the session agent to the desired position in the pipeline tree.

   A line appears when you hover over the pipeline showing where the session agent is to be placed.

   Note: You may be required to rename the session agent if an instance of the same session agent is already in the Saved session agents pane.

   After the session agent is dropped in the pipeline, the Edit session agent dialog is displayed, allowing you to change the settings for the session agent.

3. Click Add Config Items to add custom configuration items for the SessionAgent.
4. Click OK to keep any changes.

After multiple session agents have been added, you can reorder them within the pipeline or move them between pipelines using drag and drop.

Complete the following steps to edit session agent settings.

1. Double-click the session agent node.
   The Edit session agent dialog is displayed.
2. Click the + next to a group to expand it, if the session agent has configuration item groups.
3. Click a configuration setting to change it.
   The Edit Config Item dialog is displayed.
4. You can add configuration items to the session agent.
   • To add a custom configuration item, click Add Custom Config Item. Enter a name for the custom configuration item and click OK.
   • To add a custom configuration item for the session agent, click Add Config Items.
     Note: Adding a custom configuration item only inserts the item into the configuration data. Customization of the affected .DLL is required. No data validation is performed on customer configuration items through TMS.
5. Change the value as desired and click Apply to save the change.
6. When done, click OK.

The difference between HBR and Extended HBR is that child pipelines are separate processes in HBREx, and are no longer part of the parent pipeline process. By running the child pipelines as separate processes, each pipeline has extra memory space, which improves the performance of HBR.

Example of HBREx with two child pipelines:

[HBREx]
TypeName=HBREx
CanisterAppName1 = [Canister_App_Name_For_1st_Child_Pipeline]
CanisterAppName2 = [Canister_App_Name_For_2nd_Child_Pipeline]
CanisterOffline1=Daily at 2300 for 10 minutes winddown 20 minutes 
CanisterOffline2=Daily at 2300 for 10 minutes winddown 20 minutes
CanisterName1= [Canister_Name_1]
CanisterName2= [Canister_Name_1]
CanisterPipeID1=1
CanisterPipeID2=2
DLL=SessionAgentPipelineSplitterEx.dll
DownStreamConfigSection=Null
DefaultPerSecMax=200
InitTimeOut=1800
ActionScript=HBR.Action.tcl
MainScript=HBR.Main.tcl
PreProcScript=HBR.PreProc.tcl
RoutingMethod=Equal
MaxSessions=100000
PipelineConfig1=HBR_Pipeline1.cfg
PipelineConfig2=HBR_Pipeline2.cfg
ScriptTrace=OFF
CanisterSSPort1=19000
CanisterSSPort2=19000

You can access the Extended HBR session agent by navigating to the available session agents section within the pipeline editor tab of TMS.

1. In the Portal, go to TMS > Worldview.
2. Expand the node for the HBR server.
3. Expand the node for Transport Service.
4. Select Transport Service configuration > Config Actions > View/Edit.

In the Pipeline Editor window, you can see the HBR parent pipeline configured with other session agents, as well as the HBR session agent. Make note of the values specified in the HBR session agent configuration, as these can be used as a reference when configuring HBREx.

Remove the HBR session agent from the pipeline by dragging and dropping it into the Available SessionAgents box to the right. Replace the HBR session agent with HBREx by dragging and dropping into the pipeline.

The Edit SessionAgent box appears. Here you can view all of the fields of HBREx. HBREx has all the same fields as HBR, plus the “Child pipeline port range start”. This comes with the default value of 2000. You can edit the value by clicking Child pipeline port range start, and applying your changes. Child pipelines are separate processes and need to listen on individual ports. The ports that will be used by child pipelines start from the value specified in Child pipeline port range start (with a default of 2000). All parameters specified in HBREx will be the same as those specified in HBR.

The CanisterAppName for child pipelines must be specified as TealeafCSS_<port_number_assigned_to_child_pipeline>. If any other value is specified as the CanisterAppName, it will be overridden as TealeafCSS_<Port_Number>.

• Complete the following steps to move a session agent within a pipeline.
  1. Select the session agent to move.
  2. Drag the session agent to the desired position in the pipeline tree. A line appears when you hover over the pipeline showing where the session agent is to be placed.
• Complete the following steps to remove a session agent from a pipeline.
  1. Select the session agent to remove.
  2. Drag the session agent to the Available session agents list to remove the session agent from the pipeline or to the Saved session agents list to save session agent instance for future use in this configuration.

1. Make changes to the pipeline through the Pipeline Editor.
2. In the Jobs tab, schedule a job to push the changes immediately to all servers.
3. Check the Pipeline Status tab to see if data is flowing through all session agents in the pipeline.
4. Review the results in the destination system:
   • If the pipeline ends at a Canister session agent, you can search in the Portal for active sessions or recently completed sessions to review the captured and processed data.
   • For Event Bus pipelines, you must review results in the destination system.
5. Repeat these steps until you are satisfied with your pipeline configuration.

When a pipeline is removed, all of its session agents are discarded as well. To preserve the configurations for session agents in a pipeline, drag them to the Saved session agents panel first.

Note: There must be at least one pipeline to save the configuration.

Complete the following steps to remove a pipeline.

1. Select the pipeline to remove.
2. Click Remove Pipeline at the bottom of the editor.
3. Click OK to confirm the removal of the pipeline.