Record Custom User Actions

Add a New Analytics Module

1. Open your SmartHub installation directory.
   
2. Navigate to your customization folder and add a new file <your module name>-module.js (this is where your custom action logic is going to be).
   1. For example, page-like-module.js would register every click on the Like button from the SmartHub page
      
3. Navigate to the SmartHub root directory.
   
4. the file DefaultModuleSettings.js file under.
   1. Copy the contents of the setting PAXModules under the section SH.Analytics.DefaultSettings.
      
5. Go back to your customization folder and open the page's custom settings file (such as the Results.html page custom settings file ResultsCopyCustomSettings.js)
   
   1. Add the path to the new file into the section SH.Loader.FilesToLoad.
      
      
   2. Locate the section SH.Analytics.CustomSettings and paste the previously copied contents
   3. Inside the PAXModules array, add PAX_<your module name>Module.
      

Edit the Custom Module

1. Inside the new <your module name>-module.js file, paste the code below.
   

2. Change the window.PAX_PageLikeModule to match the name from step 5.3 in the section above, as well as thePageLikeaction name inside the injectionMap structure.
   
3. customBinding triggers the registering of the action
   1. In the sample code, a click event is attached to the element with the "like-button" ID.
      
4. The pageLikeCallback function structure remains the same, but the name must be changed
   
5. contextMap maps the action to the callback function called when the event is triggered
   1. For instance, getPageLikeContext is a function that adds the Timestamp to the context when the button is clicked
      
6. artifactSchemas must be changed to match the fields you registered inside the callback function

   1. For the page "Like" action, the Timestamp field should be added besides the user-related ones

(function () {
 
    var _contexts = {};
    var _callback;
 
    var getPageLikeContext = function () {
        var context = {};
 
        context['Timestamp'] = new Date();
 
        return context;
    };
 
    var pageLikeCallback = function (args) {
        _callback(args, _contexts["PageLike"]);
    };
 
    window.PAX_PageLikeModule = {
 
        injectionMap: {
            PageLike: {
                customBinding: function (context, callback) {
                    if (_contexts["PageLike"]) return;
 
                    _contexts["PageLike"] = context;
                    _callback = callback;
                     
                    pax.$('#like-button').on('click', function (e, data) {
                        pageLikeCallback();
                    });
 
                }
            }
        },
 
        contextMap: {
            PageLike: getPageLikeContext
        },
 
        contextKeysMap: {
            // union of states for each artifact referenced.
            PageLike: ['pageLike']
        },
 
        states: ['PageLike'],
 
        goalStates: [],
 
        additionalVisitPropertiesCallbacks: [],
 
        additionalSessionPropertiesCallbacks: [],
 
        actionTypes: {
            // action are interpreted differently with respect to phase and time.
            // a long hover is good (duration).  a long wait for a page load (latency) is bad.
            // some actions are atomic (download), and some are phased (pageload request, page load response),
            // some actions are indeterminate (pulsed)
            // logging sees everything as events. we need some hints to translate event sequences into actions for metric.
 
            PageLike: { type: 'atomic' }
        },
 
        artifactSchemas: {
            // what's the schema for what we persist? is specific to stuff from the app. state provided by context callbacks.
 
            pageLike: ['Timestamp', 'PageURL', 'User', 'AccountName', 'Department', 'Office', 'JobTitle', 'Title', 'UserLocation', 'Birthday', 'TimeZone', 'Manager', 'PastProjects', 'Skills', 'HireDate', 'YearsWithCompany']
        }
    };
})();