Pega Systems

Overview

Pyze for Pega enables analytics tracking in both Traditional and Constellation Pega applications. Once installed, Pyze automatically captures user interactions and allows you to track custom events and user profiles.

Prerequisites: Create a Pyze app and obtain your App Key before proceeding.

Getting Started

Step 1: Download the Package

Download the latest Pyze component from the GitHub releases page.

Step 2: Import into Pega

1. Open Dev Studio
2. Navigate to Configure → Application → Distribution → Import
3. Select the downloaded zip file and click Next
4. Continue through the wizard until import completes

×

Step 3: Enable the Component

1. Open Application Definition in Dev Studio
2. Click Manage Components under Enabled Components
3. Select Pega Pyze Component and click OK

×

Step 4: Configure Your App Key

1. Open Data types from the left menu
2. Click the dropdown arrow and select Add data type

×

3. Choose Existing Data Type and search for “Pyze”
4. Select AppKeysForPyze and click Submit

×

5. Open the data type and go to the Records tab
6. Add a record with your Application Name and Pyze App Key

×

For Constellation applications: Continue to the next section to deploy the Pyze widget.

Constellation UI: Widget Deployment

Constellation applications require the Pyze widget to be manually added to pages where you want tracking enabled.

Add Widget to Home Page

1. Open App Studio
2. Go to Channels and interfaces → Landing Page → Portal
3. Click pyHome
4. Click +Add and select the Pyze widget
5. Save changes

×

Add Widget to Case Types

Repeat for each case type you want to track:

1. Open Dev Studio
2. Go to Case Designer and select your case type
3. Open the UX tab
4. Click +Add and select the Pyze widget
5. Save changes

×

Verify Installation

Confirm the following:

• Pyze widget appears on the pyHome landing page
• Pyze widget appears on your case type screens
• App Key is correctly configured
• Data appears in your Pyze dashboard

User Profiles

Link events to specific users by setting a profile when they log in.

Identify a User

Call once when a user logs in:

PyzeIdentity.setUserProfile(
  "user-123",                          // Unique user ID
  {                                    // Pyze profile attributes
    "email_id": "john@example.com",
    "first_name": "John",
    "last_name": "Smith"
  },
  {                                    // Custom attributes
    "department": "Sales",
    "region": "West"
  }
);

Update Profile

Modify attributes for an already-identified user:

PyzeIdentity.updateUserProfile(
  { "email_id": "john.smith@example.com" },
  { "region": "East" }
);

Clear Profile on Logout

Reset identity when user logs out:

PyzeIdentity.resetUserProfile();

Supported Profile Fields

User Privacy

Opt Out of Tracking

Allow users to stop data collection:

Pyze.setUserOptOut(true);   // Stop collecting
Pyze.setUserOptOut(false);  // Resume collecting

Delete User Data

Permanently remove all user data from Pyze:

Pyze.deleteUser(true);

Advanced Configuration

Tracking Clipboard Data

Capture additional case data from the Pega clipboard.

Step 1: Identify the attribute key in the clipboard (must be a simple type like String or Number).

Step 2: Configure tracking:

• Traditional
• Constellation

1. Go to Dev Studio → Configure → User Interface → Web Analytics
2. Click Settings → App Data tab
3. Click Add Item
4. Enter the attribute name and key in format: pyWorkPage.ATTRIBUTE_NAME
5. Click Submit

×

×

1. Open Data types in Dev Studio
2. Search for ConfigPyze
3. Go to the Records tab
4. Add a record with the attribute name and key in format: caseInfo.ATTRIBUTE_NAME

×

Data Hashing

If the Pyze agent has been configured to collect sensitive data (such as email addresses, user IDs, or other PII), consider hashing the data before it is sent to Pyze. See the Data Hashing documentation for details.

Access Control

Control which users have Pyze enabled.

Enable for Specific Access Groups

1. Go to Records → SysAdmin → Dynamic System Settings
2. Set EnablePyzeByRole to true

×

3. Add role PyzePegaRole:EnablePyze to desired access groups

×

Disable Pyze Completely

1. Go to Configure → User Interface → Web Analytics
2. Uncheck Use web analytics

×

Uninstalling Pyze

To completely remove Pyze from your application:

1. Remove component: Open Application Definition, click Manage Components, remove Pyze Component
2. Remove roles: Delete PyzePegaRole:EnablePyze from all access groups
3. Unlock ruleset: Unlock the Pyze component and ruleset for editing
4. Delete ruleset: Go to System → Refactor → RuleSets, delete PyzeIntegRS
5. Delete component: Remove the component record
6. Re-login to complete removal

API Reference

See the full Web API Reference for all available methods.