During installation or upgrade, Tealeaf provides the following events, which you can use or modify to meet the requirements of your web application. These events are defined in the customer namespace, which means that you can edit them like any other events.

Login ID Sample event

The Login ID Sample event provides an example configuration for how to track login identifiers to your web application.

This event is configured to be triggered when the hit attribute Login ID is detected on each hit and to record the first found instance to the Login ID session attribute. This attribute is used in multiple locations in the Portal to indicate the login identifier of visitors to your web application.

This event is considered a "sample" event. The best method for capturing login identifiers depends on how your web application is configured. At a minimum, you must review the definition for the hit attribute Login ID to configure the proper start tag and end tag for capturing the login information.

Tealeaf provides an end-to-end tutorial for how to configure the Login ID Sample event so that you can capture login identifiers from your web application and make them searchable through the Portal.

Canister Safety Limits [BB] event

This building block event is used to place threshold limits on how large sessions can grow in the Short-Term Canister in terms of:

• Number of hits
• Size in bytes
• Time in seconds

If a session exceeds any of the defined limits in this event, it is automatically closed by the Canister and moved to the Long-Term Canister for indexing.

You may modify this event in Advanced Mode to change the Canister Safety Limits imposed on each active session in each Canister in your environment. Changes to these limits apply only to currently active sessions and all sessions that are subsequently captured by Tealeaf.

Note: After you install or upgrade your Tealeaf solution, you should review and modify the settings for Canister Safety Limits.

Note: Do not delete this event or make it inactive. If this event is not active or otherwise available, sessions are permitted to grow without limit in the Canister and can only be closed by session timeout or by the visitor.

Restore canister safety limits

If the Canister Safety Limits event is not visible in the Events tab of the Events Manager, complete the following steps to restore it.

Here is the default definition that must be applied through Advanced Mode:

// Canister Safety Limits [BB]
function PALI$E_SAFETY_LIMITS()
{
  //Default: 2048 Hits
  if ($S.NumberOfHits > 2048)
    TLCloseSession.CloseForSafetyHits();

  //Default: 5242880 Bytes (5MB)
  if (($S.TotalREQBytes + $S.TotalRSPBytes) > 5242880)
    TLCloseSession.CloseForSafetySize();

  //Default: 3600 Seconds (1 hour)
  if ($S.TotalTime> 3600)
    TLCloseSession.CloseForSafetyTime();
}

1. From the drop-down at the top of the Events tab, select All Events.
2. Select Show Inactive.
3. Enter Canister Safety in event filter.
4. If Canister Safety Limits [BB] is visible:
   1. Right-click the event.
   2. Select Make Active.

   If Make Inactive is in the context menu, the event is present and active. It was simply hidden from view by display settings. You can skip the rest of the steps.

5. If Canister Safety Limits [BB] is not visible in the filtered list:
   • Contact your Tealeaf administrator or other members of the Tealeaf team to see if the event was renamed.
   • Mouse over event names to reveal their tool tips, which for this event is E_SAFETY_LIMITS.
6. If the event was deleted, complete the following steps, which enable you to re-create the event through Advanced Mode in the Event Manager using the JavaScript™ definition above.
   1. Copy to the clipboard the JavaScript definition for this event.

      Note: Do not copy the function line. Copy all lines below the function line and use them to paste into the new event, which will have a function line provided for you.

   2. In the Events tab, click New Event.
   3. Enter the following properties:
      • Name: Canister Safety Limits [BB] (New)
      • Description: Enter a meaningful description. Be sure to note that this is the recreated version.
      • Set Evaluate to After Every Hit.
      • Select Active.
      • Clear the Display in Portal and Display in Session List check box.
      • In the Value step, clear the Searchable & Reportable and Flag Every Occurrence in Replay check box.
      • In the edit window, delete any text that is displayed.
      • Paste the version of the event that you copied from above.

        Note: Remember to leave the function line that is listed in the window unchanged.

        To locate your customer namespace value, open an event that you created and switch to Advanced Mode. The namespace value should appear in a similar location in that event.

   4. Edit the JavaScript to change the safety limit values.