Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > :ADD_COMMENT

:ADD_COMMENT

Script statement: Adds a comment to a taskAn executable object that is running. Tasks are also referred to as activities.

Syntax

:ADD_COMMENT [RunID], comment

Syntax

Description/Format

RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component .

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 scriptA particular Automation Engine object type. statement.

Comment

Comment text
Format: script literal or script variableA placeholder for a value within a script.

Comments

Comment entries include the name of a User objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task. The userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. who is responsible for activating the object called by the script statement is automatically entered in the comment area.

The length of the comment is limited in that a script line must not exceed 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 workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."].

: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).

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH