Script Statement: It changes an attribute's value during the generation process.
:PUT_ATT Attribute = Value
Syntax |
Description/Format |
---|---|
Attribute |
The name of the attribute to which a value should be assigned. |
Value |
A suitable value that should be assigned to the attribute. |
Objects are usually processed by using the attributes that have been defined for them. Despite this face, you can use the statement :PUT_ATT in order to change attributes dynamically and assign new values during the generation process. These values are only valid for the particular generation and they are not permanently stored in the objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.
The values that can be assigned to an attribute depend on the system environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications.. The start type " " can only be assigned to a jobAn Automation Engine object type for a process that runs on a target system. that starts immediately or to a groupAn Automation Engine object type that integrates tasks so that they can be processed together. that has already been defined. Any other specification will cause an error during the generation process.
For a list of all object attributes including their allowed values, refer to the User Guide.
Attributes of Rapid Automation jobs may change when new versionsAn application version holds zero or more deployment packages and may have dependencies to zero or more application versions of the same (or to different) applications of the Rapid Automation agents are released. When this happens, :PUT_ATT commands that have been defined in earlier versions of the agents will no longer work. It is possible to use object variablesPlaceholder for values that are stored in an object's "Variables & Prompts" tab/section. for field replacements instead of :PUT_ATT commands for RA specific attributes.
To change a job from using a :PUT_ATT command to an object variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type., do the following:
Note that as of version 3 of the RA FTP and Web Service agents, there are no field replacements anymore for RA attributes. In this case, you must set the attributes using :PUT_ATT.
Changing attributes is only useful before an object is processed. Therefore, you cannot use :PUT_ATT in Post-Process tabs.
Note that attributes can have different maximum lengths. :PUT_ATT does not check the specified value but truncates it to the relevant attribute's maximum length.
You cannot change the start type by using :PUT_ATT if the option "Generate at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start).'" is activated in the object.
Agent groups are resolved before the scriptA particular Automation Engine object type. is processed. This means that the selection on which agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host the taskAn executable object that is running. Tasks are also referred to as activities. will run takes place beforehand. You can use :PUT_ATT in order to define a different agent but not to define a different agent groupAn agent group combines agents of the same platform. The agents that should be included in an agent group are specified by entering the agent name or via filters. A task that runs in an agent group is processed on one or all of the agent group's agents, depending on the specified mode. A particular Automation Engine object type. . The script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… PREP_PROCESS_AGENTGROUP can be used to read the agents of an agent group.
The script statement :PUT_ATT has no effect when you use it in the ! Process tab of an Event object and in Post-Process tabs.
The attributes ATTR_DLG, HOST and SYSLST_DB, SYSLST_FILE, SYSOUT_DB, SYSOUT_FILE, OL, OO (in BS2000 jobs) can only be set using :PUT_ATT in the Pre-Process tab.
:PUT_ATT does not modify the contents of script variables.
You can use this script element in the Process tab in order to limit the maximum number of parallel runs (attribute: MAX_PARALLEL_TASKS). In this case, the limit will only be checked after the script has been processed when the task is generated at runtime.
For example:
:SET &TYPE# = GET_ATT(EVENT_TYPE)
:PUT_ATT EVENT_CHECK_METHOD2 = "FILE_STABLE"
:PRINT &TYPE#
Explanation: Let's assume that the script variableA placeholder for a value within a script. &TYPE# obtains the value "FA" through GET_ATT. After the :PUT_ATT call, the eventAction that is triggered if particular conditions apply. It can be an Automation Engine object type or an entry in a Policy Orchestrator EventBase. type is "FT" because the attribute "FILE_STABLE" belongs to the FileSystem event. Despite this fact, the variable &TYPE# still includes the value "FA."
You cannot change the attributes of a particular object (such as the Login object) by using :PUT_ATT if 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. has write access (W) to the old value but not to the attribute's new value.
To set the queueA particular Automation Engine (AE) object type. In AE, a queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. In ARA, queues are containers for workflow executions that should be executed at a certain time one after another. for a task (QUEUE attribute ), you can use the script element :PUT_ATT in the Pre-Process tab.
Note that when the option Generate at runtime is set in this task, the system will check the available slots and the statusThis represents the condition of a task (such as active, blocked, generating). of the queue before it starts processing the Pre-Process tab. The effect is that the task starts in the modified queue but the system checks the queue that is specified in the object. This means that the limit of the new queue is not verified and as a result, the task may start too early. For example, if the CLIENT_QUEUE is still specified in the queue, the task will start in any case unless it is in a stopped status.
The following example shows how a new agent can be assigned to an object.
:PUT_ATT HOST = "UNIX02"
See also:
Script element | Description |
---|---|
Adds recipients to a notificationAn Automation Engine object type used to send messages to users and user groups. [Formerly called "CallOperator."] at runtime. | |
:REMOVE_ATT | Removes receivers in a notification at runtime. |
:PUT_ATT_APPEND | Extends the notification's message text at runtime. |
GET_ATT | This function returns the values of a task's attributes during generation. |
GET_ATT_SUBSTR | Supplies part of the message text in a notification. |
Script Elements - Read or Modify Objects
Sample Collection
Notification with variable Message Text
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 |