GET_ATT
Use the GET_ATT script function to retrieve the value of an object attribute during the generation process.
If the object attribute is defined by a variable, the system resolves it and returns its corresponding value. The GET_ATT function stores this retrieved value in a script variable without modifying the original source variable. You can use this function to retrieve values stored in the following variable types:
- Script variables
- PromptSet variables
- Object variables
- Predefined variables
For more information about variables, see Variables and VARA Objects.
Syntax
GET_ATT (Attribute)
Parameters
| Parameter | Description | Format |
|---|---|---|
| Attribute | Name of the object attribute from which to retrieve the value. | AE name, script literal or script variable |
Important Considerations
- You can only retrieve values for attributes that are natively available to the specific object.
- If the task executes within an Agent Group, GET_ATT(HOST) returns the name of the specific Agent processing the task, not the Agent Group name.
Examples
This example retrieves the Archive Key of an object and stores the value in a script variable:
: SET &START# = GET_ATT (ARCHIVE_KEY1)
This example uses a script variable to dynamically specify the attribute to retrieve, storing the result in another script variable:
: SET &ATT# = "JOBREPORT_FILE"
: SET &START# = GET_ATT (&ATT#)
This example uses the GET_ATT function to evaluate a condition within an IF statement:
: IF GET_ATT (GROUP) = " "
!...
: ENDIF
This example uses a script variable (&DST#) to define the target file in a File Transfer object. The script sets the attribute using PUT_ATT, retrieves it using GET_ATT, and prints the result to the activation report.
:SET &DST# = "C:\Temp\test2.txt"
:PUT_ATT FT_DST_FILE = "&DST#"
:SET &DEST# = GET_ATT(FT_DST_FILE)
:PRINT "Target file: &DEST#"
Tip: Use the GET_ATT_PLAIN function to retrieve the name of a variable used to define an object attribute without resolving the variable.
See also:
seealso