Ignore:
Timestamp:
Aug 21, 2009, 8:17:57 AM (14 years ago)
Author:
Nicklas Nordborg
Message:

References #108: Logging the change history of an item

  • Added the new data classes to UML diagram and made updates to all other affected diagrams
  • Documented the logging feature for plug-in developers
  • Made the new data classes immutable
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/appendix/base.config.xml

    r5023 r5071  
    564564  </simplesect>
    565565 
     566  <simplesect id="appendix.base.config.log">
     567    <title>Change history logging section</title>
     568   
     569    <para>
     570      This section contains settings for logging the change history
     571      of items.
     572    </para>
     573   
     574    <variablelist>
     575    <varlistentry>
     576      <term><property>changelog.factory</property></term>
     577      <listitem>
     578        <para>
     579        The factory class that controls the entire logging system. The
     580        factory has control of what should be logged, were it should
     581        be logged, etc. BASE ships with one factory implementation
     582        <classname docapi="net.sf.basedb.core.log.db">DbLogManagerFactory</classname>
     583        which logs changes into tables in the database. The server admin
     584        may choose a different implementation provided that it implements
     585        the <interfacename docapi="net.sf.basedb.core.log">LogManagerFactory</interfacename>
     586        interface. See <xref linkend="plugin_developer.other.logging" />.
     587        If no factory is specified, logging is disabled.
     588          </para>
     589      </listitem>
     590    </varlistentry>
     591    <varlistentry>
     592      <term><property>changelog.show-in-web</property></term>
     593      <listitem>
     594        <para>
     595        A boolean value that specifies if the <guilabel>Change history</guilabel>
     596        tab should be visible in the web interface or not. The change history
     597        tab will show log information that has been stored in the database
     598        and it doesn't make sense to show this tab unless the
     599        <classname docapi="net.sf.basedb.core.log.db">DbLogManagerFactory</classname>
     600        is used.
     601          </para>
     602         
     603          <note>
     604            <para>
     605            By default, only users that are members of the
     606            <guilabel>Administrator</guilabel> role have permission to
     607            view the change history. To give other users the same permission,
     608            add the <guilabel>Change history</guilabel> permission to
     609            the appropriate role(s).
     610            </para>
     611          </note>
     612      </listitem>
     613    </varlistentry>
     614    <varlistentry>
     615      <term><property>changelog.dblogger.detailed-properties</property></term>
     616      <listitem>
     617        <para>
     618        A boolean value that specifies the amount of information
     619        that should be logged. If set, the log will contain information
     620        about which properties that was modified on each item,
     621        otherwise only the type of change (create, update, delete) is
     622        logged.
     623        </para>
     624      </listitem>
     625    </varlistentry>
     626    </variablelist>
     627   
     628  </simplesect>
     629 
    566630  <simplesect id="appendix.base.config.secondary.other">
    567631    <title>Other settings</title>
Note: See TracChangeset for help on using the changeset viewer.