In event processing, Tealeaf uses three types of attributes as part of its data collection: hit attributes, session attributes, and step attributes.
Hit attributes
A hit attribute is a request from a visitor's device to the application and the response from the application.
Hit attributes are created based on the following set of attributes:
- Hit Attribute name: The name of the hit attribute you are creating.
- Tags: Keywords to help you find this hit attribute in searches.
- Description: Here you can enter a description of the hit attribute you are creating.
- Match: You can choose whether to match the Request or the Response.
- Use: You can choose to use the Start/End expression or an exact match.
- Start tag: The value of the request or response that indicates the start of the pattern of data to collect.
- End tag: The value in the request or response that occurs after the Start Tag that indicates the end of the pattern of data to collect.
- Use Regex: Enable use of the Regex (Regular Expression) as an additional filter on the hit attribute.
- Regex: The regular expression (a piece of text the user enters) to describe the additional matching rules they want to apply to the text. Each regular expression must have at least one capture group, the first of which is used as the value to be extracted from the regular expression match.
- Block/Replace: Enable blocking/replacement of the matched values of the hit attribute. If you apply regex, the blocking/replacement blocks or replaces what the regex matched.
- Block replacement: Add text to replace whatever content is matched by the regex or block/replacement.
- Display Case: You can choose whether to display your hit attribute in uppercase, lowercase, or with no change.
Create a hit attribute
- In the Event manager, select New.
- Select Hit attribute.
- Enter the hit attribute name.
- Add tags.
- Enter a description.
- Select whether you want to match the Request or Response.
- Select whether you want to use the Start/End expression or an Exact match.
- Enter the Start tag and End tag.
- Select whether you want to Use regex. If you do, enter the Regex.
- Select whether you want to use Block/Replace. If you do, enter a Block replacement. To configure privacy settings, apply the patterns and blocking behavior that is appropriate.
- Select the Display case in which you want your hit attribute to display.
- Click Save.
You can configure privacy settings for your product by applying patterns and blocking behavior to a hit attribute. Once the hit attribute is saved, use the event tester combined with a few sample sessions and validate them one at a time to see what the hit attribute is extracting. Repeat this process until the privacy settings that you implemented work as desired.
Update a hit attribute
You can change the hit attribute data.
- Select the hit attribute.
- Click Edit.
- Update the hit attribute data.
- Click Save.
You can also delete the hit attribute.
Note: When you delete a hit attribute, items that use the hit attribute are also affected. Before you confirm that you want to delete a hit attribute, you are shown a list of the items that will be deleted along with the hit attribute. If there is an item in the hierarchy that you do not want to delete, click Cancel. Then, disassociate the item from the hit attribute and delete the hit attribute.
- Select the hit attribute.
- Click Delete. A warning message displays to confirm the deletion.
- Verify that everything in the hierarchy can be deleted and click Delete.
Step attributes
A step attribute is a single user action that is captured by one of the client frameworks and submitted for capture in JSON format.
Create a step attribute
- In the Event manager, click New.
- Select the step attribute.
- Enter the step attribute name.
- Add tags.
- Enter a description.
- Enter the step pattern path.
- If you want to use a regular expression, select Use regex and then enter the expression.
- Select the display case in which you want your step attribute to display.
- Click Save.
Change or delete a step attribute
You can edit step attributes.
- Select the step attribute.
- Click Edit.
- Update step attribute information.
- Click Save.
Or, you can delete step attributes.
Note: When you delete a step attribute, any event or dimension that is associated with the step attribute is also deleted.
- Select the step attribute.
- Click Delete. A warning message displays asking you to confirm the deletion with a list of affected items.
- Verify that everything in the hierarchy can be deleted.
Note: If there is an item in the hierarchy that you don't want to delete, click Cancel. Then, disassociate the item from the step attribute and delete the step attribute.
- Click Delete to confirm that you want to delete the step attribute.
Session attributes
A session attribute is a system or user-defined variable for storing data that pertains to a session. These variables can be updated at any time during the session. When the session is complete, the session variable data is stored as part of the session record.
Session attributes are populated by custom or system events. For example, you can modify the LoginID sample session attribute to capture and store the identifiers of users of their applications.
Create session attributes
- In the Event manager, click New.
- Select Session attribute.
- Enter the session attribute name.
- Add tags.
- Enter a description for the step attribute.
- Click +Add event, select the events, and click Select.
- Click Save.
Update session attributes
You can e.g. modify the LoginID Sample session attribute to capture and store user identifiers.
- Select the session attribute.
- Click Edit.
- Update session attribute information.
- Click Save.
You can delete the session attribute. Note that it affects items that are associated with the session attribute.
Note: When you delete a session attribute, the events or dimensions that use the session attribute are deleted. The session attribute column is deleted from session view templates that use the session attribute.
Let's take a look at an example. An event uses a session attribute that needs to be deleted and there is a report that uses the event directly as a metric and another report that uses the event in a calculated metric. When the session attribute is deleted:
- The event, the calculated metric, and the two reports are deleted.
- The event is removed as a metric.
To delete a session attribute:
- Select the session attribute.
- Click Delete. A warning message displays asking you to confirm the deletion.
- Verify that everything in the hierarchy can be deleted and click Delete.