Skip to main content

Extensions

Important

To capture event data from Google Chromeand/or Microsoft Edge browsers, you must have Receive Data From All Extensions enabled here and have installed the Task Mining browser extensions.

Extensions are used to extract web page data from websites, even when a user doesn’t interact with the web page data. Custom web page extraction rules define the data that is extracted.

For example, if a user views a Support ticket on a web page, a custom web page extraction rule could extract the Support ticket identifier from the web page. The Support ticket identifier would then be included in the Task Mining data for that user.

Note

Event processing rules capture web page data that a user interacts with. Extension web page extraction rules extract data from web pages that the user doesn’t interact with.

Before you begin, ensure you have completed the following steps or meet the requirements listed below:

  1. In the Task Mining Configuration Editor, select Extensions.

    The Extensions screen appears.

  2. Ensure Receive Data From All Extensions is enabled.

  3. Select Add Rule.

  4. Enter a:

    • Key for your rule in the Key field

    • URL for your rule in the URL field.

    • Path for your rule in the Path field.

    Note

    For more information, see Web page extraction rules.

  5. Select OK.

  6. Save and upload your configuration file.

  7. Visit the URL from step 4 and check your data extractions are working as expected.

Part

Description

Key

Identifier for the extracted data item. Must be unique in the Task Mining project configuration file

URL

Regular expression that describes the URL of the website the data item should be extracted from. The data item will only be extracted from web pages that match the URL. The regular expression must use JavaScript syntax.

Path

Defines which element/value to extract and describes the path of the data item in the document structure of the web page using:

  • An XPath expression; or

  • A JQuery.

Once web page data items have been extracted from web pages using web page extraction rules, they are saved in JSON format in the user interaction event in the WebPageExtractions column. The root element is a list of JSON objects, with each object: 

  • Representing the result of the web page extraction rule. 

  • Consisting of a key attribute that identifies the web page extraction rule and a data attribute that contains the extracted data.

As an XPath expression might return multiple data items, the data attribute is a list of strings, with each string representing a result item from the XPath expression.

Related topics