Zudy Vinyl

Before starting your application instrumentation, ensure that you have created an app and have an appKey

Install

Installing Pyze Analytics for Vinyl is simple, and requires adding the Pyze Javascript as a site widget in the Vinyl IDE

Create a new site widget, and paste the below script within binder.js as shown:

define(function () {
    const install = function (context) {

    var pyzeAppKey= context.getParameter('AppKey');
    !function(e,t){var s=e.Pyze||{_q:[]},i=e.PyzeEvents||{_q:[]},n=e.PyzeCuratedEvents||{_q:[]},r=e.PyzeIdentity||{_q:[]};function p(t,e){function s(e){t[e]=function(){t._q.push([e].concat(Array.prototype.slice.call(arguments,0)))}}for(var i=0;i<e.length;i++)s(e[i])}p(s,["initialize","getTimerReference","getAppInstanceId","postWebAppVersion","postPageView","setUserOptOut","deleteUser"]),p(i,["postCustomEvent","startTimerForEvent","postCustomEventWithAttributes","postTimedEvent","postTimedEventWithAttributes","postExplicitActivation"]),p(n,["post"]),p(r,["setUserProfile","resetUserProfile","updateUserProfile"]);var o=t.createElement("script"),a=t.getElementsByTagName("script")[0];o.type="text/javascript",o.async=!0,o.src="https://cdn.pyze.com/pyze.js",a.parentNode.insertBefore(o,a),e.Pyze=s,e.PyzeEvents=i,e.PyzeCuratedEvents=n,e.PyzeIdentity=r}(window,document),Pyze.initialize(pyzeAppKey);
        console.log(pyzeAppKey);
    }
    return {
        callbacks: {
            install: install
        }
    };
});

Initialize

To initialize the Pyze SDK, add the site widget you created to your environment via the Control Panel:

The Pyze SDK will now start capturing many automated metrics.

Custom Events

Events allow you to easily track unique user actions within your app.

Setup

• Create a new Connection, of type Rest API
• Set the base url to https://import.pyze.com
• Create a POST endpoint for v1/events
• Add the following parameters:
  • appKey, event, eventTime, type, userId

Event

Pyze custom events can be called from XP CRUD rules within your application.

Create a new XP Crud Rule, that will send your Custom Event from your Application to the Pyze Rest API created above.

• Set the event Column to the name of the event
• Set the eventTime Column to NOW()
• Set the userID Column to WHO()

This allows you to track when a user executed an action, for a simple count of how often that event is occurring.

Event with Attributes

Attributes are any key-value pair that you can attach to an event. You can have up to 99 attributes with any event. It is highly recommended to follow our Best Practices and heavily rely on attributes to make your instrumentation as minimal and useful as possible. In a typical application, you should have many more attributes than events.

• Pyze API to send custom attributes accepts the attributes in JSON format.
• Create a new XP_CRUD rule in your application as above
• Add an attributes Column with any JSON values from your application such as:

'{
  "TicketID": "' || CAST(TS.TicketID as NVARCHAR(64)) || '", 
  "Assigned User Id":"' || CAST(TS.AssignedUserID as NVARCHAR(64)) ||  '" , 
  "Priority Id":"' || CAST(TS.TicketPriorityID as NVARCHAR(64)) ||  '", 
  "Company Id":"' || CAST(TS.CompanyID as NVARCHAR(64)) ||  '", 
  "ApplicationName": "Ticketing" 
}'

Profile

Profiles are a powerful way to add data about your users to Pyze. Use profiles to add data that is not specific to a point in time (events) and are attached to a specific user.

When a user logs in to your app, call setUserProfile to identify them to Pyze. Any events that happen after they are identified, will be attributed to this user. You should only call this method once upon the initial login of a session.

You can optionally include profile attributes.

Pyze built-in profile attributes get special handling in the pyze UI, and we will attempt to discern the data type for custom attributes based on the data recieved. There is no difference between the built-in attributes and custom ones outside of formatting applied.

You can modify your binder.js in the Site Widget created as part of the installation process to add these profile calls.

//Create Pyze Profile Attributes object
var pyzeProfileAttributes = {
   "email_id"        : "xyz@abc.com",
   "date_of_birth"   : "1984-06-01",
   "first_name"      : "John",
   "last_name"       : "Jacobs"
}
//Create Custom Profile Attributes object
var customProfileAttributes = {
   "age"       : 29,
   "pincode"   : "23200",
   "city"      : "XYZ"
}
//Call the setUserProfile API
PyzeIdentity.setUserProfile(context.getCurrentAuthenticationUserName(),pyzeProfileAttributes,customProfileAttributes);

Pyze profile attributes

API Reference

Full API reference available here