Jump to content

Obsolete:OWA setup

From Wikitech

This page assists in setting up OWA for a given site with our current setup.


Configuration on owa.wikimedia.org

A person with admin rights on owa.wikimedia.org needs to create a site-id for the site(s) being monitored

Configuration of site-specific JS

Site-specific JS needs to be written for the given site. This is actually fairly straightforward, the JS is usually of the following:

$j(document).ready(function() {
		OWA.setSetting('baseUrl', window.location.protocol + '//owa.wikimedia.org/owa/');
		OWATracker = new OWA.tracker();
		OWATracker.setEndpoint(window.location.protocol + '//owa.wikimedia.org/owa/');
		OWATracker.setSiteId('/*site-id obtained from above step here*/');
		OWATracker.trackPageView();
		OWATracker.trackClicks();
	
});

Specific code needs to be in a central location

Currently the site-specific code lives in owa.wikimedia.org/resources/

Anyone with access to the owa nodes should be sure to sync up the files on all the nodes using the script ~nimishg/bin/owasync.sh


JS to be included on the site being monitored

The following 2 lines of JS will provide the owa generic tracking code and the site-specific instantiation of the code. This can either be included in the common.js for the specific site or with the inclusion of the utility that's doing the monitoring:

importScriptURI(window.location.protocol+"//owa.wikimedia.org/owa/modules/base/js/owa.tracker-combined-min.js");
importScriptURI(window.location.protocol+"//owa.wikimedia.org/resources/officeWiki.js");

Notes

  • The above code uses the wikibits importScriptURI function, something similar can be achieved with a $j(document).ready() function