Creating custom fields for your application


Create custom fields to collect additional end-user experience data such as cookies, local storage and session storage that are stored in the browser. You can also collect data such as request/response headers and payload. While the type of stored application data is the same across multiple applications, the keys and values might differ across applications. For example, two applications might use cookies with different names or use the browser's local storage differently. Based on the application’s usage, you can configure additional data to be retrieved.

To create a custom field

Tip

To successfully create and configure collection of custom fields, you must be familiar with the parameters collected by your application.

  1. From the Settings menu, select End User Experience.
  2. Select an application.
    If you have not created an application, see Collecting-end-user-experience-data-from-applications.
  3. Select the Custom Fields tab.
  4. Click + Create to create a new custom field mapping. If a custom field already exists, click Edit.png to edit it.
  5. From the Set Condition section,
    1. Set the Type to Page or Ajax.
    2. Specify the URL Pattern.
      For example, if the URL is https://mystore.com/department/clothes.html?color=blue&size=medium#sale/summer/August, you can specify /department/*#sale/* as the URL pattern.
      The URL pattern represents the path or fragment sections of the URL. It ignores the protocol (https), domain (mystore.com), and query param (color=blue&size=medium#sale/summer/August).
  6. From the Custom Field section, select the Type of Custom Field.

    Custom field

    Type

    Description

    Cookie

    Page

    Contains data such as session tokens and arrays used for making authorization decisions.Authentication cookies tagged with the HttpOnly flag cannot be accessed by the JavaScript.

    Query Param

    Page, Ajax

    Part of a uniform resource locator (URL) containing data used to sort or filter custom resource.

    Session Storage

    Page

    Data stored in the user's web browser for the current session.

    Local Storage

    Page

    Larger storage of application data in the user's web browser.

    Response Header

    Ajax

    Information that a server sends back to a client's browser in response to the HTTP request.

    Request Header

    Ajax

    Request that the client's browser sends to the server.
    The default browser entries in the Request Header cannot be accessed by the JavaScript.

    Request Payload

    Ajax

    Data sent as part of the HTTP request.

    Response Payload

    Ajax

    Data sent by the server in response to the request payload.

  7. Depending on the Type Custom Field, specify the Key and/or specify the Capture Options (applicable to storage and payload fields).
    • Capture ALL - Collect the entire JSON for the storage or payload fields.
    • Use JSON Path - Specify the path if the storage or payload fields use JSON
      For example, if the payload value is {"user": {"name": "John", "id": 12}, company:"John's Company"}
      • Specify .company to collect the company field (John's Company).
      • Specify .user.id to collect the user ID field (12).

Where to go from here

Use the system default view for analyzing end-user experience with your configured applications.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*