Logging

Logging

The PR system provides the possibility of logging the device handling and e-document processing. It uses the logging functionalities given by the underlying GX system through the functions of the gxlog module. The properties of the module can be changed by setting the log/* properties of the pr* module or inserting the proper entries in the gxsd.dat property file.

Logging is available for the prapi and capture modules through the pr property node, the prdoc module through the pr/document property node and the prrfid module through the pr/rfid property node.

For more information about logging please read the gxlog module documentation.

Logging the device handling process

By logging the prapi module the user can keep track of the device handling events, like motion detection results, image capture events or device initialization events. To enable logging set the log/logprocess property to have one or more of the following values (separated by commas):

• apierror - logging api errors independent of the user application,
• timing - logging process timings,
• initialization - logging the events of the device initialization

Example:

   <default>
      <pr>
         <log>
            <logprocess value="apierror,initialization"/>
            <file value="prapi.log"/>
            <filter value="6"/>
            <format value="$h:$m:$s ($l:$L) [$i] > $M\r\n"/>
         </log>
      </pr>
   </default>

Performance logging of the document processing module

For the document processing module only the process timings can be logged. Performance logs are generated by setting the log/logprocess property to 'timing'.

Example:

   <default>
      <pr>
         <document>
            <log>
               <logprocess value="timing"/>
               <file value="prdoc.log"/>
               <filter value="6"/>
               <format value="$h:$m:$s ($l:$L) [$i] > $M\r\n"/>
            </log>
         </document>
      </pr>
   </default>

RFID logging

The prrfid module log can be used for logging the communication and work flow between the card and the device. It is useful during the development or the testing process when communication tracing is needed. It should not be used in production systems because it may contain personal data and thus break security norms.

The log/logprocess property for the prrfid module can be set to one or more of the following values (separated by commas):

• cardinfo - logging information about the rfid card capabilities,
• timing - logging process timings,
• initialization - logging the events of the device initialization,
• rfidstream - logging binary data of the communication,
• cryptodata - logging cryptographic data,
• formatting - generates separator lines to the log

Example:

   <default>
      <pr>
         <rfid>
            <log>
               <logprocess value="cardinfo,timing,rfidstream"/>
               <file value="prrfid.log"/>
               <filter value="7"/>
               <format value="$h:$m:$s ($l:$L) [$i] > $M\r\n"/>
            </log>
         </rfid>
      </pr>
   </default>