:ADD_COMMENT

Script statement: Adds a comment to a task

Syntax

:ADD_COMMENT [RUN#] , comment

Syntax

Description/Format

Run#

Run number (RunID) of the task to which a comment should be added
Format: script literal, script variable or number

If no RunID is specified the comment is stored in the task that executes the script statement.

Comment

Comment text
Format: script literal or script variable

Comments

Comment entries include the name of a User object (see Entering Comments). The user who is responsible for activating the object called by the script statement is automatically shown in the commenting area.

Important! The value you assign to a script variable, for example by using the :SET script statement, is unlimited. However, if you use a script variable to define the comment text, the value is truncated at 1024 characters.

Example

The following example adds a comment to the task which is included in the script variable &TEXT#.

:ADD_COMMENT ,&TEXT#

In the second example, the comment is stored in the highest workflow.

:SET &TOP_JP_RunID = SYS_ACT_TOP_NR()
:
ADD_COMMENT &TOP_JP_RunID, "Successfully started FileTransfer."

See also:

Script element Description

PREP_PROCESS_COMMENTS

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

:SET Stores a value in a script variable.

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function