Custom Navigation

Introduction

The list of reports in the navigation of the reporting interface can be completely customized. Urchin ships with a number of default "Report Sets" which control the navigation and list of reports. Additional Report Sets can be easily added. And once created, they are automatically selectable in the Report Set configuration setting for the Profile. Different Report Sets can be set for different users as well.

Using Report Sets, you can modify the list of reports, turn off entire sections, change colors, change text and move reports around. This is all done by creating a Report Set definition file. Keep in mind that a Report Set definition is created for a particular Profile Type such as "Standard Website". Furthermore, adding a Profile can automatically select a custom Report Set as the default if desired.

Creating Custom Report Set

A custom Report Set is created by creating a Report Set definition file in the

   [urchin install dir]/lib/custom/profiletypes/<ProfileType>/
folder, where <ProfileType> is "Standard_Website", "E-Commerce_Website", or another Profile Type. Multiple custom Report Sets can be created. Each one will need a '.rs' extension for Urchin to recognize it. Be sure to use underscore "_" characters in the directory and filenames instead of spaces. Once a custom Report Set is created, it is available for selection in the Admininstration Interface. Here is a step by step procedure for creating a custom Report Set.

Step 1: Copy an existing Report Set
Sample Report Set definition files are included in the Profile Type folders that ship with the product. The first step is to copy the sample and rename the file with a ".rs" extension. Be sure to use underscores instead of spaces in the name. For example, if creating a Report Set for the Standard Website Profile Type, then in the directory, "lib/custom/profiletypes/Standard_Website/" within the Urchin installation, copy the file "All_Reports.rs.sample" and rename it to "my_report_set.rs" or some other descriptor.

Step 2: Modify the Report Set
Edit the new Report Set definition file. Each line in the definition file can represent a report or a menu. A description of all the configuration fields for each line is described in the top of the file. But in general, to turn off reports or entire sections, enter a '#' character in front of the entries you wish to turn off. The names of reports can be changed by modifying the third field. Names and help text can either reference an entry in the dictionary system or you can enter the text directly into the field in this file. Colors can be changed by editing fields five and six. Menus can be created by copying one of the existing menu lines and editing the text entry appropriately. The order of the entries in the file mirrors the order seen in the navigation. Each entry will need a unique ID which is in the first field. For list of all Regular Reports, see the Reference Section of this manual.

Step 3: Is this the default Report Set for Profiles of this type?
If you want the newly created Report Set to be the default setting when creating new Profiles of this type, then copy the 'default.config' file from the 'lib/reporting/profiletypes/Standard_Website/' folder to the 'lib/custom/profiletypes/Standard_Website/' folder, where 'Standard_Website' is the Profile type that we are creating the Report Set for. Edit the new default.config file in the custom area and add a line that contains: 'cs_reportset=my_report_set' where 'my_report_set is the name of the Report Set we just created without the .rs extension.

Save the file(s) and you ready to assign it as the Report Set for existing Profiles. In the Administrative Interface, edit a profile and under the Profile Settings tab, use the Report Set pull down menu to select your new Report Set.