Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Google Analytics Plugin

Latest Release Google Analytics 2.0.0 (as at 21-Nov-2011)

Provides close integration for FarCry projects with the Google Analytics service

Features include:

  • webtop overview integration; showing stats for individual pages directly in the webtop
  • support for downloads and external link reporting
  • a framework for tracking Google custom variables
  • popular content publishing rule

Screengrabs


Installation

Checkout from source control

svn checkout https://farcry.jira.com/svn/GA/trunk
to
./farcry/plugins/googleAnalytics

TRUNK should be mostly stable. But there are specific milestone tags for those who don't want to risk it.

Copy the "www" folder to a "googleanalytics" folder under your project's webroot or create a web server alias (virtual directory on IIS) as "/googleanalytics" pointed at the plugin's www folder.

Update project constructor

Add googleAnalytics to the plugin list within ./www/farcryConstructor.cfm

./www/farcryConstructor.cfm
<!---// set plugin list--->
<cfset THIS.plugins = "farcrycms,googleMaps,googleAnalytics,farcrydoc" />

Deploy content types

Go into the webtop ADMIN > DEVELOPER TOOLS and deploy all the plugin content types.

Update Google Analytics configuration file

You will need to update the plugins configuration to include your projects specific Google Analytics URCHIN code. This is found under the Content administration tab, in the Google Analytics dropdown.

You must nominate a matching domain to activate GA tracking. Note this feature allows you to nominate different urchin codes for different domains or none at all. For example, you might not want to track stats at all from developer and staging server machines.

Make sure active is always on; this property is deprecated.

Ignore Types for now; its an advanced option that needs a bit of fleshing out. Crawl through the code if you must.

The username and password for the GA API is entirely optional. It is used to pull statistics into the application on demand from Goolge. You require the GA login credentials in order to see stats in the GA webtop overview tab, or to use the "most popular" content publishing rule.

What else?

That's literally it. If GA Plugin detects that you are serving a page from one of the configured domains, it will automatically include the correct urchin code for your domain in the HEAD of your document.

v1.0.0 Google Analytics Plugin

Google Analytics uses the old style of GA tracking that goes at the bottom of the page. Seriously, upgrade to FarCry 6.x and use the latest if you can – it's worth it.

Follow the same installation steps as for v2.0.0. In addition, you will need to add the GA custom tag to the footer of your pages, see below.

Add GA custom tag to views

You will need to add the GA custom tag to all the relevant views you want to track. The best suggestion is to put the code into some sort of "footer" template that gets included on every page that visitors see.

<!--- import tag library --->
<cfimport taglib="/farcry/plugins/googleAnalytics/tags" prefix="ga" />

<!--- add track tag; ideally just above the closing </body> --->
<ga:track stObject="#request.stObj#" />

Note we pass in the entire object from the request scope; helps us deal elegantly with both individual objects and type webskins.

  • No labels