Home » API » Documentation » API » Scraping Engine API » log

webInfo

void log.webInfo ( Object object ) (professional and enterprise editions only)
void log.webInfo ( Object object, boolean saveMessage ) (professional and enterprise editions only)
void log.webInfo ( Object object, Object loggable ) (professional and enterprise editions only)
void log.webInfo ( Object object, boolean saveMessage, Object loggable ) (professional and enterprise editions only)

Description

Logs an info message to the web interface status message area. Uses the message header as the top of the message, and then logs all currently monitored session variables underneath as well as the current progress (if known) of the scrape. Also outputs the message to the log. When running in Professional edition, this simply outputs to the log.

Using this method is preferred over logMonitoredValues (which only logs to the log), because if at a later point the scrape is run in server mode for enterprise edition, a useful message is output in the web interface without needing to modify the scrape.

Parameters

  • object The message to display as a header
  • saveMessage (optional) Whether or not to save this message and continue to display it below future web messages. By default info messages are not saved.
  • loggable (optional) An additional object to log, most likely a DataRecord. This will only be logged with this message, and not 'monitored' like other values

Return Value

This method returns void.

Change Log

Version Description
5.5.29a Available in professional and enterprise editions.
5.5.43a Moved from session to log class.

Examples

Log monitored variables and progress

 log.webInfo("Record Saved");

mikes on 11/18/2011 at 6:02 pm