User Guide > UserInterface > Comments in Tasks

 Comments in Tasks

The AE system logs everything that happens in the form of messages, reports and statistical records. Comments can also be stored in tasks. In doing so, you can comment on modifications at runtime or peculiarities that occurred while the task was executed. Reactions to notifications can also be stored.

Comments refer to an individual object execution and are part of the statistical record.

Comments can be added and read in the following windows:

Call the comment window using the Comments... command in the popup window.

The upper window section shows the entries that have been made so far. They are listed in chronological order with the latest one being on top. Each comment includes date, time and user nameName of the Automation Engine user.. They are automatically stored and provide a well-structured history. Comments cannot be changed later on.

A comment including line breaks can comprise of up to 1024 characters. Longer texts are automatically truncated. The number of commenting entries is not limited.

Tasks including comments show a small red edge which is displayed together with the RunID. The following illustration lists tasks in the Activity Window:

If workflows, schedules and notifications include comments, then a red edge is shown in the upper left edge of a monitor.

Comments added to restarts are stored in the object's original execution. Thus, restarted tasks do not have red edges. Calling the comment window opens the original execution's history.

Comments refer to an execution. Hence, comments in Schedule tasks are no longer displayed in monitors after a period turnaround. The statistics, however, provide access to comments at any time.

The search for statistical records can be limited to tasks which include comments.

These task comments can be read in system client 0000. Text cannot be added.

Note that the user right S (access to statistics) is required for viewing task comments. To write a comment, you require the rights S and M (modification at runtime).

The archiving process for statistical records includes comments. The administrator can view these texts using the AE Archive Browser.

Script

AE provides script elements which can be used to handle comments in an automated form:

Script element

Description

:ADD_COMMENT

Adds a comment to a task.

PREP_PROCESS_COMMENTS

Prepares the processing of a data sequence (comments of a task).

 

See also:

Activity Window
Statistics