doc/manifest.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE doc SYSTEM "/usr/local/xslt/doc.dtd">
   3 <doc style="main.css" xmlns:xlink="http://www.w3.org/1999/xlink">
   4   <book>
   5
   6 <titlepage>
   7    <title>GNUCOMO</title>
   8    <subtitle>GNU COMPUTER MONITORING</subtitle>
   9    <subtitle>A system for interactive system monitoring.</subtitle>
  10    <subtitle>Development manifest</subtitle>
  11
  12    <author>Brenno J.S.A.A.F. de Winter, De Winter Information Solutions</author>
  13    <author>Arjen Baart, Andromeda Technology &amp; Automation</author>
  14    <date>November 07, 2002.</date>
  15    <docinfo>
  16       <infoitem label="Version">0.21</infoitem>
  17    </docinfo>
  18
  19 </titlepage>
  20
  21 <toc/>
  22
  23 <chapter>
  24    <heading>About this document.</heading>
  25
  26 <para>
  27 This document describes the technical specifications for the Gnucomo project.
  28 It will describe the functionality achieved, design specifications and choices made.
  29 The document will be the manifest for the developers to work in the same direction
  30 and not run into unneeded disappointments.
  31 </para>
  32
  33 <section>
  34   <heading>History of the document.</heading>
  35
  36 <table cpos='lp{3cm}lp{5cm}'>
  37   <thead>
  38     <col>Version</col><col>Author</col><col>Date</col><col>Remarks</col>
  39   </thead>
  40   <row>
  41     <col>0.l</col><col>Brenno de Winter</col><col>Jul 11, 2002</col>
  42     <col>
  43       Initial version
  44     </col>
  45   </row>
  46   <row>
  47     <col>0.11</col><col>Arjen Baart</col><col>Jul 12, 2002</col>
  48     <col>
  49       Additional guidelines and dataflow diagram.
  50     </col>
  51   </row>
  52   <row>
  53     <col>0.12</col><col>Brenno de Winter</col><col>Jul 15, 2002</col>
  54     <col>
  55       Database design added
  56     </col>
  57   </row>
  58   <row>
  59     <col>0.13</col><col>Arjen Baart</col><col>Jul 16, 2002</col>
  60     <col>
  61       Entity-relationship model added.
  62     </col>
  63   </row>
  64   <row>
  65     <col>0.14</col><col>Brenno de Winter</col><col>Jul 17, 2002</col>
  66     <col>
  67       Based on feedback. Small changes to the datamodel and finishing touches
  68       in lay-out of the tables. Added some examples.
  69     </col>
  70   </row>
  71   <row>
  72     <col>0.15</col><col>Brenno de Winter, Arjen Baart</col><col>Jul 21, 2002</col>
  73     <col>
  74       Additional feedback processed, indexes added, ERD added and SQL-script created.
  75     </col>
  76   </row>
  77   <row>
  78     <col>0.16</col><col>Brenno de Winter</col><col>Aug 7, 2002</col>
  79     <col>
  80       Communication handling added.
  81     </col>
  82   </row>
  83   <row>
  84     <col>0.17</col><col>Brenno de Winter</col><col>Aug 11, 2002</col>
  85     <col>
  86       <para>* Description of the client-side for communications.</para>
  87       <para>* Several updates to the database descriptions, drawings added.</para>
  88       <para>* More work on the installation chapter.</para>
  89       <para>* Created an extra field to the unprocessed_log table and added
  90               a between the table service and unprocessed_log.</para>
  91     </col>
  92   </row>
  93   <row>
  94     <col>0.18</col><col>Brenno de Winter, Peter Roozemaal</col><col>Aug 15, 2002</col>
  95     <col>
  96       <para>* Review done by Peter Roozemaal: adjusted intro and several clarifications made</para>
  97       <para>* Arjen Baart: Adjustments to database drawings</para>
  98       <para>* New installation recommendations</para>
  99     </col>
 100   </row>
 101   <row>
 102     <col>0.19</col><col>Arjen Baart</col><col>Aug 27, 2002</col>
 103     <col>
 104       Conversion to XMLDoc
 105     </col>
 106   </row>
 107   <row>
 108     <col>0.20</col><col>Arjen Baart</col><col>Oct 20, 2002</col>
 109     <col>
 110       Minor layout improvements
 111     </col>
 112   </row>
 113   <row>
 114     <col>0.21</col><col>Arjen Baart</col><col>Nov 07, 2002</col>
 115     <col>
 116       Installation instructions added.
 117       Combined chapters 4 through 7 into one chapter (4).
 118     </col>
 119   </row>
 120 </table>
 121
 122 </section>
 123 </chapter>
 124
 125 <chapter>
 126 <heading>Aim of the project.</heading>
 127
 128 <para>
 129 The number of log-files in a system and the tools in general do not make
 130 monitoring a system simple. Quite often there is so much information that
 131 attention for logfiles seems to fade away. For that reason monitoring routers
 132 and clients is often not an option. Instead of timely detection of problems,
 133 logs more often are used to find out what went wrong. When a system is
 134 under attack early signals can often easily be detected<footnote>Just as in
 135 real life there a signals that things are not going in the right direction.
 136 For the attacks on September 11th 2001 there were many signals available
 137 that could to have led to early detection: warnings of several intelligence
 138 agencies, warnings within the FBI, flight schools that report strange
 139 customers that want to steer a plane and don't seem to care about take
 140 off and landing, people opening accounts under fake names.</footnote>
 141 and preventive measures could have been taken if the time was only available.
 142 </para>
 143
 144 <para>
 145 The Gnucomo project is meant to make pro-active monitoring of computers
 146 and devices easier. It will contain a set of applications that will
 147 retrieve all types of monitoring information from devices and place
 148 it into a database. Devices can be server computers, desktop computers,
 149 PBX'es or other systems. By running checks the manual process of
 150 watching log files can be reduced. Also an intelligent script can
 151 see things that a human being will easy overlook. Gnucomo won't
 152 relieve an administrator of all manual work on log-files, but will
 153 increase the changes on actual monitoring.
 154 </para>
 155 <para>
 156 With all this data being available at one central location the gnucomo-server
 157 acts as some kind of black box for computer systems. If something does
 158 happen the evidence will be available at a remote location available
 159 for exploration<footnote>This analogy is based on a remarkable anecdote:
 160 One a trip to US I spoke to a 747-captain of Air France. While talking
 161 over several subjects we touched security. When we went some deeper I
 162 touched the subject gnucomo and he told me that Air France was doing
 163 the very same with real black boxes. By sending all the data to Paris
 164 errors can be detected earlier and be resolved. In any less fortunate
 165 case the cause of the crash might be detected sooner (or fuller).
 166 For me this was a signal there is a point in working gnucomo because
 167 the analogy is valid.</footnote>. Forensics will be made easier.
 168 Also the collected data is available from multiple locations make
 169 it easier to found more about an attack. The change that you overlook
 170 things will be reduced.
 171 </para>
 172 <para>
 173 Based on the entered data all sorts of analysis will be performed to discover
 174 abnormalities a normal maintenance tool or IDS wouldn't be looking at.
 175 An example could be a website in Dutch that suddenly obtains a lot of
 176 attention from Greek visitors (based on the location of their
 177 IP<footnote>That IP could also warn for other things like: excessive
 178 data traffic from wireless connections at times that you wouldn't be
 179 expecting traffic at all, absence of traffic when you would be expecting
 180 some traffic at least or even what article is liked in which part of the world,
 181 what regions poses the highest threat to the security of the system (based
 182 on the location of the IP address).</footnote>). These abnormalities will
 183 be presented as user-friendly as possible to increase awareness of the
 184 state of the system. By doing that the system can also be used for more
 185 complex analysis. One than can look at long-term trends like hacking
 186 attempts that take place, new exploits that are tried all of a sudden
 187 or signs of distributed attacks or a certain pattern of attempts<footnote>A portscan
 188 that last three days is hard to detect with a real-time IDS,
 189 while gnucomo would discover this anyhow. With correct intelligence
 190 one portscan from multiple IP-addresses can be related.</footnote>.
 191 </para>
 192 <para>
 193 Also extra data will be gathered where ever possible to save time to
 194 the administrator. If IP address attract attention of gnucomo the next
 195 logical step would be to use tools like dig, whois and visiting arin-related
 196 websites. This data will automatically be collected in an early stage and
 197 stored in the database.
 198 </para>
 199 <para>
 200 The results will be gathered in a warning system.
 201 Those warnings will be presented to the administrative person
 202 who is responsible for that particular machine or network.
 203 Having multiple systems in the system can add to the intelligence that
 204 can be gathered. The interface will be web-based and aimed at user-friendliness.
 205 </para>
 206 <para>
 207 Since multiple systems can enter data into the Gnucomo database more
 208 intelligent hardware and security detection can be done.
 209 When things do go wrong Gnucomo contains as much information as
 210 possible to figure out what happened and assist in the forensics.
 211 Since research on the signals afterwards is broader more attention
 212 will be given as much data as possible and do less filtering.
 213 </para>
 214 <para>
 215 With the data in the database also policies can be checked automatically
 216 retro-actively so that the security leaves some room to stretch some rules.
 217 This may sound not logic, because one of the main functions of security is
 218 to enforce rules. But some rules are made with the different meanings.
 219 For instance: a rule may be that private browsing isn't allowed.
 220 The background of such a rule might be to try and reduce the amount
 221 of data traffic (too many people downloading mp3's, or people not
 222 getting to work anymore). By monitoring that specific fact
 223 (bandwidth spent on non-business related Internet use)
 224 it's possible to be relaxed on that rule and enable many good-willing
 225 users reading his/hers daily newspaper.
 226 </para>
 227 <para>
 228 The scope of the project is clearly limited to monitoring and not to
 229 offer automated maintenance or web-based maintenance.
 230 There are other projects currently being able to provide that
 231 functionality. We will focus on intelligence and user-friendliness
 232 of representation of facts presented. A warning should trigger
 233 an administrator to get up and do something using the tools he or she values the most.
 234 </para>
 235 <para>
 236 Also we are not aiming to replace great tools like SNORT as a real-time IDS.
 237 These tools can do thing, that in the beginning won't be a part of gnucomo
 238 out of performance reasons. Also there is no need to duplicate what they
 239 already did. If that energy is placed in intelligent we're very complimentary.
 240 Gnucomo can however be a reality check on an existing NIDS (Network Intrusion
 241 Detection System). For instance if warnings keep coming it may be time to
 242 rethink the rules that have been set.
 243 </para>
 244
 245 <para>
 246 This evolves to the following list of functions gnucomo can provide:
 247 </para>
 248 <itemize>
 249   <item> Intrusion detection </item>
 250   <item> Detecting hacker attempts </item>
 251   <item> Early detection of system failures </item>
 252   <item> Exhaustion of system resources </item>
 253   <item> Capacity planning for future expansion </item>
 254   <item> Spotting bottlenecks in a system.  </item>
 255   <item> Verifying system integrity </item>
 256   <item> Assistance with troubleshooting </item>
 257   <item> Perform post-mortem forensics </item>
 258   <item> Incident response system.  </item>
 259 </itemize>
 260 </chapter>
 261
 262 <chapter>
 263    <heading>Decisions for the overall system.</heading>
 264
 265 <para>
 266 In order to get the project running we have to make some decisions before
 267 we can start. Of course are the decisions always open for review,
 268 but initially our main aim is to get a system running. This doesn't
 269 mean that we allow a lesser architecture, but more that we create an
 270 environment that will lead to results.
 271 </para>
 272 <para>
 273 The following decisions apply to the system in general:
 274 </para>
 275 <itemize>
 276   <item>
 277     The major part of the system will be used for security features.
 278     The solution itself has to be secure.
 279   </item>
 280   <item>
 281     In general we strive to be as platform and application independent as possible.
 282     However to achieve software to get ready and to assure progress some selections
 283     will have to be made excluding options for applications<footnote>An example is
 284     in the database. By using stored procedures and triggers MySQL cannot be used.
 285     However the data integrity at that point is more important than the ability to
 286     use MySQL.</footnote>. Where possible we will enable ports to other applications
 287     and platforms.
 288   </item>
 289   <item>
 290     The computers collecting the data will only be Linux machines,
 291     with future support for other Unices. However it is not aim our
 292     to port this part of the project to other platforms just now.
 293   </item>
 294   <item>
 295     The database system will make heavy use of stored procedures and
 296     triggers and thus lock out some less feature-full database.
 297   </item>
 298   <item>
 299     Although we're not married to a database system initially this will be
 300     PostgreSQL only so that we can build for results. The code however
 301     shouldn't be build to deliberately lock outer systems.
 302     Other database that might be interesting to add: DB2, Oracle
 303     (if the rainfall of security advisories seems to be over) and Informix.
 304   </item>
 305   <item>
 306     The interface for the user will be a web-interface written in PHP
 307     with PostgreSQL-database access. Despite the fact that initially
 308     this will be the preferred way to communicate with our system,
 309     other interfaces are welcome and should be supported.
 310   </item>
 311   <item>
 312     The technologies used for the daemons on the central site and remote
 313     site are open for discussion. A decision is made when it is clear what
 314     exactly will be needed to code.
 315   </item>
 316   <item>
 317     The original logfiles on systems will not be harmed in any way,
 318     but will be saved the way they presented to gnucomo.
 319   </item>
 320   <item>
 321     In the database processed data as well as raw data will be stored.
 322   </item>
 323   <item>
 324     Our main aim is to ease the life of the administrator when dealing with
 325     the symptoms of a machine so that he doesn't miss important notifications.
 326     The project will be made around detection. We won't focus on making a
 327     maintenance applications but solely on monitoring, because other applications
 328     like webmin or linuxconf do already deliver such functionality.
 329     We are complementary to those applications. This doesn't mean that
 330     the system cannot send SMS'es, e-mails or make alarms sound.
 331   </item>
 332   <item>
 333     Any output of the logbook will be stored and sent within a certain
 334     interval which can be set. By doing that the mechanism will not flood
 335     the total mechanism and overload machines.
 336   </item>
 337   <item>
 338     When applications for gnucomo we will try and do the non-server part
 339     as platform independent as possible. This in order to prevent writing
 340     a same application multiple times. For instance one for Unices, one
 341     for Macintosh and one for Microsoft.
 342   </item>
 343   <item>
 344     To ensure the quality of software and to prevent any unwanted functionality
 345     rolling into the project all code will be reviewed by one of the lead members
 346     before it is accepted. Since this project is aimed at throughput speed no
 347     formal procedures will be enforced, but we promise not to let software in
 348     that hasn't been checked.
 349   </item>
 350 </itemize>
 351
 352 </chapter>
 353
 354 <chapter>
 355   <heading>Overall system Architecture</heading>
 356
 357 <para>
 358 The overall systems aims to make maintenance data better accessible and by
 359 doing that lowering the barrier to be on alert for intrusions,
 360 system failure and other misery that can happen to computer systems.
 361 Also more systems can be monitored and even focus can be placed on desktop computers,
 362 something that nowadays rarely happens. Since the solution is only aimed at
 363 monitoring (with some responses possible) other people can watch their system(s)
 364 without being Administrator<footnote>This can be interesting for people using
 365 this service and not doing their own maintenance (smaller companies).
 366 If technical action needs to be taken a warning can be send to an administrator.
 367 This saves costs and time.</footnote>.
 368 </para>
 369 <para>
 370 The main system will know to sides:
 371 </para>
 372
 373 <itemize>
 374   <item> Central Application - server </item>
 375   <item> Monitored System - client </item>
 376 </itemize>
 377
 378 <para>
 379 The project has been setup as a two sided system in order to be able to
 380 guard many computers at the same time.
 381 However it may be obvious that both sides of the application can very
 382 well be installed on a single system.
 383 </para>
 384 <para>
 385 When events<footnote>A signal can be the outcome of process that finished,
 386 logbook entries, warnings from intrusion detection systems,
 387 etc. </footnote> happen they will be stored in a file.
 388 When this file is delivered to a certain directory a daemon will detect
 389 this and start the transfer of the file. The file will be transferred
 390 to the central application or the client. This transfer will be triggered
 391 immediately after a process has finished or with a certain time-interval
 392 when it concerns a logbook. All output will be placed in a directory where
 393 the daemon detects it and ensures the transport. For transport currently
 394 only two mechanisms will be supported:
 395 </para>
 396 <itemize>
 397   <item>
 398     Encrypted file copy relying on the SSH protocol.
 399     On Unix-based systems this will scp (secure copy).
 400   </item>
 401   <item>
 402     E-Mail. The e-mail is encrypted and signed using gpg and then sent to the server.
 403     Since the file format will identify the type-of-output the Subject-field of
 404     the e-mail is not really needed.
 405   </item>
 406 </itemize>
 407
 408 <section>
 409   <heading>Central Application: signal handler.</heading>
 410
 411 <para>
 412 <para>
 413
 414   <picture src="architecture.png" eps="architecture"/>
 415        Illustration 1 Basic overview of the processes on the server.
 416 </para>
 417
 418 On one machine signals from the network will come in.
 419 These signals can be logfiles, result files from applications,
 420 remarks entered by the administrator or whatever.
 421 Data delivery takes place into a certain directory.
 422 A daemon detects that data has come in and will enter it into the database.
 423 Once in the database stored procedures and triggers will recognize certain
 424 behavior and generate alerts. The user responsible for the server will be
 425 confronted with the alerts and can mark them, add comments to it or ignore them.
 426 Also it will be possible to do intelligent analysis on not so logical relations
 427 per computer or across computers<footnote>A good example could be a portscan
 428 on a system that takes place during a week. Normal a simple portscan takes
 429 place in a couple of minutes and will thus be easy to detect.
 430 By taking a longer period such a scan is harder to detect. </footnote>. Such
 431 scripts make detection possible, that is too time consuming to do during
 432 processing of the data.
 433 </para>
 434 </section>
 435
 436 <section>
 437   <heading>Data processing.</heading>
 438
 439 <para>The data processing has four tasks:</para>
 440 <itemize>
 441   <item>
 442     Extracting data from e-mail and store it in the input-buffer.
 443     This can be done by a daemon that checks the e-mail<footnote>It would be logical
 444     to place an e-mail server like sendmail or postfix on the server.
 445     In many cases the monitored computer will be featuring a SMTP daemon.
 446     If a system is comprimised no evidence that comes through will be really
 447     trustworthy. By sending it to another machine all evidence that is
 448     available will have left the system the moment a hack takes place.</footnote>
 449     with a certain interval extracts the e-mails and leave the content
 450     in a file in the input buffer. This daemon has only rights to write
 451     to the directory it has to write to. <emph>We may as well have the
 452     email captured directly by a program with a
 453     "gnucomo: |/usr/local/bin/gnucomo-input" - like alias.</emph>
 454   </item>
 455   <item>
 456     Detect files in the input buffer decrypt the content and verify the signature.
 457     Another daemon will see the log-files and starts checking if the origin is
 458     correct (by verifying the signature) and decrypting the content.
 459     The legible files will be processed by entering the data into the database.
 460   </item>
 461   <item>
 462     The database will accept the data and perform a certain number of
 463     checks as the data comes in. During the processing of the data
 464     abnormalities will be detected and entered into a notification table.
 465     The database system will also carry out more complex tasks on given
 466     moments in time and enter them as well in the notification table.
 467   </item>
 468   <item>
 469     The database system must be able to undertake action when high
 470     alerts are being entered into the database.
 471     This can be a couple of things to begin with:
 472     send an e-mail or SMS. In a later stage other technologies may be added as well.
 473     In this scheme we also make a possibility to escalate problems when no
 474     action is taken in a certain amount of time.
 475   </item>
 476 </itemize>
 477 </section>
 478
 479 <section>
 480   <heading>Web interface.</heading>
 481
 482 <para>
 483 The web interface will used to interact with the user.
 484 The interface should be intuitive and easy to understand.
 485 More important warnings should directly draw attention.
 486 The user must be able to perform settings so that warnings
 487 can be rated differently than the original settings.
 488 </para>
 489 <para>
 490 The interface will do the following things:
 491 </para>
 492 <itemize>
 493   <item>
 494     Show a list of warnings that are currently open.
 495   </item>
 496   <item>
 497     It must be possible to sort the list on all the fields shown.
 498   </item>
 499   <item>
 500     Deliver detailed information (logbook entries) upon request that have led to the warning.
 501   </item>
 502   <item>
 503     Undertake certain actions like sending
 504     <reference href="mailto:abuse@internet-provider.net">abuse@internet-provider.net</reference>
 505     e-mails with information.
 506   </item>
 507   <item>
 508     Monitor actions on outstanding issues.
 509   </item>
 510 </itemize>
 511 <para/>
 512 </section>
 513
 514 <section>
 515   <heading>Priority mechanism.</heading>
 516 <para>
 517 Each notification has a certain priority that requires a different handling
 518 of the issue. How each priority will be dealt with is something that can
 519 be set per server. The priority mechanism is a simple system of five
 520 categories (can be more or less).
 521 </para>
 522 <para/>
 523 </section>
 524
 525 <section>
 526   <heading>The dataflow diagram.</heading>
 527 <para>The main dataflow will be as follows.</para>
 528 <para>
 529   <picture src="dataflow.png" eps="dataflow" scale="0.7"/>
 530 </para>
 531 <para/>
 532 </section>
 533
 534 <section>
 535   <heading>Sending messages to the central gnucomo system.</heading>
 536
 537 <para>
 538 One of the main tasks is getting all the messages to the database.
 539 Ultimately gnucomo will support multiple ways of receiving the data.
 540 Basically anything goes, but two mechanisms will be supported in the project
 541 to begin with:
 542 </para>
 543 <enumerate>
 544     <item>
 545       E-mail. Messages and elements from logfiles will be sent through e-mail.
 546     </item>
 547     <item>
 548       File copy. Using technologies like scp or ftp (not preferred due to
 549       the insecure nature) can place files directly in the receiving directory.
 550     </item>
 551 </enumerate>
 552
 553 <subsection>
 554   <heading>Ensuring data integrity.</heading>
 555 <para>&lt;TO BE DESCRIBED&gt;</para>
 556 </subsection>
 557
 558 <subsection>
 559   <heading>Directories and filenames on the server.</heading>
 560
 561 <para>
 562 Files will be dealt with as if gnucomo were a user (actually there will
 563 be a user gnucomo). The files will be placed in the <code>/home/gnucomo/</code> directory.
 564 Only <code>/home/gnucomo/incoming/dropbox/</code> can be used to save data in
 565 from external systems. All other directories are only available for the user gnucomo.
 566 The filename will represent the data that is received. The details are seperated with
 567 underscores. When data is sent by e-mail the filename will be written in the first
 568 line of the e-mail. A typical filename looks like this:
 569 </para>
 570
 571 <para>
 572 <strong>3_messages_20020807235208_1.asc</strong>
 573 </para>
 574
 575 <para>
 576 the logic behind this is following:
 577 </para>
 578
 579 <para>
 580 <emph>urgency_typeofmessage_timestamp_objectid.typeoffile.</emph>
 581 </para>
 582
 583 <table cpos='lp{10cm}'>
 584   <thead>
 585     <col>
 586       <para>Part of filename</para>
 587     </col>
 588     <col>
 589       <para>Explanation</para>
 590     </col>
 591   </thead>
 592   <row>
 593     <col>
 594       <para>Urgency</para>
 595     </col>
 596     <col>
 597       <para>This indicates the urgency of the file. The lower the number the higher
 598             it will rank when an overview is given. Standard files are ranked value 3.
 599             The ranking works as follows:</para>
 600       <para>* 1 <strong>Urgent flash message.</strong> Something urgent needs to
 601             be reported. This is only used for emergencies like serious alarms.</para>
 602       <para>* 2 <strong>Rapid delivery.</strong> An important message has to get
 603             through that is more important than normal delivery, but is not top
 604             priority like an emergency.</para>
 605       <para>* 3 <strong>Normal.</strong> This is used in most
 606             case for normal messages.</para>
 607       <para>* 4 <strong>Low priority.</strong> This is data would be useful
 608             to place into the system as nice to have.</para>
 609     </col>
 610   </row>
 611   <row>
 612     <col>
 613       <para>TypeOfMessage</para>
 614     </col>
 615     <col>
 616       <para>This is an indicator what type of data is delivered to gnucomo.
 617             There are several categories:</para>
 618       <para>* <strong>cron.</strong> This data comes from the /var/log/cron-log (unix).</para>
 619       <para>* <strong>httpaccess.</strong> This data comes from the normal http-log (Apache).</para>
 620       <para>* <strong>httperror.</strong> This data comes from the http_error-log (Apache).</para>
 621       <para>* <strong>maillog.</strong> This data comes from the /var/log/maillog (unix).</para>
 622       <para>* <strong>messages.</strong> The data delivered here comes from
 623             the /var/log/messages file (unix)</para>
 624       <para>* <strong>text.</strong> This file contains a message in plaintext
 625             generated by a gnucomo-client and can be anything.
 626             It will be dealt with as plaintext.</para>
 627     </col>
 628   </row>
 629   <row>
 630     <col>
 631       <para>Timestamp</para>
 632     </col>
 633     <col>
 634       <para>The timestamp is made in war-log (YYYYMMDDHHMMSS) format.
 635             The timestamp is generated on the client in GMT (to discover
 636             discrepancies in timing).</para>
 637     </col>
 638   </row>
 639   <row>
 640     <col>
 641       <para>Objectid</para>
 642     </col>
 643     <col>
 644       <para>The objectid is the id that is used within the central
 645             gnucomo system to recognize the client.
 646             Based on this entry the database can link the data to the correct object.
 647             Also gpg can obtain the correct e-mail address (by running a query
 648             in the database) for verification of the signature of the crypted message.</para>
 649     </col>
 650   </row>
 651   <row>
 652     <col>
 653       <para>TypeOfFile</para>
 654     </col>
 655     <col>
 656       <para>Indicates the file type:</para>
 657       <para>* <strong>asc.</strong> Plaintext ASCII</para>
 658       <para>* <strong>gpg.</strong> gpg-crypted data.</para>
 659       <para>* <strong>und.</strong> Undertermined data. When files
 660             come in by e-mail it is not 100% sure if they are crypted
 661             or not. These data has first to be analyzed before it is
 662             moved to the correct queue. </para>
 663     </col>
 664   </row>
 665 </table>
 666
 667 <subsubsection>
 668   <heading>Directory for incoming data.</heading>
 669
 670 <para>
 671 For incoming messages there will be separate directories
 672 (<code>/home/gnucomo/incoming/</code>)for:
 673 </para>
 674 <enumerate>
 675     <item>
 676       Dropbox. This directory is ready to receive data from all sorts of systems.
 677       This directory is world writeable (<strong><emph>but not deleteable!</emph></strong>):
 678       <code>/home/gnucomo/incoming/dropbox/</code>
 679     </item>
 680     <item>
 681       Encrypted messages. In this directory messages will be placed that are still
 682       gpg-crypted. In this directory the files await decryption and verification of
 683       the signature. This directory is: <code>/home/gnucomo/incoming/crypted/</code>
 684     </item>
 685     <item>
 686       Decrypted with errors. During the decryption exercise anything can go wrong.
 687       Decrypting can fail or the signature may show errors. If this happens the
 688       original message is moved to a different directory:
 689       <code>/home/gnucomo/incoming/cryptfail/</code>
 690     </item>
 691     <item>
 692       Inbox. After successful decryption the decrypted message is moved to the inbox.
 693       Data that is not encrypted can be moved here from the dropbox after certain
 694       verifications. The directory is: <code>/home/gnucomo/incoming/inbox/</code>
 695     </item>
 696     <item>
 697       Processed. After processing the data the file is stored in the directory
 698       processed for further reference for a certain amount of time.
 699       The directory is: <code>/home/gnucomo/incoming/processed/</code>
 700     </item>
 701     <item>
 702       Archive. After a certain period the files will be archived.
 703       Since not every system will archive everything this directory may
 704       also be a symbolic link to <code>/dev/null</code>.
 705       The used directory is: <code>/home/gnucomo/archive/</code>
 706     </item>
 707 </enumerate>
 708 </subsubsection>
 709
 710 <subsubsection>
 711    <heading>Directory for outgoing data.</heading>
 712
 713 <para>
 714 For outgoing messages the directory <code>/home/gnucomo/outgoing</code> will
 715 be used. This directory knows a couple of sub directories:
 716 </para>
 717
 718 <enumerate>
 719     <item>
 720       Dropbox. This directory is used by the central gnucomo system to
 721       place outgoing messages in.
 722       The used directory is: <code>/home/gnucomo/outgoing/dropbox/</code>
 723     </item>
 724     <item>
 725       Outbox. After processing the message (including signing and encrypting
 726       when applicable) the messages are placed in the outbox:
 727       <code>/home/gnucomo/outgoing/outbox/</code>
 728     </item>
 729     <item>
 730       Processed. After processing the data the file is stored in the
 731       directory processed for further reference for a certain amount
 732       of time. After sending a message a confirmation will be made that
 733       is saved as an incoming message.
 734       The directory is: <code>/home/gnucomo/outgoing/processed/</code>
 735     </item>
 736     <item>
 737       Archive. After a certain period the files will be archived.
 738       Since not every system will archive everything this directory
 739       may also be a symbolic link to <code>/dev/null</code>.
 740       The used directory is: <code>/home/gnucomo/archive/</code>
 741     </item>
 742 </enumerate>
 743
 744 </subsubsection>
 745
 746 <subsubsection>
 747    <heading>Overview. </heading>
 748
 749 <para>The total directory-structure looks like this:</para>
 750
 751 <verbatim>
 752     /home/gnucomo/
 753     /home/gnucomo/archive
 754     /home/gnucomo/incoming
 755     /home/gnucomo/incoming/crypted
 756     /home/gnucomo/incoming/cryptfail
 757     /home/gnucomo/incoming/dropbox
 758     /home/gnucomo/incoming/inbox
 759     /home/gnucomo/incoming/processed
 760     /home/gnucomo/outgoing
 761     /home/gnucomo/outgoing/dropbox
 762     /home/gnucomo/outgoing/outbox
 763     /home/gnucomo/outgoing/processed
 764 </verbatim>
 765
 766 </subsubsection>
 767 </subsection>
 768
 769 <subsection>
 770   <heading>Directories on the client-side.</heading>
 771
 772 <para>
 773 On the client-side the files that need to be transmitted will be placed in a
 774 directory system as well. In the future this system may not be in use at all
 775 devices (routers, certain MS Windows-machine, IP Telephones, etc.). For those
 776 systems a different mechanism will become be described here.
 777 Initially we focus on Linux systems that will enter data into the database.
 778 </para>
 779 <para>
 780 The filename convention will be totally identical to the filename
 781 convention on the server, since this the same mechanism.
 782 </para>
 783 <para>
 784 To facilitate gnucomo client and server on one and the same machine
 785 the gnucomo-client should have a different default user.
 786 For this purpose the user <strong>gcm_client</strong> will be created.
 787 </para>
 788
 789 <subsubsection>
 790    <heading>Directory for incoming data.</heading>
 791 <para>
 792 For incoming messages there will be separate directories
 793 (<code>/home/gnucomo/incoming/</code>)for:
 794 </para>
 795 <enumerate>
 796     <item>
 797       Dropbox. This directory is ready to receive data from all sorts of systems.
 798       This directory is world writeable (<emph><strong>but not deleteable!</strong></emph>):
 799       <code>/home/gcm_client/incoming/dropbox/</code>
 800     </item>
 801     <item>
 802       Encrypted messages. In this directory messages will be placed that
 803       are still gpg-crypted. In this directory the files await decryption
 804       and verification of the signature.
 805       This directory is: <code>/home/gcm_client/incoming/crypted/</code>
 806     </item>
 807     <item>
 808       Decrypted with errors. During the decryption exercise anything can go wrong.
 809       Decrypting can fail or the signature may show errors.
 810       If this happens the original message is moved to a different directory:
 811       <code>/home/gcm_client/incoming/cryptfail/</code>
 812     </item>
 813     <item>
 814       Inbox. After successful decryption the decrypted message is moved
 815       to the inbox. Data that is not encrypted can be moved here from
 816       the dropbox after certain verifications. The directory is:
 817       <code>/home/gcm_client/incoming/inbox/</code>
 818     </item>
 819     <item>
 820       Processed. After processing the data the file is stored
 821       in the directory processed for further reference for a
 822       certain amount of time. The directory is:
 823       <code>/home/gcm_client/incoming/processed/</code>
 824     </item>
 825 </enumerate>
 826
 827 </subsubsection>
 828
 829 <subsubsection>
 830    <heading>Directory for outgoing data.</heading>
 831
 832 <para>
 833 For outgoing messages the directory <code>/home/gcm_client/outgoing</code> will be used.
 834 This directory knows a couple of sub directories:
 835 </para>
 836 <enumerate>
 837     <item>
 838       Dropbox. This directory is used by the central gnucomo system to place
 839       outgoing messages in.
 840       The used directory is: <code>/home/gcm_client/outgoing/dropbox/</code>
 841     </item>
 842     <item>
 843       Outbox. After processing the message (including signing and
 844       encrypting when applicable) the messages are placed in the outbox:
 845       <code>/home/gcm_client/outgoing/outbox/</code>
 846     </item>
 847     <item>
 848       Processed. After processing the data the file is stored in the
 849       directory processed for further reference for a certain amount
 850       of time. After sending a message a confirmation will be made
 851       that is saved as an incoming message.
 852       The directory is: <code>/home/gcm_client/outgoing/processed/</code>
 853     </item>
 854 </enumerate>
 855 </subsubsection>
 856
 857 <subsubsection>
 858   <heading>Overview. </heading>
 859     <para>The total directory-structure looks like this:</para>
 860
 861 <verbatim>
 862     /home/gcm_client/
 863     /home/gcm_client/archive
 864     /home/gcm_client /incoming
 865     /home/gcm_client/incoming/crypted
 866     /home/gcm_client/incoming/cryptfail
 867     /home/gcm_client/incoming/dropbox
 868     /home/gcm_client/incoming/inbox
 869     /home/gcm_client/incoming/processed
 870     /home/gcm_client/outgoing
 871     /home/gcm_client/outgoing/dropbox
 872     /home/gcm_client/outgoing/outbox
 873     /home/gcm_client/outgoing/processed
 874 </verbatim>
 875 </subsubsection>
 876 </subsection>
 877 </section>
 878
 879 <section>
 880       <heading>Getting data into the database.</heading>
 881
 882 <para>
 883 The files in the /home/gnucomo/incoming/inbox/ should be stored in the database.
 884 For this purpose there is a table <emph>unprocessed_log</emph>.
 885 The data of the filename as well as the content of the file need
 886 to be placed in one record.
 887 </para>
 888 <para>
 889 There are some fields that have to be addressed immediately:
 890 </para>
 891 <enumerate>
 892     <item>
 893       Servicecode: The servicecode will be obtained out of the filename the
 894       is the type_of_message-field in the filename.
 895     </item>
 896     <item>
 897       Objectid: This data is given in the filename it can be found
 898       in the <emph>objectid</emph>-part of the filename.
 899     </item>
 900     <item>
 901       Logdata: The data is saved as follows: filename (unaltered)
 902       &lt;CR&gt;textual data of the file.
 903     </item>
 904 </enumerate>
 905 <para>
 906 The daemon application that delivers the data is called <strong>gcm-input</strong>.
 907 It performs the following steps with no extra functionality:
 908 </para>
 909
 910 <enumerate>
 911     <item>
 912       <para>Detect if a file is available.</para>
 913     </item>
 914     <item>
 915       <para>Write the data in the database.</para>
 916     </item>
 917 </enumerate>
 918
 919 <para>
 920 To write the data in the database a database user gcm_input exists.
 921 This user has only the right to enter data into the database.
 922 There are no deletion, update or select-permissions.
 923 </para>
 924
 925 </section>
 926 </chapter>
 927
 928 <chapter>
 929   <heading><label name='database'/>The database.</heading>
 930
 931 <para>
 932 The database is the heart of the system.
 933 It will contain all event-data of multiple computers.
 934 The intelligence that can be performed on the database will be placed there.
 935 To do this as integratedly as possible stored procedures and triggers will be used.
 936 To begin with we have selected checks to be performed that will be
 937 expanded throughout time.
 938 </para>
 939 <para>
 940 Since the gnucomo database and files contain sensitive data
 941 security measures have to be in place. Several database users
 942 will exist that have limited rights to perform a certain task
 943 ensuring some protection against unauthorized access.
 944 However these mechanisms on it's own will work fine, bad maintenance may still
 945 screw-up good security. Good database maintenance is needed.
 946 For the gnucomo the protection of the valid authentic nature of
 947 the data in the database has our highest priority.
 948 </para>
 949 <para>
 950 A <emph>table-name</emph> in this chapter is written in cursive writing.
 951 </para>
 952
 953 <section>
 954   <heading>Database conventions.</heading>
 955
 956 <para>
 957 The database will be built according the following conventions:
 958 </para>
 959 <itemize>
 960   <item>
 961     All names for tables, indexes and fields will be written in lower
 962     case and will be singular. Spaces in names are not allowed.
 963   </item>
 964   <item>
 965     If a table contains field referring to other tables the mother-tables are
 966     mentioned in alphabetical order with an underscore between the table-names.
 967     So <emph>object</emph> and <emph>user</emph>
 968     will make a third table <emph>object_user</emph>
 969   </item>
 970   <item>
 971     A data access user (being the interface) is not allowed to write to
 972     the log-entries and the warnings. To change the state of a warning
 973     a stored procedure will do so by having a different entry in a table.
 974     This should make it possible to discover who did what at which moment in time.
 975   </item>
 976   <item>
 977     The name of two related fields that make the relationship between two
 978     tables will be the same to avoid confusion.
 979   </item>
 980 </itemize>
 981 </section>
 982
 983 <section>
 984   <heading>Database design.</heading>
 985
 986 <para>
 987 In the design we anticipate to deliver an as best as possible database performance.
 988 That means that data that needs to be entered occasionally can be heavily indexed
 989 to increase performance. However data that is mainly stored will only be indexed
 990 marginally to have the best possible performance on data entry. If during one of
 991 the checks on data-entry a notification is made, the information related to that
 992 notification will be indexed very well to increase retrieval performance.
 993 What we will try to avoid is that the user interface will cause full table
 994 scan and affect the performance of the overall system dramatically.
 995 One of the techniques to increase performance on display is to work with views.
 996 So where it is feasible we will use them.
 997 </para>
 998
 999 <para>
1000 The following model pictures the database as described in the remainder
1001 of this chapter.
1002 </para>
1003 <para>
1004       <picture src="erd.png" eps="erd" scale="0.7"/>
1005 </para>
1006
1007 <para>
1008 In general the database must also be maintained well.
1009 So daily maintenance scripts should keep the performance good<footnote>PostgreSQL seems
1010 to have very good features to do proper maintenance and they have to be exploited to
1011 the full extend.</footnote>.
1012 </para>
1013
1014 </section>
1015 <section>
1016   <heading>Actual design.</heading>
1017
1018 <para>
1019 In this part of the chapter the tables will be explained and then described
1020 with all important elements. Per table a sub-chapter will be created.
1021 Each table will have a table design, indexes, relationships and the required data
1022 (for those tables where the data itself is relevant in the design or sample data
1023 (for those cases where no set data is needed). For the relationships beside a
1024 description the subset of the total schema has been incorporated in
1025 the document so that it is more clear what exactly is meant.
1026 Due to the complex nature of the design those drawings sometimes will seem funny.
1027 </para>
1028 <para>
1029 For the fieldtypes the types of PostgreSQL will be used.
1030 These values can be found in Chapter 3 of the PostgreSQL User Manual
1031 (<reference href="http://www.postgresql.org/">http://www.postgresql.org</reference>).
1032 </para>
1033 <para>
1034 For indexes primary keys are always <emph>unique</emph> and called
1035 primary key in the name. Since unique indexes within PostgreSQL only
1036 work on B-Tree indexes (which is default) we will use B-Tree for all indexes.
1037 In cases where an exception is made the used type of index will be indicated
1038 in the characteristics. A footnote will explain why a different type of
1039 index has been selected.
1040 </para>
1041
1042 <subsection>
1043 <heading>action</heading>
1044
1045 <para>
1046 In the table action all recognized actions that can be taken are stored.
1047 Several actions will lead to change in <emph>statuscode</emph>.
1048 However this doesn't apply to all actions<footnote>A status NEW
1049 of a notification that cannot be dealt with automatically will
1050 <strong>not</strong> change before a user looked at it.</footnote>.
1051 Actions take place through background processes and the interface.
1052 This table mainly is used for retrieval so indexing will be done as much as possible.
1053 </para>
1054
1055 <subsubsection>
1056   <heading>The fields.</heading>
1057
1058 <para>
1059 The table below describes the fields:
1060 </para>
1061 <para/>
1062 <para>
1063 <table cpos='lllp{6cm}'>
1064   <thead>
1065     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1066     <col>
1067       Remarks
1068     </col>
1069   </thead>
1070   <row>
1071     <col> actionid </col> <col> Bigserial </col> <col> 8 </col>
1072     <col>
1073       Autonumber bigint (eight bit)
1074     </col>
1075   </row>
1076   <row>
1077     <col> actionname </col> <col> Text </col> <col> <para/> </col>
1078     <col>
1079       Short descriptive name for the type of action
1080     </col>
1081   </row>
1082   <row>
1083     <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
1084     <col>
1085       New status that will be given to a notification when this action takes place.
1086     </col>
1087   </row>
1088   <row>
1089     <col> description </col> <col> Text </col> <col> <para/> </col>
1090     <col>
1091       A longer description (without limit) on the action.
1092     </col>
1093   </row>
1094 </table>
1095 </para>
1096
1097 </subsubsection>
1098
1099 <subsubsection>
1100   <heading>The indexes.</heading>
1101
1102 <para>
1103 Indices for this table are:
1104 </para>
1105     <table cpos='lll'>
1106       <thead>
1107         <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1108       </thead>
1109       <row>
1110         <col> act_pk </col> <col> actionID </col> <col> Primary key </col>
1111       </row>
1112       <row>
1113         <col> act_actionname </col> <col> actionname </col> <col> Unique </col>
1114       </row>
1115       <row>
1116         <col> act_statuscode </col> <col> statuscode </col> <col> <para/> </col>
1117       </row>
1118     </table>
1119     <para/>
1120
1121 </subsubsection>
1122 <subsubsection>
1123   <heading>The relationships.</heading>
1124
1125 <para>
1126 Relationships with other tables:
1127 </para>
1128     <table cpos='llp{7cm}'>
1129       <thead>
1130         <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
1131       </thead>
1132       <row>
1133         <col> actionid </col> <col> action_notification_user </col>
1134         <col>
1135           Each action that takes place will be log. The Actionid will bring
1136           classification to the individual records. This relationship has to be enforced.
1137         </col>
1138       </row>
1139     </table>
1140     <para>In the model this looks like this:</para>
1141     <para>
1142       <picture src="erd-action.png" eps="erd-action"/>
1143     </para>
1144 </subsubsection>
1145
1146 <subsubsection>
1147   <heading>Default data in table.</heading>
1148
1149 <para>
1150 The data in this table is standard for the system and part of the design.
1151 The user cannot change this or add value to it.
1152 </para>
1153
1154 <table cpos='p{1cm}p{2cm}p{1.5cm}p{6cm}'>
1155   <thead>
1156     <col>Actionid</col><col>Actionname</col><col>Statuscode</col>
1157     <col>
1158       Description
1159     </col>
1160   </thead>
1161   <row>
1162     <col>1</col><col>Entry in the system</col><col>NEW</col>
1163     <col>
1164       This indicates that a notification is entered into the system. The status is a <strong>NEW</strong>.
1165     </col>
1166   </row>
1167   <row>
1168     <col>2</col><col>Displayed to user</col><col>OPN</col>
1169     <col>
1170       The notification has been displayed to the user.
1171       It is not guaranteed that the user has read the notification,
1172       but he/she should be aware of it.
1173       The status will now be changed to <strong>OPEN</strong> if the current
1174       status is <strong>NEW</strong>.
1175     </col>
1176   </row>
1177   <row>
1178     <col>3</col><col>Remarks added</col><col>PEN</col>
1179     <col>
1180       Remarks have been added to the notification. The status has now been
1181       changed to <strong>PENDING</strong>.
1182     </col>
1183   </row>
1184   <row>
1185     <col>4</col><col>Priority changed manually</col><col>PEN</col>
1186     <col>
1187       The priority of the notification has been changed by the user.
1188       The new status is now <strong>PENDING</strong>.
1189     </col>
1190   </row>
1191   <row>
1192     <col>5</col><col>Priority changed automatically</col><col>PEN</col>
1193     <col>
1194       The priority of the notification has been changed by the system.
1195       If the status is not <strong>OPEN</strong> or <strong>NEW</strong> the new
1196       status is become <strong>PENDING</strong>.
1197     </col>
1198   </row>
1199   <row>
1200     <col>6</col><col>Action taken</col><col>PEN</col>
1201     <col>
1202       A action has been taken. The status is now <strong>PENDING</strong>.
1203     </col>
1204   </row>
1205   <row>
1206     <col>7</col><col>Assignment to user</col><col>PEN</col>
1207     <col>
1208       A notification has been explicitly assigned to another user.
1209       The status is now <strong>PENDING</strong>.
1210     </col>
1211   </row>
1212   <row>
1213     <col>8</col><col>More information or research needed.</col><col>INV</col>
1214     <col>
1215       The notification is relevant and will be handled, however more information
1216       or research will be needed. The status is <strong>UNDER INVESTIGATION</strong>.
1217     </col>
1218   </row>
1219   <row>
1220     <col>9</col><col>Make output reference.</col><col>REF</col>
1221     <col>
1222       Automated output from an object has been sent to gnucomo.
1223       The input has been identified as a valid reference for future.
1224       Status is now <strong>REFERENCE</strong><footnote>A reference is used to
1225       find differences in output. This feature must reduce the number of wrongful alerts.
1226       Only if a change has taken place a notification is generated.
1227       First time reports will always generate a notification.
1228       By signing this off the system will be silent again.</footnote>.
1229     </col>
1230   </row>
1231   <row>
1232     <col>10</col><col>Job output no longer reference.</col><col>CLS</col>
1233     <col>
1234       By making a newer job output reference this output has been obsoleted.
1235       Since once it was a reference the notification can be closed.
1236       The new status for the notification is now <strong>CLOSED</strong>.
1237     </col>
1238   </row>
1239   <row>
1240     <col>11</col><col>Action taken please verify.</col><col>VRF</col>
1241     <col>
1242       An action has been taken and things should have been resolved.
1243       Before the notification can be closed a verification has to be done.
1244       New status is now <strong>VERIFY</strong>.
1245     </col>
1246   </row>
1247   <row>
1248     <col>12</col><col>Action not accepted.</col><col>PEN</col>
1249     <col>
1250       A check has been done and the results were not good.
1251       New verification is needed.
1252       New status is now <strong>PENDING</strong>.
1253     </col>
1254   </row>
1255   <row>
1256     <col>13</col><col>Action verified</col><col>CLS</col>
1257     <col>
1258       The verification for the action has been done and the action is approved.
1259       The new status is now <strong>CLOSED</strong>.
1260     </col>
1261   </row>
1262   <row>
1263     <col>14</col><col>E-mail sent</col>
1264       <col>OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote></col>
1265     <col>
1266       An e-mail has been sent.
1267     </col>
1268   </row>
1269   <row>
1270     <col>15</col><col> SMS sent </col>
1271       <col>OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote></col>
1272     <col>
1273       A SMS has been sent.
1274     </col>
1275   </row>
1276   <row>
1277     <col>16</col><col>Fax sent</col>
1278       <col>OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote></col>
1279     <col>
1280       A fax has been sent.
1281     </col>
1282   </row>
1283   <row>
1284     <col>17</col><col>Log-entries shown</col><col>XXXX</col>
1285     <col>
1286       The log entries have been shown. No changes to the status made.
1287     </col>
1288   </row>
1289   <row>
1290     <col>18</col><col>Notification closed</col><col>CLS</col>
1291     <col>
1292       Notification has been closed.
1293     </col>
1294   </row>
1295   <row>
1296     <col>19</col><col>Notification reopened</col><col>OPN</col>
1297     <col>
1298       Notification has been re-opened
1299     </col>
1300   </row>
1301 </table>
1302 </subsubsection>
1303
1304 </subsection>
1305
1306 <subsection>
1307    <heading>Action_notification_user.</heading>
1308
1309 <para>
1310 In the table action_notification_user each step that is taken regarding a
1311 notification is logged. This table is very important for later use if
1312 something goes wrong, but is also relevant for the interface.
1313 All steps of a notification can be traced here.
1314 There will be a lot of entries here, but retrieval is more crucial for
1315 performance than data entry. So indexing on logic fields is very relevant.
1316 Processing might be slower, but that's worth the price.
1317 </para>
1318
1319 <subsubsection>
1320   <heading>The fields.</heading>
1321
1322 <para>
1323 The table below describes the fields:
1324 </para>
1325
1326 <table cpos='lllp{6cm}'>
1327   <thead>
1328     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1329     <col>
1330       Remarks
1331     </col>
1332   </thead>
1333   <row>
1334     <col> actionstepid </col> <col> Bigserial </col> <col> 8 </col>
1335     <col>
1336       Autonumber bigint (eight bit)
1337     </col>
1338   </row>
1339   <row>
1340     <col> actionid </col> <col> Bigint </col> <col> 8 </col>
1341     <col>
1342       Reference to the action that is being registered here.
1343     </col>
1344   </row>
1345   <row>
1346     <col> username </col> <col> Text </col> <col> <para/> </col>
1347     <col>
1348       The username of the user that is involved in the action.
1349     </col>
1350   </row>
1351   <row>
1352     <col> notificationid </col> <col> Bigint </col> <col> 8 </col>
1353     <col>
1354       Reference to the notification.
1355     </col>
1356   </row>
1357   <row>
1358     <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
1359     <col>
1360       The time when the action has been entered into the system.
1361       This is the time without the timezone<footnote>The timestamp without
1362       time has been selected, since this is the system time.
1363       To have the system functioning without any physical borders one
1364       of the settings on the system is time in GMT (UTC).
1365       This ensures also the added value of the system log.</footnote>.
1366       This will be automatically added when the record is added into the database.
1367     </col>
1368   </row>
1369   <row>
1370     <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
1371     <col>
1372       The status of the Notification
1373     </col>
1374   </row>
1375   <row>
1376     <col> remarks </col> <col> Text </col> <col> <para/> </col>
1377     <col>
1378       Remarks entered by the user if it concerns a manual action
1379       or the text of automatically generated warnings.
1380     </col>
1381   </row>
1382 </table>
1383
1384 </subsubsection>
1385
1386 <subsubsection>
1387   <heading>The indexes.</heading>
1388
1389 <para>
1390 The table is indexed on the following fields:
1391 </para>
1392
1393 <table cpos='lll'>
1394   <thead>
1395     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1396   </thead>
1397   <row>
1398     <col> anu_pk (action_user_actionstepid_key) </col> <col> actionstepid </col>
1399     <col> Primary key </col>
1400   </row>
1401   <row>
1402     <col> anu_actionid </col> <col> actionid </col> <col> <para/> </col>
1403   </row>
1404   <row>
1405     <col> anu_username </col> <col> username </col> <col> <para/> </col>
1406   </row>
1407   <row>
1408     <col> anu_notificationid </col> <col> notificationid </col> <col> <para/> </col>
1409   </row>
1410   <row>
1411     <col> anu_timestamp </col> <col> timestamp </col> <col> <para/> </col>
1412   </row>
1413   <row>
1414     <col> anu_statuscode </col> <col> statuscode </col> <col> <para/> </col>
1415   </row>
1416 </table>
1417 </subsubsection>
1418
1419 <subsubsection>
1420   <heading>The relationships.</heading>
1421
1422 <para>
1423 Relationships with other tables:
1424 </para>
1425 <table cpos='llp{7cm}'>
1426   <thead>
1427     <col> Fieldname </col> <col> Remote Table </col>
1428     <col> Remarks </col>
1429   </thead>
1430   <row>
1431     <col> actionid </col> <col> action </col>
1432     <col>
1433       Indicates the action that has been taken. The relationship has to be enforced.
1434     </col>
1435   </row>
1436   <row>
1437     <col> notificationid </col> <col> notification </col>
1438     <col>
1439       Each action that takes place is registered in this table.
1440       By using the notification the relevant notification. The relationship has to be enforced.
1441     </col>
1442   </row>
1443   <row>
1444     <col> username </col> <col> user </col>
1445     <col>
1446       Each step in the process has to be related to the user.
1447       If the system itself generates an action the user will be
1448       <strong>gnucomo</strong><footnote>This implies that the system
1449       automatically has an username gnucomo.</footnote>.
1450     </col>
1451   </row>
1452 </table>
1453
1454 <para>
1455 In the model this looks like this:
1456 </para>
1457 <para>
1458 <picture src="erd-anu.png" eps="erd-anu"/>
1459 </para>
1460
1461 </subsubsection>
1462
1463 <subsubsection>
1464   <heading>Sample data.</heading>
1465
1466 <para>
1467 Since no data is delivered automatically a couple of sample records are shown here.
1468 </para>
1469
1470     <table cpos='p{1cm}p{1cm}p{1cm}lllp{4cm}'>
1471       <thead>
1472         <col> Actionstepid </col> <col> Actionid </col> <col> Notificationid </col>
1473         <col> Username </col> <col> Timestamp </col> <col> Status </col>
1474         <col> Remarks </col>
1475       </thead>
1476       <row>
1477         <col> 1 </col> <col> 1 </col> <col> 1 </col> <col> Gnucomo </col>
1478         <col> 2002-07-14 16:14:09 </col> <col> NEW </col>
1479         <col>
1480           Gnucomo detected a portscan
1481         </col>
1482       </row>
1483       <row>
1484         <col> 2 </col> <col> 5 </col> <col> 1 </col> <col> Gnucomo </col>
1485         <col> 2002-07-14 16:14:09 </col> <col> NEW </col>
1486         <col>
1487           Priority set to: 3
1488         </col>
1489       </row>
1490       <row>
1491         <col> 3 </col> <col> 5 </col> <col> 1 </col> <col> Gnucomo </col>
1492         <col> 2002-07-14 16:14:09 </col> <col> OPN </col>
1493         <col>
1494           <para>Automatic e-mail to user:
1495       <reference href="mailto:brenno@dewinter.com">brenno@dewinter.com</reference>:</para>
1496           <para>Gnucomo detected a portscan on system
1497       <reference href="http://gnucomo.dewinter.com/">gnucomo.dewinter.com</reference></para>
1498         </col>
1499       </row>
1500       <row>
1501         <col> 4 </col> <col> 2 </col> <col> 1 </col> <col> Brenno </col>
1502         <col> 2002-07-14 16:18:09 </col> <col> OPN </col>
1503         <col>
1504           Notification shown through webinterface.
1505         </col>
1506       </row>
1507       <row>
1508         <col> 5 </col> <col> 17 </col> <col> 1 </col> <col> Brenno </col>
1509         <col> 2002-07-14 16:18:12 </col> <col> PEN </col>
1510         <col>
1511           <para/>
1512         </col>
1513       </row>
1514       <row>
1515         <col> 6 </col> <col> 4 </col> <col> 1 </col> <col> Brenno </col>
1516         <col> 2002-07-14 16:20:37 </col> <col> PEN </col>
1517         <col>
1518           Priority set to: 1
1519         </col>
1520       </row>
1521       <row>
1522         <col> 7 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1523         <col> 2002-07-1416:21:58 </col> <col> PEN </col>
1524         <col>
1525           After reviewing the logs I see a portscan. On very specific ports. More analysis needed.
1526         </col>
1527       </row>
1528       <row>
1529         <col> 8 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1530         <col> 2002-07-14 16:24:59 </col> <col> PEN </col>
1531         <col>
1532           Services tables learns me that all services are aimed at Windows-based services.
1533       Attempts for platform specific expoits.
1534         </col>
1535       </row>
1536       <row>
1537         <col> 9 </col> <col> 4 </col> <col> 1 </col> <col> Brenno </col>
1538         <col> 2002-07-14 16:25:03 </col> <col> PEN </col>
1539         <col>
1540           Priority set to: 4
1541         </col>
1542       </row>
1543       <row>
1544         <col> 10 </col> <col> 2 </col> <col> 1 </col> <col> Brenno </col>
1545         <col> 2002-07-14 16:30:09 </col> <col> PEN </col>
1546         <col>
1547           Notification shown through webinterface.
1548         </col>
1549       </row>
1550       <row>
1551         <col> 11 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1552         <col> 2002-07-14 16:31:48 </col> <col> PEN </col>
1553         <col>
1554           Portscan has finished and no other action seems to take place now.
1555         </col>
1556       </row>
1557       <row>
1558         <col> 12 </col> <col> 18 </col> <col> 1 </col> <col> Brenno </col>
1559         <col> 2002-07-14 16:43:03 </col> <col> CLS </col>
1560         <col>
1561           <para/>
1562         </col>
1563       </row>
1564     </table>
1565     </subsubsection>
1566 </subsection>
1567
1568 <subsection>
1569   <heading>log &amp; log_adv. </heading>
1570
1571 <para>
1572 To store the log-data there are two tables in use that have a one-on-one relationship.
1573 The logic behind this is the difference between raw-always needed data and the somewhat
1574 processed data to support basic retrieval.
1575 The last category isn't always used and when it's used it is redundant.
1576 Also the raw log is very important to the integrity of the system.
1577 For these reasons the processed data has been physically separated in a
1578 second table called <emph>log_adv</emph>.
1579 If needed a view will be available that combines the two tables.
1580 Despite the load indexing on <emph>log_adv</emph> will be done thoroughly.
1581 </para>
1582 </subsection>
1583
1584 <subsection>
1585   <heading>log.</heading>
1586
1587 <subsubsection>
1588   <heading>The fields of log.</heading>
1589
1590 <para>
1591 The fields in log are focussed around the raw data and the data needed
1592 to link this to other tables in the system.
1593 </para>
1594
1595 <table cpos='lllp{6cm}'>
1596   <thead>
1597     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1598     <col>
1599       Remarks
1600     </col>
1601   </thead>
1602   <row>
1603     <col> logid </col> <col> Bigserial </col> <col> 8 </col>
1604     <col>
1605       Autonumber bigint (eight bit)
1606     </col>
1607   </row>
1608   <row>
1609     <col> objectid </col> <col> Bigint </col> <col> 8 </col>
1610     <col>
1611       Reference to the object that submitted this log entry
1612     </col>
1613   </row>
1614   <row>
1615     <col> original_filename </col> <col> Text </col> <col> <para/> </col>
1616     <col>
1617       This field refers to the filename that contained this entry.
1618       The original entries as received by the gnucomo-server (flat files).
1619       The files are sent in batches, which makes it very hard to find where the
1620       original logline is. This will enable to see the files to detect
1621       bugs in gnucomo if any occur.
1622       It may well be that in a later stage this functionality becomes obsolete.
1623     </col>
1624   </row>
1625   <row>
1626     <col> servicecode </col> <col> Text </col> <col> <para/> </col>
1627     <col>
1628       This field explains what service was recognized (for instance 'kernel, 'httpd' or 'smtp')
1629     </col>
1630   </row>
1631   <row>
1632     <col> type_of_logid </col> <col> Bigint </col> <col> 8 </col>
1633     <col>
1634       Reference to the table type_of_log that contains information on what
1635       type of log/report we have here (how gnucomo recognized it).
1636     </col>
1637   </row>
1638   <row>
1639     <col> object_timestamp </col> <col> Timestamp </col> <col> 8 </col>
1640     <col>
1641       Timestamp as has been written into the log.
1642     </col>
1643   </row>
1644   <row>
1645     <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
1646     <col>
1647       The time when the action has been entered into the system.
1648       This is the time without the timezone<footnote>The timestamp without time
1649       has been selected, since this is the system time.
1650       To have the system functioning without any physical borders one of
1651       the settings on the system is time in GMT (UTC).
1652       This ensures also the added value of the system log.</footnote>.
1653       This will be generated upon entry into the database.
1654     </col>
1655   </row>
1656   <row>
1657     <col> rawdata </col> <col> TEXT </col> <col> <para/> </col>
1658     <col>
1659       The raw log data
1660     </col>
1661   </row>
1662 </table>
1663 </subsubsection>
1664
1665 <subsubsection>
1666   <heading>The indexes.</heading>
1667
1668 <para>
1669 The indices of the table:
1670 </para>
1671
1672 <table cpos='lll'>
1673   <thead>
1674     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1675   </thead>
1676   <row>
1677     <col> log_pk (log_logid_key) </col> <col> logid </col> <col> Primary key </col>
1678   </row>
1679   <row>
1680     <col> log_objectid </col> <col> objectid </col> <col> <para/> </col>
1681   </row>
1682   <row>
1683     <col> log_original_filename </col> <col> original_filename </col> <col> <para/> </col>
1684   </row>
1685   <row>
1686     <col> log_servicecode </col> <col> servicecode </col> <col> <para/> </col>
1687   </row>
1688   <row>
1689     <col> log_type_of_logid </col> <col> type_of_logid </col> <col> <para/> </col>
1690   </row>
1691   <row>
1692     <col> log_object_timestamp </col> <col> object_timestamp </col> <col> <para/> </col>
1693   </row>
1694   <row>
1695     <col> log_timestamp </col> <col> timestamp </col> <col> <para/> </col>
1696   </row>
1697 </table>
1698 </subsubsection>
1699
1700 <subsubsection>
1701   <heading>The relationships.</heading>
1702
1703 <para>
1704 Relationships with other tables:
1705 </para>
1706
1707 <table cpos='llp{6cm}'>
1708   <thead>
1709     <col> Fieldname </col> <col> Remote Table </col>
1710     <col>
1711       Remarks
1712     </col>
1713   </thead>
1714   <row>
1715     <col> objectid </col> <col> object </col>
1716     <col>
1717       This make the link from what object the logline came
1718     </col>
1719   </row>
1720   <row>
1721     <col> type_of_logid </col> <col> type_of_log </col>
1722     <col>
1723       Each logbook has a certain type of reporting.
1724       This explains what type of log was received (and thus which rules for detection was applied).
1725     </col>
1726   </row>
1727   <row>
1728     <col> systemuser </col> <col> user </col>
1729     <col>
1730       Links a registered user of an object to this log
1731       entry<footnote>Upon entry of an object most of the times the
1732       passwd-file (UNIX-systems) or the userlist will serve as the entrypoint of users.
1733       Non existing users will be added and will have to be verified by an
1734       administrator before this entry become definite.</footnote>.
1735     </col>
1736   </row>
1737 </table>
1738
1739 <para>In the model this looks like this:</para>
1740
1741 <para>
1742   <picture src="erd-log.png" eps="erd-log"/>
1743 </para>
1744
1745
1746 </subsubsection>
1747 <subsubsection>
1748   <heading>The fields of log_adv.</heading>
1749
1750 <para>
1751 The fields of the table <emph>log_adv</emph> are shown below:
1752 </para>
1753
1754 <table cpos='lllp{6cm}'>
1755   <thead>
1756     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1757     <col>
1758       Remarks
1759     </col>
1760   </thead>
1761   <row>
1762     <col> logid </col> <col> Bigint </col> <col> 8 </col>
1763     <col>
1764       Bigint (eight bit) 1-to-1 relationship with log
1765     </col>
1766   </row>
1767   <row>
1768     <col> source_ip </col> <col> Inet </col> <col> <para/> </col>
1769     <col>
1770       This is the IP-address (V4) of the host that sended the data.
1771     </col>
1772   </row>
1773   <row>
1774     <col> destination_ip </col> <col> Inet </col> <col> <para/> </col>
1775     <col>
1776       This is the IP-address (V4) of the host that was targetted.
1777     </col>
1778   </row>
1779   <row>
1780     <col> mac_address </col> <col> Macaddr </col> <col> <para/> </col>
1781     <col>
1782       This is the MAC-address logged
1783     </col>
1784   </row>
1785   <row>
1786     <col> packetlength </col> <col> Int </col> <col> <para/> </col>
1787     <col>
1788       The length of the packet
1789     </col>
1790   </row>
1791   <row>
1792     <col> protocol </col> <col> Text </col> <col> <para/> </col>
1793     <col>
1794       The protocol used for transmission(mostly TCP/UDP/ICMP).
1795     </col>
1796   </row>
1797   <row>
1798     <col> source_port </col> <col> Int </col> <col> <para/> </col>
1799     <col>
1800       The portnumber used at origin.
1801     </col>
1802   </row>
1803   <row>
1804     <col> destination_port </col> <col> Int </col> <col> <para/> </col>
1805     <col>
1806       The portnumber for the target
1807     </col>
1808   </row>
1809   <row>
1810     <col> messageid </col> <col> Text </col> <col> <para/> </col>
1811     <col>
1812       Messageid for e-mails
1813     </col>
1814   </row>
1815   <row>
1816     <col> system_username </col> <col> Text </col> <col> <para/> </col>
1817     <col>
1818       Username on the object
1819     </col>
1820   </row>
1821   <row>
1822     <col> networkdevice </col> <col> Text </col> <col> <para/> </col>
1823     <col>
1824       When this is about network-traffic the device that worked the data
1825     </col>
1826   </row>
1827 </table>
1828 </subsubsection>
1829
1830 <subsubsection>
1831   <heading>The indexes.</heading>
1832
1833 <para>
1834 The table is indexed on the following fields:
1835 </para>
1836
1837 <table cpos='lll'>
1838   <thead>
1839     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1840   </thead>
1841   <row>
1842     <col> loa_logid </col> <col> logid </col> <col> Primary key </col>
1843   </row>
1844   <row>
1845     <col> loa_source_ip </col> <col> source_ip </col> <col> <para/> </col>
1846   </row>
1847   <row>
1848     <col> loa_destination_ip </col> <col> destination_ip </col> <col> <para/> </col>
1849   </row>
1850   <row>
1851     <col> loa_mac_address </col> <col> mac_address </col> <col> <para/> </col>
1852   </row>
1853   <row>
1854     <col> loa_packetlength </col> <col> packetlength </col> <col> <para/> </col>
1855   </row>
1856   <row>
1857     <col> loa_protocol </col> <col> protocol </col> <col> <para/> </col>
1858   </row>
1859   <row>
1860     <col> loa_source_port </col> <col> source_port </col> <col> <para/> </col>
1861   </row>
1862   <row>
1863     <col> loa_destination_port </col> <col> destination_port </col> <col> <para/> </col>
1864   </row>
1865   <row>
1866     <col> loa_messageid </col> <col> messageid </col> <col> <para/> </col>
1867   </row>
1868   <row>
1869     <col> loa_system_username </col> <col> system_username </col> <col> <para/> </col>
1870   </row>
1871   <row>
1872     <col> networkdevice </col> <col> networkdevice </col> <col> <para/> </col>
1873   </row>
1874 </table>
1875 </subsubsection>
1876
1877 <subsubsection>
1878   <heading>The relationships.</heading>
1879
1880 <para>
1881 There is only one relation with this table.
1882 </para>
1883
1884 <table cpos='llp{6cm}'>
1885   <thead>
1886     <col> Fieldname </col> <col> Remote Table </col>
1887     <col>
1888       Remarks
1889     </col>
1890   </thead>
1891   <row>
1892     <col> Logid </col> <col> Log </col>
1893     <col>
1894       This will make a link to the table <emph>log</emph>. The relationship is a one-on-one relationship.
1895     </col>
1896   </row>
1897 </table>
1898 </subsubsection>
1899
1900 <subsubsection>
1901   <heading>Sample data combined from log and log_adv.</heading>
1902
1903 <para>
1904 The sample data derrived here has been gathered in logs.
1905 Since the tablestructure is very long the representation is somewhat different:
1906 </para>
1907
1908 <table cpos='lp{8cm}'>
1909   <thead>
1910     <col> Fieldname </col> <col> Value.  </col>
1911   </thead>
1912   <row>
1913     <col> Logid </col> <col> 1 </col>
1914   </row>
1915   <row>
1916     <col> Objectid </col> <col> 1 </col>
1917   </row>
1918   <row>
1919     <col> Original_filename </col> <col> 7f0100.messages.20020714231801 </col>
1920   </row>
1921   <row>
1922     <col> Rawdata </col>
1923     <col>
1924       Jul 14 18:16:42 webber kernel: IN=eth0 OUT= MAC=00:60:67:36:61:a5:00:90:69:60:c0:5d:08:00 SRC=193.79.237.146 DST=212.204.216.11 LEN=40 TOS=0x00 PREC=0x00 TTL=245 id=19308 DF PROTO=TCP SPT=36375 DPT=113 WINDOW=8760 RES=0x00 RST URGP=0
1925     </col>
1926   </row>
1927   <row>
1928     <col> Type_of_logid </col> <col> 1 </col>
1929   </row>
1930   <row>
1931     <col> Timestamp </col> <col> 2002-07-14 23:29:01 </col>
1932   </row>
1933   <row>
1934     <col> Object_timestamp </col> <col> 2002-07-14 18:16:42 </col>
1935   </row>
1936   <row>
1937     <col> Source_ip </col> <col> 193.79.237.146 </col>
1938   </row>
1939   <row>
1940     <col> Destination_ip </col> <col> 212.204.216.11 </col>
1941   </row>
1942   <row>
1943     <col> Mac_address </col> <col> 00:60:67:36:61:a5:00:90:69:60:c0:5d:08:00 </col>
1944   </row>
1945   <row>
1946     <col> Packetlength </col> <col> 40 </col>
1947   </row>
1948   <row>
1949     <col> Protocol </col> <col> TCP </col>
1950   </row>
1951   <row>
1952     <col> Source_port </col> <col> 36375 </col>
1953   </row>
1954   <row>
1955     <col> Destination_port </col> <col> 113 </col>
1956   </row>
1957   <row>
1958     <col> Messageid </col> <col> <para/> </col>
1959   </row>
1960   <row>
1961     <col> Systemuser </col> <col> <para/> </col>
1962   </row>
1963   <row>
1964     <col> Networkdevice </col> <col> eth0 </col>
1965   </row>
1966 </table>
1967 </subsubsection>
1968 </subsection>
1969
1970 <subsection>
1971   <heading>log_notification. </heading>
1972
1973 <para>
1974 In the log_notification the logbook entries that have caused an alert to occur are saved.
1975 When this table is used something has been detected.
1976 As this is clearly an intermediate table we anticipate to design checks where
1977 multiple entries in a log-file can lead to one notification.
1978 For forensics indexing will be focussed on retrieval speed.
1979 </para>
1980
1981 <subsubsection>
1982   <heading>The fields.</heading>
1983
1984 <para>
1985 The fields are listed below:
1986 </para>
1987
1988 <table cpos='lllp{6cm}'>
1989   <thead>
1990     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1991     <col>
1992       Remarks
1993     </col>
1994   </thead>
1995   <row>
1996     <col> notificationid </col> <col> Bigint </col> <col> 8 </col>
1997     <col>
1998       Reference to the notification
1999     </col>
2000   </row>
2001   <row>
2002     <col> logid </col> <col> Bigint </col> <col> 8 </col>
2003     <col>
2004       Reference to the logbook
2005     </col>
2006   </row>
2007 </table>
2008
2009 </subsubsection>
2010 <subsubsection>
2011   <heading>The indexes.</heading>
2012
2013 <para>
2014 The table is indexed on the following fields:
2015 </para>
2016 <table cpos='lll'>
2017   <thead>
2018     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
2019   </thead>
2020   <row>
2021     <col> lon_pk </col> <col>notificationid </col> <col>Primary key </col>
2022   </row>
2023   <row>
2024     <col> <para/> </col> <col>logid </col> <col>Primary key (second field) </col>
2025   </row>
2026   <row>
2027     <col>lon_notificationid </col> <col> notificationid </col> <col> <para/> </col>
2028   </row>
2029   <row>
2030     <col> lon_logid </col> <col>logid </col> <col> <para/> </col>
2031   </row>
2032 </table>
2033 </subsubsection>
2034
2035 <subsubsection>
2036   <heading>The relationships.</heading>
2037
2038 <para>
2039 Relationships with other tables:
2040 </para>
2041
2042 <table cpos='llp{8cm}'>
2043   <thead>
2044     <col> Fieldname </col> <col> Remote Table </col>
2045     <col>
2046       Remarks
2047     </col>
2048   </thead>
2049   <row>
2050     <col> Logid </col> <col> Log </col>
2051     <col>
2052       Indicates the log-entry that was on of the triggers that led to the notification.
2053     </col>
2054   </row>
2055   <row>
2056     <col> NotificationID </col> <col> Notification </col>
2057     <col>
2058       Indicates the notification where the entry in the log was a trigger.
2059     </col>
2060   </row>
2061 </table>
2062
2063 <para>In the model this look like this:</para>
2064 <para>
2065   <picture src="erd-lognotif.png" eps="erd-lognotif"/>
2066 </para>
2067 </subsubsection>
2068
2069 <subsubsection>
2070   <heading>Sample data.</heading>
2071 <para>
2072 Some sample data:
2073 </para>
2074
2075 <table cpos='ll'>
2076   <thead>
2077     <col> LogID </col> <col> NotificationID </col>
2078   </thead>
2079   <row>
2080     <col> 4 </col> <col> 1 </col>
2081   </row>
2082   <row>
2083     <col> 5 </col> <col> 1 </col>
2084   </row>
2085   <row>
2086     <col> 8 </col> <col> 1 </col>
2087   </row>
2088   <row>
2089     <col> 9 </col> <col> 1 </col>
2090   </row>
2091   <row>
2092     <col> 5 </col> <col> 2 </col>
2093   </row>
2094   <row>
2095     <col> 6 </col> <col> 2 </col>
2096   </row>
2097   <row>
2098     <col> 11 </col> <col> 2 </col>
2099   </row>
2100 </table>
2101 </subsubsection>
2102 </subsection>
2103
2104 <subsection>
2105   <heading>notification. </heading>
2106
2107 <para>
2108 In this table all detected issues per object will be written.
2109 Issues are entered based on immediate detection, periodical detection or manually.
2110 Since this table is mostly used to work from in the interface being in control is crucial.
2111 When systems function properly more retrieval than data entry will take place.
2112 Also data retrieval will be done in all sorts of ways. Indexing must be huge to facilitate that.
2113 </para>
2114
2115 <subsubsection>
2116   <heading>The fields.</heading>
2117
2118 <para>
2119 The fields of the <emph>notification</emph> table are:
2120 </para>
2121
2122 <table cpos='lllp{6cm}'>
2123   <thead>
2124     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
2125     <col>
2126       Remarks
2127     </col>
2128   </thead>
2129   <row>
2130     <col> notificationid </col> <col> Bigserial </col> <col> 8 </col>
2131     <col>
2132       Autonumber
2133     </col>
2134   </row>
2135   <row>
2136     <col> objectid </col> <col> Bigint </col> <col> 8 </col>
2137     <col>
2138       Reference to the <emph>object</emph>
2139     </col>
2140   </row>
2141   <row>
2142     <col> type_of_notification_id </col> <col> Bigint </col> <col> 8 </col>
2143     <col>
2144       Reference to the <emph>type_of_notification</emph> indicating what
2145       type of notification we have here and what basic rules apply.
2146     </col>
2147   </row>
2148   <row>
2149     <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2150     <col>
2151       Timestamp that this notification was created.
2152     </col>
2153   </row>
2154   <row>
2155     <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
2156     <col>
2157       The status the actual status a notification has.
2158     </col>
2159   </row>
2160   <row>
2161     <col> priority </col> <col> Int </col> <col> 4 </col>
2162     <col>
2163       The priority that is given to this issue<footnote>Basically there will be
2164       five priority levels. The rule is that the lower the number gets the more
2165       urgent the issue is. At the moment the priority level is set by the system
2166       pre-defined actions will take place.</footnote>.
2167     </col>
2168   </row>
2169   <row>
2170     <col> escalation_count_timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2171     <col>
2172       Timestamp since the last escalation took place<footnote>The system offers
2173       the possibility to automatically escalate issue if no action has been
2174       taken within a certain amount of time.
2175       Based on the status and the type of notification escalation can take place.</footnote>.
2176     </col>
2177   </row>
2178   <row>
2179     <col> repeat_notification_timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2180     <col>
2181       Timestamp at which moment in time a repeat notification should occur<footnote>After
2182       this time has passed a notification is being resent.
2183       After a resent automatically a new time is set for another resent.
2184       If any actions takes place (except automated entries of course)
2185       the time is emptied so that an administrator will no longer be bothered by the system.</footnote>.
2186     </col>
2187   </row>
2188   <row>
2189     <col> securitylevel_view </col> <col> Int </col> <col> 4 </col>
2190     <col>
2191       The securitylevel that is needed to view this entry.
2192     </col>
2193   </row>
2194   <row>
2195     <col> securitylevel_add </col> <col> Int </col> <col> 4 </col>
2196     <col>
2197       Securitylevel to add information to this item or to undertake action
2198     </col>
2199   </row>
2200   <row>
2201     <col> securitylevel_close </col> <col> Int </col> <col> 4 </col>
2202     <col>
2203       The securitylevel needed to be able to close this notification.
2204     </col>
2205   </row>
2206 </table>
2207 </subsubsection>
2208
2209 <subsubsection>
2210   <heading>The indexes.</heading>
2211
2212 <para>
2213 The indices are:
2214 </para>
2215 <table cpos='lll'>
2216   <thead>
2217     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
2218   </thead>
2219   <row>
2220     <col> not_pk (notification_notificationid_key) </col> <col> notificationid </col>
2221     <col> Primary key </col>
2222   </row>
2223   <row>
2224     <col> not_objectid </col> <col> objectid </col> <col> <para/> </col>
2225   </row>
2226   <row>
2227     <col> not_type_of_notificationid </col> <col> type_of_notificationid </col>
2228     <col> <para/> </col>
2229   </row>
2230   <row>
2231     <col> not_timestamp </col> <col> timestamp </col> <col> <para/> </col>
2232   </row>
2233   <row>
2234     <col> not_statuscode </col> <col> statuscode </col> <col> <para/> </col>
2235   </row>
2236   <row>
2237     <col> not_priority </col> <col> priority </col> <col> <para/> </col>
2238   </row>
2239   <row>
2240     <col> not_escalation_count_timestamp </col> <col> escalation_count_timestamp </col>
2241     <col> <para/> </col>
2242   </row>
2243   <row>
2244     <col>
2245       <para>not_repeat_notification_timestamp</para>
2246       <para>(not_repeat_notification_timesta)</para>
2247     </col>
2248     <col> repeat_notification_timestamp </col> <col> <para/> </col>
2249   </row>
2250 </table>
2251 </subsubsection>
2252
2253 <subsubsection>
2254   <heading>The relationships.</heading>
2255
2256 <para>
2257 Relationships with other tables:
2258 </para>
2259
2260 <table cpos='llp{8cm}'>
2261   <thead>
2262     <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
2263   </thead>
2264   <row>
2265     <col> Logid </col> <col> Log </col>
2266     <col>
2267       Indicates the log-entry that was on of the triggers that led to the notification.
2268     </col>
2269   </row>
2270   <row>
2271     <col> NotificationID </col> <col> Notification </col>
2272     <col>
2273       Indicates the notification where the entry in the log was a trigger.
2274     </col>
2275   </row>
2276 </table>
2277
2278 <para>In the model this look like this:</para>
2279 <para>
2280   <picture src="erd-notif.png" eps="erd-notif"/>
2281 </para>
2282 </subsubsection>
2283
2284 <subsubsection>
2285   <heading>Sample data.</heading>
2286
2287 <para>
2288 The following data is an example of a notification placed in the database.
2289 </para>
2290 <table cpos='ll'>
2291   <thead>
2292     <col> Fieldname </col> <col> Data </col>
2293   </thead>
2294   <row>
2295     <col> Notificationid </col> <col> 1 </col>
2296   </row>
2297   <row>
2298     <col> ObjectID </col> <col> 1 </col>
2299   </row>
2300   <row>
2301     <col> Type_of_notification_id </col> <col> 1 </col>
2302   </row>
2303   <row>
2304     <col> Timestamp </col> <col> 17-07-2002 16:07 </col>
2305   </row>
2306   <row>
2307     <col> Statuscode </col> <col> NEW </col>
2308   </row>
2309   <row>
2310     <col> Priority </col> <col> 3 </col>
2311   </row>
2312   <row>
2313     <col> Escalation_count_timestamp </col> <col> 17-07-2002 16:07 </col>
2314   </row>
2315   <row>
2316     <col> Repeat_notification_timestamp </col> <col> 17-07-2002 20:48PM </col>
2317   </row>
2318   <row>
2319     <col> Securitylevel_view </col> <col> 3 </col>
2320   </row>
2321   <row>
2322     <col> Securitylevel_add </col> <col> 3 </col>
2323   </row>
2324   <row>
2325     <col> Securitylevel_close </col> <col> 4 </col>
2326   </row>
2327 </table>
2328 </subsubsection>
2329 </subsection>
2330
2331 <subsection>
2332   <heading>object</heading>
2333
2334 <para>
2335 The <emph>object</emph> table contains general information on the objects being monitored.
2336 The table object will more be used for retrieval, since adding objects will be an
2337 occasional process. Anything that for some reason can be indexed ought to be indexed.
2338 </para>
2339
2340 <subsubsection>
2341   <heading>The fields.</heading>
2342
2343 <para>
2344 The fields are:
2345 </para>
2346 <table cpos='lllp{6cm}'>
2347   <thead>
2348     <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
2349     <col>
2350       Remarks
2351     </col>
2352   </thead>
2353   <row>
2354     <col> objectid </col> <col> Bigserial </col> <col> 8 </col>
2355     <col>
2356       Autonumbering code for the computer or device.
2357     </col>
2358   </row>
2359   <row>
2360     <col> objectname </col> <col> Text </col> <col> <para/> </col>
2361     <col>
2362       The hostname of the object
2363     </col>
2364   </row>
2365   <row>
2366     <col> objectcode </col> <col> Text </col> <col> <para/> </col>
2367     <col>
2368       Unique identifier (if existent) on the system<footnote>In Linux this will
2369       typically be the <emph>hostid</emph>.</footnote>.
2370     </col>
2371   </row>
2372   <row>
2373     <col> scp_enabled </col> <col> Boolean </col> <col> <para/> </col>
2374     <col>
2375       Can communication occur through scp (T = Yes / F = No)
2376     </col>
2377   </row>
2378   <row>
2379     <col> scp_inet </col> <col> Inet </col> <col> <para/> </col>
2380     <col>
2381       IP Address of the object for scp-data transfer.
2382     </col>
2383   </row>
2384   <row>
2385     <col> mail_enabled </col> <col> Boolean </col> <col> <para/> </col>
2386     <col>
2387       Can communication occur through e-mail (T = Yes/F = No).
2388     </col>
2389   </row>
2390   <row>
2391     <col> mail_from </col> <col> Text </col> <col> <para/> </col>
2392     <col>
2393       The e-mail address where e-mail will come from.
2394     </col>
2395   </row>
2396   <row>
2397     <col> sms_enabled </col> <col> Boolean </col> <col> <para/> </col>
2398     <col>
2399       Can communication occur through SMS (T = Yes/F = No).
2400     </col>
2401   </row>
2402   <row>
2403     <col> sms_number </col> <col> Text </col> <col> <para/> </col>
2404     <col>
2405       The SMS-number to send a notification to.
2406     </col>
2407   </row>
2408   <row>
2409     <col> fax_enabled </col> <col> Boolean </col> <col> <para/> </col>
2410     <col>
2411       Can communication occur through Fax (T = Yes/F = No).
2412     </col>
2413   </row>
2414   <row>
2415     <col> fax_number </col> <col> Text </col> <col> <para/> </col>
2416     <col>
2417       The fax-number to send a notification to.
2418     </col>
2419   </row>
2420   <row>
2421     <col>
2422       object_description
2423     </col>
2424     <col>
2425       Text
2426     </col>
2427     <col>
2428       <para/>
2429     </col>
2430     <col>
2431       Description of the object. What type of system is it
2432     </col>
2433   </row>
2434   <row>
2435     <col> object_owner </col> <col> Text </col> <col> <para/> </col>
2436     <col>
2437       Owner-details
2438     </col>
2439   </row>
2440   <row>
2441     <col> physical_location </col> <col> Text </col> <col> <para/> </col>
2442     <col>
2443       Physical address and when applicable entry-details needed to get to the object.
2444     </col>
2445   </row>
2446   <row>
2447     <col> timezone </col> <col> Text </col> <col> <para/> </col>
2448     <col>
2449       The timezone where this object is located<footnote>For objects that
2450       move around like PDA's and laptops the timezone can be the place where
2451       a person is stationed or better GMT.</footnote>.
2452     </col>
2453   </row>
2454   <row>
2455     <col> remark </col> <col> Text </col> <col> <para/> </col>
2456     <col>
2457       Additional remarks that shouldn't be in the previous TEXT fields.
2458     </col>
2459   </row>
2460 </table>
2461 </subsubsection>
2462
2463 <subsubsection>
2464   <heading>The indexes.</heading>
2465
2466 <para>
2467 The <emph>object</emph> table is indexed on the following fields:
2468 </para>
2469
2470 <table cpos='lll'>
2471   <thead>
2472     <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
2473   </thead>
2474   <row>
2475     <col> obj_pk (object_objectid_key) </col> <col> objectid </col> <col> Primary key </col>
2476   </row>
2477   <row>
2478     <col> obj_objectname </col> <col> objectname </col> <col> Unique </col>
2479   </row>
2480   <row>
2481     <col> obj_objectcode </col> <col> objectcode </col> <col> Unique </col>
2482   </row>
2483   <row>
2484     <col> obj_mail_from </col> <col> mail_from </col> <col> <para/> </col>
2485   </row>
2486 </table>
2487 </subsubsection>
2488
2489 <subsubsection>
2490   <heading>The relationships.</heading>
2491
2492 <para>
2493 The relationships with other tables are listed below:
2494 </para>
2495
2496 <table cpos='llp{8cm}'>
2497   <thead>
2498     <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
2499   </thead>
2500   <row>
2501     <col> ObjectID </col> <col> Log (adv) </col>
2502     <col> Reference to processed log-entries </col>
2503   </row>
2504   <row>
2505     <col> <para/> </col> <col> Notification </col>
2506     <col>
2507       Reference to the table <emph>notification</emph> that contains the notifications
2508       that have been created.
2509     </col>
2510   </row>
2511   <row>
2512     <col> <para/> </col> <col> Object_issue </col>
2513     <col>
2514       Reference to the <emph>object_issue</emph> that indicates how notifications have to be handled .
2515     </col>
2516   </row>
2517   <row>
2518     <col> <para/> </col> <col> Object_priority </col>
2519     <col>
2520       Reference to the <emph>object_priority</emph> table that indicates how a
2521       certain level of priority has to be dealt with.
2522     </col>
2523   </row>
2524   <row>
2525     <col> <para/> </col> <col> Object_system_user </col>
2526     <col>
2527       Reference to a list of system user to discover abnormalities in user behaviour.
2528     </col>
2529   </row>
2530   <row>
2531     <col> <para/> </col> <col> Object_user </col>
2532     <col> Reference to the <emph>object_user</emph> </col>
2533   </row>
2534   <row>
2535     <col> <para/> </col> <col> Unprocessed_log </col>
2536     <col>
2537       Reference to the entries that have not been processed at all.
2538     </col>
2539   </row>
2540 </table>
2541
2542 <para>In the relationshipmodel this looks like this:</para>
2543 <para>
2544   <picture src="erd-object.png" eps="erd-object"/>
2545 </para>
2546 </subsubsection>
2547
2548 <subsubsection>
2549   <heading>Sample data.</heading>
2550 <para>
2551 There is no preset data and therefor it's an example has been created.
2552 The table has quite some fields so the example has the fieldname in the
2553 left column and the data in the right column.
2554 </para>
2555 <table cpos='lp{6cm}'>
2556       <thead>
2557         <col>
2558           <para>Fieldname</para>
2559         </col>
2560         <col>
2561           <para>Sample data</para>
2562         </col>
2563       </thead>
2564       <row>
2565         <col>
2566           <para>Objectid</para>
2567         </col>
2568         <col>
2569           <para>1</para>
2570         </col>
2571       </row>
2572       <row>
2573         <col>
2574           <para>Objectname</para>
2575         </col>
2576         <col>
2577           <para>webber.dewinter.com</para>
2578         </col>
2579       </row>
2580       <row>
2581         <col>
2582           <para>Objectcode</para>
2583         </col>
2584         <col>
2585           <para>7f0100</para>
2586         </col>
2587       </row>
2588       <row>
2589         <col>
2590           <para>Scp_enabled</para>
2591         </col>
2592         <col>
2593           <para>T</para>
2594         </col>
2595       </row>
2596       <row>
2597         <col>
2598           <para>Scp_inet</para>
2599         </col>
2600         <col>
2601           <para>192.168.221.212</para>
2602         </col>
2603       </row>
2604       <row>
2605         <col>
2606           <para>Mail_enabled</para>
2607         </col>
2608         <col>
2609           <para>T</para>
2610         </col>
2611       </row>
2612       <row>
2613         <col>
2614           <para>Mail_from</para>
2615         </col>
2616         <col>
2617           <para>
2618             <reference href="mailto:gnucomo@maintenance.dewinter.com">gnucomo@maintenance.dewinter.com</reference>
2619           </para>
2620         </col>
2621       </row>
2622       <row>
2623         <col>
2624           <para>Sms_enabled</para>
2625         </col>
2626         <col>
2627           <para>T</para>
2628         </col>
2629       </row>
2630       <row>
2631         <col>
2632           <para>Sms_number</para>
2633         </col>
2634         <col>
2635           <para>06-XXXXXXXX</para>
2636         </col>
2637       </row>
2638       <row>
2639         <col>
2640           <para>Fax_enabled</para>
2641         </col>
2642         <col>
2643           <para>T</para>
2644         </col>
2645       </row>
2646       <row>
2647         <col>
2648           <para>Fax_number</para>
2649         </col>
2650         <col>
2651           <para>0318-XXXXXX</para>
2652         </col>
2653       </row>
2654       <row>
2655         <col>
2656           <para>Object_description</para>
2657         </col>
2658         <col>
2659           <para>19 inch 4 units, AMD-300 with two 27Gb disks (RAID-0), 256Mb memory</para>
2660         </col>
2661       </row>
2662       <row>
2663         <col>
2664           <para>Object_owner</para>
2665         </col>
2666         <col>
2667           <para>Brenno de Winter</para>
2668           <para>De Winter Information Solutions</para>
2669           <para>Your street here 32</para>
2670           <para>9999 XX YOUR CITY</para>
2671           <para>THE NETHERLANDS</para>
2672           <para>Phone: +31 XXX XXX XXX</para>
2673         </col>
2674       </row>
2675       <row>
2676         <col>
2677           <para>Physical_location</para>
2678         </col>
2679         <col>
2680           <para>Internet Provider XYZ</para>
2681           <para>Your street here 38</para>
2682           <para>9999 XX YOUR CITY</para>
2683           <para>THE NETHERLANDS</para>
2684           <para>Phone: +31 XXX XXX XXX</para>
2685           <para/>
2686           <para>Dataroom. System: Q7845</para>
2687         </col>
2688       </row>
2689       <row>
2690         <col>
2691           <para>Remark</para>
2692         </col>
2693         <col>
2694           <para>A replacement system is available at the office location. The following persons have been authorized to enter the data room at the ISP:</para>
2695           <para>* Arjen Baart</para>
2696           <para>* Peter Busser</para>
2697           <para>* Brenno de Winter</para>
2698         </col>
2699       </row>
2700     </table>
2701     <para/>
2702 </subsubsection>
2703 </subsection>
2704
2705 <subsection>
2706   <heading>object_issue. </heading>
2707 <para>
2708 This table will store the policy on a certain issue like the priority being
2709 recognized and special actions to take.
2710 Since policies are utilized by the systems continuously all other process will rely on this index,
2711 while users will change the values occasionally.
2712 </para>
2713
2714 <subsubsection>
2715   <heading>The fields.</heading>
2716
2717 <para>
2718 The fields of <emph>object_issue</emph>:
2719 </para>
2720
2721 <table cpos='lllp{6cm}'>
2722       <thead>
2723         <col>
2724           <para>Fieldname</para>
2725         </col>
2726         <col>
2727           <para>Fieldtype</para>
2728         </col>
2729         <col>
2730           <para>Size</para>
2731         </col>
2732         <col>
2733           <para>Remarks</para>
2734         </col>
2735       </thead>
2736       <row>
2737         <col>
2738           <para>objectid</para>
2739         </col>
2740         <col>
2741           <para>Bigint</para>
2742         </col>
2743         <col>
2744           <para>8</para>
2745         </col>
2746         <col>
2747           <para>Reference to the object</para>
2748         </col>
2749       </row>
2750       <row>
2751         <col>
2752           <para>type_of_notificationid</para>
2753         </col>
2754         <col>
2755           <para>Bigint</para>
2756         </col>
2757         <col>
2758           <para>8</para>
2759         </col>
2760         <col>
2761           <para>Reference to the <emph>type_of_notification</emph> indicating
2762            what type of notification we have here and what basic rules apply.</para>
2763         </col>
2764       </row>
2765       <row>
2766         <col>
2767           <para>default_priority</para>
2768         </col>
2769         <col>
2770           <para>Int</para>
2771         </col>
2772         <col>
2773           <para>4</para>
2774         </col>
2775         <col>
2776           <para>The priority that will be set automatically when this type of
2777            notification is entered into the system.</para>
2778         </col>
2779       </row>
2780       <row>
2781         <col>
2782           <para>escalation</para>
2783         </col>
2784         <col>
2785           <para>Boolean</para>
2786         </col>
2787         <col>
2788           <para/>
2789         </col>
2790         <col>
2791           <para>Will the system perform automatic escalation (T = Yes / F = No)</para>
2792         </col>
2793       </row>
2794       <row>
2795         <col>
2796           <para>escalation_time</para>
2797         </col>
2798         <col>
2799           <para>Time</para>
2800         </col>
2801         <col>
2802           <para/>
2803         </col>
2804         <col>
2805           <para>The time after which a higher priority is awarded to the notification.</para>
2806         </col>
2807       </row>
2808       <row>
2809         <col>
2810           <para>max_priority</para>
2811         </col>
2812         <col>
2813           <para>Int</para>
2814         </col>
2815         <col>
2816           <para/>
2817         </col>
2818         <col>
2819           <para>The maximum priority given to this type of notification.</para>
2820         </col>
2821       </row>
2822       <row>
2823         <col>
2824           <para>adjusted_setting</para>
2825         </col>
2826         <col>
2827           <para>Text</para>
2828         </col>
2829         <col>
2830           <para/>
2831         </col>
2832         <col>
2833           <para>Some checks can have a special settings (for instance alert
2834            after 5 failed login attempts instead of 3).</para>
2835         </col>
2836       </row>
2837 </table>
2838 </subsubsection>
2839
2840 <subsubsection>
2841   <heading>The indexes.</heading>
2842
2843 <para>
2844 These are the indices:
2845 </para>
2846 <table cpos='lll'>
2847       <thead>
2848         <col>
2849           <para>Indexname</para>
2850         </col>
2851         <col>
2852           <para>Field</para>
2853         </col>
2854         <col>
2855           <para>Characteristics</para>
2856         </col>
2857       </thead>
2858       <row>
2859         <col>
2860           <para>obi_pk</para>
2861         </col>
2862         <col>
2863           <para>objectid</para>
2864         </col>
2865         <col>
2866           <para>Primary key</para>
2867         </col>
2868       </row>
2869       <row>
2870         <col>
2871           <para/>
2872         </col>
2873         <col>
2874           <para>type_of_notification_id</para>
2875         </col>
2876         <col>
2877           <para>Primary key</para>
2878         </col>
2879       </row>
2880       <row>
2881         <col>
2882           <para>obi_objectid</para>
2883         </col>
2884         <col>
2885           <para>Objectid</para>
2886         </col>
2887         <col>
2888           <para/>
2889         </col>
2890       </row>
2891       <row>
2892         <col>
2893           <para>obi_type_of_notificationid</para>
2894         </col>
2895         <col>
2896           <para>type_of_notification_id</para>
2897         </col>
2898         <col>
2899           <para/>
2900         </col>
2901       </row>
2902     </table>
2903     </subsubsection>
2904
2905 <subsubsection>
2906    <heading>The relationships.</heading>
2907
2908 <para>
2909 Relationships with other tables:
2910 </para>
2911
2912 <table cpos='llp{6cm}'>
2913       <thead>
2914         <col>
2915           <para>Fieldname</para>
2916         </col>
2917         <col>
2918           <para>Remote Table</para>
2919         </col>
2920         <col>
2921           <para>Remarks</para>
2922         </col>
2923       </thead>
2924       <row>
2925         <col>
2926           <para>ObjectID</para>
2927         </col>
2928         <col>
2929           <para>Object</para>
2930         </col>
2931         <col>
2932           <para>Reference to the <emph>object</emph> (which object does this apply to).</para>
2933         </col>
2934       </row>
2935       <row>
2936         <col>
2937           <para>Type_of_issueid</para>
2938         </col>
2939         <col>
2940           <para>Type_of_issue</para>
2941         </col>
2942         <col>
2943           <para>Reference to the type of issue.</para>
2944         </col>
2945       </row>
2946     </table>
2947
2948 <para>In the model this look like this:</para>
2949 <para>
2950     <picture src="erd-objissue.png" eps="erd-objissue"/>
2951 </para>
2952
2953 </subsubsection>
2954 <subsubsection>
2955   <heading>Sample data.</heading>
2956
2957 <para>
2958 Some sample data:
2959 </para>
2960 <table cpos='lllllll'>
2961       <thead>
2962         <col>
2963           <para>Objectid</para>
2964         </col>
2965         <col>
2966           <para>Type_of_notification_id</para>
2967         </col>
2968         <col>
2969           <para>Default Priority</para>
2970         </col>
2971         <col>
2972           <para>Escalation</para>
2973         </col>
2974         <col>
2975           <para>Escalation_time</para>
2976         </col>
2977         <col>
2978           <para>Max_priority</para>
2979         </col>
2980         <col>
2981           <para>Adjusted_setting</para>
2982         </col>
2983       </thead>
2984       <row>
2985         <col>
2986           <para>1</para>
2987         </col>
2988         <col>
2989           <para>1</para>
2990         </col>
2991         <col>
2992           <para>3</para>
2993         </col>
2994         <col>
2995           <para>T</para>
2996         </col>
2997         <col>
2998           <para>00:15:00</para>
2999         </col>
3000         <col>
3001           <para>1</para>
3002         </col>
3003         <col>
3004           <para/>
3005         </col>
3006       </row>
3007       <row>
3008         <col>
3009           <para>1</para>
3010         </col>
3011         <col>
3012           <para>2</para>
3013         </col>
3014         <col>
3015           <para>4</para>
3016         </col>
3017         <col>
3018           <para>T</para>
3019         </col>
3020         <col>
3021           <para>00:30:00</para>
3022         </col>
3023         <col>
3024           <para>2</para>
3025         </col>
3026         <col>
3027           <para/>
3028         </col>
3029       </row>
3030       <row>
3031         <col>
3032           <para>1</para>
3033         </col>
3034         <col>
3035           <para>3</para>
3036         </col>
3037         <col>
3038           <para>5</para>
3039         </col>
3040         <col>
3041           <para>F</para>
3042         </col>
3043         <col>
3044           <para/>
3045         </col>
3046         <col>
3047           <para/>
3048         </col>
3049         <col>
3050           <para>7</para>
3051         </col>
3052       </row>
3053       <row>
3054         <col>
3055           <para>2</para>
3056         </col>
3057         <col>
3058           <para>1</para>
3059         </col>
3060         <col>
3061           <para>4</para>
3062         </col>
3063         <col>
3064           <para>T</para>
3065         </col>
3066         <col>
3067           <para>00:45:00</para>
3068         </col>
3069         <col>
3070           <para>2</para>
3071         </col>
3072         <col>
3073           <para/>
3074         </col>
3075       </row>
3076       <row>
3077         <col>
3078           <para>2</para>
3079         </col>
3080         <col>
3081           <para>3</para>
3082         </col>
3083         <col>
3084           <para>5</para>
3085         </col>
3086         <col>
3087           <para>F</para>
3088         </col>
3089         <col>
3090           <para/>
3091         </col>
3092         <col>
3093           <para/>
3094         </col>
3095         <col>
3096           <para>8</para>
3097         </col>
3098       </row>
3099     </table>
3100 </subsubsection>
3101 </subsection>
3102
3103 <subsection>
3104   <heading>object_priority.</heading>
3105
3106 <para>
3107 This table stores per object how a certain level of priority is being dealt with.
3108 What policies do apply. This table is mostly used for retrieval, so firm indexing is logic.
3109 </para>
3110
3111 <subsubsection>
3112   <heading>The fields.</heading>
3113
3114 <para>
3115 The fields are listed below:
3116 </para>
3117 <table cpos='lllp{6cm}'>
3118       <thead>
3119         <col>
3120           <para>Fieldname</para>
3121         </col>
3122         <col>
3123           <para>Fieldtype</para>
3124         </col>
3125         <col>
3126           <para>Size</para>
3127         </col>
3128         <col>
3129           <para>Remarks</para>
3130         </col>
3131       </thead>
3132       <row>
3133         <col>
3134           <para>objectid</para>
3135         </col>
3136         <col>
3137           <para>Bigint</para>
3138         </col>
3139         <col>
3140           <para>8</para>
3141         </col>
3142         <col>
3143           <para>Reference to the object</para>
3144         </col>
3145       </row>
3146       <row>
3147         <col>
3148           <para>priorityid</para>
3149         </col>
3150         <col>
3151           <para>Int</para>
3152         </col>
3153         <col>
3154           <para>4</para>
3155         </col>
3156         <col>
3157           <para>Priority.</para>
3158         </col>
3159       </row>
3160       <row>
3161         <col>
3162           <para>send_mail</para>
3163         </col>
3164         <col>
3165           <para>Boolean</para>
3166         </col>
3167         <col>
3168           <para/>
3169         </col>
3170         <col>
3171           <para>Send an e-mail if this priority is set? Yes = T / No = F</para>
3172         </col>
3173       </row>
3174       <row>
3175         <col>
3176           <para>send_sms</para>
3177         </col>
3178         <col>
3179           <para>Boolean</para>
3180         </col>
3181         <col>
3182           <para/>
3183         </col>
3184         <col>
3185           <para>Send a sms message if this priority is set? Yes = T / No = F</para>
3186         </col>
3187       </row>
3188       <row>
3189         <col>
3190           <para>send_fax</para>
3191         </col>
3192         <col>
3193           <para>Boolean</para>
3194         </col>
3195         <col>
3196           <para/>
3197         </col>
3198         <col>
3199           <para>Send a fax if this priority is set? Yes = T / No = F</para>
3200         </col>
3201       </row>
3202       <row>
3203         <col>
3204           <para>repeat_notification</para>
3205         </col>
3206         <col>
3207           <para>Boolean</para>
3208         </col>
3209         <col>
3210           <para/>
3211         </col>
3212         <col>
3213           <para>Repeat this notification if no action occurs since the notification. Yes = T / No = F</para>
3214         </col>
3215       </row>
3216       <row>
3217         <col>
3218           <para>interval_for_repeat</para>
3219         </col>
3220         <col>
3221           <para>Time</para>
3222         </col>
3223         <col>
3224           <para/>
3225         </col>
3226         <col>
3227           <para>Time interval that is set to wait for a response.</para>
3228         </col>
3229       </row>
3230     </table>
3231     </subsubsection>
3232
3233 <subsubsection>
3234   <heading>The indexes.</heading>
3235
3236 <para>
3237 Indices of the <emph>object_priority</emph> table:
3238 </para>
3239
3240 <table cpos='lll'>
3241       <thead>
3242         <col>
3243           <para>Indexname</para>
3244         </col>
3245         <col>
3246           <para>Field</para>
3247         </col>
3248         <col>
3249           <para>Characteristics</para>
3250         </col>
3251       </thead>
3252       <row>
3253         <col>
3254           <para>obi_pk</para>
3255         </col>
3256         <col>
3257           <para>objectid</para>
3258         </col>
3259         <col>
3260           <para>Primary key</para>
3261         </col>
3262       </row>
3263       <row>
3264         <col>
3265           <para/>
3266         </col>
3267         <col>
3268           <para>priorityid</para>
3269         </col>
3270         <col>
3271           <para>Primary key</para>
3272         </col>
3273       </row>
3274       <row>
3275         <col>
3276           <para>obi_objectid</para>
3277         </col>
3278         <col>
3279           <para>Objectid</para>
3280         </col>
3281         <col>
3282           <para/>
3283         </col>
3284       </row>
3285       <row>
3286         <col>
3287           <para>obi_type_of_notification_id</para>
3288         </col>
3289         <col>
3290           <para>type_of_notification_id</para>
3291         </col>
3292         <col>
3293           <para/>
3294         </col>
3295       </row>
3296     </table>
3297 </subsubsection>
3298
3299 <subsubsection>
3300   <heading>The relationships.</heading>
3301
3302 <para>
3303 Relationships with other tables:
3304 </para>
3305
3306 <table cpos='llp{6cm}'>
3307       <thead>
3308         <col>
3309           <para>Fieldname</para>
3310         </col>
3311         <col>
3312           <para>Remote Table</para>
3313         </col>
3314         <col>
3315           <para>Remarks</para>
3316         </col>
3317       </thead>
3318       <row>
3319         <col>
3320           <para>ObjectID</para>
3321         </col>
3322         <col>
3323           <para>Object</para>
3324         </col>
3325         <col>
3326           <para>Reference to the object (which object does this apply to).</para>
3327         </col>
3328       </row>
3329       <row>
3330         <col>
3331           <para>Priorityid</para>
3332         </col>
3333         <col>
3334           <para>Priority</para>
3335         </col>
3336         <col>
3337           <para>Reference to the priority.</para>
3338         </col>
3339       </row>
3340     </table>
3341
3342 <para>
3343 In the model this look like this:
3344 </para>
3345 <para>
3346 <picture src="erd-objprior.png" eps="erd-objprior"/>
3347 </para>
3348 </subsubsection>
3349 </subsection>
3350
3351 <subsection>
3352   <heading>object_service</heading>
3353
3354 <para>
3355 The object service table indicates which services can be expected on the system.
3356 If input fails to show up a notification can be generated.
3357 </para>
3358
3359 <subsubsection>
3360   <heading>The fields.</heading>
3361
3362 <para>
3363 The fields are listed below:
3364 </para>
3365
3366 <table cpos='lllp{6cm}'>
3367       <thead>
3368         <col>
3369           <para>Fieldname</para>
3370         </col>
3371         <col>
3372           <para>Fieldtype</para>
3373         </col>
3374         <col>
3375           <para>Size</para>
3376         </col>
3377         <col>
3378           <para>Remarks</para>
3379         </col>
3380       </thead>
3381       <row>
3382         <col>
3383           <para>objectid</para>
3384         </col>
3385         <col>
3386           <para>Bigint</para>
3387         </col>
3388         <col>
3389           <para>8</para>
3390         </col>
3391         <col>
3392           <para>Reference to the object</para>
3393         </col>
3394       </row>
3395       <row>
3396         <col>
3397           <para>servicecode</para>
3398         </col>
3399         <col>
3400           <para>Text</para>
3401         </col>
3402         <col>
3403           <para/>
3404         </col>
3405         <col>
3406           <para>Reference to service.</para>
3407         </col>
3408       </row>
3409       <row>
3410         <col>
3411           <para>expected_interval</para>
3412         </col>
3413         <col>
3414           <para>Bigint</para>
3415         </col>
3416         <col>
3417           <para>8</para>
3418         </col>
3419         <col>
3420           <para>The expected interval in minutes between two log entries.
3421           If this gives a time-out a notification is generated<footnote>To avoid many
3422           false positives it may be wise to give the system always 1 or 2 minutes extra time.
3423           If for some reason a connection is slow or a mail-daemon restarted
3424           the effect would generate tuns of notifications.</footnote>.
3425           The following values can be considered the most common:</para>
3426           <para>* 60 hourly entries</para>
3427           <para>* 120 two hourly entries</para>
3428           <para>* 240 four hourly entries</para>
3429           <para>* 480 eight hourly entries</para>
3430           <para>* 920 twelve hourly entries</para>
3431           <para>* 1840 daily entries</para>
3432           <para>* 12880 weekly entries</para>
3433         </col>
3434       </row>
3435       <row>
3436         <col>
3437           <para>last_entry</para>
3438         </col>
3439         <col>
3440           <para>Timestamp</para>
3441         </col>
3442         <col>
3443           <para/>
3444         </col>
3445         <col>
3446           <para>The timestamp of the last entry (for detecting exceeded interval).
3447           This field could be derived from the log-table as well, but the
3448           redundance gives a performance on detection that is useful, since a
3449           check should run every minute.</para>
3450         </col>
3451       </row>
3452       <row>
3453         <col>
3454           <para>default_priority</para>
3455         </col>
3456         <col>
3457           <para>Int</para>
3458         </col>
3459         <col>
3460           <para>4</para>
3461         </col>
3462         <col>
3463           <para>Priority given if this service didn't occur.</para>
3464         </col>
3465       </row>
3466       <row>
3467         <col>
3468           <para>maximum_priority</para>
3469         </col>
3470         <col>
3471           <para>Int</para>
3472         </col>
3473         <col>
3474           <para>4</para>
3475         </col>
3476         <col>
3477           <para>Maximum priority (in case of escalation)</para>
3478         </col>
3479       </row>
3480       <row>
3481         <col>
3482           <para>accepted</para>
3483         </col>
3484         <col>
3485           <para>Boolean</para>
3486         </col>
3487         <col>
3488           <para/>
3489         </col>
3490         <col>
3491           <para>If a service hasn't been set, the application user should
3492           indicate that this is valid (logs shouldn't just appear).
3493           New entries will be added automatically but still have to be verified.</para>
3494         </col>
3495       </row>
3496     </table>
3497 </subsubsection>
3498
3499 <subsubsection>
3500   <heading>The indexes.</heading>
3501
3502 <para>
3503 The table is indexed on the following fields:
3504 </para>
3505 <table cpos='lll'>
3506       <thead>
3507         <col>
3508           <para>Indexname</para>
3509         </col>
3510         <col>
3511           <para>Field</para>
3512         </col>
3513         <col>
3514           <para>Characteristics</para>
3515         </col>
3516       </thead>
3517       <row>
3518         <col>
3519           <para>obs_pk</para>
3520         </col>
3521         <col>
3522           <para>objectid</para>
3523         </col>
3524         <col>
3525           <para>Primary key</para>
3526         </col>
3527       </row>
3528       <row>
3529         <col>
3530           <para/>
3531         </col>
3532         <col>
3533           <para>servicecode</para>
3534         </col>
3535         <col>
3536           <para>Primary key</para>
3537         </col>
3538       </row>
3539       <row>
3540         <col>
3541           <para>obs_objectid</para>
3542         </col>
3543         <col>
3544           <para>objectid</para>
3545         </col>
3546         <col>
3547           <para/>
3548         </col>
3549       </row>
3550       <row>
3551         <col>
3552           <para>obs_servicecode</para>
3553         </col>
3554         <col>
3555           <para>servicecode</para>
3556         </col>
3557         <col>
3558           <para/>
3559         </col>
3560       </row>
3561       <row>
3562         <col>
3563           <para>obs_accepted</para>
3564         </col>
3565         <col>
3566           <para>accepted</para>
3567         </col>
3568         <col>
3569           <para/>
3570         </col>
3571       </row>
3572     </table>
3573 </subsubsection>
3574
3575 <subsubsection>
3576    <heading>The relationships.</heading>
3577
3578 <para>
3579 Relationships with other tables:
3580 </para>
3581
3582 <table cpos='llp{8cm}'>
3583       <thead>
3584         <col>
3585           <para>Fieldname</para>
3586         </col>
3587         <col>
3588           <para>Remote Table</para>
3589         </col>
3590         <col>
3591           <para>Remarks</para>
3592         </col>
3593       </thead>
3594       <row>
3595         <col>
3596           <para>objectID</para>
3597         </col>
3598         <col>
3599           <para>Object</para>
3600         </col>
3601         <col>
3602           <para>Reference to the object (which object does this apply to).</para>
3603         </col>
3604       </row>
3605       <row>
3606         <col>
3607           <para>servicecode</para>
3608         </col>
3609         <col>
3610           <para>Service</para>
3611         </col>
3612         <col>
3613           <para>Reference to the service table. </para>
3614         </col>
3615       </row>
3616     </table>
3617
3618 <para>In the model this look like this:</para>
3619 <para>
3620   <picture src="erd-objservice.png" eps="erd-objservice"/>
3621 </para>
3622 </subsubsection>
3623 </subsection>
3624
3625 <subsection>
3626   <heading>object_system_user</heading>
3627
3628 <para>
3629 This table will derive a list of users that can be identified based
3630 on the log-files in the system. This table is filled during data entry.
3631 But the filling of the table is dependent on the fact if the user has been entered before.
3632 So during the processing the read will be done more than the data entry and
3633 that makes heavy indexing logic.
3634 </para>
3635 <subsubsection>
3636   <heading>The fields.</heading>
3637
3638 <para>
3639 The fields of <emph>object_system_user</emph> are listed below:
3640 </para>
3641
3642 <table cpos='lllp{6cm}'>
3643       <thead>
3644         <col>
3645           <para>Fieldname</para>
3646         </col>
3647         <col>
3648           <para>Fieldtype</para>
3649         </col>
3650         <col>
3651           <para>Size</para>
3652         </col>
3653         <col>
3654           <para>Remarks</para>
3655         </col>
3656       </thead>
3657       <row>
3658         <col>
3659           <para>objectid</para>
3660         </col>
3661         <col>
3662           <para>Bigint</para>
3663         </col>
3664         <col>
3665           <para>8</para>
3666         </col>
3667         <col>
3668           <para>Reference to the object</para>
3669         </col>
3670       </row>
3671       <row>
3672         <col>
3673           <para>system_username</para>
3674         </col>
3675         <col>
3676           <para>Text</para>
3677         </col>
3678         <col>
3679           <para/>
3680         </col>
3681         <col>
3682           <para>Username on the object/system.</para>
3683         </col>
3684       </row>
3685       <row>
3686         <col>
3687           <para>can_login</para>
3688         </col>
3689         <col>
3690           <para>Boolean</para>
3691         </col>
3692         <col>
3693           <para/>
3694         </col>
3695         <col>
3696           <para>Can this user login (T = Yes / F = No)?</para>
3697         </col>
3698       </row>
3699       <row>
3700         <col>
3701           <para>can_be_root</para>
3702         </col>
3703         <col>
3704           <para>Boolean</para>
3705         </col>
3706         <col>
3707           <para/>
3708         </col>
3709         <col>
3710           <para>Can this user become root (T = Yes / F = No)?</para>
3711         </col>
3712       </row>
3713     </table>
3714     </subsubsection>
3715
3716 <subsubsection>
3717   <heading>The indexes.</heading>
3718
3719 <para>
3720 The table is indexed on the following fields:
3721 </para>
3722 <table cpos='lll'>
3723       <thead>
3724         <col>
3725           <para>Indexname</para>
3726         </col>
3727         <col>
3728           <para>Field</para>
3729         </col>
3730         <col>
3731           <para>Characteristics</para>
3732         </col>
3733       </thead>
3734       <row>
3735         <col>
3736           <para>osu_pk</para>
3737         </col>
3738         <col>
3739           <para>objectid</para>
3740         </col>
3741         <col>
3742           <para>Primary key</para>
3743         </col>
3744       </row>
3745       <row>
3746         <col>
3747           <para/>
3748         </col>
3749         <col>
3750           <para>system_username</para>
3751         </col>
3752         <col>
3753           <para>Primary key</para>
3754         </col>
3755       </row>
3756       <row>
3757         <col>
3758           <para>osu_objectid</para>
3759         </col>
3760         <col>
3761           <para>objectid</para>
3762         </col>
3763         <col>
3764           <para/>
3765         </col>
3766       </row>
3767       <row>
3768         <col>
3769           <para>osu_system_username</para>
3770         </col>
3771         <col>
3772           <para>system_username</para>
3773         </col>
3774         <col>
3775           <para/>
3776         </col>
3777       </row>
3778     </table>
3779     </subsubsection>
3780
3781 <subsubsection>
3782   <heading>The relationships.</heading>
3783
3784 <para>
3785 Relationships with other tables:
3786 </para>
3787 <table cpos='llp{8cm}'>
3788       <thead>
3789         <col>
3790           <para>Fieldname</para>
3791         </col>
3792         <col>
3793           <para>Remote Table</para>
3794         </col>
3795         <col>
3796           <para>Remarks</para>
3797         </col>
3798       </thead>
3799       <row>
3800         <col>
3801           <para>ObjectID</para>
3802         </col>
3803         <col>
3804           <para>Object</para>
3805         </col>
3806         <col>
3807           <para>Reference to the object (which object does this apply to).</para>
3808         </col>
3809       </row>
3810       <row>
3811         <col>
3812           <para>System_username</para>
3813         </col>
3814         <col>
3815           <para>Log</para>
3816         </col>
3817         <col>
3818           <para>Log entries can refer to the system username.</para>
3819         </col>
3820       </row>
3821     </table>
3822     <para>In the model this look like this:</para>
3823     <para/>
3824
3825     <para>
3826       <picture src="erd-objsysusr.png" eps="erd-objsysusr"/>
3827     </para>
3828     </subsubsection>
3829 </subsection>
3830
3831 <subsection>
3832   <heading>object_user</heading>
3833
3834 <para>
3835 This table will enable users to get access to the information belonging to an object.
3836 Also this table is mainly used for data retrieval and will rely on the indexes.
3837 </para>
3838 <subsubsection>
3839   <heading>The fields.</heading>
3840
3841 <para>
3842 The fields of <emph>object_user</emph> are listed below:
3843 </para>
3844
3845 <table cpos='lllp{6cm}'>
3846       <thead>
3847         <col>
3848           <para>Fieldname</para>
3849         </col>
3850         <col>
3851           <para>Fieldtype</para>
3852         </col>
3853         <col>
3854           <para>Size</para>
3855         </col>
3856         <col>
3857           <para>Remarks</para>
3858         </col>
3859       </thead>
3860       <row>
3861         <col>
3862           <para>Objectid</para>
3863         </col>
3864         <col>
3865           <para>Bigint</para>
3866         </col>
3867         <col>
3868           <para>8</para>
3869         </col>
3870         <col>
3871           <para>Reference to the <emph>object</emph></para>
3872         </col>
3873       </row>
3874       <row>
3875         <col>
3876           <para>Username</para>
3877         </col>
3878         <col>
3879           <para>Text</para>
3880         </col>
3881         <col>
3882           <para/>
3883         </col>
3884         <col>
3885           <para>Username in gnucomo. A reference to <emph>user</emph>.</para>
3886         </col>
3887       </row>
3888       <row>
3889         <col>
3890           <para>Security_level</para>
3891         </col>
3892         <col>
3893           <para>Int</para>
3894         </col>
3895         <col>
3896           <para/>
3897         </col>
3898         <col>
3899           <para>The security-level granted to this user.</para>
3900         </col>
3901       </row>
3902     </table>
3903 </subsubsection>
3904
3905 <subsubsection>
3906   <heading>The indexes.</heading>
3907 <para>
3908 The indices of the <emph>object_user</emph> table:
3909 </para>
3910 <table cpos='lll'>
3911       <thead>
3912         <col>
3913           <para>Indexname</para>
3914         </col>
3915         <col>
3916           <para>Field</para>
3917         </col>
3918         <col>
3919           <para>Characteristics</para>
3920         </col>
3921       </thead>
3922       <row>
3923         <col>
3924           <para>ous_pk</para>
3925         </col>
3926         <col>
3927           <para>objectid</para>
3928         </col>
3929         <col>
3930           <para>Primary key</para>
3931         </col>
3932       </row>
3933       <row>
3934         <col>
3935           <para/>
3936         </col>
3937         <col>
3938           <para>username</para>
3939         </col>
3940         <col>
3941           <para>Primary key</para>
3942         </col>
3943       </row>
3944       <row>
3945         <col>
3946           <para>ous_objectid</para>
3947         </col>
3948         <col>
3949           <para>objectid</para>
3950         </col>
3951         <col>
3952           <para/>
3953         </col>
3954       </row>
3955       <row>
3956         <col>
3957           <para>ous_username</para>
3958         </col>
3959         <col>
3960           <para>username</para>
3961         </col>
3962         <col>
3963           <para/>
3964         </col>
3965       </row>
3966       <row>
3967         <col>
3968           <para>ous_security_level</para>
3969         </col>
3970         <col>
3971           <para>ous_security_level</para>
3972         </col>
3973         <col>
3974           <para/>
3975         </col>
3976       </row>
3977     </table>
3978 </subsubsection>
3979
3980 <subsubsection>
3981   <heading>The relationships.</heading>
3982
3983 <para>
3984 Relationshiips with other tables:
3985 </para>
3986
3987 <table cpos='llp{8cm}'>
3988       <thead>
3989         <col>
3990           <para>Fieldname</para>
3991         </col>
3992         <col>
3993           <para>Remote Table</para>
3994         </col>
3995         <col>
3996           <para>Remarks</para>
3997         </col>
3998       </thead>
3999       <row>
4000         <col>
4001           <para>objectID</para>
4002         </col>
4003         <col>
4004           <para>object</para>
4005         </col>
4006         <col>
4007           <para>Reference to the object (which object does this apply to).</para>
4008         </col>
4009       </row>
4010       <row>
4011         <col>
4012           <para>username</para>
4013         </col>
4014         <col>
4015           <para>user</para>
4016         </col>
4017         <col>
4018           <para>Reference to the user.</para>
4019         </col>
4020       </row>
4021     </table>
4022
4023     <para>In the model this look like this:</para>
4024     <picture src="erd-objusr.png" eps="erd-objusr"/>
4025
4026 </subsubsection>
4027 </subsection>
4028
4029 <subsection>
4030   <heading>priority</heading>
4031
4032 <para>
4033 The priority table contains information on the levels that are recognized by the system.
4034 Mainly data retrieval so depending on indexing.
4035 It needs to be said that most likely only a couple of states will exist<footnote>By default
4036 we will use five states, but many states can be given to enable all
4037 types of differentiation.</footnote>.
4038 </para>
4039
4040 <subsubsection>
4041   <heading>The fields.</heading>
4042
4043 <para>
4044 The fields of the <emph>priority</emph> table are listed below:
4045 </para>
4046
4047 <table cpos='lllp{6cm}'>
4048       <thead>
4049         <col>
4050           <para>Fieldname</para>
4051         </col>
4052         <col>
4053           <para>Fieldtype</para>
4054         </col>
4055         <col>
4056           <para>Size</para>
4057         </col>
4058         <col>
4059           <para>Remarks</para>
4060         </col>
4061       </thead>
4062       <row>
4063         <col>
4064           <para>priority</para>
4065         </col>
4066         <col>
4067           <para>Int</para>
4068         </col>
4069         <col>
4070           <para>4</para>
4071         </col>
4072         <col>
4073           <para>Priority</para>
4074         </col>
4075       </row>
4076       <row>
4077         <col>
4078           <para>send_mail</para>
4079         </col>
4080         <col>
4081           <para>Boolean</para>
4082         </col>
4083         <col>
4084           <para/>
4085         </col>
4086         <col>
4087           <para>Send an e-mail if this priority is set? Yes = T / No = F</para>
4088         </col>
4089       </row>
4090       <row>
4091         <col>
4092           <para>send_sms</para>
4093         </col>
4094         <col>
4095           <para>Boolean</para>
4096         </col>
4097         <col>
4098           <para/>
4099         </col>
4100         <col>
4101           <para>Send a sms message if this priority is set? Yes = T / No = F</para>
4102         </col>
4103       </row>
4104       <row>
4105         <col>
4106           <para>send_fax</para>
4107         </col>
4108         <col>
4109           <para>Boolean</para>
4110         </col>
4111         <col>
4112           <para/>
4113         </col>
4114         <col>
4115           <para>Send a fax if this priority is set? Yes = T / No = F</para>
4116         </col>
4117       </row>
4118       <row>
4119         <col>
4120           <para>repeat_notification</para>
4121         </col>
4122         <col>
4123           <para>Boolean</para>
4124         </col>
4125         <col>
4126           <para/>
4127         </col>
4128         <col>
4129           <para>Repeat this notification if no action occurs since the notification. Yes = T / No = F</para>
4130         </col>
4131       </row>
4132       <row>
4133         <col>
4134           <para>interval_for_repeat</para>
4135         </col>
4136         <col>
4137           <para>Time</para>
4138         </col>
4139         <col>
4140           <para/>
4141         </col>
4142         <col>
4143           <para>Time interval that is set to wait for a response.</para>
4144         </col>
4145       </row>
4146     </table>
4147 </subsubsection>
4148
4149 <subsubsection>
4150   <heading>The indexes.</heading>
4151
4152 <para>
4153 The table is indexed on the following fields:
4154 </para>
4155
4156 <table cpos='lll'>
4157       <thead>
4158         <col>
4159           <para>Indexname</para>
4160         </col>
4161         <col>
4162           <para>Field</para>
4163         </col>
4164         <col>
4165           <para>Characteristics</para>
4166         </col>
4167       </thead>
4168       <row>
4169         <col>
4170           <para>pri_pk</para>
4171         </col>
4172         <col>
4173           <para>priority</para>
4174         </col>
4175         <col>
4176           <para>Primary key</para>
4177         </col>
4178       </row>
4179     </table>
4180 </subsubsection>
4181
4182 <subsubsection>
4183   <heading>The relationships.</heading>
4184
4185 <para>
4186 Relationships with other tables:
4187 </para>
4188 <table cpos='llp{8cm}'>
4189       <thead>
4190         <col>
4191           <para>Fieldname</para>
4192         </col>
4193         <col>
4194           <para>Remote Table</para>
4195         </col>
4196         <col>
4197           <para>Remarks</para>
4198         </col>
4199       </thead>
4200       <row>
4201         <col>
4202           <para>priority</para>
4203         </col>
4204         <col>
4205           <para>object_priority</para>
4206         </col>
4207         <col>
4208           <para>Reference to the object (which object does this apply to). </para>
4209         </col>
4210       </row>
4211     </table>
4212
4213     <para>In the model this look like this:</para>
4214     <para>
4215       <picture src="erd-prior.png" eps="erd-prior"/>
4216     </para>
4217 </subsubsection>
4218 </subsection>
4219
4220 <subsection>
4221   <heading>service</heading>
4222
4223 <para>
4224 The table <emph>service</emph> indicates the service that can be handled by the system.
4225 Out of the servicelist the administrator can indicate what services to expect.
4226 </para>
4227 <subsubsection>
4228   <heading>The fields.</heading>
4229
4230 <para>
4231 The fields are listed below:
4232 </para>
4233 <table cpos='lllp{6cm}'>
4234       <thead>
4235         <col>
4236           <para>Fieldname</para>
4237         </col>
4238         <col>
4239           <para>Fieldtype</para>
4240         </col>
4241         <col>
4242           <para>Size</para>
4243         </col>
4244         <col>
4245           <para>Remarks</para>
4246         </col>
4247       </thead>
4248       <row>
4249         <col>
4250           <para>servicecode</para>
4251         </col>
4252         <col>
4253           <para>Text</para>
4254         </col>
4255         <col>
4256           <para/>
4257         </col>
4258         <col>
4259           <para>The code that is written for the service</para>
4260         </col>
4261       </row>
4262       <row>
4263         <col>
4264           <para>servicename</para>
4265         </col>
4266         <col>
4267           <para>Text</para>
4268         </col>
4269         <col>
4270           <para/>
4271         </col>
4272         <col>
4273           <para>The expanded name for the service</para>
4274         </col>
4275       </row>
4276       <row>
4277         <col>
4278           <para>default_priority</para>
4279         </col>
4280         <col>
4281           <para>Int</para>
4282         </col>
4283         <col>
4284           <para>4</para>
4285         </col>
4286         <col>
4287           <para>The advised priority if these log-entries don't
4288            come in<footnote>Advised priorities can be changed in the object_service
4289            table per object. </footnote>.</para>
4290         </col>
4291       </row>
4292       <row>
4293         <col>
4294           <para>max_priority</para>
4295         </col>
4296         <col>
4297           <para>Int</para>
4298         </col>
4299         <col>
4300           <para>4</para>
4301         </col>
4302         <col>
4303           <para>The maximum priority advised for this
4304           service<footnote>Advised priorities can be changed in the
4305           object_service table per object.</footnote>.</para>
4306         </col>
4307       </row>
4308     </table>
4309 </subsubsection>
4310
4311 <subsubsection>
4312   <heading>The indexes.</heading>
4313
4314 <para>
4315 The table is indexed on the following fields:
4316 </para>
4317 <table cpos='lll'>
4318       <thead>
4319         <col>
4320           <para>Indexname</para>
4321         </col>
4322         <col>
4323           <para>Field</para>
4324         </col>
4325         <col>
4326           <para>Characteristics</para>
4327         </col>
4328       </thead>
4329       <row>
4330         <col>
4331           <para>ser_pk</para>
4332         </col>
4333         <col>
4334           <para>servicecode</para>
4335         </col>
4336         <col>
4337           <para>Primary key</para>
4338         </col>
4339       </row>
4340       <row>
4341         <col>
4342           <para>ser_servicename</para>
4343         </col>
4344         <col>
4345           <para>servicename</para>
4346         </col>
4347         <col>
4348           <para>Unique</para>
4349         </col>
4350       </row>
4351     </table>
4352 </subsubsection>
4353
4354 <subsubsection>
4355   <heading>The relationships.</heading>
4356 <para>
4357 Relationships with other tables:
4358 </para>
4359 <table cpos='llp{8cm}'>
4360       <thead>
4361         <col>
4362           <para>Fieldname</para>
4363         </col>
4364         <col>
4365           <para>Remote Table</para>
4366         </col>
4367         <col>
4368           <para>Remarks</para>
4369         </col>
4370       </thead>
4371       <row>
4372         <col>
4373           <para>servicecode</para>
4374         </col>
4375         <col>
4376           <para>log</para>
4377         </col>
4378         <col>
4379           <para>What log entries have been tied to this type of service.</para>
4380         </col>
4381       </row>
4382       <row>
4383         <col>
4384           <para/>
4385         </col>
4386         <col>
4387           <para>object_service</para>
4388         </col>
4389         <col>
4390           <para>Settings for this service per object.</para>
4391         </col>
4392       </row>
4393       <row>
4394         <col>
4395           <para/>
4396         </col>
4397         <col>
4398           <para>unprocessed_log</para>
4399         </col>
4400         <col>
4401           <para>What unprocessed log entries have been tied to this type of service.</para>
4402         </col>
4403       </row>
4404     </table>
4405
4406     <para>In the model this look like this:</para>
4407     <para>
4408       <picture src="erd-service.png" eps="erd-service"/>
4409     </para>
4410 </subsubsection>
4411 </subsection>
4412
4413 <subsection>
4414   <heading>status.</heading>
4415
4416 <para>
4417 The table <emph>status</emph> contains the possible states that a notification can have.
4418 As with the table <emph>priority</emph> these statuses are limited in number by
4419 default but can be expanded. Also here retrieval prevails above data entry and
4420 therefor indexing is important.
4421 </para>
4422
4423 <subsubsection>
4424   <heading>The fields.</heading>
4425
4426 <para>
4427 The fields of the <emph>status</emph> table are listed below:
4428 </para>
4429
4430 <table cpos='lllp{6cm}'>
4431       <thead>
4432         <col>
4433           <para>Fieldname</para>
4434         </col>
4435         <col>
4436           <para>Fieldtype</para>
4437         </col>
4438         <col>
4439           <para>Size</para>
4440         </col>
4441         <col>
4442           <para>Remarks</para>
4443         </col>
4444       </thead>
4445       <row>
4446         <col>
4447           <para>statuscode</para>
4448         </col>
4449         <col>
4450           <para>Varchar</para>
4451         </col>
4452         <col>
4453           <para>3</para>
4454         </col>
4455         <col>
4456           <para>The code for the status</para>
4457         </col>
4458       </row>
4459       <row>
4460         <col>
4461           <para>statusname</para>
4462         </col>
4463         <col>
4464           <para>Text</para>
4465         </col>
4466         <col>
4467           <para/>
4468         </col>
4469         <col>
4470           <para>What is the correct name for the status</para>
4471         </col>
4472       </row>
4473       <row>
4474         <col>
4475           <para>open_notification</para>
4476         </col>
4477         <col>
4478           <para>Boolean</para>
4479         </col>
4480         <col>
4481           <para/>
4482         </col>
4483         <col>
4484           <para>Is the notification still open when this status is set? Yes = T / No = F</para>
4485         </col>
4486       </row>
4487       <row>
4488         <col>
4489           <para>description</para>
4490         </col>
4491         <col>
4492           <para>Text</para>
4493         </col>
4494         <col>
4495           <para/>
4496         </col>
4497         <col>
4498           <para>Explanation of the code</para>
4499         </col>
4500       </row>
4501     </table>
4502 </subsubsection>
4503
4504 <subsubsection>
4505   <heading>The indexes.</heading>
4506 <para>
4507 The table is indexed on the following fields:
4508 </para>
4509
4510 <table cpos='lll'>
4511       <thead>
4512         <col>
4513           <para>Indexname</para>
4514         </col>
4515         <col>
4516           <para>Field</para>
4517         </col>
4518         <col>
4519           <para>Characteristics</para>
4520         </col>
4521       </thead>
4522       <row>
4523         <col>
4524           <para>sta_pk</para>
4525         </col>
4526         <col>
4527           <para>statuscode</para>
4528         </col>
4529         <col>
4530           <para>Primary key</para>
4531         </col>
4532       </row>
4533       <row>
4534         <col>
4535           <para>sta_statusname</para>
4536         </col>
4537         <col>
4538           <para>statusname</para>
4539         </col>
4540         <col>
4541           <para>Unique</para>
4542         </col>
4543       </row>
4544       <row>
4545         <col>
4546           <para>sta_open_notification</para>
4547         </col>
4548         <col>
4549           <para>open_notification</para>
4550         </col>
4551         <col>
4552           <para/>
4553         </col>
4554       </row>
4555     </table>
4556 </subsubsection>
4557
4558 <subsubsection>
4559   <heading>The relationships.</heading>
4560 <para>
4561 Relationships with other tables
4562 </para>
4563
4564 <table cpos='lll'>
4565       <thead>
4566         <col>
4567           <para>Fieldname</para>
4568         </col>
4569         <col>
4570           <para>Remote Table</para>
4571         </col>
4572         <col>
4573           <para>Remarks</para>
4574         </col>
4575       </thead>
4576       <row>
4577         <col>
4578           <para/>
4579         </col>
4580         <col>
4581           <para/>
4582         </col>
4583         <col>
4584           <para/>
4585         </col>
4586       </row>
4587     </table>
4588     <para>In the model this look like this:</para>
4589     <para>
4590       <picture src="erd-status.png" eps="erd-status"/>
4591     </para>
4592 </subsubsection>
4593
4594 <subsubsection>
4595   <heading>Default values.</heading>
4596 <para>The status values are default for the system and for that reason are predefined.</para>
4597 <table cpos='p{2cm}lp{1cm}p{6cm}'>
4598       <thead>
4599         <col>
4600           <para>Statuscode</para>
4601         </col>
4602         <col>
4603           <para>Statusname</para>
4604         </col>
4605         <col>
4606           <para>Open Notification</para>
4607         </col>
4608         <col>
4609           <para/>
4610         </col>
4611       </thead>
4612       <row>
4613         <col>
4614           <para>new</para>
4615         </col>
4616         <col>
4617           <para>New entry</para>
4618         </col>
4619         <col>
4620           <para>T</para>
4621         </col>
4622         <col>
4623           <para>Just detected nothing has been done yet.</para>
4624         </col>
4625       </row>
4626       <row>
4627         <col>
4628           <para>opn</para>
4629         </col>
4630         <col>
4631           <para>Open</para>
4632         </col>
4633         <col>
4634           <para>T</para>
4635         </col>
4636         <col>
4637           <para>The notification has been displayed, but nothing has been done yet.</para>
4638         </col>
4639       </row>
4640       <row>
4641         <col>
4642           <para>pen</para>
4643         </col>
4644         <col>
4645           <para>Pending</para>
4646         </col>
4647         <col>
4648           <para>T</para>
4649         </col>
4650         <col>
4651           <para>The notification is currently being worked on.</para>
4652         </col>
4653       </row>
4654       <row>
4655         <col>
4656           <para>ver</para>
4657         </col>
4658         <col>
4659           <para>Waiting for verification</para>
4660         </col>
4661         <col>
4662           <para>T</para>
4663         </col>
4664         <col>
4665           <para>The notification has been worked on.
4666           After it has been verified the notification can be closed.</para>
4667         </col>
4668       </row>
4669       <row>
4670         <col>
4671           <para>cls</para>
4672         </col>
4673         <col>
4674           <para>Closed</para>
4675         </col>
4676         <col>
4677           <para>F</para>
4678         </col>
4679         <col>
4680           <para>The notification has been closed</para>
4681         </col>
4682       </row>
4683       <row>
4684         <col>
4685           <para>rej</para>
4686         </col>
4687         <col>
4688           <para>Rejected</para>
4689         </col>
4690         <col>
4691           <para>F</para>
4692         </col>
4693         <col>
4694           <para>This was a false positive and has been rejected.</para>
4695         </col>
4696       </row>
4697       <row>
4698         <col>
4699           <para>inv</para>
4700         </col>
4701         <col>
4702           <para>Investigate</para>
4703         </col>
4704         <col>
4705           <para>T</para>
4706         </col>
4707         <col>
4708           <para>The notification is under investigation and awaiting additional details.</para>
4709         </col>
4710       </row>
4711     </table>
4712 </subsubsection>
4713 </subsection>
4714
4715 <subsection>
4716   <heading>type_of_issue.</heading>
4717
4718 <para>
4719 This table will contain a list of all available issues that can be detected.
4720 All issues have a suggested priority setting.
4721 This is typically data retrieval and good indexing is needed.</para>
4722
4723 <subsubsection>
4724   <heading>The fields.</heading>
4725
4726 <para>
4727 Fields of <emph>type_of_issue</emph> are:
4728 </para>
4729
4730 <table cpos='lllp{6cm}'>
4731       <thead>
4732         <col>
4733           <para>Fieldname</para>
4734         </col>
4735         <col>
4736           <para>Fieldtype</para>
4737         </col>
4738         <col>
4739           <para>Size</para>
4740         </col>
4741         <col>
4742           <para>Remarks</para>
4743         </col>
4744       </thead>
4745       <row>
4746         <col>
4747           <para>type_of_issueid</para>
4748         </col>
4749         <col>
4750           <para>Bigserial</para>
4751         </col>
4752         <col>
4753           <para>8</para>
4754         </col>
4755         <col>
4756           <para>The sequential code for the issue.</para>
4757         </col>
4758       </row>
4759       <row>
4760         <col>
4761           <para>name</para>
4762         </col>
4763         <col>
4764           <para>Text</para>
4765         </col>
4766         <col>
4767           <para/>
4768         </col>
4769         <col>
4770           <para>Name for the issue</para>
4771         </col>
4772       </row>
4773       <row>
4774         <col>
4775           <para>suggested_priority</para>
4776         </col>
4777         <col>
4778           <para>Int</para>
4779         </col>
4780         <col>
4781           <para>4</para>
4782         </col>
4783         <col>
4784           <para>The advised priority setting.</para>
4785         </col>
4786       </row>
4787       <row>
4788         <col>
4789           <para>description</para>
4790         </col>
4791         <col>
4792           <para>Text</para>
4793         </col>
4794         <col>
4795           <para/>
4796         </col>
4797         <col>
4798           <para>Description of the method and how this can be set.</para>
4799         </col>
4800       </row>
4801       <row>
4802         <col>
4803           <para>active</para>
4804         </col>
4805         <col>
4806           <para>Boolean</para>
4807         </col>
4808         <col>
4809           <para/>
4810         </col>
4811         <col>
4812           <para>Is this check currently being used in the system.</para>
4813         </col>
4814       </row>
4815     </table>
4816 </subsubsection>
4817
4818 <subsubsection>
4819   <heading>The indexes.</heading>
4820 <para>
4821 The table is indexed on the following fields:
4822 </para>
4823
4824 <table cpos='lll'>
4825       <thead>
4826         <col>
4827           <para>Indexname</para>
4828         </col>
4829         <col>
4830           <para>Field</para>
4831         </col>
4832         <col>
4833           <para>Characteristics</para>
4834         </col>
4835       </thead>
4836       <row>
4837         <col>
4838           <para>toi_pk</para>
4839           <para>(type_of_issue_type_of_issue_key)</para>
4840         </col>
4841         <col>
4842           <para>type_of_issueid</para>
4843         </col>
4844         <col>
4845           <para>Primary key</para>
4846         </col>
4847       </row>
4848       <row>
4849         <col>
4850           <para>toi_name</para>
4851         </col>
4852         <col>
4853           <para>name</para>
4854         </col>
4855         <col>
4856           <para>Unique</para>
4857         </col>
4858       </row>
4859       <row>
4860         <col>
4861           <para>toi_active</para>
4862         </col>
4863         <col>
4864           <para>active</para>
4865         </col>
4866         <col>
4867           <para/>
4868         </col>
4869       </row>
4870     </table>
4871 </subsubsection>
4872
4873 <subsubsection>
4874   <heading>The relationships.</heading>
4875 <table cpos='lll'>
4876       <thead>
4877         <col>
4878           <para>Fieldname</para>
4879         </col>
4880         <col>
4881           <para>Remote Table</para>
4882         </col>
4883         <col>
4884           <para>Remarks</para>
4885         </col>
4886       </thead>
4887       <row>
4888         <col>
4889           <para>type_of_issueid</para>
4890         </col>
4891         <col>
4892           <para>object_issue</para>
4893         </col>
4894         <col>
4895           <para/>
4896         </col>
4897       </row>
4898     </table>
4899
4900     <para>In the model this look like this:</para>
4901     <para>
4902       <picture src="erd-toi.png" eps="erd-toi"/>
4903     </para>
4904 </subsubsection>
4905
4906 <subsubsection>
4907   <heading>Default values.</heading>
4908
4909 <para>
4910 All checks are entered as code into the system.
4911 This table only works for the application only.
4912 The user can set specifics in the application only.
4913 </para>
4914 <table cpos='lllll'>
4915       <thead>
4916         <col>
4917           <para>Type_of_issueid</para>
4918         </col>
4919         <col>
4920           <para>Name</para>
4921         </col>
4922         <col>
4923           <para>Suggested_priority</para>
4924         </col>
4925         <col>
4926           <para>Description</para>
4927         </col>
4928         <col>
4929           <para>Active</para>
4930         </col>
4931       </thead>
4932       <row>
4933         <col>
4934           <para>1</para>
4935         </col>
4936         <col>
4937           <para>Manual entry</para>
4938         </col>
4939         <col>
4940           <para>4</para>
4941         </col>
4942         <col>
4943           <para>A manual entry of a notification.</para>
4944         </col>
4945         <col>
4946           <para>T</para>
4947         </col>
4948       </row>
4949 </table>
4950 </subsubsection>
4951 </subsection>
4952
4953 <subsection>
4954   <heading>unprocessed_log</heading>
4955
4956 <para>
4957 The <emph>user</emph> table contains the users that can login the monitoring application.
4958 It will also store if the users maintains the system.
4959 Mainly used for retrieval so properly indexed.
4960 </para>
4961
4962 <subsubsection>
4963   <heading>The fields.</heading>
4964
4965 <para>
4966 The fields are listed below:
4967 </para>
4968
4969 <table cpos='lllp{6cm}'>
4970       <thead>
4971         <col>
4972           <para>Fieldname</para>
4973         </col>
4974         <col>
4975           <para>Fieldtype</para>
4976         </col>
4977         <col>
4978           <para>Size</para>
4979         </col>
4980         <col>
4981           <para>Remarks</para>
4982         </col>
4983       </thead>
4984       <row>
4985         <col>
4986           <para>unprocessedid</para>
4987         </col>
4988         <col>
4989           <para>Bigserial</para>
4990         </col>
4991         <col>
4992           <para/>
4993         </col>
4994         <col>
4995           <para>Autonumber entry</para>
4996         </col>
4997       </row>
4998       <row>
4999         <col>
5000           <para>objectid</para>
5001         </col>
5002         <col>
5003           <para>Bigint</para>
5004         </col>
5005         <col>
5006           <para/>
5007         </col>
5008         <col>
5009           <para>Reference to the object</para>
5010         </col>
5011       </row>
5012       <row>
5013         <col>
5014           <para>servicecode</para>
5015         </col>
5016         <col>
5017           <para>Text</para>
5018         </col>
5019         <col>
5020           <para/>
5021         </col>
5022         <col>
5023           <para>The service that entered this data.</para>
5024         </col>
5025       </row>
5026       <row>
5027         <col>
5028           <para>logdata</para>
5029         </col>
5030         <col>
5031           <para>Text</para>
5032         </col>
5033         <col>
5034           <para/>
5035         </col>
5036         <col>
5037           <para>The data that comes from the file.</para>
5038         </col>
5039       </row>
5040     </table>
5041 </subsubsection>
5042
5043 <subsubsection>
5044   <heading>The indexes.</heading>
5045 <para>
5046 The indices of the table:
5047 </para>
5048
5049 <table cpos='lll'>
5050       <thead>
5051         <col>
5052           <para>Indexname</para>
5053         </col>
5054         <col>
5055           <para>Field</para>
5056         </col>
5057         <col>
5058           <para>Characteristics</para>
5059         </col>
5060       </thead>
5061       <row>
5062         <col>
5063           <para>unl_pk</para>
5064           <para>(unprocessed_l_unprocessedid_key)</para>
5065         </col>
5066         <col>
5067           <para>unprocessedid</para>
5068         </col>
5069         <col>
5070           <para>Primary key</para>
5071         </col>
5072       </row>
5073     </table>
5074 </subsubsection>
5075
5076 <subsubsection>
5077   <heading>The relationships.</heading>
5078 <para>
5079 Relationships with other tables:
5080 </para>
5081
5082 <table cpos='llp{8cm}'>
5083       <thead>
5084         <col>
5085           <para>Fieldname</para>
5086         </col>
5087         <col>
5088           <para>Remote Table</para>
5089         </col>
5090         <col>
5091           <para>Remarks</para>
5092         </col>
5093       </thead>
5094       <row>
5095         <col>
5096           <para>objectid</para>
5097         </col>
5098         <col>
5099           <para>object</para>
5100         </col>
5101         <col>
5102           <para>Reference to the object that is reporting the data</para>
5103         </col>
5104       </row>
5105       <row>
5106         <col>
5107           <para>servicecode</para>
5108         </col>
5109         <col>
5110           <para>service</para>
5111         </col>
5112         <col>
5113           <para>Reference to the servicecode that is mentioned in the filename.</para>
5114         </col>
5115       </row>
5116     </table>
5117     <para>In the model this look like this:</para>
5118     <para>
5119       <picture src="erd-unplog.png" eps="erd-unplog"/>
5120     </para>
5121 </subsubsection>
5122
5123 <subsubsection>
5124   <heading>Sample values.</heading>
5125     <para>To do</para>
5126 </subsubsection>
5127 </subsection>
5128
5129 <subsection>
5130   <heading>user_gnucomo</heading>
5131
5132 <para>
5133 The <emph>user</emph> table contains the users that can login the monitoring application.
5134 It will also store if the users maintains the system.
5135 Mainly used for retrieval so properly indexed.
5136 </para>
5137
5138 <subsubsection>
5139   <heading>The fields.</heading>
5140
5141 <para>
5142 The fields are listed in the table below:
5143 </para>
5144
5145 <table cpos='lllp{6cm}'>
5146       <thead>
5147         <col>
5148           <para>Fieldname</para>
5149         </col>
5150         <col>
5151           <para>Fieldtype</para>
5152         </col>
5153         <col>
5154           <para>Size</para>
5155         </col>
5156         <col>
5157           <para>Remarks</para>
5158         </col>
5159       </thead>
5160       <row>
5161         <col>
5162           <para>username</para>
5163         </col>
5164         <col>
5165           <para>Text</para>
5166         </col>
5167         <col>
5168           <para/>
5169         </col>
5170         <col>
5171           <para>Name the user is known by</para>
5172         </col>
5173       </row>
5174       <row>
5175         <col>
5176           <para>password</para>
5177         </col>
5178         <col>
5179           <para>Text</para>
5180         </col>
5181         <col>
5182           <para/>
5183         </col>
5184         <col>
5185           <para>Password</para>
5186         </col>
5187       </row>
5188       <row>
5189         <col>
5190           <para>active_sessionid</para>
5191         </col>
5192         <col>
5193           <para>Bigint</para>
5194         </col>
5195         <col>
5196           <para/>
5197         </col>
5198         <col>
5199           <para>Sessionnumber currently used by user.
5200           If this is set to 0 a user is not present on the system.
5201           Only one session can be open at a time.</para>
5202         </col>
5203       </row>
5204       <row>
5205         <col>
5206           <para>account_active</para>
5207         </col>
5208         <col>
5209           <para>Boolean</para>
5210         </col>
5211         <col>
5212           <para/>
5213         </col>
5214         <col>
5215           <para>Is the account currently active?</para>
5216         </col>
5217       </row>
5218       <row>
5219         <col>
5220           <para>security_level</para>
5221         </col>
5222         <col>
5223           <para>Int</para>
5224         </col>
5225         <col>
5226           <para/>
5227         </col>
5228         <col>
5229           <para>Given securitylevel to this user</para>
5230         </col>
5231       </row>
5232     </table>
5233 </subsubsection>
5234
5235 <subsubsection>
5236   <heading>The indexes</heading>
5237 <para>
5238 The table is indexed on the following fields:
5239 </para>
5240 <table cpos='lll'>
5241       <thead>
5242         <col>
5243           <para>Indexname</para>
5244         </col>
5245         <col>
5246           <para>Field</para>
5247         </col>
5248         <col>
5249           <para>Characteristics</para>
5250         </col>
5251       </thead>
5252       <row>
5253         <col>
5254           <para>usr_pk</para>
5255         </col>
5256         <col>
5257           <para>username</para>
5258         </col>
5259         <col>
5260           <para>Primary key</para>
5261         </col>
5262       </row>
5263       <row>
5264         <col>
5265           <para>usr_active_sessionid</para>
5266         </col>
5267         <col>
5268           <para>active_sessionid</para>
5269         </col>
5270         <col>
5271           <para>Unique</para>
5272         </col>
5273       </row>
5274     </table>
5275 </subsubsection>
5276
5277 <subsubsection>
5278   <heading>The relationships.</heading>
5279 <para>
5280 Relationships with other tables
5281 </para>
5282 <table cpos='lll'>
5283       <thead>
5284         <col>
5285           <para>Fieldname</para>
5286         </col>
5287         <col>
5288           <para>Remote Table</para>
5289         </col>
5290         <col>
5291           <para>Remarks</para>
5292         </col>
5293       </thead>
5294       <row>
5295         <col>
5296           <para>ObjectID</para>
5297         </col>
5298         <col>
5299           <para>Object</para>
5300         </col>
5301         <col>
5302           <para>Link to the object</para>
5303         </col>
5304       </row>
5305     </table>
5306     <para>In the model this look like this:</para>
5307     <para>
5308       <picture src="erd-usr.png" eps="erd-usr"/>
5309     </para>
5310 </subsubsection>
5311 </subsection>
5312 </section>
5313
5314 </chapter>
5315
5316 <chapter>
5317   <heading>Warnings that can be detected.</heading>
5318 </chapter>
5319
5320     <chapter>
5321       <heading>User Interface.</heading>
5322
5323     <para>To be determined in the near future.</para>
5324 </chapter>
5325
5326 <chapter>
5327   <heading>The installation process.</heading>
5328
5329 <para>
5330 Since the system must make maintenance and security easier to use,
5331 the burden of installation should as easy as possible.
5332 Where possible the installation script should take away as much work as possible.
5333 Where settings need to be done, this should be done through an interface.
5334 However at no point we take the user's right to understand and work with system.
5335 Configuration-files should be easy to understand and the choice must be there to do installation manually.
5336 For the time being, we will use the manual installation procedure outlined below:
5337 </para>
5338
5339 <para>
5340 Since there is no binary package available for Gnucomo yet, you will need
5341 to compile and install Gnucomo from the source code.
5342 Before making the Gnucomo binaries, make sure you have the following
5343 packages installed:
5344 <itemize>
5345 <item>postgresql, postgresql-server, postgresql-develop</item>
5346 <item>AXE</item>
5347 <item>libxml2, libxml2-develop</item>
5348 </itemize>
5349
5350 Make sure your PostgreSQL database server is up and running.
5351 If you also want to use the web interface, you will need Apache with PHP.
5352 The PHP module needs Postgresql and DOM-XML support.
5353 With all required packages installed, you should be able to go into
5354 the <emph>src</emph> directory and type <code>make</code> to create
5355 a binary <code>gcm_input</code>.
5356 </para>
5357
5358 <para>
5359 To use gnucomo, you need to create a database and a configuration file.
5360 To make the database in your PostgreSQL server, log in as a DBA (DataBase
5361 Administrator, usually the user 'postgres') and create the database and a
5362 user who can use the database.
5363 Here is an example:
5364
5365 <verbatim>
5366
5367   createdb gnucomo
5368   createuser arjen
5369
5370 </verbatim>
5371
5372 If you also want to be able to use the test scripts, you will need to
5373 create the <code>gnucomo_test</code> database as well.
5374 The configuration file for Gnucomo is a rather simple XML file that
5375 states at least what database Gnucomo uses and the userid with which
5376 Gnucomo will log in to the database server.
5377 These parameters should be the same as the database and user you just
5378 created in your role of DBA.
5379 There is an example configuration file, <code>gnucomo.conf</code> in the
5380 <emph>src</emph> directory.
5381 You should copy this config file to one of the following places:
5382 <enumerate>
5383 <item><code>/etc/gnucomo.conf</code></item>
5384 <item><code>/usr/local/etc/gnucomo.conf</code></item>
5385 </enumerate>
5386 With the database and the configuration file in place, you should
5387 be able to run <code>gcm_input</code> to read log files and store
5388 log entries in the database.
5389 </para>
5390     <section>
5391       <heading>Supported platforms.</heading>
5392
5393     <para>The following two Linux distributions have been selected to be actively supported:</para>
5394     <itemize>
5395       <item>
5396         <para>Debian GNU/Linux (.deb packages)</para>
5397       </item>
5398       <item>
5399         <para>RedHat Linux (.rpm packages)</para>
5400       </item>
5401     </itemize>
5402     <para>We will try and facilitate as many operating systems client-side and as many unices server-side, but efforts on testing out of the projects will be very minimalistic to ensure that the project keeps delivering new version and new features. </para>
5403     </section>
5404
5405     <section>
5406       <heading>Installation on the server.</heading>
5407
5408     <para>The following steps will be part of a script, that can automatically perform these steps:</para>
5409
5410 <enumerate>
5411     <item>
5412       <para>Create the user <emph>gnucomo</emph>.</para>
5413     </item>
5414     <item>
5415       <para>Make the directory as described in the chapter <emph>Sending messages to the central gnucomo system</emph> in the subchapter <emph>directories</emph>.(server-side).</para>
5416     </item>
5417 </enumerate>
5418     </section>
5419
5420     <section>
5421       <heading>Installation on a UNIX-client.</heading>
5422
5423     <para>The following steps will be part of a script, that can automatically perform these steps:</para>
5424 <enumerate>
5425     <item>
5426       <para>Create the user <emph>gcm_client</emph>.</para>
5427     </item>
5428     <item>
5429       <para>Make the directory as described in the chapter <emph>Sending messages to the central gnucomo system</emph> in the subchapter <emph>directories</emph> (client-side).</para>
5430     </item>
5431     <item>
5432       <para>Creation of the database user gcm_input. This user has only the right to enter data into the database. There are no deletion, update or select-permissions.</para>
5433     </item>
5434 </enumerate>
5435
5436     </section>
5437     </chapter>
5438
5439 <chapter>
5440   <heading>Dependency on other free software.</heading>
5441
5442 <para>The following list is a set of applications that will be used on to make our application work:</para>
5443     <table cpos='lp{8cm}l'>
5444       <thead>
5445         <col>
5446           <para>Application</para>
5447         </col>
5448         <col>
5449           <para>Needed for</para>
5450         </col>
5451         <col>
5452           <para>Client/Server</para>
5453         </col>
5454       </thead>
5455       <row>
5456         <col>
5457           <para>gpg</para>
5458         </col>
5459         <col>
5460           <para>The encryption of the information being transferred between the two systems.</para>
5461         </col>
5462         <col>
5463           <para>Client</para>
5464           <para>Server</para>
5465         </col>
5466       </row>
5467       <row>
5468         <col>
5469           <para>GNU/Linux</para>
5470         </col>
5471         <col>
5472           <para>The basic operating system. Allthough the system might work very well on all types on versions of Linux, FreeBSD, OpenBSD or any unices the main focus for distribution is given to: Debian GNU/Linux and RedHat Linux (the downloadable iso-version). </para>
5473         </col>
5474         <col>
5475           <para>Server</para>
5476         </col>
5477       </row>
5478       <row>
5479         <col>
5480           <para>mail</para>
5481         </col>
5482         <col>
5483           <para>The application enabling the sending of messages.</para>
5484         </col>
5485         <col>
5486           <para>Client</para>
5487           <para>Server</para>
5488         </col>
5489       </row>
5490       <row>
5491         <col>
5492           <para>openssh</para>
5493         </col>
5494         <col>
5495           <para>If e-mail is not used this application will deliver the file-copy</para>
5496         </col>
5497         <col>
5498           <para>Client</para>
5499           <para>Server</para>
5500         </col>
5501       </row>
5502       <row>
5503         <col>
5504           <para>PostgreSQL</para>
5505         </col>
5506         <col>
5507           <para>The database where all the signals from client will be stored.</para>
5508         </col>
5509         <col>
5510           <para>Client</para>
5511         </col>
5512       </row>
5513     </table>
5514 <section>
5515 <heading>Related projects</heading>
5516
5517 <para>
5518 There are a number of projects that can help <strong>Gnucomo</strong> or perform
5519 similar funtions:
5520
5521 <itemize>
5522    <item>
5523    <reference href='http://crm114.sourceforge.net/'>CRM114</reference> - The Controllable
5524    Regex Mutilator.
5525    </item>
5526 </itemize>
5527 </para>
5528 </section>
5529 </chapter>
5530
5531 <chapter>
5532   <heading>Settings on the server machine.</heading>
5533
5534 <section>
5535   <heading>Required.</heading>
5536
5537 <para>The following settings are required to ensure that the functionality is as much as expected.</para>
5538
5539 <subsection>
5540   <heading>Timezone in GMT (UTC).</heading>
5541
5542 <para>Since all international traffic registers all entries in UTC (Universal Time Coordinate) this system will do so as well. Therefore the clock has to be adjusted to that as well as the system settings.</para>
5543 <para>These settings can found on a RedHat computer in the <code>/etc/sysconfig/clock-file</code>. On Debian this stored in the file <code>/etc/timezone</code>.</para>
5544 </subsection>
5545 </section>
5546
5547 <section>
5548   <heading>Suggested.</heading>
5549
5550 <subsection>
5551   <heading>Use NTP.</heading>
5552
5553 <para>If a computer is running for some time the clocks tend to be off the correct time. This makes it harder to detect what exactly happened exactly at what moment in time and reduce value of log-entries. Especially considering that ultimately all data is gathered in one central system. To overcome this Network Time Protocol (NTP RFC 13025 March 1992) has been created that explains a protocol to synchronize clocks through the Internet. Many operating systems like Microsoft Windows 2000 Server and FreeBSD, OpenBSD and Linux  support this. A ntp-server (or ntpd) can be found at: http://www.eecis.udel.edu/~ntp/ It is strongly recommended that you use this.</para>
5554
5555     </subsection>
5556     </section>
5557     </chapter>
5558
5559     <chapter>
5560       <heading>Settings on the client machine.</heading>
5561
5562     <section>
5563       <heading>Required.</heading>
5564     </section>
5565
5566     <section>
5567       <heading>Suggested.</heading>
5568
5569     <subsection>
5570       <heading>Use NTP.</heading>
5571
5572     <para>If a computer is running for some time the clocks tend to be off the correct time. This makes it harder to detect what exactly happened exactly at what moment in time and reduce value of log-entries. Especially considering that ultimately all data is gathered in one central system. To overcome this Network Time Protocol (NTP RFC 13025 March 1992) has been created that explains a protocol to synchronize clocks through the Internet. Many operating systems like Microsoft Windows 2000 Server and FreeBSD, OpenBSD and Linux  support this. A ntp-server (or ntpd) can be found at: http://www.eecis.udel.edu/~ntp/ It is strongly recommended that you use this.</para>
5573
5574     </subsection>
5575     </section>
5576     </chapter>
5577
5578     <chapter>
5579       <heading>Appendices.</heading>
5580
5581     <section>
5582       <heading>Appendix A. GNU Public License Version 2, June 1991.</heading>
5583
5584     <para>Copyright (C) 1989, 1991 Free Software Foundation, Inc.</para>
5585     <para>59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
5586     <para>Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</para>
5587
5588     <subsection>
5589       <heading>Preamble</heading>
5590     <para>The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. </para>
5591     <para>When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.</para>
5592     <para>To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.</para>
5593     <para>For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.</para>
5594     <para>We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. </para>
5595     <para>Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.</para>
5596     <para>Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.</para>
5597     <para>The precise terms and conditions for copying, distribution and modification follow.</para>
5598     <para>GNU GENERAL PUBLIC LICENSE</para>
5599     </subsection>
5600
5601     <subsection>
5602       <heading>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</heading>
5603
5604 <enumerate>
5605     <item>
5606       <para>This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The &quot;Program&quot;, below, refers to any such program or work, and a &quot;work based on the Program&quot; means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term &quot;modification&quot;.) Each licensee is addressed as &quot;you&quot;.</para>
5607     <para>Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. </para>
5608     </item>
5609     <item>
5610       <para>You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.</para>
5611     <para>You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.</para>
5612     </item>
5613     <item>
5614       <para>You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</para>
5615     <para>a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.</para>
5616     <para>b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.</para>
5617     <para>c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)</para>
5618     <para>These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</para>
5619     <para>Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.</para>
5620     <para>In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</para>
5621     </item>
5622     <item>
5623       <para>You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:</para>
5624     <para>a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, </para>
5625     <para>b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,</para>
5626     <para>c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)</para>
5627     <para>The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</para>
5628     <para>If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.</para>
5629     </item>
5630     <item>
5631       <para>You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</para>
5632     </item>
5633     <item>
5634       <para>You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.</para>
5635     </item>
5636     <item>
5637       <para>Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein.</para>
5638     <para>You are not responsible for enforcing compliance by third parties to this License.</para>
5639     </item>
5640     <item>
5641       <para>If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.</para>
5642     <para>If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.</para>
5643     <para>It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</para>
5644     <para>This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</para>
5645     </item>
5646     <item>
5647       <para>If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</para>
5648     </item>
5649     <item>
5650       <para>The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</para>
5651     <para>Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and &quot;any later version&quot;, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.</para>
5652     </item>
5653     <item>
5654       <para>If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</para>
5655     </item>
5656 </enumerate>
5657     </subsection>
5658     <subsection>
5659       <heading>NO WARRANTY</heading>
5660 <enumerate>
5661     <item>
5662       <para>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVidE THE PROGRAM &quot;AS IS&quot; WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
5663     </item>
5664     <item>
5665       <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
5666     </item>
5667 </enumerate>
5668     <para>END OF TERMS AND CONDITIONS</para>
5669     </subsection>
5670     <subsection>
5671       <heading>How to Apply These Terms to Your New Programs</heading>
5672     <para>If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. </para>
5673     <para>To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the &quot;copyright&quot; line and a pointer to where the full notice is found.</para>
5674     <para>&lt;one line to give the program's name and a brief idea of what it does.&gt; Copyright (C) &lt;year&gt; &lt;name of author&gt; This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</para>
5675     <para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</para>
5676     <para>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
5677     <para>Also add information on how to contact you by electronic and paper mail.</para>
5678     <para>If the program is interactive, make it output a short notice like this when it starts in an interactive mode:</para>
5679     <para>Gnomovision version 69, Copyright (C) year name of author</para>
5680     <para>Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.</para>
5681     <para>This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.</para>
5682     <para/>
5683     <para>The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.</para>
5684     <para>You should also get your employer (if you work as a programmer) or your school, if any, to sign a &quot;copyright disclaimer&quot; for the program, if necessary. Here is a sample; alter the names:</para>
5685     <para>Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. </para>
5686     <para>&lt;signature of Ty Coon&gt;, 1 April 1989 Ty Coon, President of Vice</para>
5687     <para>This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.</para>
5688     </subsection>
5689     </section>
5690     </chapter>
5691   </book>
5692 </doc>