Posting Messages to the Log

To post messages to the log, use the following methods of the Log object:

• Log.Message - logs an informative message.

• Log.Error - logs an error message.

• Log.Warning - logs a warning message.

• Log.Event - logs an event message.

  Note:

  The number of logged events can be limited by using the Store last … events project property.

• Log.Checkpoint - logs a custom checkpoint message.

Each of these methods lets you specify the message text, text for Details, priority, the message’s font style and color and an image for the log’s Picture pane.

All parameters except for the message text are optional. So, in the simplest case you can use only one parameter - the message text - to post a message to the log. The following code demonstrates this. It calls the Error method to log an error message with the text An error occurred.

Log.Error("An error occurred.")

The following code snippet logs an error with additional information and the highest priority:

Log.Error("Error Message Text", "Details Text", pmHighest)

pmHighest is a built-in constant for specifying the highest priority. Here is a complete list of these constants:

The priority values that you can use in logging methods are not limited with these constants. To specify the priority you can use any integer number, that is, you can use as many priority levels as needed, not just the predefined ones. The following code snippet demonstrates how to post an informative message with a custom priority value:

Log.Message("Message Text", "Extended Text", 350)

The following example demonstrates how to log an image along with a message. It logs a warning with an image of the computer desktop or mobile device screen:

Log.Warning("Warning Message Text", "Extended Text", pmHighest, null, Sys.Desktop)

Log.Warning("Warning Message Text", "Extended Text", pmHighest, null, Sys.Desktop)

Log.Warning("Warning Message Text", "Extended Text", pmHighest, null, Mobile.Device("MyDevice").Desktop.Picture())

...

attr = Log.CreateNewAttributes()
attr.ExtendedMessageAsPlainText = False
# Open a text file holding HTML code
MyFile = aqFile.OpenTextFile("c:\\MyHTMLCode.txt", aqFile.faRead, aqFile.ctANSI)

# Read the HTML code from the file to a single string
str = MyFile.ReadAll()

# Post a log message with the HTML page as extended information
Log.Message("Message Text", str, 300, attr)
...

In keyword tests, you can use the Log Message operation to add messages to the test log. This operation lets you choose the message type (information, error, warning and so on), specify the message text, priority and other parameters. For example, to log an error with the highest priority, follow these steps:

• Add the Log Message operation to your keyword test.

• In the operation parameters wizard:

  • Choose Error to specify that we will post an error message.

  • Type An error occurred into the Message text box. This is the text of our message.

  • Switch to the Details tabbed page and type Additional Info text there. This is the extended text of our message.

  Click Next.

• The second page displays all of the parameters of the message. As you can see, the MessageText parameter contains the message text, and the AdditionalText parameter contains the extended text that we specified on the previous page.

  In our case, we need to specify the priority. To do this, enter 500 into the Priority cell and press Enter. (500 corresponds to the pmHighest constant. See above).

  For detailed information on how to specify parameter values on this page, see Specifying Operation Parameters.

• Click Finish to close the wizard and to add the operation to the test.

Now after this operation is run, the “An error occurred” error message will be added to the log with the highest priority and the string “Additional Info text” as additional information.