Authoring - Performing the auditing

Assume that some authors and users have already accessed the 'Encyclopedia: Encarta' content. To explore this activity you proceed in the following way.

Requesting an auditing log

Popup the menu of the ‘Encyclopedia: Encarta’ folder (or any of its dependants). The ‘Auditing’ menu item shows the corresponding auditing rules in its submenu. If you select one of the sub items a window will open to show you an overview of all the triggered events defined in that auditing rule and related to 'Encyclopedia: Encarta'.

A project's auditing log

You can sort this list by clicking on the header columns. In this way you can select a range of log items related to for example a time period or a specific author.

By clicking on the ‘Save as’ button you can save all or a selective part of the log to an XML or a TXT file.

Saving the auditing log

The XML file can then be used to perform the post process written by your own staff. The TXT file can be opened by some other applications such as MicroSoft’s Excell. Below is an example of a HelpServer event log output opened in an Excell worksheet.

Auditing log in an Excell worksheet

The data is then transformed into a pivot chart.

Auditing log in a pivot chart

If you are working as an administrator then probably the 'Auditing' root item will be available in the Workbench tree. It contains all the available auditing rules.

Requesting the auditing log on an auditing rule

If you request the auditing on such a rule object you get an overview of all the log items related to one specific auditing rule. Here in our example this approach won't make any difference because the auditing rule is used in one project. But should you want to reuse the same auditing rule in other projects then you would see the auditing log of all the projects in which the auditing rule is involved. This can be resource consuming and therefore we do not recommend this approach. We advise you to create at least one auditing rule per project and to request the auditing logs on the project folder or its dependants.


 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Customizing the look and feel
 User accounts
 Working with templates
 Working with metadata
 Creating an auditing rule to trace content access
 Enabling the auditing
 Performing the auditing
 Creating an auditing rule to trace user activity
 Auditing for a specific part in a project
 Workflow management
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript