Documentation Center

IWriteMetadataPlugin - OnFieldChangeAuditViaLogger

Executed when metadata is changed. It only monitors the values of the fields defined in the FieldsToMonitor parameter for which the values changed.

Plugin Configuration

The following parameters can be configured:
ParameterRequiredDefault valueAllowed valuesDescription
LoggerNameYes Defines the name of the logger rule which is configured in specific log configuration file.
LoggerValueSeparatorNo|Defines the separator of logged values. Logged values are separated by separator in log.
FieldsToMonitorYesSee Requested metadata xml.Defines the names and levels of the fields to monitor. For these fields the values are logged.
This example configuration will monitor the values of the FISHANNOTATIONTEXT and FISHANNOTATIONSTATUS fields on the annotation level. If an annotation is created or updated and configured field values are changed, this plugin will log original and new value for each field.
<write ishcondition="ISHType='ISHAnnotation'">
  <body>
    <sequence>
      <plugin name="ISHLOGANNOTATIONCHANGES" handler="OnFieldChangeAuditViaLogger" ishcondition="ISHLevel='annotation'">
        <description>Log metadata changes into separate audit logger (only IWrite, no IDelete coverage)</description>
        <initialize>
          <parameters>
            <parameter name="LoggerName">AnnotationAuditLog</parameter>
            <parameter name="LoggerValueSeparator">|</parameter>
            <parameter name="FieldsToMonitor">
              <ishfields>
                <ishfield name="FISHANNOTATIONTEXT" level="annotation"/>
                <ishfield name="FISHANNOTATIONSTATUS" level="annotation" ishvaluetype="element"/>
              </ishfields>
            </parameter>
          </parameters>
        </initialize>
      </plugin>
    </sequence>
  </body>
</write>

Remarks