Search

Module: Editor

Version: 4.1.0.0 +

User: Developer

Object Type: Action Object

Parent of:

no children

Child of:

- Action

- XmlBuilder

 

Description

A LogMessage enables a Futurama developer to log custom made messages. The overall configuration of the logging of messages is explained in the log configuration section. Messages are logged similarly to the way Futurama system messages are logged. This means the logging behavior depends on the mode (website, webservice, editor, batch) Futurama is running in.

Properties

Condition

This property indicates under which condition the LogMessage is to be executed. If nothing is entered the LogMessage will always be executed. If a condition has been filled in the LogMessage will only be executed if the Condition is 'True'. In the property a Formula of type Boolean can be entered as well as a Fixed or a Reference to another object of type Boolean.

DebugLogMode (from version 4.1)

Indicates the level of detail of debug information that is logged when running a Futurama application (website, webservice, console application) to the trace, a logfile, a database etc. The possible values are:

  • None: no debug information is logged
  • Simple: only basic information is given
  • Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown

IsPublic

Possible values are True or False. If the value is False, then the object can only be used within the document where it is created. If the value is True, then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is True and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to True only when necessary.

Message

This property represents the string message to be logged. It can contain a Fixed string, but also a Formula (of Type string) or a Reference.

Type

Represents the message type: Info, Warning, Error or Debug. The settings in the log configuration section define whether these message types are actually logged or not.

(Name)

The name of the object.

Comment

Here a comment can be entered. For example a short description of the object.

ID

The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window. 

Related Topics

log configuration section: Here is described how the logging can be set up.

Updated: 2012-08-07