Urchin 4 And Urchin 5 Database Utilities

Urchin Database Utilities

Urchin 4/5 installation includes utilities to insert, edit, and delete records in Urchin database. The only two ways to change data in Urchin internal database are through Urchin Control Panel or by the means of Urchin database utilities.

The following Urchin database utilities are located in the util subdirectory of the Urchin installation directory (/hsphere/shared/urchin for Unix, C:\Program Files\Urchin for Windows):

• uconf-import (not used for H-Sphere Windows accounts) is a utility that imports XML data to Urchin database. XML data may be transferred to the standard input or taken from an XML file.
  For more details on uconf-import options, see the manual on the Urchin Documentaion Center.

• uconf-driver (uconf-driver.exe for Windows) is a utility that allows inserting, deleting or updating database tables.
  Visit Urchin Documentaion Center for the uconf-driver options.

Urchin Database Tables

1. Logfile is the table that holds log file locations. In H-Sphere, Urchin log files are accessed remotely via HTTP protocol. Log file is returned by the print-log.pl script.

   Here is an example of XML representaion of a Logfile table record:

   <Logfile Name="urchin.com">
      ct_name=urchin.com
      cr_type=remote
      ct_loglocation=/hsphere/local/urchin/var/logs/
      cr_protocol=http
      ct_server=63.212.171.4
      ct_port=80
      ct_remotelocation=cgi-bin/print-log.pl?urchin&urchin.com;&xgyvijmuxpuad07p1w;/nuw==&.gz
      cs_logformat=ncsa
   </Logfile>
   

   Field description:

   Field name	XML Representation	Description
   Name	<Logfile Name="urchin.com">	Record name, coincides with the domain name in H-Sphere.
   ct_name	ct_name=urchin.com	The name of a domain where statistics is collected.
   cr_type	cr_type=remote	Type of access to log files; it is always "remote" in H-Sphere
   ct_loglocation	ct_loglocation=/hsphere/local/urchin/var/logs/	On remote access to this directory, log files with Web boxes' collected statistics are taken.
   cr_protocol	cr_protocol=http	Protocol used to access log files; it is always "http" in H-Sphere;
   ct_server	ct_server=63.212.171.4	IP of the logical server where log files are located.
   ct_remotelocation	ct_remotelocation= cgi-bin/print-log.pl?urchin&urchin.com;&xgyvijmuxpuad07p1w;/nuw==&.gz	Location of log files; in H-Sphere, it is set as the URI of a CGI script that collects statistics from remote log files, with a query string containing the script parameters.
   cs_logformat	cs_logformat=ncsa	Log file format: ncsa for Unix, w3c for Windows.

2. Profile is a table used to access statistics in the form of charts, diagrams, etc.

   Here is an example of XML representaion of a Profile table record:

   <Profile Name="urchin.com">
      ct_name=urchin.com
      ct_reportdomains=urchin.com,www.urchin.com
      cs_llist="urchin.com"
   </Profile>
   

   Table field description:

   Field name	XML Representation	Description
   Name	<Profile Name="urchin.com">	Record name, coinsides with the domain name in H-Sphere.
   ct_name	ct_name=urchin.com	The name of a domain where statistics is being collected.
   ct_website	Web site URL.
   ct_reportdomains	ct_reportdomains=urchin.com,www.urchin.com	Possible ways to access domain, domain names separated with commas
   cs_llist	cs_llist="urchin.com"	The domain where log file is located; this field is used to link this table to the Logfile table.

3. User is the table where the list of users is stored. User names are identical to H-Sphere account names. Access to reports is also set in this table.

   Here is an example of XML representation of a Users table record:

   <User Name="Urchin">
      ct_name=Urchin
      ct_password=USCC|3980261512
      cs_rlist="urchin.com"
   </User>
   

   Table field description:

   Field name	XML Representation	Description
   Name	<User Name="Urchin">	Record name, coincides with the domain name in H-Sphere.
   ct_name	ct_name=Urchin	User name.
   ct_password	ct_password=USCC|3980261512	User's password.
   cs_rlist	cs_rlist="urchin.com"	The list of available reports.

4. Task is the table that contains tasks for collecting statistics.

   Here is an example of XML representation of a Task table record:

   <Task Name="urchin.com">
      ct_name=urchin.com
      cr_frequency=5
      cs_hour=4
      cs_minute=0
   </Task>
   

   Field name	XML Representation	Description
   Name	<Task Name="urchin.com">	Record name, coincides with the domain name in H-Sphere.
   ct_name	ct_name=urchin.com	Domain name.
   cr_frequency	cr_frequency=5	Task launching frequency; 5 means it would launch every 24 hours.
   cs_hour cs_minute	cs_hour=4, cs_minute=0	Task launching time.