:ADD_COMMENT

Use the :ADD_COMMENT script statement to add a comment to a task. Comment entries include the name of a User object. The user who activated the object called by the script statement is automatically shown in the comment area. For more information, see Adding Comments.

Syntax

:ADD_COMMENT [RunID] , comment

Parameters

• :ADD_COMMENT
  Adds a comment to a task

• RunID
  (Optional) RunID of the task to add the comment to
  Note: If you do not specify a RunID, the comment is added in the task that executes the script statement.
  Format: script literal, script variable, or number

• comment
  Comment text
  Format: script literal or script variable
  Maximum characters: 1024
  Important! The value you assign to a script variable is unlimited. However, when you use a script variable to define a comment text, the value of the script variable is truncated to 1024 characters.

Example

The following example adds a comment to the task that contains the script. The text in the comment is stored in a script variable.

:ADD_COMMENT ,&TEXT#

In the following example, the script retrieves the RunID of the top Workflow, and adds a comment to that Workflow.

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

See also: