Event Log - Write

Declaration

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

Related Topics   

Description

Logs the specified message to the Windows Event Log. This activity can also specify a level value such as warning or error, in order 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 in order to control

Parameters

General

Property Type Required Default Markup Description
Message Text Yes (Empty) MESSAGE="Message to log" The message to log.
Message type Text(options) Yes Information
  • TYPE="information"
  • TYPE="warning"
  • TYPE="error"
 The type of entry to log. The available options are:
  • Information (default) - The log entry will be categorized as information. This can be used to display general information or describe successful operation of an application, driver, or service.
  • 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

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task reports an error event.

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