Google Analytics

Navigation:  Reference > Project Configuration Settings > Publishing Options > WebHelp >

Google Analytics

Previous pageReturn to chapter overviewNext page

Show/Hide Hidden Text

 

flag_green        Key Information

Your GA code for the help site you want to track consists of your account number and a sequential number at the end after a dash! For example, in UA-123456-1, the "-1" part at end end identifies the profile of the help site you want to track. Be careful to enter the full code with this identifier!

Help & Manual Professional has built-in support for Google Analytics

Please note that Google Analytics support is available in Help & Manual Professional only. This feature is not available in the Basic version of Help & Manual.

Google Analytics is an enterprise-class web analytics solution that gives you rich insights into your WebHelp traffic. Powerful, flexible and easy-to-use features let you see and analyze your traffic data in an entirely new way. Google Analytics gives you a wealth of feedback and information that enables you to improve your help in many ways.

By integrating Google Analytics, you can track how the content of your WebHelp system is used and measure its effectiveness.

Tracking includes:

Topics viewed

Viewing paths

Entry and exit pages

Full text search terms

Index keywords used to locate topics

Tracking of external links such as file downloads and outgoing web links

Click to expand/collapseStep1: Create your free Google Analytics (GA) account

1.If you already have a Google account for any Google service, login to Google and add Google Analytics to the list of services that you use. If you don't have a Google account yet, click here to create one.

2.Follow the instructions on Google to complete your Google Analytics account.

Click to expand/collapseStep 2: Enable search tracking for your GA profile

When users of your WebHelp system use the full-text search to find content, Help & Manual automatically tracks those searches. To make Google Analytics deliver correct results however, we need to change some parameters in your GA profile settings.

1.In the Google Analytics Profile overview, click Edit:

exp_googleaccount
 

2.On the Profile Settings page, click Edit again to change the search option:

exp_googleaccount2 

 

3.Check the option Do Track Site Search and enter the query parameters "q,zoom_query", separated by a comma:

exp_googleaccount3
 

4.Click Save Changes to complete the settings change.

Click to expand/collapseStep 3: Prepare your Webhelp project for tracking

The settings are almost complete. Copy your GA account number (e.g. "UA-123456-1") from the Google Analytics page and enter it in Help & Manual.

IMPORTANT: Your GA code for the help site you want to track consists of your account number and a sequential number at the end after a dash! For example, in UA-123456-1, the "-1" part at end end identifies the profile of the help site you want to track. Be careful to enter the full code with this identifier.

1.In the Project Explorer on the left of the main Help & Manual screen go to Configuration > Publishing Options > WebHelp > Google Analytics.

2.Enter the GA account number.

3.Recompile your WebHelp system and upload it to your web server.

That's it. Google Analytics pretty quickly picks up tracking data. Note that it will usually takes a couple of hours before you can view any results. It will be a few days before the data starts to become really meaningful.

See also:

Profiling WebHelp with Google Analytics (Overview)

Full Text Search (Configuration Options)