Event Log - Write

Declaration

<AMEVENTLOG MESSAGE="text (message to log)" TYPE="text (options)" />

Description: Logs the specified message to the Windows Event Log (not supported on Windows 95/98/ME). This activity can also specify a level value such as warning or error, to limit the events that are written to those that specify the error level.

Practical Usage

Provides a way to record user generated messages onto a central location. Can be used together with an Event Log trigger to control

General Parameters

Property

Type

Required

Default

Markup

Description

Message

 

Yes

(Empty)

MESSAGE="Message to log"

The message to log.

Message type

Text

(options)

Yes

Information

  1. TYPE="information"

  2. TYPE="warning"

  3. TYPE="error"

The type of entry to log. The available options are:

  • Warning - The log entry will be categorized as a warning message, such as an event that is not necessarily significant, but may indicate a possible future problem.

  • Error - The log entry will be categorized as an error message. Can be used to indicate a significant problem such as loss of data or functionality.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description Report error event "There was a problem executing the application."

<AMEVENTLOG MESSAGE="There was a problem executing the application." 
TYPE="error" />