LogRecord API

LogRecord stores two types of logs.

This code executes an update operation and examines the log records for the Customer MBO:

int id = 101;
Customer result = Customer.findById(id);
result.setFname("newFname");
result.save();
result.submitPending();
SMP101DB.synchronize();
result = Customer.findById(id);
for(com.sybase.persistence.LogRecord logRecord : result.getLogRecords())
{
   //Working with logRecord
}

The code in the log record is an HTTP status code. See Developer Guide: Android Object API Applications >Client Object API Usage >Exceptions > Handling Exceptions > HTTP Error Codes.

There is no logRecord generated for a successful operation replay. The SAP Mobile Server only creates a logRecord when an operation fails or completes with warnings.

This sample code shows how to find the corresponding MBO with the LogRecord and to delete the log record when a record is processed.

private void processLogs()
{
  Query query = new Query();
  GenericList<LogRecord> logRecords = SMP101DB.getLogRecords(query);
  for(LogRecord log : logRecords)
  {
    // log warning message
    Log.warning("log " + log.getComponent() + ":" + log.getEntityKey()
    + " code:" + log.getCode()
    + " msg:" + log.getMessage());
			
    if (log.getComponent().equals("Customer"))
    {
      long surrogateKey = Long.parseLong(log.getEntityKey());
      Customer c = Customer.find(surrogateKey);
      if (c.isPending())
      {
	     c.cancelPending();
      }
				
    // delete the LogRecord after it is processed
      log.delete();
      log.submitPending();
    }
   SMP101DB.beginSynchronize(null, null);
}
A LogRecord is not generated for a successful operation replay. SAP Mobile Server only creates one when an operation fails or completes with warnings. The client is responsible for removing operation replay log records. SAP Mobile Server typically allows a period of time for the client to download and act on the operation replay log record. Therefore, the client should proactively remove these log records when they are consumed. Failure to do so may result in accumulation of operation replay log records until SAP Mobile Server removes them. This sample code illustrates how to find the corresponding MBO with the LogRecord and delete the log record when it is processed.
private void processLogs() 
{ 
   Query query = new Query(); 
   GenericList<LogRecord> logRecords = SMP101DB.getLogRecords(query); 
   for(LogRecord log : logRecords) 
   { 
      // log warning message 
      Log.warning("log " + log.getComponent() 
      + ":" + log.getEntityKey() 
      + " code:" + log.getCode() + " msg:" + log.getMessage()); 

      if (log.getComponent().equals("Customer")) 
      { 
         long surrogateKey = Long.parseLong(log.getEntityKey()); 
         Customer c = Customer.find(surrogateKey); 
         if (c.isPending()) 
         { 
            c.cancelPending(); 
         } 

         // delete the LogRecord after it is processed 
         log.delete(); 
         log.submitPending(); 
      } 
   }
SAP Mobile Server is responsible for deleting client log records uploaded by the application. These application logs are used for audit and/or support services. Determine and set the retention policy from SAP Control Center after consulting with the application's developers. If there are multiple applications using the same package, retain them based on the maximum required time for each application. Client log records are removed that are outside the retention window, and deleted records removed from the client database the next time the application synchronizes. See Improve Synchronization Performance by Reducing the Log Record Size in Troubleshooting for details about reducing the Log Record size.